build(docs): auto alphabetize .spelling file
#12521
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
- run a tiny shell script as part of `make docs-spellcheck` to alphabetize the file
- currently made it case-senstive sorted as that was a smaller diff / more consistent with the existing ordering
- but could make it case-insensitive if we wanted to
- slightly rewrite comments / naming in Docs GHA Workflow step to account for this additional "linter"
Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
agilgur5
added
area/docs
9 tasks
|
Windows unit test randomly failed, but that is a flake and not currently required to pass CI |
Joibel
reviewed
Jan 15, 2024
- the previous text was direclty taken from [the README](https://github.com/lukeapage/node-markdown-spellcheck/blob/78ad8e3c21fe982a1e4d1fc1fbf421fb57c9739b/readme.md?plain=1#L106) - we don't use the ` - filename` config part (and nor am I sure how it works), so remove that - comment that `# ` is a comment is self-explanatory / redundant if there is a single comment - clarify that we use this as a dictionary specifically and no other config Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
terrytangyuan
approved these changes
Jan 17, 2024
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.
Fixes #12360 (comment)
Related to #11814 (comment)
Motivation
We've had a few different attempts to alphabetize this at different times, but manual efforts mean that things can get undone unfortunately easily. So I wrote a tiny script to automate alphabetizing it
Modifications
run a tiny shell script as part of
make docs-spellcheckto alphabetize the fileclarify / shorten comments in the
.spellingfile (was previously verbatim copy+pasted from its README)slightly rewrite comments / naming in Docs GHA Workflow step to account for this additional "linter"
Verification
Makefile, where the$(shell ...)was necessarydevcontainerand native on macOS{ head -n 5; sort; }or{ sed -u 5q; sort; }did not seem to work on my Mac, so I went with theawkvariantcat <(head -n 5 .spelling) <(tail -n +6 .spelling | sort | uniq)| teein there as just redirecting the output with> .spellingwould cause an empty file