Lint: CI for structure and spelling #4
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
This commit starts to add additional linting for the OAP, in order to validate the structure and content of the documents. There are two pieces to this commit: * Structural linting uses yamale to validate the OAP data against yaml schema for equipment, points, and tags files. The schemas are based on the actual data present and so might not be exactly what the designers intended; but prevent indentation errors. * Spellchecking runs cspell on the text. Identifiers and other words must be added to lint/ids.txt or the build will fail. * Two github workflows which run these linters on commit. In the future, we should add additional check; eg to ensure each point has a definition (see OntologyAlignmentProject#2); but until that issue is closed the test would fail anyways.
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.
Here is another concept of how to add a post-commit hook which validates the structure.
I took my best guess about the YAML structure, so I'm sure it could be refined; but it definitely helps with any YAML indentation issues or typeos in keys.