Skip to content

Commit eee3510

Browse files
jsorefjsoref
committed
Add check-spelling
1 parent 5656ab2 commit eee3510

File tree

8 files changed

+1981
-0
lines changed

8 files changed

+1981
-0
lines changed

‎.github/actions/spelling/README.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# check-spelling/check-spelling configuration
2+
3+
File | Purpose | Format | Info
4+
-|-|-|-
5+
[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)
6+
[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)
7+
[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)
8+
[excludes.txt](excludes.txt) | Files to ignore entirely | perl regular expression | [excludes](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-excludes)
9+
[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)
10+
[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)
11+
[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)
12+
[advice.md](advice.md) | Supplement for GitHub comment when unrecognized words are found | GitHub Markdown | [advice](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-advice)
13+
14+
Note: you can replace any of these files with a directory by the same name (minus the suffix)
15+
and then include multiple files inside that directory (with that suffix) to merge multiple files together.

‎.github/actions/spelling/advice.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
<!-- See https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-advice --> <!-- markdownlint-disable MD033 MD041 -->
2+
<details><summary>If you see a bunch of garbage</summary>
3+
4+
If it relates to a ...
5+
<details><summary>well-formed pattern</summary>
6+
7+
See if there's a [pattern](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples:-patterns) that would match it.
8+
9+
If not, try writing one and adding it to the `patterns.txt` file.
10+
11+
Patterns are Perl 5 Regular Expressions - you can [test](
12+
https://www.regexplanet.com/advanced/perl/) yours before committing to verify it will match your lines.
13+
14+
Note that patterns can't match multiline strings.
15+
</details>
16+
<details><summary>binary-ish string</summary>
17+
18+
Please add a file path to the `excludes.txt` file instead of just accepting the garbage.
19+
20+
File paths are Perl 5 Regular Expressions - you can [test](
21+
https://www.regexplanet.com/advanced/perl/) yours before committing to verify it will match your files.
22+
23+
`^` refers to the file's path from the root of the repository, so `^README\.md$` would exclude [README.md](
24+
../tree/HEAD/README.md) (on whichever branch you're using).
25+
</details>
26+
27+
</details>

‎.github/actions/spelling/allow.txt‎

Whitespace-only changes.

‎.github/actions/spelling/excludes.txt‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# See https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples:-excludes
2+
(?:^|/)(?i)COPYRIGHT
3+
(?:^|/)(?i)LICEN[CS]E
4+
(?:^|/)package(?:-lock|)\.json$
5+
(?:^|/)vendor/
6+
ignore$
7+
\.avi$
8+
\.exe$
9+
\.ico$
10+
\.jpe?g$
11+
\.lock$
12+
\.map$
13+
\.min\..
14+
\.mod$
15+
\.mp[34]$
16+
\.pdf$
17+
\.png$
18+
\.wav$
19+
^attack/disclosure-directory/
20+
^attack/disclosure-localpaths/
21+
^attack/email/
22+
^attack/file-upload/malicious-images/
23+
^attack/html_js_fuzz/
24+
^attack/ip/
25+
^attack/json/
26+
^attack/unicode/
27+
^attack/xml/
28+
^discovery/dns/
29+
^discovery/predictable-filepaths/
30+
^discovery/UserAgent/
31+
^docs/misc/htmlcodes-cheatsheet\.htm$
32+
^wordlist
33+
^\.github/
34+
^\Qattack/file-upload/alt-extensions-asp.txt\E$
35+
^\Qattack/file-upload/alt-extensions-coldfusion.txt\E$
36+
^\Qattack/file-upload/alt-extensions-jsp.txt\E$
37+
^\Qattack/file-upload/alt-extensions-php.txt\E$
38+
^\Qattack/file-upload/file-ul-filter-bypass-microsoft-asp.txt\E$
39+
^\Qattack/file-upload/file-ul-filter-bypass-ms-php.txt\E$
40+
^\Qattack/file-upload/file-ul-filter-bypass-x-platform-php.txt\E$
41+
^\Qattack/html_js_fuzz/html_attributes.txt\E$
42+
^\Qattack/html_js_fuzz/javascript_events.txt\E$
43+
^\Qattack/http-protocol/crlf-injection.txt\E$
44+
^\Qattack/http-protocol/known-uri-types.txt\E$
45+
^\Qattack/integer-overflow/integer-overflows.txt\E$
46+
^\Qattack/lfi/JHADDIX_LFI.txt\E$
47+
^\Qattack/mimetypes/MimeTypes.txt\E$
48+
^\Qattack/os-cmd-execution/Commands-Linux.txt\E$
49+
^\Qattack/os-cmd-execution/Commands-Windows.txt\E$
50+
^\Qattack/path-traversal/path-traversal-windows.txt\E$
51+
^\Qattack/path-traversal/traversals-8-deep-exotic-encoding.txt\E$
52+
^\Qattack/rfi/rfi.txt\E$
53+
^\Qattack/unicode/upsidedown.txt\E$
54+
^\Qattack/xss/html-event-attributes.txt\E$
55+
^\Qattack/xss/test.xxe\E$
56+
^\Qattack/xss/xss-other.txt\E$
57+
^\Qdiscovery/dns/alexaTop1mAXFRcommonSubdomains.txt\E$
58+
^\Qdiscovery/URI_SCHEMES/IANA_registerd_URI_schemes.txt\E$
59+
^\Qdiscovery/UserAgent/UserAgents.txt\E$
60+
^\Qregex/breakpoint-ignores.txt\E$
61+
^\Qregex/pii.readme.txt\E$
62+
^\Qregex/pii.txt\E$
63+
^\Qregex/sessionid.txt\E$
64+
^\Qweb-backdoors/sh/cmd.sh\E$

0 commit comments

Comments
 (0)