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

config-json.md: files.invalidator not documented? #428

Open
fapdash opened this issue Feb 4, 2023 · 1 comment
Open

config-json.md: files.invalidator not documented? #428

fapdash opened this issue Feb 4, 2023 · 1 comment

Comments

@fapdash
Copy link
Contributor

fapdash commented Feb 4, 2023

I just saw this PR utilizing files.invalidator and it doesn't seem to be documented in https://github.com/exercism/docs/blob/43a2d226da5e2c8631de8d5006adb9c60ccf877b/building/tracks/config-json.md.

Is this on purpose or should this be added?

@ee7
Copy link
Member

ee7 commented Feb 4, 2023

Is this on purpose or should this be added?

I believe it's an oversight - it should be added. It's documented elsewhere:

- The `"files.invalidator"` key is optional
- The `"files.invalidator"` value must be an array
- The `"files.invalidator"` values must be valid patterns⁵
- The `"files.invalidator"` values must not have duplicates
- Patterns can only be listed in either the `"files.solution"`, `"files.test"`, `"files.example"`, `"files.exemplar"`, `"files.editor"` or `"files.invalidator"` array (no overlap)

- The `"files.invalidator"` key is optional
- The `"files.invalidator"` value must be an array
- The `"files.invalidator"` values must not have duplicates
- The files listed in the `"files.solution"` must exist
- The files listed in the `"files.test"` must exist
- The files listed in the `"files.exemplar"` must exist
- The files listed in the `"files.editor"` must exist
- The files listed in the `"files.invalidator"` must exist
- Files can only be listed in either the `"files.solution"`, `"files.test"`, `"files.exemplar"` or `"files.invalidator"` array (no overlap)

- The `"files.invalidator"` key is optional
- The `"files.invalidator"` value must be an array
- The `"files.invalidator"` values must not have duplicates
- 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
- The files listed in the `"files.editor"` must exist
- The files listed in the `"files.invalidator"` must exist
- Files can only be listed in either the `"files.solution"`, `"files.test"`, `"files.example` or `"files.invalidator"` array (no overlap)

- `invalidator`: files that when changed, cause a solution to become out-of-date (optional)

- `invalidator`: files that when changed, cause a solution to become out-of-date (optional)

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

No branches or pull requests

2 participants