-
Notifications
You must be signed in to change notification settings - Fork 223
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
chore: add spell check #2953
Merged
Merged
chore: add spell check #2953
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
erika-wallace
temporarily deployed
to
AcceptanceTests
July 29, 2024 20:33
— with
GitHub Actions
Inactive
erika-wallace
temporarily deployed
to
AcceptanceTests
July 29, 2024 20:33
— with
GitHub Actions
Inactive
erika-wallace
temporarily deployed
to
AcceptanceTests
July 29, 2024 20:45
— with
GitHub Actions
Inactive
erika-wallace
temporarily deployed
to
AcceptanceTests
July 29, 2024 20:45
— with
GitHub Actions
Inactive
zwhitfield3
reviewed
Jul 29, 2024
zwhitfield3
reviewed
Jul 29, 2024
zwhitfield3
reviewed
Jul 29, 2024
zwhitfield3
reviewed
Jul 29, 2024
zwhitfield3
approved these changes
Jul 29, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This PR is well structured with a clean implementation. The testing instructions were clear and easy to follow. This is fantastic work @erika-wallace! Can't wait to see this new CI check in action!
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.
Description
Work Item
This pull request adds a job to the Tests workflow and a Git pre-commit hook to the CLI repository, both dedicated to spell checking modified files. The spell checker will generate a list of any misspelled words it detects, including the file and line number. Also, there's a
custom-dictionary.txt
file that should be updated with words, variables, package names, etc. that are flagged by the spell checker but are not actually misspelled.The
spell-check
job in the Tests workflow will fail if any spelling errors are detected, and the Git pre-commit hook will block the commit. To bypass the Git pre-commit hook and commit changes without running the spell check, use the-n
flag.Testing
yarn
NOTE: There should be a Git error when you try to commit, that's the expected behavior of the Git pre-commit hook due to the misspellings.
git commit
with the-n
flag and push changes to the branchNOTE: This will bypass the Git pre-commit hook and initiate the Tests workflow, which should also fail as expected.
-n
flag)NOTE: At this point, the commit should go through and the Tests workflow should pass.