Add spellchecking tools + CI #44
Merged
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
All lists of names referencing BPF functions, maps, and programs are now generated with code blocks. This allows the spell checker to ignore these names. Signed-off-by: Dylan Reimerink <[email protected]>
This commit adds a new spellcheck tool. The purpose of which is to be our first CI tooling to check for spelling errors. Due to the use of markdown extensions and code generation, it is difficult to use ready made tools. What our custom tool does is render the markdown files to HTML, parse the HTML with custom logic and exceptions, then feed the text into `aspell` (GNU spell checker) to check for spelling errors, and then do a best effort to find the location of the spelling mistake in the markdown files. Aspell allows to the addition of a personal word list, which will be added in a followup commit. In addition, the tool excludes code blocks, text between <nospell></nospell> tags, generated output, and html which is not from the markdown files. Signed-off-by: Dylan Reimerink <[email protected]>
This commit addresses all spelling errors found by the new spellchecker in one of the following ways: * Fixing the spelling in the docs * Adding correct jagron and shorthands to the .aspell.en.pws file * Adding markdown code backticks around code references, names and commands * Adding <nospell> tags around one-off unrecognized spelling which do not need to be added to the .aspell.en.pws file. Signed-off-by: Dylan Reimerink <[email protected]>
dylandreimerink
force-pushed
the
feature/spell-check
branch
2 times, most recently
from
42e24cc to
08b050a
Compare
This commits adds a workflow file which triggers `make spellcheck` for every opened PR. Signed-off-by: Dylan Reimerink <[email protected]>
dylandreimerink
force-pushed
the
feature/spell-check
branch
2 times, most recently
from
390a04a to
929c702
Compare
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.
This PR adds a spelling checker. Implemented as a custom layer around aspell to deal with our somewhat unique markdown dialect.
What our custom tool does is render the markdown files to HTML, parse the HTML with custom logic and exceptions, then feed the text into
aspell(GNU spell checker) to check for spelling errors, and then do a best effort to find the location of the spelling mistake in the markdown files.Existing issues found be the spellchecker were resolved in one of the following ways:
commands
not need to be added to the .aspell.en.pws file.