lint: add more linting rules for track config.json #183
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The properties validated are: - language: non-empty string (required) - slug: non-empty string (required) - blurb: non-empty string (required) - active: boolean (required) - version: integer (required)
This signals to the reader that the tags are known at compile-time.
Otherwise, it always performs 36 string comparisons for every input tag.
Nim supports trailing commas here, and this reduces the diff if we ever add more tags underneath.
Put only names to the right to avoid possible ambiguity with "version and tags fields".
I think this makes it easier: - for us to compare our code to the spec and see which fields we currently check. - for end users to compare the success message output with their config.json file and see which fields haven't been checked. See the order in the spec: https://github.com/exercism/docs/blob/main/anatomy/tracks/configlet/linting.md#rule-configjson-file-is-valid
ee7
approved these changes
Feb 19, 2021
There was a problem hiding this comment.
Non-blocking comment: Can we think of a better name than track.nim? I think:
- it's too close to
src/sync/tracks.nim - it sounds like it handles linting the whole track, when actually it just handles the root
config.jsonfile
I'm fine with something like these:
track_config.nimroot_config.nim
or whatever you like.
Otherwise LGTM - approved, conditional on squashing at merge-time.
ErikSchierboom
commented
Feb 19, 2021
src/lint/track.nim
Outdated
| "used_for/web_development" | ||
| ] | ||
| "used_for/web_development", | ||
| ].toHashSet() |
There was a problem hiding this comment.
Doh. I should have come up with this myself 🤦
|
I'm fine with |
This avoids confusion with `src/sync/tracks.nim` and makes it clearer that the file just handles linting of the root `config.json` file, not the whole track.
|
Squashed and merged |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds some more linting rules for the track's config.json.
I'm not really happy with our error messages, but we can improve that later on. At this stage, it is important to just have some validation.