chore: add schema validation to yaml for documentation #2518
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.
Description
This adds a schema validation task to each component which will check all metadata files for valid formatting and that it aligns with the defined rules in
./schemas/documentation.schema.json
.This validation can be run ad-hoc and runs as part of the lint-staged task to prevent new invalid schema from being committed (can still be overwritten with --no-verify).
How and where has this been tested?
Please tag yourself on the tests you've marked complete to confirm the tests have been run by someone other than the author.
Validation steps
Add an invalid entry to the
components/accordion/metadata/*.yml
(i.e.,foo: bar
):yarn validator accordion
: should report the error to the consoleyarn validate
: should report success for other components and report the failure for accordion's schemaTo-do list