Skip to content

Commit ca3fcc7

Browse files
jsorefjsoref
committed
Add check-spelling
1 parent 17ea220 commit ca3fcc7

13 files changed

Lines changed: 2803 additions & 1 deletion

File tree

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

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
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+
[candidate.patterns](candidate.patterns) | Patterns that might be worth adding to [patterns.txt](patterns.txt) | perl regular expression with optional comment block introductions (all matches will be suggested) | [candidates](https://github.com/check-spelling/check-spelling/wiki/Feature:-Suggest-patterns)
12+
[line_forbidden.patterns](line_forbidden.patterns) | Patterns to flag in checked lines | perl regular expression (order matters, first match wins) | [patterns](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-patterns)
13+
[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)
14+
[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)
15+
[config.json](config.json) | Action Configuration | JSON key (action configuration variable) value (action configuration value) | [config](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-config)
16+
[block-delimiters.list](block-delimiters.list) | Define block begin/end markers to ignore lines of text | line with _literal string_ for **start** followed by line with _literal string_ for **end** | [block ignore](https://github.com/check-spelling/check-spelling/wiki/Feature%3A-Block-Ignore#status)
17+
18+
Note: you can replace any of these files with a directory by the same name (minus the suffix)
19+
and then include multiple files inside that directory (with that suffix) to merge multiple files together.

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

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
<!-- See https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-advice --> <!-- markdownlint-disable MD033 MD041 -->
2+
<details><summary>If the flagged items are :exploding_head: false positives</summary>
3+
4+
If items relate to a ...
5+
6+
* binary file (or some other file you wouldn't want to check at all).
7+
8+
Please add a file path to the `excludes.txt` file matching the containing file.
9+
10+
File paths are Perl 5 Regular Expressions - you can [test](
11+
https://www.regexplanet.com/advanced/perl/) yours before committing to verify it will match your files.
12+
13+
`^` refers to the file's path from the root of the repository, so `^README\.md$` would exclude [README.md](
14+
../tree/HEAD/README.md) (on whichever branch you're using).
15+
16+
* well-formed pattern.
17+
18+
If you can write a [pattern](
19+
https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples:-patterns
20+
) that would match it,
21+
try adding it to the `patterns.txt` file.
22+
23+
Patterns are Perl 5 Regular Expressions - you can [test](
24+
https://www.regexplanet.com/advanced/perl/) yours before committing to verify it will match your lines.
25+
26+
Note that patterns can't match multiline strings.
27+
28+
</details>
29+
30+
<!-- adoption information-->
31+
:steam_locomotive: If you're seeing this message and your PR is from a branch that doesn't have check-spelling,
32+
please merge to your PR's base branch to get the version configured for your repository.

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
github
2+
https
3+
passthrough
4+
ssh
5+
ubuntu
6+
workarounds

‎.github/actions/spelling/block-delimiters.list‎

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# block-delimiters file...
2+
# - Empty lines are ignored -- you can use them as section delimiters
3+
# - Lines beginning with a `#` are ignored
4+
# - Lines beginning with `\#` let you match blocks where the first character is a `#`
5+
# -- i.e. the `\` is ignored and the line isn't treated as a comment
6+
# `\` is not otherwise special
7+
8+
# app/assets/logos/oss-partners/index.ts
9+
OSS_PARTNERS = [
10+
]
11+
12+
# server/utils/image-proxy.ts
13+
TRUSTED_IMAGE_DOMAINS = [
14+
]
15+
16+
# app/pages/blog/alpha-release.md
17+
<BlogPostFederatedArticles
18+
/>
19+
20+
# Public Keys
21+
-----BEGIN PUBLIC KEY-----
22+
-----END PUBLIC KEY-----
23+
24+
# Private Keys
25+
-----BEGIN PRIVATE KEY-----
26+
-----END PRIVATE KEY-----
27+
28+
# EC Private Key
29+
-----BEGIN EC PRIVATE KEY-----
30+
-----END EC PRIVATE KEY-----
31+
32+
# RSA Private Key
33+
-----BEGIN RSA PRIVATE KEY-----
34+
-----END RSA PRIVATE KEY-----
35+
36+
# GPG Public Key
37+
-----BEGIN PGP PUBLIC KEY BLOCK-----
38+
-----END PGP PUBLIC KEY BLOCK-----
39+
40+
# GPG Signature
41+
-----BEGIN PGP SIGNATURE-----
42+
-----END PGP SIGNATURE-----
43+
44+
# Certificates
45+
-----BEGIN CERTIFICATE-----
46+
-----END CERTIFICATE-----
47+
48+
# All Contributors
49+
<!-- ALL-CONTRIBUTORS-LIST:START
50+
<!-- ALL-CONTRIBUTORS-LIST:END
51+
52+
# dependabot
53+
<summary>Release notes</summary>
54+
</details>
55+
56+
# dependabot
57+
<summary>Changelog</summary>
58+
</details>
59+
60+
# dependabot
61+
<summary>Most Recent Ignore Conditions Applied to This Pull Request</summary>
62+
</details>
63+
64+
# dependabot
65+
[Dependabot compatibility score]
66+
</details>
67+
68+
# dependabot
69+
<summary>Commits</summary>
70+
</details>
71+
72+
# dependabot
73+
<summary>Dependabot commands and options</summary>
74+
</details>

0 commit comments

Comments
 (0)