Skip to content

Add linting section on practice exercise .meta/config.json validation #91

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Mar 23, 2021
Merged

Add linting section on practice exercise .meta/config.json validation #91

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 29 additions & 1 deletion building/configlet/lint.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ The `config.json` file should have the following checks:
- The `"authors"` values must not have duplicates
- The `"authors"` values are treated case-insensitively
- The `"contributors"` key is optional
- The `"contributors"` value must be a non-empty array
- The `"contributors"` value must be an array
- The `"contributors"` values must be non-empty, non-blank strings
- The `"contributors"` values must not have duplicates
- The `"contributors"` values are treated case-insensitively
Expand Down Expand Up @@ -209,6 +209,34 @@ The `config.json` file should have the following checks:
- The Markdown must conform to the [Markdown standards](../../../contributing/standards/markdown.md)
- Links must be absolute (relative links are not allowed)

### Rule: exercises/practice/<slug>/.meta/config.json is valid

- The file must be valid JSON
- The JSON root must be an object
- The `"authors"` key is optional
- The `"authors"` value must be an array
- The `"authors"` values must be non-empty, non-blank strings
- The `"authors"` values must not have duplicates
- The `"authors"` values are treated case-insensitively
- The `"contributors"` key is optional
- The `"contributors"` value must be an array
- The `"contributors"` values must be non-empty, non-blank strings
- The `"contributors"` values must not have duplicates
- The `"contributors"` values are treated case-insensitively
- Users can only be listed in either the `"authors"` or `"contributors"` array (no overlap)
- The `"files.solution"` key is required
- The `"files.solution"` value must be a non-empty array
- The `"files.test"` key is required
- The `"files.test"` value must be a non-empty array
- The `"files.example"` key is required
- The `"files.example"` value must be a non-empty array
- The files listed in the `"files.solution"` must exist
- The files listed in the `"files.test"` must exist
- The files listed in the `"files.example"` must exist
- Files can only be listed in either the `"files.solution"`, `"files.test"` or `"files.example` array (no overlap)
- The `"language_versions"` key is optional
- The `"language_versions"` value must be a string

### Rule: exercises/shared/.docs/cli.md is valid

- The Markdown must conform to the [Markdown standards](../../../contributing/standards/markdown.md)
Expand Down