Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reformat exercise config files #531

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Conversation

kytrinyx
Copy link
Member

@kytrinyx kytrinyx commented Dec 4, 2022

This runs the bin/configlet fmt --update command to
reformat the exercise configs.

This runs the `bin/configlet fmt --update` command to
reformat the exercise configs.
@kytrinyx kytrinyx requested a review from a team as a code owner December 4, 2022 12:07
@SaschaMann SaschaMann marked this pull request as draft December 4, 2022 14:02
Copy link
Contributor

@SaschaMann SaschaMann left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This moves the most relevant info in that file down for no apparent reason. It should not be merged as it is imo.

@kytrinyx
Copy link
Member Author

kytrinyx commented Dec 4, 2022

This is the behavior of Configlet. The order of keys is alphabetical.
This has been reviewed, approved, and released for over a year.

Update: I was wrong about the order of keys. It is explicitly defined and described here: exercism/configlet#468

I am in favor of leaving fmt the way it is, as I value the consistency and predictability of the choices that were made.

Please reconsider merging this PR.

If you care so strongly about this that you do not wish to merge the PR, then please do what it takes to reach consensus with staff and maintainers so that all tracks can use the automation consistently.

@SaschaMann
Copy link
Contributor

SaschaMann commented Dec 4, 2022

That's an arbitrary order for a file that's meant to be edited and updated by humans and there's no "why" that explains why this change is useful or should be made.

This isn't the first time weird workarounds are needed due to configlet behaviour that isn't well thought out, see #523.

@kytrinyx
Copy link
Member Author

kytrinyx commented Dec 4, 2022

@SaschaMann I'm not saying that you're wrong. I'm asking you to help move things forward.

I see two solutions here:

  1. Configlet remains as is.
  2. Configlet changes.

You can decide that you don't actually care that much about this particular change, or you can decide that you do, in fact, care a lot about this particular change, in which case it is up to you to convince all the other maintainers and the Exercism staff that your way is better.

Whatever the decision ends up being, that's a decision that I expect all track maintainers to follow.

This isn't the first time weird workarounds are needed due to configlet behaviour that isn't well thought out

Did you suggest an improvement to Configlet for that case? For example, if the track's config.json had exercises and concepts that are in a wip state, perhaps Configlet could refrain from linting or fmting them.

@kytrinyx
Copy link
Member Author

I was wrong about the order of the keys being alphabetical. The order of keys is defined, and is described here:
exercism/configlet#468

I would ask that you open an issue on the configlet repository to suggest tweaking the order, if you feel this is important.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants