-
Notifications
You must be signed in to change notification settings - Fork 66
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
Add check-spelling #535
Draft
jsoref
wants to merge
1
commit into
gitgitgadget:main
Choose a base branch
from
jsoref:check-spelling
base: main
Could not load branches
Branch not found: {{ refName }}
Could not load tags
Nothing to show
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Add check-spelling #535
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
# check-spelling/check-spelling configuration | ||
|
||
File | Purpose | Format | Info | ||
-|-|-|- | ||
[dictionary.txt](dictionary.txt) | Replacement dictionary (creating this file will override the default dictionary) | one word per line | [dictionary](https://github.com/check-spelling/check-spelling/wiki/Configuration#dictionary) | ||
[allow.txt](allow.txt) | Add words to the dictionary | one word per line (only letters and `'`s allowed) | [allow](https://github.com/check-spelling/check-spelling/wiki/Configuration#allow) | ||
[reject.txt](reject.txt) | Remove words from the dictionary (after allow) | grep pattern matching whole dictionary words | [reject](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-reject) | ||
[excludes.txt](excludes.txt) | Files to ignore entirely | perl regular expression | [excludes](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-excludes) | ||
[only.txt](only.txt) | Only check matching files (applied after excludes) | perl regular expression | [only](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-only) | ||
[patterns.txt](patterns.txt) | Patterns to ignore from checked lines | perl regular expression (order matters, first match wins) | [patterns](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-patterns) | ||
[expect.txt](expect.txt) | Expected words that aren't in the dictionary | one word per line (sorted, alphabetically) | [expect](https://github.com/check-spelling/check-spelling/wiki/Configuration#expect) | ||
[advice.txt](advice.txt) | Supplement for GitHub comment when unrecognized words are found | GitHub Markdown | [advice](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-advice) | ||
|
||
Note: you can replace any of these files with a directory by the same name (minus the suffix) | ||
and then include multiple files inside that directory (with that suffix) to merge multiple files together. |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
advice.txt |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
<!-- See https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-advice --> <!-- markdownlint-disable MD033 MD041 --> | ||
<details><summary>If you see a bunch of garbage</summary> | ||
|
||
If it relates to a ... | ||
<details><summary>well-formed pattern</summary> | ||
|
||
See if there's a [pattern](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples:-patterns) that would match it. | ||
|
||
If not, try writing one and adding it to the `patterns.txt` file. | ||
|
||
Patterns are Perl 5 Regular Expressions - you can [test]( | ||
https://www.regexplanet.com/advanced/perl/) yours before committing to verify it will match your lines. | ||
|
||
Note that patterns can't match multiline strings. | ||
</details> | ||
<details><summary>binary-ish string</summary> | ||
|
||
Please add a file path to the `excludes.txt` file instead of just accepting the garbage. | ||
|
||
File paths are Perl 5 Regular Expressions - you can [test]( | ||
https://www.regexplanet.com/advanced/perl/) yours before committing to verify it will match your files. | ||
|
||
`^` refers to the file's path from the root of the repository, so `^README\.md$` would exclude [README.md]( | ||
../tree/HEAD/README.md) (on whichever branch you're using). | ||
</details> | ||
|
||
</details> |
Empty file.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
# See https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples:-excludes | ||
(?:^|/)(?i)COPYRIGHT | ||
(?:^|/)(?i)LICEN[CS]E | ||
(?:^|/)package(?:-lock)\.json$ | ||
(?:^|/)vendor/ | ||
ignore$ | ||
\.lock$ | ||
\.min\. | ||
\.mod$ | ||
^images/gitgitgadget\.png$ | ||
^script/lookup-commit\.sh$ | ||
^\.github/ | ||
^\.vscode/settings\.json$ |
Oops, something went wrong.
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.
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 content is included as supplemental text to a GitHub comment when a commit/PR introduces unknown words into the repository in a file that isn't excluded on a line where that content isn't masked.