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

lint(track_config): add initial concepts checks #264

Merged
merged 1 commit into from
Apr 2, 2021

Conversation

ee7
Copy link
Member

@ee7 ee7 commented Apr 2, 2021

This commit fully implements these rules:

  • The "concepts" key is required
  • The "concepts" value must be an array
  • The "concepts[].uuid" key is required
  • The "concepts[].slug" key is required
  • The "concepts[].name" key is required

And partially implements these rules:

  • The "concepts[].uuid" value must be a unique, lowercased v4 UUID string
  • The "concepts[].slug" value must be a non-empty, non-blank, lowercased string using kebab-case
  • The "concepts[].name" value must be a non-empty, non-blank, titleized string

These rules are not yet implemented:

  • The "concepts" value must have a entry with a matching "slug" property for each concept listed in a concept exercise's "concepts" property
  • Each "concepts" value must have a concept/<concepts.slug>/about.md file.
  • Each "concepts" value must have a concept/<concepts.slug>/introduction.md file.
  • Each "concepts" value must have a concept/<concepts.slug>/links.json file.

This PR causes the below diff to the output of configlet lint

research_experiment_1

+Missing key: 'concepts':
+./config.json
+

That is:

  • all of the real tracks have a concepts that is at least the empty array.
  • all of the tracks that have a non-empty array pass the checks.

@ee7 ee7 requested a review from ErikSchierboom as a code owner April 2, 2021 11:56
@ee7 ee7 merged commit d757b6f into exercism:main Apr 2, 2021
@ee7 ee7 deleted the lint-track-config-concepts branch April 2, 2021 12:35
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