diff --git a/@actions-upload-artifact.md b/@actions-upload-artifact.md index ead1dca..5faaae3 100644 --- a/@actions-upload-artifact.md +++ b/@actions-upload-artifact.md @@ -3,7 +3,7 @@ 1. The official way to upload an artifact is [actions/upload-artifact](https://github.com/actions/upload-artifact) 2. That uses [@actions/artifact](https://github.com/actions/toolkit/tree/main/packages/artifact) 3. Specifically, it uses `artifact.create().uploadArtifact(artifactName, files, rootDirectory, options)` see [example](https://github.com/actions/toolkit/tree/main/packages/artifact#example-using-absolute-file-paths) -4. That uses [@actions/http-client/auth](https://github.com/actions/http-client/blob/544584c8ca4a255395fd73c66bc5eb90ac8abea1/auth.ts) +4. That uses [@actions/http-client/auth](https://raw.githubusercontent.com/actions/http-client/544584c8ca4a255395fd73c66bc5eb90ac8abea1/auth.ts) The underlying stuff uses: @@ -55,7 +55,7 @@ curl -X POST -d @$fileToUpload -vvv \ ``` -The implementation in Python: https://github.com/KOLANICH-libs/miniGHAPI.py/blob/09388fba1145275181fe6ca7f7e3c526abc96d4f/miniGHAPI/undocumented.py (it is bound to hash because can be moved into another file in future) +The implementation in Python: https://raw.githubusercontent.com/KOLANICH-libs/miniGHAPI.py/09388fba1145275181fe6ca7f7e3c526abc96d4f/miniGHAPI/undocumented.py (it is bound to hash because can be moved into another file in future) Few highlights: @@ -66,3 +66,6 @@ Few highlights: 1. create an artifact container 2. upload the artifact into a file within container. THIS MUST BE A RANGE QUERY. IT IS SUSPECTED IT CAN BE USED TO PATCH PARTS OF FILES, WHICH MAY BE USEFUL FOR STORING BINARY DATABASES AND FUSE FILESYSTEMS. 3. PATCH the container. The artifact will not appear within a pipeline without this query. GitHub official action code sets the size in it, but in fact it has no effect at all, likely it is just a discrepancy between the server and client code. It is suspected that the PATCH query can be utilised to make the artifact appear not as a zip archive. + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/@dependabot.md b/@dependabot.md index e9b07ea..f108775 100644 --- a/@dependabot.md +++ b/@dependabot.md @@ -21,3 +21,6 @@ https://github.community/t/permissions-nesecary-to-comment-on-a-pr/179047/2 1. create an empty commit and push that. 2. amend the current commit and force push it. (This might upset `@dependabot`) + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Accepting-Suggestions.md b/Accepting-Suggestions.md index 129aad8..3fc18a3 100644 --- a/Accepting-Suggestions.md +++ b/Accepting-Suggestions.md @@ -45,9 +45,9 @@ You probably want to use `git-bash` from https://git-scm.com/download/win (insta The code is provided as a convenience--what it does is take certain recommendations from check-spelling and apply them to the check-spelling configuration directory. -- There are probably `Unrecognized words` that need to be added to [`expect.txt`](https://github.com/check-spelling/check-spelling/wiki/Configuration#expect) (or some variant). -- There may be items that are no longer found that need to be removed from [`expect.txt`](https://github.com/check-spelling/check-spelling/wiki/Configuration#expect) (or some variant) so that they'd be flagged if they're reintroduced later. -- If there are [suggestions for additions to `excludes.txt`](https://github.com/check-spelling/check-spelling/wiki/Feature:-Heuristic-exclude-suggestions), versions after [v0.0.21](https://github.com/check-spelling/check-spelling/releases/tag/v0.0.21) would apply them, and you could manually add them to [`excludes.txt`](https://github.com/check-spelling/check-spelling/wiki/Configuration#excludes) (although this isn't necessary). +- There are probably `Unrecognized words` that need to be added to [`expect.txt`](Configuration.md#expect) (or some variant). +- There may be items that are no longer found that need to be removed from [`expect.txt`](Configuration.md#expect) (or some variant) so that they'd be flagged if they're reintroduced later. +- If there are [suggestions for additions to `excludes.txt`](./Feature:-Heuristic-exclude-suggestions), versions after [v0.0.21](https://github.com/check-spelling/check-spelling/releases/tag/v0.0.21) would apply them, and you could manually add them to [`excludes.txt`](Configuration.md#excludes) (although this isn't necessary). ## Preformatted commit (v0.0.22+) @@ -72,3 +72,6 @@ In order for this to be useful, you'll then need to create a merge commit betwee You could rebase your commits onto the base branch at this point (or in some other order). A version after 0.0.22 should include instructions for merging. Whether you merge or rebase is up to you or the project to which you're contributing. If you choose to rebase, you'll probably want to rearrange the commits. You might also want to rearrange the commits if you merge -- the order of commands given is designed to be likely to not immediately have merge conflicts but probably doesn't tell the best "story". + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Archaic-words.md b/Archaic-words.md index d9e5e68..180c3c2 100644 --- a/Archaic-words.md +++ b/Archaic-words.md @@ -6,7 +6,7 @@ That dictionary is fairly comprehensive. Unfortunately, it has a number of archa ## Compensating -- You can remove words using `reject` see [[Configuration Examples: reject]] +- You can remove words using `reject` see [Configuration Examples: reject](./Configuration-Examples:-reject.md) - You can replace the dictionary using `dictionary` (`dictionary.txt` or `dictionary/*.txt`) - I plan to offer reduced dictionaries (based on implementation experience) which one could select using `DICTIONARY_VERSION` @@ -17,5 +17,8 @@ That dictionary is fairly comprehensive. Unfortunately, it has a number of archa - [occurence](https://english.stackexchange.com/questions/431928/is-occurence-a-word) (obsolete) -- to be removed from [microsoft/terminal](https://github.com/microsoft/terminal/pull/9679) - [Sorce](https://en.wiktionary.org/wiki/Sorce) (surname) -- removed from [microsoft/winget-cli](https://github.com/microsoft/winget-cli/commit/3c10211f321701f313ca56593e4944f963110dbe) - [spae](https://www.dictionary.com/browse/spae) (from Old English), spaebook, spaecraft, spaed, spaedom, spaeing, spaeings, spae-man, spaeman, spaer, Spaerobee, spaes, spaewife, spaewoman, spaework, spaewright -- removed from [microsoft/terminal](https://github.com/microsoft/terminal/commit/dc43524eb23feb9962e5277c639628d0e982f1bf#diff-4a97f7b6bd038d5e4082fe476036b224) -- [wether](https://www.dictionary.com/browse/wether) (from Old English / Old High German) -- removed from [microsoft/terminal](https://github.com/microsoft/terminal/commit/9409e851d043775ea973a7cc50cc1ba0c2f660a2#diff-4a97f7b6bd038d5e4082fe476036b224) +- [wether](https://www.dictionary.com/browse/wether) (from Old English / Old High German) -- removed from [microsoft/terminal](https://github.com/microsoft/terminal/commit/9409e851d043775ea973a7cc50cc1ba0c2f660a2#diff-4a97f7b6bd038d5e4082fe476036b224) - [untill](https://en.wiktionary.org/wiki/untill) ([archaic spelling](https://books.google.com/ngrams/graph?content=untill%2Cuntil&year_start=1800&year_end=2008&corpus=15&smoothing=3&share=&direct_url=t1%3B%2Cuntill%3B%2Cc0%3B.t1%3B%2Cuntil%3B%2Cc0) of until) + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Behavior-change:-Consumed-line-endings.md b/Behavior-change:-Consumed-line-endings.md index 5481ae9..d6f0b68 100644 --- a/Behavior-change:-Consumed-line-endings.md +++ b/Behavior-change:-Consumed-line-endings.md @@ -1,8 +1,8 @@ # Behavior change: Consumed line endings -Through [[v0.0.19|https://github.com/check-spelling/check-spelling/releases/tag/v0.0.19]], the line ending was included as part of the line being parsed. +Through [v0.0.19](https://github.com/check-spelling/check-spelling/releases/tag/v0.0.19), the line ending was included as part of the line being parsed. -With the [[v0.0.20|https://github.com/check-spelling/check-spelling/releases/tag/v0.0.20]], the line ending will not be included in the parsed content. +With the [v0.0.20](https://github.com/check-spelling/check-spelling/releases/tag/v0.0.20), the line ending will not be included in the parsed content. This could impact patterns that specifically look for `\n` / `\r` / …. @@ -22,3 +22,6 @@ pkg/strutil/strutil_test.go: ` matches a line_forbidden.patterns entry. (forbidd ``` I couldn't think of any better contortions to prevent this messy output. + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Behavior-change:-Dropping-word-stemming.md b/Behavior-change:-Dropping-word-stemming.md index bd65544..c6a0d33 100644 --- a/Behavior-change:-Dropping-word-stemming.md +++ b/Behavior-change:-Dropping-word-stemming.md @@ -16,4 +16,7 @@ This allows one to add just a single entry (the stem) to a **dictionary** / **ex The downside to this stemming is that if a repo has both `potato` and `potatos`, the latter was treated as a stem of the former and they were collectively accepted if the former is in the dictionary. -As of [[0.0.17-alpha|https://github.com/check-spelling/check-spelling/releases/tag/0.0.17-alpha]], I'm removing this feature. Those upgrading will probably need to add extra items to their **dictionary** / **expect** files. For `check-spelling` itself, that amounted to 6 new entries out of under 100, so about 6%. +As of [0.0.17-alpha](https://github.com/check-spelling/check-spelling/releases/tag/0.0.17-alpha), I'm removing this feature. Those upgrading will probably need to add extra items to their **dictionary** / **expect** files. For `check-spelling` itself, that amounted to 6 new entries out of under 100, so about 6%. + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Behavior-change:-File-line-column-notation.md b/Behavior-change:-File-line-column-notation.md index 7a0438c..9b6ea2e 100644 --- a/Behavior-change:-File-line-column-notation.md +++ b/Behavior-change:-File-line-column-notation.md @@ -7,3 +7,6 @@ As of v0.0.21, the notation will be something like: `.github/workflows/spelling. filename:line-number:initial-offset ... end-offset. This should be friendlier to tools like `vi` or `VSCode`. + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Behavior-change:-Ignoring-two-letter-words.md b/Behavior-change:-Ignoring-two-letter-words.md index 040e7dc..1ba1c02 100644 --- a/Behavior-change:-Ignoring-two-letter-words.md +++ b/Behavior-change:-Ignoring-two-letter-words.md @@ -4,4 +4,7 @@ Afaict, two letter words just aren't worth the effort of spell checking. I will take implementation feedback. But, `prerelease` now, and `0.0.18-alpha` (when it's released), by default, will not complain about two letter words. -See [[Autodetect valid word lengths|Feature: Autodetect valid word lengths]] for more information. +See [Autodetect valid word lengths](./Feature:-Autodetect-valid-word-lengths.md) for more information. + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Behavior-change:-Job-Summaries.md b/Behavior-change:-Job-Summaries.md index 277ddf3..33c5912 100644 --- a/Behavior-change:-Job-Summaries.md +++ b/Behavior-change:-Job-Summaries.md @@ -22,3 +22,6 @@ Job Summaries are an alternative to comments ## Timeline I haven't figured out how to integrate this feature into my workflow. + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Behavior-change:-Log-output-order.md b/Behavior-change:-Log-output-order.md index 56f72cd..df03af8 100644 --- a/Behavior-change:-Log-output-order.md +++ b/Behavior-change:-Log-output-order.md @@ -9,3 +9,6 @@ Generally there are far fewer skipped files than unrecognized words, so listing One should integrate the list of skipped files into `excludes.txt`, which will result in 0 items in this category and effectively the same output as the current state. I'm not sure when I'll do this, but, probably soon. + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Behavior-change:-Patterns-masking-character.md b/Behavior-change:-Patterns-masking-character.md index a0ee862..c53f3be 100644 --- a/Behavior-change:-Patterns-masking-character.md +++ b/Behavior-change:-Patterns-masking-character.md @@ -6,16 +6,16 @@ Originally patterns resulted in roughly a single "` `", and more recently a "` ` ## Problems -With the introduction of [[Forbidden patterns|Feature: Forbidden patterns]], how those masked items worked mattered a bit. +With the introduction of [Forbidden patterns](./Feature:-Forbidden-patterns.md), how those masked items worked mattered a bit. -Specifically, if one used this pattern (from [[Configuration Examples: patterns]]): +Specifically, if one used this pattern (from [Configuration Examples: patterns](./Configuration-Examples:-patterns.md)): ``` # version suffix v# [Vv]\d+(?:\b|(?=[a-zA-Z_])) ``` -And this forbidden pattern (from [[Configuration Examples: forbidden]]): +And this forbidden pattern (from [Configuration Examples: forbidden](./Configuration-Examples:-forbidden.md)): ``` # Reject duplicate words @@ -54,4 +54,7 @@ Instead of masking `patterns` with "` `", as of [v0.0.20](https://github.com/che It's unlikely that anyone will notice this change as the only place this should matter is forbidden patterns which are v0.0.20 feature. -The spell checker itself ignores non-alpha characters (treating them as equivalent to "` `") already. So the "`=`" is really only relevant during evaluation of [[Forbidden patterns|Feature: Forbidden patterns]]. +The spell checker itself ignores non-alpha characters (treating them as equivalent to "` `") already. So the "`=`" is really only relevant during evaluation of [Forbidden patterns](./Feature:-Forbidden-patterns.md). + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Behavior-change:-case-changes-in-expect.md b/Behavior-change:-case-changes-in-expect.md index f6fe6a2..e9ea178 100644 --- a/Behavior-change:-case-changes-in-expect.md +++ b/Behavior-change:-case-changes-in-expect.md @@ -16,3 +16,6 @@ FILETYPE ## Proposed change The UI should at least clearly draw attention to this change, because it's confusing. + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Breaking-Change:-Dropping-support-for-broken-act.md b/Breaking-Change:-Dropping-support-for-broken-act.md index e84f845..df41df5 100644 --- a/Breaking-Change:-Dropping-support-for-broken-act.md +++ b/Breaking-Change:-Dropping-support-for-broken-act.md @@ -27,3 +27,6 @@ As the current version of [nektos/act](https://github.com/nektos/act) is [v0.2.4 ## Disclaimer While I'm fairly certain these bugs existed, since I reported them, and I worked around them, at this time, I can't reproduce them (using old versions of act), so it's possible that there weren't actually shipping versions with these bugs, but I'm pretty sure there were. Oh well. + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Breaking-Change:-Reorganized-cspell-Dictionaries-in-v0.0.22.md b/Breaking-Change:-Reorganized-cspell-Dictionaries-in-v0.0.22.md index 996045d..c014a1a 100644 --- a/Breaking-Change:-Reorganized-cspell-Dictionaries-in-v0.0.22.md +++ b/Breaking-Change:-Reorganized-cspell-Dictionaries-in-v0.0.22.md @@ -4,4 +4,7 @@ check-spelling uses [streetsidesoftware/cspell-dicts](https://github.com/streets This means that `cspell:` paths that reference the old locations are likely to break. -You are likely to encounter a [`dictionary-not-found`](https://github.com/check-spelling/check-spelling/wiki/Event-descriptions#dictionary-not-found) error which should walk you through the steps necessary to resolve the problem. +You are likely to encounter a [`dictionary-not-found`](Event-descriptions.md#dictionary-not-found) error which should walk you through the steps necessary to resolve the problem. + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Breaking-change:-Artifacts-are-zipped.md b/Breaking-change:-Artifacts-are-zipped.md index 456d1da..ed93589 100644 --- a/Breaking-change:-Artifacts-are-zipped.md +++ b/Breaking-change:-Artifacts-are-zipped.md @@ -16,3 +16,6 @@ Instead of trying to upload a half dozen or so tiny files, check-spelling will n - If someone upgrades the check job to a version that does this, but doesn't upgrade the comment job to a version that supports this, the generated artifacts will not work. - If a workflow has custom code relying on the files from artifact, it will need to be adjusted. -- I doubt anyone is doing this. + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Breaking-change:-Dropping-printf-special-cases.md b/Breaking-change:-Dropping-printf-special-cases.md index 3aca8dd..6a6c6c6 100644 --- a/Breaking-change:-Dropping-printf-special-cases.md +++ b/Breaking-change:-Dropping-printf-special-cases.md @@ -2,7 +2,7 @@ ## Background -When the core for check-spelling was initially developed, it was a lot simpler and didn't have any support for [`patterns`](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples:-patterns). +When the core for check-spelling was initially developed, it was a lot simpler and didn't have any support for [`patterns`](./Configuration-Examples:-patterns.md). As it was often run against C/C++ repositories, code was baked-in to handle `\n`, `\r`, and `\t`. @@ -19,3 +19,6 @@ If you're currently relying on that special casing, you'll need to add entries t ## Schedule Expecting to deploy in [v0.0.22](https://github.com/check-spelling/check-spelling/releases/tag/v0.0.22) + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Breaking-change:-Dropping-support-for-on:-schedule.md b/Breaking-change:-Dropping-support-for-on:-schedule.md index 6cae586..1c8c51e 100644 --- a/Breaking-change:-Dropping-support-for-on:-schedule.md +++ b/Breaking-change:-Dropping-support-for-on:-schedule.md @@ -4,19 +4,19 @@ The original workaround for not having permissions for pull requests from forks was to use the [`schedule` event](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#schedule). -That was supplanted with the introduction of support for [[pull_request_target|Feature: Support pull_request_target]]. +That was supplanted with the introduction of support for [pull_request_target](./Feature:-Support-pull_request_target.md). -There was other contemplated work [[Limit schedule branches|Feature: Limit schedule branches]] for the feature, but `pull_request_target` has proven to be considerably cleaner than `schedule` and at this point, `schedule` is mostly abandoned. +There was other contemplated work [Limit schedule branches](./Feature:-Limit-schedule-branches.md) for the feature, but `pull_request_target` has proven to be considerably cleaner than `schedule` and at this point, `schedule` is mostly abandoned. ## Plan -### [[v0.0.22|https://github.com/check-spelling/check-spelling/releases/tag/v0.0.22]] +### [v0.0.22](https://github.com/check-spelling/check-spelling/releases/tag/v0.0.22) Will probably be the last version supporting `schedule`. It will include a warning linking to this item. -### [[v0.0.23|https://github.com/check-spelling/check-spelling/releases/tag/v0.0.23]] +### [v0.0.23](https://github.com/check-spelling/check-spelling/releases/tag/v0.0.23) (or whatever comes after 0.0.22) @@ -24,8 +24,11 @@ Will probably not support `schedule`. ## Migration -In most cases you should be able to refresh your workflow using https://github.com/check-spelling/spell-check-this/blob/main/.github/workflows/spelling.yml adopting a standard [`on: pull_request_target`](./Feature:-Support-pull_request_target). +In most cases you should be able to refresh your workflow using https://raw.githubusercontent.com/check-spelling/spell-check-this/main/.github/workflows/spelling.yml adopting a standard [`on: pull_request_target`](./Feature:-Support-pull_request_target.md). ## Feedback If you're actually using `schedule`, please [check for an issue](https://github.com/check-spelling/check-spelling/issues?q=is%3Aissue+is%3Aopen+schedule+event+created%3A%3E%3D2023-04-01). If there is one, please add your use case to it, if there isn't one, please open an issue and explain why you're using `schedule` instead of `push`/`pull_request`/`pull_request_target`. + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Breaking-change:-Smaller-cspell-dictionaries.md b/Breaking-change:-Smaller-cspell-dictionaries.md index af73380..2b0ebaa 100644 --- a/Breaking-change:-Smaller-cspell-dictionaries.md +++ b/Breaking-change:-Smaller-cspell-dictionaries.md @@ -17,3 +17,6 @@ Old|New -|- `cspell:companies/companies.txt` | `cspell:companies/src/companies.txt` `cspell:python/python.txt` | `cspell:python/src/python/python.txt` + `cspell:python/src/python/python-lib.txt` _probably_ + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Breaking-change:-Smaller-dictionary.md b/Breaking-change:-Smaller-dictionary.md index f906414..60054ab 100644 --- a/Breaking-change:-Smaller-dictionary.md +++ b/Breaking-change:-Smaller-dictionary.md @@ -2,18 +2,21 @@ ⏸️ There is no timeline for this work. -The default dictionary 📘 through [[v0.0.19|https://github.com/check-spelling/check-spelling/releases/tag/v0.0.19]] is quite large. +The default dictionary 📘 through [v0.0.19](https://github.com/check-spelling/check-spelling/releases/tag/v0.0.19) is quite large. The downside of its comprehensiveness is that it has lots of archaic words. This means that it's rather forgiving of typos for common words in favor of those archaic words. -It also means that if/when I implement [[correction suggestions|Feature: Suggest corrections]] suggestions are pretty quirky (e.g. `Debian` -> `cebian`). +It also means that if/when I implement [correction suggestions](./Feature:-Suggest-corrections.md) suggestions are pretty quirky (e.g. `Debian` -> `cebian`). I'll probably test the upgrade with known consumers and maybe switch in 0.0.19-alpha. -Note that as of 0.0.17-alpha, it's possible to specify a specific [[dictionary revision|Feature: Versioned dictionaries]], which means that consumers will be able to avoid adopting the newer dictionary. +Note that as of 0.0.17-alpha, it's possible to specify a specific [dictionary revision](./Feature:-Versioned-dictionaries.md), which means that consumers will be able to avoid adopting the newer dictionary. -My tentative plan is to try [[wamerican-small|https://packages.debian.org/sid/wamerican-small]] based on http://wordlist.aspell.net/. -If that works for some/most, I'll add [[wbritish-small|https://packages.debian.org/sid/wbritish-small]] as an alternate (and probably a combined). +My tentative plan is to try [wamerican-small](https://packages.debian.org/sid/wamerican-small) based on http://wordlist.aspell.net/. +If that works for some/most, I'll add [wbritish-small](https://packages.debian.org/sid/wbritish-small) as an alternate (and probably a combined). I expect that I'll make the default `wamerican-small`, and give each project the dictionary that makes sense. -I'm still thinking about the right way to do multiple dictionaries in general (see [[Area dictionaries|Feature: Area dictionaries]]). +I'm still thinking about the right way to do multiple dictionaries in general (see [Area dictionaries](./Feature:-Area-dictionaries.md)). + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Bug-fix:-Case-changes-should-fail.md b/Bug-fix:-Case-changes-should-fail.md index 0213f10..c9334f1 100644 --- a/Bug-fix:-Case-changes-should-fail.md +++ b/Bug-fix:-Case-changes-should-fail.md @@ -16,3 +16,6 @@ might add a general lowercase noun and write it as the first word in an English English_ and if/when check-spelling starts trying to support other languages, this feature could go away. Note: The generated expect update script (in the log, or the next time you get a fail) will properly update `Microsoft` to `microsoft`. + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Bug-fix:-Report-instances-of-items-that-used-to-be-covered-by-a-now-missing-expect-entry.md b/Bug-fix:-Report-instances-of-items-that-used-to-be-covered-by-a-now-missing-expect-entry.md index e6e7ed7..8696b51 100644 --- a/Bug-fix:-Report-instances-of-items-that-used-to-be-covered-by-a-now-missing-expect-entry.md +++ b/Bug-fix:-Report-instances-of-items-that-used-to-be-covered-by-a-now-missing-expect-entry.md @@ -23,3 +23,6 @@ check-spelling would complain about `Helllo` (suggesting adding it to `expect.tx ## Availability Expected to be available in [v0.0.22](https://github.com/check-spelling/check-spelling/releases/tag/v0.0.22) + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Configuration-Examples:-advice.md b/Configuration-Examples:-advice.md index c65f1d6..bc1c805 100644 --- a/Configuration-Examples:-advice.md +++ b/Configuration-Examples:-advice.md @@ -4,9 +4,9 @@ Advice is a file that is inserted raw into GitHub comments (or potentially in th Here are some examples: -- https://github.com/microsoft/terminal/blob/main/.github/actions/spelling/advice.md -- https://github.com/imazen/imageflow/blob/main/.github/actions/spell-check/advice.txt -- https://github.com/jsoref/jitsi-videobridge/blob/e26301eab0a15f2366f5d2b73e2c0cc714007a14/.github/actions/spell-check/advice.txt +- https://raw.githubusercontent.com/microsoft/terminal/main/.github/actions/spelling/advice.md +- https://raw.githubusercontent.com/imazen/imageflow/main/.github/actions/spell-check/advice.txt +- https://raw.githubusercontent.com/jsoref/jitsi-videobridge/e26301eab0a15f2366f5d2b73e2c0cc714007a14/.github/actions/spell-check/advice.txt ```
If you see a bunch of garbage and it relates to a binary-ish string @@ -25,3 +25,6 @@ https://www.regexplanet.com/advanced/perl/) yours before committing to verify it ## advice.md As of [v0.0.18](https://github.com/check-spelling/check-spelling/releases/tag/v0.0.18), the file can be named `advice.md` instead of `advice.txt`. + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Configuration-Examples:-allow.md b/Configuration-Examples:-allow.md index a31478f..a76a0a0 100644 --- a/Configuration-Examples:-allow.md +++ b/Configuration-Examples:-allow.md @@ -1,10 +1,13 @@ This allows you to add additional words to the dictionary without replacing the core dictionary. See -[check-spelling/spell-check-this](https://github.com/check-spelling/spell-check-this):[`.github/actions/spelling/allow.txt`](https://github.com/check-spelling/spell-check-this/blob/main/.github/actions/spelling/allow.txt) for a basic example. +[check-spelling/spell-check-this](https://github.com/check-spelling/spell-check-this):[`.github/actions/spelling/allow.txt`](https://raw.githubusercontent.com/check-spelling/spell-check-this/main/.github/actions/spelling/allow.txt) for a basic example. Format: One word per line. Each case/variation needs to be added individually. -If you need something fancier, you can use [[hunspell .dic & .aff files|Feature: Hunspell dictionary support]] instead. +If you need something fancier, you can use [hunspell .dic & .aff files](./Feature:-Hunspell-dictionary-support.md) instead. + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Configuration-Examples:-block-delimiters.md b/Configuration-Examples:-block-delimiters.md index d0774d9..7347151 100644 --- a/Configuration-Examples:-block-delimiters.md +++ b/Configuration-Examples:-block-delimiters.md @@ -17,7 +17,7 @@ # See also -- [[Block Ignore|Feature: Block Ignore]] +- [Block Ignore](./Feature:-Block-Ignore.md) # Notes @@ -27,3 +27,6 @@ - The start and stop delimiters are checked for as strings not regular expressions. - Block delimiter checks happen before pattern evaluation (and are effectively mutually exclusive to them). - Each block delimiter must have both a start and stop delimiter and there can only be a single stop for a given start delimiter. If you encounter a case where you need to have a choice of possible stop delimiters for a specific start delimiter, please file a ticket with your example. + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Configuration-Examples:-excludes.md b/Configuration-Examples:-excludes.md index f775034..9f3c489 100644 --- a/Configuration-Examples:-excludes.md +++ b/Configuration-Examples:-excludes.md @@ -42,3 +42,6 @@ Once you've upgraded, you can safely convert... ## Purpose `excludes` is designed to enable check-spelling to skip files that match any of the patterns in `excludes`. + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Configuration-Examples:-forbidden.md b/Configuration-Examples:-forbidden.md index a51a764..89e41b9 100644 --- a/Configuration-Examples:-forbidden.md +++ b/Configuration-Examples:-forbidden.md @@ -20,10 +20,13 @@ ## See also -- [[Forbidden patterns|Feature: Forbidden patterns]] -- [[Configuration Examples: patterns]] +- [Forbidden patterns](./Feature:-Forbidden-patterns.md) +- [Configuration Examples: patterns](./Configuration-Examples:-patterns.md) ## Notes - `forbidden` operate on a per line basis -- there is no support for multiline patterns, see [[Feature: Block Ignore]] for my current thoughts +- there is no support for multiline patterns, see [Feature: Block Ignore](./Feature:-Block-Ignore.md) for my current thoughts + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Configuration-Examples:-only.md b/Configuration-Examples:-only.md index d096cb0..b808b8a 100644 --- a/Configuration-Examples:-only.md +++ b/Configuration-Examples:-only.md @@ -8,8 +8,11 @@ ``` ℹ️ The syntax of this file is identical to the one for `excludes`. -You can look at [[Configuration Examples: excludes]] for more examples. +You can look at [Configuration Examples: excludes](./Configuration-Examples:-excludes.md) for more examples. ## Purpose `only` is used to limit which files check-spelling will check to _only_ files that match one of the listed patterns. + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Configuration-Examples:-patterns.md b/Configuration-Examples:-patterns.md index f96a6d1..8fa441c 100644 --- a/Configuration-Examples:-patterns.md +++ b/Configuration-Examples:-patterns.md @@ -414,7 +414,7 @@ posthog\.init\((['"])phc_[^"',]+\g{-1}, ## Duplicates -If you have [duplicate detection](https://github.com/check-spelling/check-spelling/wiki/Feature%3A-Forbidden-patterns#duplicate-words), you may run into false positives, here are some examples of ways to suppress them: +If you have [duplicate detection](Feature%3A-Forbidden-patterns.md#duplicate-words), you may run into false positives, here are some examples of ways to suppress them: ``` # mounts @@ -423,11 +423,14 @@ mount (?:-n |)-t (\w+)\s+\g{-1} ## See also -- [[Forbidden patterns|Feature: Forbidden patterns]] +- [Forbidden patterns](./Feature:-Forbidden-patterns.md) ## Notes - `patterns` operate on a per line basis - the first match wins, and matches are replaced by a single space character -- roughly resulting in the matched content being treated as a word break (and not seen by the word checker) - the behavior may change such that the length of a replacement matches the length of the replaced content... -- there is no support for multiline patterns, see [[Feature: Block Ignore]] for my current thoughts +- there is no support for multiline patterns, see [Feature: Block Ignore](./Feature:-Block-Ignore.md) for my current thoughts + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Configuration-Examples:-reject.md b/Configuration-Examples:-reject.md index e80b55c..7ce71f6 100644 --- a/Configuration-Examples:-reject.md +++ b/Configuration-Examples:-reject.md @@ -2,7 +2,7 @@ Note that regular expressions are generally case-sensitive. You can use `(?:(?i)...)` to make a line case-insensitive (currently all lines are treated together, so if you don't scope your item, it will carry through to the remaining lines, which is could be unexpected -- this is likely to change in the near future). -See [[Archaic-words]] +See [Archaic-words](Archaic-words.md) ``` ^attache$ @@ -24,3 +24,6 @@ Here these patterns are quite broad. - `^untill` will match some farming terms, but again, it's unlikely you're using them (if you are, add a `$` to the line to just match `until`). - `vender` is archaic (formerly used by the New Yorker) https://english.stackexchange.com/questions/28201/vendor-vs-vender-in-standard-american-english -- note that the New Yorker appears to have abandoned this spelling as well see https://www.newyorker.com/video/watch/the-fruit-vendor - `^wether` matches a number of terms, the main one is a typo for `whether`, if you need `wetherhog` or similar, adjust the pattern. + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Configuration-Files.md b/Configuration-Files.md index 4f15130..6819de0 100644 --- a/Configuration-Files.md +++ b/Configuration-Files.md @@ -23,7 +23,7 @@ posted to GitHub. It's freeform. You can use it to explain how contributors should decide where to put new entries. -See [[Configuration Examples: advice]] for examples. +See [Configuration Examples: advice](./Configuration-Examples:-advice.md) for examples. ## allow @@ -41,15 +41,15 @@ Some candidates: - C or JavaScript reserved words - The names of all types/ functions from the C standard library -See [Area dictionaries](https://github.com/check-spelling/check-spelling/wiki/Feature:-Area-dictionaries) for other examples. +See [Area dictionaries](./Feature:-Area-dictionaries.md) for other examples. -For entire reusable lists that don't live in your repository, you can use [extra_dictionaries](#extra_dictionaries) instead. +For entire reusable lists that don't live in your repository, you can use [extra_dictionaries](#extra-dictionaries) instead. ## block delimiters This allows you to define a pair of start/stop delimiters which will cause check-spelling to skip the contents of lines between start and stop delimiters. -See [[Configuration Examples: block delimiters]] for examples and [[Feature: Block Ignore]] for information about the feature. +See [Configuration Examples: block delimiters](./Configuration-Examples:-block-delimiters.md) for examples and [Feature: Block Ignore](./Feature:-Block-Ignore.md) for information about the feature. ## dictionary @@ -60,9 +60,9 @@ If you want to include the default dictionary, place it into the directory next to your own. Alternatively, if you want to retrieve a dictionary from a remote URL, -see the workflow configuration values [dictionary_url](#dictionary_url) and [dictionary_version](#dictionary_version). +see the workflow configuration values [dictionary_url](#dictionary-url) and [dictionary_version](#dictionary-version). -If you just want to supplement the dictionary, you can use [`extra_dictionaries`](#extra_dictionaries) or [allow](#allow). +If you just want to supplement the dictionary, you can use [`extra_dictionaries`](#extra-dictionaries) or [allow](#allow). ## excludes @@ -76,7 +76,7 @@ unless you explicitly use `(?:(?i)...)` or Files matching these patterns will be skipped. -See [[Configuration Examples: excludes]] for examples. +See [Configuration Examples: excludes](./Configuration-Examples:-excludes.md) for examples. Lines that start with `#` will be ignored. @@ -128,7 +128,7 @@ unless you explicitly use `(?:(?i)...)` or Tokens within files that match these expressions will be flagged. -See [[Configuration Examples: forbidden]] for examples. +See [Configuration Examples: forbidden](./Configuration-Examples:-forbidden.md) for examples. ## only @@ -138,7 +138,7 @@ They are merged using an `OR` (`|`). Files not matching these patterns will be skipped. -See [[Configuration Examples: only]] for examples. +See [Configuration Examples: only](./Configuration-Examples:-only.md) for examples. Lines that start with `#` will be ignored. @@ -155,7 +155,7 @@ unless you explicitly use `(?:(?i)...)` or Tokens within files that match these expressions will be skipped. -See [[Configuration Examples: patterns]] for examples. +See [Configuration Examples: patterns](./Configuration-Examples:-patterns.md) for examples. ## reject @@ -166,4 +166,7 @@ The order of operations is: > `(dictionary + allows) - reject` -See [[Configuration Examples: reject]] for examples. +See [Configuration Examples: reject](./Configuration-Examples:-reject.md) for examples. + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Configuration-information.md b/Configuration-information.md index 1fea602..4f7f1a2 100644 --- a/Configuration-information.md +++ b/Configuration-information.md @@ -1,15 +1,18 @@ ## Configuration information -- [[Configuration]] -- [[Configuration Files]] - - [[Configuration Examples: advice]] - - [[Configuration Examples: allow]] - - [[Configuration Examples: block delimiters]] - - [[Configuration Examples: excludes]] - - [[Configuration Examples: forbidden]] - - [[Configuration Examples: only]] - - [[Configuration Examples: patterns]] - - [[Configuration Examples: reject]] -- [[Configuration: Advanced]] -- [[Configuration: Multiple programming languages]] -- [[Configuration: Workflows]] +- [Configuration](Configuration.md) +- [Configuration Files](./Configuration.md#files) + - [Configuration Examples: advice](./Configuration-Examples:-advice.md) + - [Configuration Examples: allow](./Configuration-Examples:-allow.md) + - [Configuration Examples: block delimiters](./Configuration-Examples:-block-delimiters.md) + - [Configuration Examples: excludes](./Configuration-Examples:-excludes.md) + - [Configuration Examples: forbidden](./Configuration-Examples:-forbidden.md) + - [Configuration Examples: only](./Configuration-Examples:-only.md) + - [Configuration Examples: patterns](./Configuration-Examples:-patterns.md) + - [Configuration Examples: reject](./Configuration-Examples:-reject.md) +- [Configuration: Advanced](./Configuration:-Advanced.md) +- [Configuration: Multiple programming languages](./Configuration:-Multiple-programming-languages.md) +- [Configuration: Workflows](./Configuration:-Workflows.md) + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Configuration.md b/Configuration.md index c7ffc10..33c4004 100644 --- a/Configuration.md +++ b/Configuration.md @@ -1,58 +1,58 @@ # Configuration -- [[Quick Start]] +- [Quick Start](Quick-Start.md) - [Workflow Parameters](#workflow-parameters) -- [[Configuration Files]] -- See [[Configuration: Workflows]] for the general workflow modes +- [Files](#files) +- See [Configuration: Workflows](./Configuration:-Workflows.md) for the general workflow modes ## Workflow Parameters -See [[Configuration: Workflows]] for the supported GitHub workflows. +See [Configuration: Workflows](./Configuration:-Workflows.md) for the supported GitHub workflows. | Parameter | Description | | ------------- | ------------- | -| [GITHUB_TOKEN](#github_token) | github credential secret for api requests | +| [GITHUB_TOKEN](#github-token) | github credential secret for api requests | | [config](#config) | directory with config files | -| [dictionary_url](#dictionary_url) | url for primary dictionary | -| [dictionary_version](#dictionary_version) | version of primary dictionary | -| [experimental_apply_changes_via_bot](#experimental_apply_changes_via_bot) | allow [@check-spelling-bot](https://github.com/check-spelling-bot) to update PRs | -| [experimental_parallel_jobs](#experimental_parallel_jobs) | parallelize spell checking file tasks | -| [shortest_word](#shortest_word) | minimum word length | -| [longest_word](#longest_word) | maximum word length | -| [post_comment](#post_comment) | post comment | -| [experimental_path](#experimental_path) | Directory root to check for spelling (note that bucket/project/config are independent of this) | -| [capture_output_unknown_words](#capture_output_unknown_words) | Capture unknown words (should be added to expect.txt) as an action output | -| [capture_output_stale_words](#capture_output_stale_words) | Capture stale words (should be removed from expect.txt) as an action output | -| [capture_output_skipped_files](#capture_output_skipped_files) | Capture skipped files (could be added to excludes.txt) as an action output | -| [experimental_commit_note](#experimental_commit_note) | If set, commit updates to expect automatically with this note | -| [only_check_changed_files](#only_check_changed_files) | If set, only check changed files | -| [dictionary_source_prefixes](#dictionary_source_prefixes) | prefixes for urls for dictionaries defined in [extra_dictionaries](#extra_dictionaries) | -| [extra_dictionaries](#extra_dictionaries) | Dictionaries to include | -| [check_extra_dictionaries](#check_extra_dictionaries) | If there are unknown words, see if they are in these additional dictionaries | -| [extra_dictionary_limit](#extra_dictionary_limit) | The number of [check_extra_dictionaries](#check_extra_dictionaries) to report | -| [event_aliases](#event_aliases) | Map an unsupported GitHub event to a known event | -| [suppress_push_for_open_pull_request](#suppress_push_for_open_pull_request) | If running from a `push` event and there's an open `pull_request`, stop working and rely on the `pull_request` handling to check the branch | -| [report_title_suffix](#report_title_suffix) | Appended to title (for use in [matrix configurations](https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idstrategymatrix)) | +| [dictionary_url](#dictionary-url) | url for primary dictionary | +| [dictionary_version](#dictionary-version) | version of primary dictionary | +| [experimental_apply_changes_via_bot](#experimental-apply-changes-via-bot) | allow [@check-spelling-bot](https://github.com/check-spelling-bot) to update PRs | +| [experimental_parallel_jobs](#experimental-parallel-jobs) | parallelize spell checking file tasks | +| [shortest_word](#shortest-word) | minimum word length | +| [longest_word](#longest-word) | maximum word length | +| [post_comment](#post-comment) | post comment | +| [experimental_path](#experimental-path) | Directory root to check for spelling (note that bucket/project/config are independent of this) | +| [capture_output_unknown_words](#capture-output-unknown-words) | Capture unknown words (should be added to expect.txt) as an action output | +| [capture_output_stale_words](#capture-output-stale-words) | Capture stale words (should be removed from expect.txt) as an action output | +| [capture_output_skipped_files](#capture-output-skipped-files) | Capture skipped files (could be added to excludes.txt) as an action output | +| [experimental_commit_note](#experimental-commit-note) | If set, commit updates to expect automatically with this note | +| [only_check_changed_files](#only-check-changed-files) | If set, only check changed files | +| [dictionary_source_prefixes](#dictionary-source-prefixes) | prefixes for urls for dictionaries defined in [extra_dictionaries](#extra-dictionaries) | +| [extra_dictionaries](#extra-dictionaries) | Dictionaries to include | +| [check_extra_dictionaries](#check-extra-dictionaries) | If there are unknown words, see if they are in these additional dictionaries | +| [extra_dictionary_limit](#extra-dictionary-limit) | The number of [check_extra_dictionaries](#check-extra-dictionaries) to report | +| [event_aliases](#event-aliases) | Map an unsupported GitHub event to a known event | +| [suppress_push_for_open_pull_request](#suppress-push-for-open-pull-request) | If running from a `push` event and there's an open `pull_request`, stop working and rely on the `pull_request` handling to check the branch | +| [report_title_suffix](#report-title-suffix) | Appended to title (for use in [matrix configurations](https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idstrategymatrix)) | | [warnings](#warnings) | Treat specific errors as warnings | | [notices](#notices) | Treat specific errors as notices | -| [custom_task](#custom_task) | Workflow magic | -| [internal_state_directory](#internal_state_directory) | Workflow magic | -| [check_file_names](#check_file_names) | Spell check file paths | -| [anonymize_secpoll_source](#anonymize_secpoll_source) | Use public dns to check action security state | -| [ignore_security_advisory](#ignore_security_advisory) | Override action security state warning | -| [largest_file](#largest_file) | Ignore large files | -| [unknown_word_limit](#unknown_word_limit) | Limit the number of reports per unknown word | -| [disable_checks](#disable_checks) | Disable various check-spelling behaviors | -| [check_commit_messages](#check_commit_messages) | Check commit / PR metadata | -| [use_magic_file](#use_magic_file) | Detect binary files | -| [use_sarif](#use_sarif) | Generate SARIF Reports | -| [summary_table](#summary_table) | Summary Table | +| [custom_task](#custom-task) | Workflow magic | +| [internal_state_directory](#internal-state-directory) | Workflow magic | +| [check_file_names](#check-file-names) | Spell check file paths | +| [anonymize_secpoll_source](#anonymize-secpoll-source) | Use public dns to check action security state | +| [ignore_security_advisory](#ignore-security-advisory) | Override action security state warning | +| [largest_file](#largest-file) | Ignore large files | +| [unknown_word_limit](#unknown-word-limit) | Limit the number of reports per unknown word | +| [disable_checks](#disable-checks) | Disable various check-spelling behaviors | +| [check_commit_messages](#check-commit-messages) | Check commit / PR metadata | +| [use_magic_file](#use-magic-file) | Detect binary files | +| [use_sarif](#use-sarif) | Generate SARIF Reports | +| [summary_table](#summary-table) | Summary Table | | [report-timing](#report-timing) | Report file processing times | -| [alternate_engine](#alternate_engine) | Use another version of check-spelling | -| [alternate_engine_key](#alternate_engine_key) | ssh key to check out alternate version of check-spelling | +| [alternate_engine](#alternate-engine) | Use another version of check-spelling | +| [alternate_engine_key](#alternate-engine-key) | ssh key to check out alternate version of check-spelling | | [cache-dictionaries](#cache-dictionaries) | Allows workflows to disable caching dictionaries | -| [caller_container](#caller_container) | Hack for `act` | -| [candidate_example_limit](#candidate_example_limit) | Limit the number of reports per pattern suggestion | +| [caller_container](#caller-container) | Hack for `act` | +| [candidate_example_limit](#candidate-example-limit) | Limit the number of reports per pattern suggestion | | [checkout](#checkout) | Let action manage checkout process | | [ignore-pattern](#ignore-pattern) | Characters to ignore while parsing lines | | [lower-pattern](#lower-pattern) | Pattern describing lowercase characters while parsing lines | @@ -60,12 +60,12 @@ See [[Configuration: Workflows]] for the supported GitHub workflows. | [not-upper-or-lower-pattern](#not-upper-or-lower-pattern) | Pattern describing characters that are neither uppercase nor lowercase while parsing lines | | [punctuation-pattern](#punctuation-pattern) | Pattern describing punctuation characters while parsing lines | | [upper-pattern](#upper-pattern) | Pattern describing uppercase characters while parsing lines | -| [quit_without_error](#quit_without_error) | Cause action not to trigger a failure state regardless of its internal status | -| [spell_check_this](#spell_check_this) | Fallback configuration data to use with checkout | -| [ssh_key](#ssh_key) | Git ssh key for checking out (to enable writes with workflows) | +| [quit_without_error](#quit-without-error) | Cause action not to trigger a failure state regardless of its internal status | +| [spell_check_this](#spell-check-this) | Fallback configuration data to use with checkout | +| [ssh_key](#ssh-key) | Git ssh key for checking out (to enable writes with workflows) | | [task](#task) | Workflow magic | -See [[Configuration: Advanced]] for additional options. +See [Configuration: Advanced](./Configuration:-Advanced.md) for additional options. ### GITHUB_TOKEN @@ -75,35 +75,35 @@ By default the [GITHUB_TOKEN](https://docs.github.com/en/actions/reference/authe ⚠️ [@dependabot](https://github.com/dependabot) appears to be unfriendly to this token. > **Note:** GitHub Actions get an automatic token which allows for read operations. -> If the Action is a [pull_request](#pull_request) and the originating repository isn't trusted, then the automatic token will not have write permission, +> If the Action is a [pull_request](#pull-request) and the originating repository isn't trusted, then the automatic token will not have write permission, > which means it won't be able to post a comment to the PR, there are three ways to address this: > -> - Use [pull_request_target](./Configuration:-Workflows#pull_request_target) recommended as of [0.0.17-alpha](https://github.com/check-spelling/check-spelling/releases/tag/0.0.17-alpha) +> - Use [pull_request_target](./Configuration:-Workflows.md#pull-request-target) recommended as of [0.0.17-alpha](https://github.com/check-spelling/check-spelling/releases/tag/0.0.17-alpha) > - Create a custom Personal Access Token with `repo read` + `comment` -> - Use [schedule](./Configuration:-Workflows#schedule) instead +> - Use [schedule](./Configuration:-Workflows.md#schedule) instead ### config Default: `.github/actions/spelling` -In this directory, you can place [files](#Files) to influence the spell checker. +In this directory, you can place [files](#files) to influence the spell checker. ### dictionary_url If you don't define a dictionary using [dictionary](#dictionary) files, the spell checker will retrieve a dictionary. You can provide a different url if you have a preferred base. The default includes a variable (`$DICTIONARY_VERSION`) -for a [version](#dictionary_version). +for a [version](#dictionary-version). -This [[feature|Feature: Versioned dictionaries]] is new with [0.0.17](https://github.com/check-spelling/check-spelling/releases/tag/0.0.17-alpha). +This [feature](./Feature:-Versioned-dictionaries.md) is new with [0.0.17](https://github.com/check-spelling/check-spelling/releases/tag/0.0.17-alpha). ### dictionary_version -If [dictionary_url](#dictionary_url) includes (`$DICTIONARY_VERSION`), +If [dictionary_url](#dictionary-url) includes (`$DICTIONARY_VERSION`), you can override the default version. Over time, the default version will probably change. -See [[versioned dictionaries|Feature: Versioned dictionaries]] +See [versioned dictionaries](./Feature:-Versioned-dictionaries.md) for more information. ### experimental_apply_changes_via_bot @@ -122,7 +122,7 @@ incorporating the feedback it reports. ```yaml - if: ${{ + if: ${% raw %}{{{% endraw %} github.event_name == 'issue_comment' && github.event.issue.pull_request && contains(github.event.comment.body, '@check-spelling-bot apply') @@ -206,25 +206,25 @@ Future versions will select different tags for `cspell`, and you can mix and mat > **Warning** > If you don't override `check_extra_dictionaries`, you'll want to ensure that `cspell:` maps to something that has each of the items in it, otherwise check-spelling will be a bit upset... -Used with [extra_dictionaries](#extra_dictionaries) / [check_extra_dictionaries](#check_extra_dictionaries) to define supplemental dictionary urls in a compact form. +Used with [extra_dictionaries](#extra-dictionaries) / [check_extra_dictionaries](#check-extra-dictionaries) to define supplemental dictionary urls in a compact form. ### extra_dictionaries Extra dictionaries to be used when looking for unknown words. -This is a list of urls, additional url prefixes are defined by [`dictionary_source_prefixes`](#dictionary_source_prefixes). +This is a list of urls, additional url prefixes are defined by [`dictionary_source_prefixes`](#dictionary-source-prefixes). -See [Area dictionaries](https://github.com/check-spelling/check-spelling/wiki/Feature:-Area-dictionaries). +See [Area dictionaries](./Feature:-Area-dictionaries.md). ### check_extra_dictionaries After unknown words are identified, they can be checked against additional dictionaries. -This enables users to choose additional dictionaries to add to [extra_dictionaries](#extra_dictionaries) in future runs. +This enables users to choose additional dictionaries to add to [extra_dictionaries](#extra-dictionaries) in future runs. ### extra_dictionary_limit -In order to not drown in [check_extra_dictionaries](#check_extra_dictionaries) suggestions, only this number of dictionaries are suggested in reports. The rest are available in the generated artifact. If you find the number of listed dictionaries isn't sufficient, you can increase this number. +In order to not drown in [check_extra_dictionaries](#check-extra-dictionaries) suggestions, only this number of dictionaries are suggested in reports. The rest are available in the generated artifact. If you find the number of listed dictionaries isn't sufficient, you can increase this number. ### event_aliases @@ -250,7 +250,7 @@ The report_title_suffix enables each comment to have a distinct bit to help hint check-spelling defaults to defining certain events as errors and others as warnings. If you disagree with these values, you can change the mapping by using this field. -See [[Treat specific errors as warnings|Feature: Treat specific errors as warnings]] for more information. +See [Treat specific errors as warnings](./Feature:-Treat-specific-errors-as-warnings.md) for more information. ## notices @@ -259,7 +259,7 @@ See [[Treat specific errors as warnings|Feature: Treat specific errors as warnin check-spelling defaults to defining certain events as errors and others as warnings. As with [warnings](#warnings), if you disagree with these values, you can change the mapping by using this field. -See [[Treat specific errors as warnings|Feature: Treat specific errors as warnings]] for more information. +See [Treat specific errors as warnings](./Feature:-Treat-specific-errors-as-warnings.md) for more information. ### custom_task @@ -272,7 +272,7 @@ Replaced by [task](#task). ### internal_state_directory -As part of [custom_task](#custom_task), the default task returns its internal state. This needs to be passed to the `custom_task`: `comment` phase. +As part of [custom_task](#custom-task), the default task returns its internal state. This needs to be passed to the `custom_task`: `comment` phase. Use this parameter to indicate where the internal state was stashed. @@ -280,7 +280,7 @@ Generally stashing is done via `actions/upload-artifact@v2` and unstashing via ` ### check_file_names -People misspell file names too. If you want, Check Spelling can complain about them too. [[Feature: Check filenames and paths]] +People misspell file names too. If you want, Check Spelling can complain about them too. [Feature: Check filenames and paths](./Feature:-Check-filenames-and-paths.md) ### anonymize_secpoll_source @@ -316,7 +316,7 @@ GitHub will try to attach annotations for the first couple of reported items. The downside of this limit, of course, is that if there are more instances of a given misspelled word than this limit, you will have to find the others on your own and fix them as well. (Or just iterate with the action until it's happy...) -See [[Limit reports for each unknown word|Feature: Cap reports per unknown word]] +See [Limit reports for each unknown word](./Feature:-Cap-reports-per-unknown-word.md) ## disable_checks @@ -324,8 +324,8 @@ Introduced after v0.0.20: This is a comma-delimited list of flags: -- `noisy-file` - [[Scan noisy files|Feature: Scan noisy files]] -- `word-collating` - [[Disable word collating|Feature: Disable word collating]] +- `noisy-file` - [Scan noisy files](./Feature:-Scan-noisy-files.md) +- `word-collating` - [Disable word collating](./Feature:-Disable-word-collating.md) ## check_commit_messages @@ -333,7 +333,7 @@ This is a comma-delimited list of flags: Introduced in [v0.0.21](https://github.com/check-spelling/check-spelling/releases/tag/v0.0.21) -[[Check commit / PR metadata|Feature: Check commit messages]] +[Check commit / PR metadata](./Feature:-Check-commit-messages.md) You can specify multiple values @@ -356,7 +356,7 @@ Quickly check if files are binary and skip them if they are. Introduced in [v0.0.21](https://github.com/check-spelling/check-spelling/releases/tag/v0.0.21) -See [[Feature: Sarif output]]. This can be used as an alternative to having the tool generate +See [Feature: Sarif output](./Feature:-Sarif-output.md). This can be used as an alternative to having the tool generate comments on PRs / commits (i.e. you could remove the comment `jobs`). It integrates with GitHub's SARIF analysis and reporting. @@ -370,9 +370,9 @@ to see reports, so the experience may be slightly bumpy for projects w/ external Introduced in [v0.0.22](https://github.com/check-spelling/check-spelling/releases/tag/v0.0.22) -Include a [[Summary Table|Feature: Summary Table]] in the [[Step Summary|Feature: Step Summary]]. +Include a [Summary Table](./Feature:-Summary-Table.md) in the [Step Summary](./Feature:-Step-Summary.md). -See [[Feature: Summary Table]] +See [Feature: Summary Table](./Feature:-Summary-Table.md) ## report-timing @@ -382,75 +382,75 @@ Generate a csv file with the start and stop time for each processed file. Note that there can be multiple threads running and the precision is fairly low so it's very easy for a number of files to all have the same start and stop times. -See [[Feature: Timing Report]] +See [Feature: Timing Report](./Feature:-Timing-Report.md) ## alternate_engine -For testing a different version of check-spelling, generally from a private repository. See also [alternate_engine_key](#alternate_engine_key) +For testing a different version of check-spelling, generally from a private repository. See also [alternate_engine_key](#alternate-engine-key) ## alternate_engine_key -ssh key to use to check out the [alternate_engine](#alternate_engine). +ssh key to use to check out the [alternate_engine](#alternate-engine). ## cache-dictionaries -This enables consumers to disable [[Feature: Cache dictionaries]]. +This enables consumers to disable [Feature: Cache dictionaries](./Feature:-Cache-dictionaries.md). ## caller_container [act](https://github.com/nektos/act) Hack to enable passing check-spelling job data from one check-spelling job to another. ```yaml - caller_container: ${{ needs.spelling.outputs.docker_container }} + caller_container: ${% raw %}{{{% endraw %} needs.spelling.outputs.docker_container }} ``` ## candidate_example_limit [v0.0.22](https://github.com/check-spelling/check-spelling/releases/tag/v0.0.22) -Control how many lines are reported for each [[pattern suggestion|Feature: Suggest patterns]]. +Control how many lines are reported for each [pattern suggestion](./Feature:-Suggest-patterns.md). ## checkout -check-spelling workflows often need `write` access in order to perform various actions (adding PR comments, adding commit comments, generating SARIF reports) and having write access is a bit of a pain for pull requests from foreign repositories (see [Configuration: Workflows `pull_request_target`](https://github.com/check-spelling/check-spelling/wiki/Configuration%3A-Workflows#pull_request_target) for the various combinations). +check-spelling workflows often need `write` access in order to perform various actions (adding PR comments, adding commit comments, generating SARIF reports) and having write access is a bit of a pain for pull requests from foreign repositories (see [Configuration: Workflows `pull_request_target`](Configuration%3A-Workflows.md#pull-request-target) for the various combinations). With `checkout: 1`, the check-spelling action will use [actions/checkout](https://github.com/actions/checkout) to check out the repository and [check-spelling/checkout-merge](https://github.com/check-spelling/checkout-merge) to get the merged commit instead of requiring the workflow to include the messy logic. ## bucket -See [[Configuration: Advanced]]. +See [Configuration: Advanced](./Configuration:-Advanced.md). ## project -See [[Configuration: Advanced]]. +See [Configuration: Advanced](./Configuration:-Advanced.md). ## debug -See [[Configuration: Advanced]]. +See [Configuration: Advanced](./Configuration:-Advanced.md). ## ignore-pattern -Part of [[Feature: Configurable word characters]]. +Part of [Feature: Configurable word characters](./Feature:-Configurable-word-characters.md). ## lower-pattern -Part of [[Feature: Configurable word characters]]. +Part of [Feature: Configurable word characters](./Feature:-Configurable-word-characters.md). ## not-lower-pattern -Part of [[Feature: Configurable word characters]]. +Part of [Feature: Configurable word characters](./Feature:-Configurable-word-characters.md). ## not-upper-or-lower-pattern -Part of [[Feature: Configurable word characters]]. +Part of [Feature: Configurable word characters](./Feature:-Configurable-word-characters.md). ## punctuation-pattern -Part of [[Feature: Configurable word characters]]. +Part of [Feature: Configurable word characters](./Feature:-Configurable-word-characters.md). ## upper-pattern -Part of [[Feature: Configurable word characters]]. +Part of [Feature: Configurable word characters](./Feature:-Configurable-word-characters.md). ## quit_without_error @@ -458,11 +458,11 @@ Prevent check-spelling from exiting with an error code. ## spell_check_this -repository containing check-spelling metadata to use when the current checkout doesn't have any. This is mostly useful for [[Feature: Easier bootstrapping]]. +repository containing check-spelling metadata to use when the current checkout doesn't have any. This is mostly useful for [Feature: Easier bootstrapping](./Feature:-Easier-bootstrapping.md). ## ssh_key -The ssh key to use to check out the repository (when using [checkout](#checkout)), this enables [[Feature: Update with deploy key]] to work smoothly. +The ssh key to use to check out the repository (when using [checkout](#checkout)), this enables [Feature: Update with deploy key](./Feature:-Update-with-deploy-key) to work smoothly. If the value isn't set (e.g. because it points to an undefined secret), the code will rely on `contents: write` in order to update the repository. @@ -477,46 +477,49 @@ Used to pass messages between multiple check-spelling stages, especially from a ## Configuration Files -See [[Configuration Files]] +See [Configuration Files](./Configuration-Files.md) #### Files ##### advice -See [Configuration Files: Advice](https://github.com/check-spelling/check-spelling/wiki/Configuration-Files#advice) +See [Configuration Files: Advice](Configuration-Files.md#advice) ##### allow -See [Configuration Files: Allow](https://github.com/check-spelling/check-spelling/wiki/Configuration-Files#allow) +See [Configuration Files: Allow](Configuration-Files.md#allow) ##### block delimiters -See [Configuration Files: Block Delimiters](https://github.com/check-spelling/check-spelling/wiki/Configuration-Files#block-delimiters) +See [Configuration Files: Block Delimiters](Configuration-Files.md#block-delimiters) ##### dictionary -See [Configuration Files: Dictionary](https://github.com/check-spelling/check-spelling/wiki/Configuration-Files#dictionary) +See [Configuration Files: Dictionary](Configuration-Files.md#dictionary) ##### excludes -See [Configuration Files: Excludes](https://github.com/check-spelling/check-spelling/wiki/Configuration-Files#excludes) +See [Configuration Files: Excludes](Configuration-Files.md#excludes) ##### expect -See [Configuration Files: Expect](https://github.com/check-spelling/check-spelling/wiki/Configuration-Files#expect) +See [Configuration Files: Expect](Configuration-Files.md#expect) ##### forbidden -See [Configuration Files: Forbidden](https://github.com/check-spelling/check-spelling/wiki/Configuration-Files#forbidden) +See [Configuration Files: Forbidden](Configuration-Files.md#forbidden) ##### only -See [Configuration Files: Only](https://github.com/check-spelling/check-spelling/wiki/Configuration-Files#only) +See [Configuration Files: Only](Configuration-Files.md#only) ##### patterns -See [Configuration Files: Patterns](https://github.com/check-spelling/check-spelling/wiki/Configuration-Files#patterns) +See [Configuration Files: Patterns](Configuration-Files.md#patterns) ##### reject -See [Configuration Files: Reject](https://github.com/check-spelling/check-spelling/wiki/Configuration-Files#reject) +See [Configuration Files: Reject](Configuration-Files.md#reject) + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Configuration:-Advanced.md b/Configuration:-Advanced.md index 8efcc94..4970035 100644 --- a/Configuration:-Advanced.md +++ b/Configuration:-Advanced.md @@ -8,7 +8,7 @@ | [project](#project) | a folder within `bucket`. This allows you to share common items across projects. | | [timeframe](#timeframe) | number of minutes (default 60) to consider when a **schedule** workflow checks for updated PRs. | -ℹ️ These are additional items beyond the core items listed in [Configuration](https://github.com/check-spelling/check-spelling/wiki/Configuration). +ℹ️ These are additional items beyond the core items listed in [Configuration](Configuration.md). ## bucket @@ -18,7 +18,7 @@ - `https://` (or `http://`) - curl compatible - `gs://` - gsutil url -ℹ️ This has been superseded by [`config`](https://github.com/check-spelling/check-spelling/wiki/Configuration#config) +ℹ️ This has been superseded by [`config`](Configuration.md#config) ## project @@ -27,13 +27,16 @@ - `./` - if you don't need an extra nesting layer - directory - especially for sharing a general bucket across multiple projects -ℹ️ This has been superseded by [`config`](https://github.com/check-spelling/check-spelling/wiki/Configuration#config) +ℹ️ This has been superseded by [`config`](Configuration.md#config) ## timeframe -Used by the **[schedule](./Configuration:-Workflows#schedule)** action. Any open pull requests from another repository +Used by the **[schedule](./Configuration:-Workflows.md#schedule)** action. Any open pull requests from another repository will be checked, and if the commit is within that timeframe, it will be processed. ℹ️ In general you shouldn't need to use this as there are more recent ways to achieve desired goals. In [`v0.0.21`](https://github.com/check-spelling/check-spelling/releases/tag/v0.0.21), reports are available via the step summary w/o requiring any special permissions. + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Configuration:-Multiple-programming-languages.md b/Configuration:-Multiple-programming-languages.md index 5fec573..481ef82 100644 --- a/Configuration:-Multiple-programming-languages.md +++ b/Configuration:-Multiple-programming-languages.md @@ -36,21 +36,21 @@ jobs: fail-fast: false matrix: category: ["java", "python", "other"] - name: Spell checking (${{matrix.category}}) + name: Spell checking (${% raw %}{{{% endraw %}matrix.category}}) steps: - name: checkout-merge if: "contains(github.event_name, 'pull_request')" uses: actions/checkout@v2 with: - ref: refs/pull/${{github.event.pull_request.number}}/merge + ref: refs/pull/${% raw %}{{{% endraw %}github.event.pull_request.number}}/merge - name: checkout if: "!contains(github.event_name, 'pull_request')" uses: actions/checkout@v2 - uses: check-spelling/check-spelling@prerelease id: spelling with: - config: .github/actions/spelling-${{matrix.category}} - report_title_suffix: ${{matrix.category}} + config: .github/actions/spelling-${% raw %}{{{% endraw %}matrix.category}} + report_title_suffix: ${% raw %}{{{% endraw %}matrix.category}} ``` - `.github/actions/spelling`: @@ -120,4 +120,7 @@ I suspect that this would mean each category would get its own 10 😃 . ## See also -Using [[Area dictionaries|Feature: Area dictionaries]] should make this pretty reasonable (you could specify distinct area dictionaries using the matrix, but, you the cost for the extra dictionaries is minimal, so I'd just include all of them unconditionally). +Using [Area dictionaries](./Feature:-Area-dictionaries.md) should make this pretty reasonable (you could specify distinct area dictionaries using the matrix, but, you the cost for the extra dictionaries is minimal, so I'd just include all of them unconditionally). + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Configuration:-Workflows.md b/Configuration:-Workflows.md index a9d05eb..df4a392 100644 --- a/Configuration:-Workflows.md +++ b/Configuration:-Workflows.md @@ -10,25 +10,25 @@ If you see this error (instead of getting comments): > curl: (6) Could not resolve host: null -That's probably the problem. The fix is to [upgrade the workflow](https://github.com/check-spelling/spell-check-this/blob/main/.github/workflows/spelling.yml). +That's probably the problem. The fix is to [upgrade the workflow](https://raw.githubusercontent.com/check-spelling/spell-check-this/main/.github/workflows/spelling.yml). Note that this can happen in a fork even if things are working fine in the upstream repository as default permissions can vary from organization to organization or repository to repository. ## Supported GitHub flows - [push](#push) -- [pull_request_target](#pull_request_target) +- [pull_request_target](#pull-request-target) - [Checking potential merges for PRs](#checking-prs-by-their-merge-commit) - [checkout (built-in)](#built-in) - [actions/checkout](#using-actionscheckout) -- [pull_request](#pull_request) ⚠️ -- [issue_comment](#issue_comment) +- [pull_request](#pull-request) ⚠️ +- [issue_comment](#issue-comment) - [schedule](#schedule) 🙅 ### Notes - [Ignore Draft PRs](#draft) -- See [[Workflow Variables|Configuration#Workflow_Variables]] +- See [Workflow Variables](Configuration.md#workflow-variables) ### push @@ -103,14 +103,14 @@ jobs: - name: Checkout code uses: actions/checkout@v4 with: - ref: ${{ github.event.pull_request && format('refs/pull/{0}/merge', github.event.pull_request.number) || github.event.ref }} + ref: ${% raw %}{{{% endraw %} github.event.pull_request && format('refs/pull/{0}/merge', github.event.pull_request.number) || github.event.ref }} - name: Check Spelling uses: check-spelling/check-spelling@main ``` ### pull_request -ℹ️ You should be able to migrate to [pull_request_target](#pull_request_target) +ℹ️ You should be able to migrate to [pull_request_target](#pull-request-target) when you upgrade to 0.0.17-alpha. ⚠️ Non-member contributors who create a pull request @@ -145,7 +145,7 @@ Instead, for projects that receive PRs, I've settled on using a ### issue_comment -If you want to let user [[update the expect list|Feature: Update expect list]] from a PR ([[smoothly with a deploy key|Feature: Update with deploy key]]), you can use a job like this: +If you want to let user [update the expect list](./Feature:-Update-expect-list.md) from a PR ([smoothly with a deploy key](./Feature:-Update-with-deploy-key.md)), you can use a job like this: ```yml on: @@ -161,7 +161,7 @@ jobs: pull-requests: write actions: read runs-on: ubuntu-latest - if: ${{ + if: ${% raw %}{{{% endraw %} github.event_name == 'issue_comment' && github.event.issue.pull_request && contains(github.event.comment.body, '@check-spelling-bot apply') @@ -172,22 +172,22 @@ jobs: with: experimental_apply_changes_via_bot: 1 checkout: true - ssh_key: "${{ secrets.CHECK_SPELLING }}" + ssh_key: "${% raw %}{{{% endraw %} secrets.CHECK_SPELLING }}" ``` -- `contents: write` is mostly for forks as the `ssh_key: "${{ secrets.CHECK_SPELLING }}"` will be used if possible to push the generated commit. +- `contents: write` is mostly for forks as the `ssh_key: "${% raw %}{{{% endraw %} secrets.CHECK_SPELLING }}"` will be used if possible to push the generated commit. - `pull-requests: write` enables collapsing the triggering comment. - `actions: read` is needed for private repositories. ### schedule -🙅 [[Breaking change: Dropping support for on: schedule]] after [v0.0.22](https://github.com/check-spelling/check-spelling/releases/tag/v0.0.22) +🙅 [Breaking change: Dropping support for on: schedule](./Breaking-change:-Dropping-support-for-on:-schedule.md) after [v0.0.22](https://github.com/check-spelling/check-spelling/releases/tag/v0.0.22) This is basically a cron job run by GitHub. It will look through open PRs and comment if they've been updated -since the last run (assuming the [timeframe](./Configuration:-Advanced#timeframe) is correct). +since the last run (assuming the [timeframe](./Configuration:-Advanced.md#timeframe) is correct). -See [timeframe](./Configuration:-Advanced#timeframe) for the configuration window. +See [timeframe](./Configuration:-Advanced.md#timeframe) for the configuration window. Example workflow snippet: @@ -226,3 +226,6 @@ There are two sides to this: 1. An additional `if:` condition for `github.event.pull_request.draft == false` -- this suppresses checks while the PR is in draft (note that any initial `push` events will still run and may trigger scanning / reporting if it's unhappy, but subsequent runs once a PR is opened will be suppressed by check-spelling's `suppress_push_for_open_pull_request`) 2. `on:` / `pull_request_target:` / `types:` / `'ready_for_review'` -- this triggers a check when someone converts the PR from draft to ready for review (otherwise you'd have to wait for an additional push, which would be frustrating). + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Current-script-differs-from-apply.pl.md b/Current-script-differs-from-apply.pl.md index 46c1c77..85866ef 100644 --- a/Current-script-differs-from-apply.pl.md +++ b/Current-script-differs-from-apply.pl.md @@ -1,14 +1,17 @@ # Current script differs from `apply.pl` -check-spelling offers an [`apply.pl` script to enable update expect command line](https://github.com/check-spelling/check-spelling/wiki/Feature:-Update-expect-command-line). +check-spelling offers an [`apply.pl` script to enable update expect command line](./Feature:-Update-expect-command-line.md). The design of `apply.pl` was such that some could choose to save `apply.pl` locally, **audit it**, and then use it to apply updates. New versions of check-spelling will include improvements to `apply.pl`. In order to let users know that the version they've saved locally is no longer current, `apply.pl` includes code to compare the version it has with a specific version and warn if it's out of date. (This would apply to users of `main`, `prerelease`, and potentially a versioned release branch in case it received additional updates.) -Unfortunately, as of [check-spelling v0.0.22](https://github.com/check-spelling/check-spelling/releases/tag/v0.0.22), the version of `apply.pl` points to the [`prerelease` version of `apply.pl`](https://github.com/check-spelling/check-spelling/blob/prerelease/apply.pl) which means that people using/running that version will encounter a warning that the version that's running (v0.0.22) is out of date (as there are new features in `prerelease`). This is a _harmless_ 🐛. +Unfortunately, as of [check-spelling v0.0.22](https://github.com/check-spelling/check-spelling/releases/tag/v0.0.22), the version of `apply.pl` points to the [`prerelease` version of `apply.pl`](https://raw.githubusercontent.com/check-spelling/check-spelling/prerelease/apply.pl) which means that people using/running that version will encounter a warning that the version that's running (v0.0.22) is out of date (as there are new features in `prerelease`). This is a _harmless_ 🐛. ## Fixes * 📓 I intend to change the release process so that the next release's `apply.pl` points to the version of `apply.pl` from the release instead of the `prerelease`. * 📓 `main` will point to `main` so that it will be out of date less often. + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Deprecations.md b/Deprecations.md index 8151075..6220fcf 100644 --- a/Deprecations.md +++ b/Deprecations.md @@ -4,4 +4,7 @@ This page will list pending and deprecated features. Feature|Status -|- -[[Breaking change: Dropping support for on: schedule]]|Deprecated as of [v0.0.22](https://github.com/check-spelling/check-spelling/releases/tag/v0.0.22) +[Breaking change: Dropping support for on: schedule](./Breaking-change:-Dropping-support-for-on:-schedule.md)|Deprecated as of [v0.0.22](https://github.com/check-spelling/check-spelling/releases/tag/v0.0.22) + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Dictionary:-K8s.md b/Dictionary:-K8s.md index 9ef6a01..fec2e10 100644 --- a/Dictionary:-K8s.md +++ b/Dictionary:-K8s.md @@ -3,3 +3,6 @@ At present, https://github.com/streetsidesoftware/cspell-dicts does not include a useful Kubernetes dictionary, however there are Kubernetes projects for which it'd be useful. For [v0.0.22](https://github.com/check-spelling/check-spelling/releases/tag/v0.0.22), check-spelling will include a simple dictionary for Kubernetes based on the contents of the dhall files in https://github.com/dhall-lang/dhall-kubernetes/commit/753c7d04fb70845294095abb350cdadc79a94184. + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Dictionary:-Lisp.md b/Dictionary:-Lisp.md index 38709bb..1da572f 100644 --- a/Dictionary:-Lisp.md +++ b/Dictionary:-Lisp.md @@ -3,3 +3,6 @@ At present, https://github.com/streetsidesoftware/cspell-dicts does not include a Lisp dictionary, however there are lisp projects for which it'd be useful. For [v0.0.22](https://github.com/check-spelling/check-spelling/releases/tag/v0.0.22), check-spelling will include a simple dictionary for Lisp. + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Event-descriptions.md b/Event-descriptions.md index 661281a..19d258a 100644 --- a/Event-descriptions.md +++ b/Event-descriptions.md @@ -35,12 +35,12 @@ Each event should be listed in the [**Action Log**](https://docs.github.com/en/a - [Resolution](#resolution-12) - [unsupported-repo-notation](#unsupported-repo-notation) - [unsupported-configuration](#unsupported-configuration) - - [`only_check_changed_files` and `use_sarif`](#only_check_changed_files-and-use_sarif) - - [`use_sarif` and `security-events: write`](#use_sarif-and-security-events-write) + - [`only_check_changed_files` and `use_sarif`](#only-check-changed-files-and-use-sarif) + - [`use_sarif` and `security-events: write`](#use-sarif-and-security-events-write) - [Resolution](#resolution-13) - - [`use_sarif` and private repositories](#use_sarif-and-private-repositories) + - [`use_sarif` and private repositories](#use-sarif-and-private-repositories) - [Resolution](#resolution-14) - - [`use_sarif` and `act`](#use_sarif-and-act) + - [`use_sarif` and `act`](#use-sarif-and-act) - [minified-file](#minified-file) - [Resolution](#resolution-15) - [duplicate-extra-dictionary](#duplicate-extra-dictionary) @@ -70,7 +70,7 @@ Each event should be listed in the [**Action Log**](https://docs.github.com/en/a - [unclosed-block-ignore](#unclosed-block-ignore) - [Resolution](#resolution-27) -ℹ️ As of [v0.0.20](https://github.com/check-spelling/check-spelling/releases/tag/v0.0.20), workflows can [[configure whether specific events are treated as ❌Errors or ⚠️Warnings|Feature: Treat specific errors as warnings]]. +ℹ️ As of [v0.0.20](https://github.com/check-spelling/check-spelling/releases/tag/v0.0.20), workflows can [configure whether specific events are treated as ❌Errors or ⚠️Warnings](./Feature:-Treat-specific-errors-as-warnings.md). # unrecognized-spelling @@ -83,7 +83,7 @@ The token isn't in the dictionary - If there's a correct word (e.g. `compatibility`), correct the spelling - If the word should be in the dictionary, add it to `allow.txt` -- If a portion of the line shouldn't be checked, add a pattern to `patterns.txt` -- see [[Configuration Examples: patterns]] +- If a portion of the line shouldn't be checked, add a pattern to `patterns.txt` -- see [Configuration Examples: patterns](./Configuration-Examples:-patterns.md) - If it isn't really a word, but you're temporarily using it, add it to `expect.txt` # noisy-file @@ -94,7 +94,7 @@ This generally means that the file doesn't appear to be English. Technically it means there are fewer unique dictionary words in the file than unique non-word tokens. -ℹ️ Info: [[Feature: Autodetect noisy files]] +ℹ️ Info: [Feature: Autodetect noisy files](./Feature:-Autodetect-noisy-files.md) ## Resolution @@ -103,7 +103,7 @@ Technically it means there are fewer unique dictionary words in the file than un - If the file should be checked, some combination of: - add entries to the dictionary (via `allow.txt`) - mask runs of noise (via `patterns.txt`) -- If you really just need to check the files, see [[Scan noisy files|Feature: Scan noisy files]] +- If you really just need to check the files, see [Scan noisy files](./Feature:-Scan-noisy-files.md) # bad-regex @@ -199,7 +199,7 @@ dos2unix .github/actions/spelling/expect.txt > Warning: unknown-words.sh:894:43 ... 59, Warning - `patterns patterns` matches an objections.patterns entry. (forbidden-pattern) -This is generated by [[Forbidden patterns|Feature: Forbidden patterns]]. +This is generated by [Forbidden patterns](./Feature:-Forbidden-patterns.md). The repository has a specific regular expression defining a pattern that it doesn't want used. @@ -222,7 +222,7 @@ Please try to migrate to the newer supported item. > Warning: gigantic-file.sh:0:0 ... 0, Warning - size `10000000` exceeds limit `1000000`. (large-file) -This is generated by [[Configurable file size limits|Feature: Configurable file size limits]]. +This is generated by [Configurable file size limits](./Feature:-Configurable-file-size-limits.md). ## Resolution @@ -234,7 +234,7 @@ If the file should be skipped, please add it to `excludes.txt`. > Warning: pkg/testutil/testutil_windows.go:26:67 ... 69, Warning - `amd` is not a recognized word-- found 80 times. (limited-references) -This is generated when a word appears more than [[unknown_word_limit|Configuration#unknown_word_limit]] times. +This is generated when a word appears more than [unknown_word_limit](Configuration.md#unknown-word-limit) times. ## Resolution @@ -366,7 +366,7 @@ The [line in question](https://github.com/commercialhaskell/stack/blob/f3a167873 , concat [["-fhpc"] | isLocal && toCoverage (boptsTestOpts bopts)] ``` -👩‍🔬 In a version after 0.0.20, as part of [[Suggest patterns|Feature: Suggest patterns]], you can provide a `candidate.patterns` file. +👩‍🔬 In a version after 0.0.20, as part of [Suggest patterns](./Feature:-Suggest-patterns.md), you can provide a `candidate.patterns` file. If a line in a file (that isn't _excluded_), and after being filtered for patterns has word-like items that aren't in the dictionary, then those lines will be checked against _candidate patterns_. Each candidate will report separately against each line. @@ -496,7 +496,7 @@ Between [v20220816](https://github.com/check-spelling/cspell-dicts/releases/tag/ # check-file-path -If you have enabled [[Check filenames and paths|Feature: Check filenames and paths]] with [`check_file_names: 1`](https://github.com/check-spelling/check-spelling/wiki/Configuration#check_file_names), then in addition to checking the contents of files, check-spelling will check the file paths. +If you have enabled [Check filenames and paths](./Feature:-Check-filenames-and-paths) with [`check_file_names: 1`](Configuration.md#check-file-names), then in addition to checking the contents of files, check-spelling will check the file paths. A reported item will correspond to a portion of a file path, possibly a folder, possibly a file name, or possibly the file extension. Initially, a bunch of the items listed will be false positives, but it's quite possible that one or two of them will be misspellings. @@ -507,8 +507,8 @@ In the log form, the numbers `9 ... 18` refer to character offsets within the fi ## Identifying the problematic items -- If you enabled [[Summary Table|Feature: Summary Table]] with [`summary_table: 1`](https://github.com/check-spelling/check-spelling/wiki/Configuration#summary_table) and there is enough space, the individual paths should appear in the details table. -- If you enabled [[Sarif output|Feature: Sarif output]] with [`use_sarif: 1`](https://github.com/check-spelling/check-spelling/wiki/Configuration#use_sarif) and the repository is public (or is private and has advanced security enabled) and you are a member of the security group / an owner/admin, then individual items should appear in the Sarif report. +- If you enabled [Summary Table](./Feature:-Summary-Table) with [`summary_table: 1`](Configuration.md#summary-table) and there is enough space, the individual paths should appear in the details table. +- If you enabled [Sarif output](./Feature:-Sarif-output) with [`use_sarif: 1`](Configuration.md#use-sarif) and the repository is public (or is private and has advanced security enabled) and you are a member of the security group / an owner/admin, then individual items should appear in the Sarif report. - You can find them listed in the `Spell check` section of the Action log (they should have `(check-file-path)` on each line). ## Resolution @@ -532,11 +532,11 @@ Most of the time, the fault is in pattern definitions, especially patterns that - Consider adding a `\b` or `\s` to the edges of your pattern. - It's possible to add the items to expect or to the dictionary if they're really correct. -- See [[Warning about substring matches|Feature: Warning about substring matches]] for more advice. +- See [Warning about substring matches](./Feature:-Warning-about-substring-matches.md) for more advice. # summary-table-skipped -When producing a [[Summary Table|Feature: Summary Table]], if sections would cause the Summary to exceed its size limit, they'll be dropped. +When producing a [Summary Table](./Feature:-Summary-Table.md), if sections would cause the Summary to exceed its size limit, they'll be dropped. ## Resolution @@ -557,7 +557,7 @@ When processing a file, if the time to parse exceeds the `splitter_timeout` envi - Add the file to `excludes.txt` - Adjust patterns to improve parsing behavior -- Increase [`splitter_timeout`](https://github.com/check-spelling/check-spelling/wiki/Feature%3A-Parsing-Timeouts#configuration) +- Increase [`splitter_timeout`](Feature%3A-Parsing-Timeouts.md#configuration) # ignored-expect-variant @@ -583,21 +583,21 @@ Similarly, if you use the term `widgit`, you might write it in a plural as `widg # no-files-to-check -Check Spelling works by reviewing files and identifying problems with them. You can configure which files it should check by using [excludes](https://github.com/check-spelling/check-spelling/wiki/Configuration#excludes) and [only](https://github.com/check-spelling/check-spelling/wiki/Configuration#only) +Check Spelling works by reviewing files and identifying problems with them. You can configure which files it should check by using [excludes](Configuration.md#excludes) and [only](Configuration.md#only) ## Resolution -- Remove entries from [excludes](https://github.com/check-spelling/check-spelling/wiki/Configuration#excludes) -- Adjust or add items in [only](https://github.com/check-spelling/check-spelling/wiki/Configuration#only) +- Remove entries from [excludes](Configuration.md#excludes) +- Adjust or add items in [only](Configuration.md#only) - Review the contents of the repository and compare against both # noisy-file-list -[[Check filenames and paths|Feature: Check filenames and paths]] results in a list of file paths to be checked as if it was the contents of a file. The general [noisy-file](#noisy-file) heuristic has triggered on the file list itself. +[Check filenames and paths](./Feature:-Check-filenames-and-paths) results in a list of file paths to be checked as if it was the contents of a file. The general [noisy-file](#noisy-file) heuristic has triggered on the file list itself. ## Resolution -- Turn off [[Check filenames and paths|Feature: Check filenames and paths]]. +- Turn off [Check filenames and paths](./Feature:-Check-filenames-and-paths.md). - Add file path words to the dictionary (`allow.txt`). - Add file paths to patterns (`patterns.txt`) to exclude noisy file paths. @@ -635,7 +635,7 @@ Please [file a bug](https://github.com/check-spelling/check-spelling/issues/new) # unclosed-block-ignore -A [[Block Ignore|Feature: Block Ignore]] rule's start pattern matched content in the file, but the corresponding end tag wasn't found. +A [Block Ignore](./Feature:-Block-Ignore.md) rule's start pattern matched content in the file, but the corresponding end tag wasn't found. As a result, all content after the begin tag was ignored. @@ -645,3 +645,6 @@ Note that this feature is experimental, it's possible you've encountered a bug. - If you believe the behavior is incorrect, please [file a bug](https://github.com/check-spelling/check-spelling/issues/new). - If the end token really isn't present, consider adjusting your begin/end tokens. + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/FAQ.md b/FAQ.md index bace53f..ab23cd7 100644 --- a/FAQ.md +++ b/FAQ.md @@ -10,10 +10,10 @@ The recommended approach to upgrading is to _merge_ the contents of https://github.com/check-spelling/spell-check-this/tree/main/.github into your `.github` directory. -For the [workflow](https://github.com/check-spelling/spell-check-this/blob/main/.github/workflows/spelling.yml), -you'll generally want to copy over any settings that you've applied (typically dictionary configuration) and remove any items you've removed. +For the [workflow](https://raw.githubusercontent.com/check-spelling/spell-check-this/main/.github/workflows/spelling.yml), +you'll generally want to copy over any settings that you've applied (typically dictionary configuration) and remove any items you've removed. -New releases of check-spelling will add new features, some of which may be enabled by default. But, often, to avoid behavior changes to existing deployments, they require opting in, and thus additional flags via [[workflow parameters|Configuration#workflow-parameters]]. +New releases of check-spelling will add new features, some of which may be enabled by default. But, often, to avoid behavior changes to existing deployments, they require opting in, and thus additional flags via [workflow parameters](Configuration.md#workflow-parameters). The [spell-check-this template repository](https://github.com/check-spelling/spell-check-this) enables some settings which you might not want, in some ways it's a showcase of what check-spelling can do (e.g. check PR summary and descriptions, or even commit messages). @@ -33,4 +33,7 @@ Reports for some repositories will have an entry like: Users without write access to the repository will probably not be able to see the [👼 SARIF report](#), and will instead see a 404 page. -This relates to the fact that SARIF was designed for reporting results from security scanners, as such GitHub restricts who has access to the reports. For more information, see [[SARIF output visibility|Feature:-Sarif-output#visibility]]. +This relates to the fact that SARIF was designed for reporting results from security scanners, as such GitHub restricts who has access to the reports. For more information, see [SARIF output visibility](./Feature:-Sarif-output.md#visibility). + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Allow.md b/Feature:-Allow.md index 2318515..d1f223b 100644 --- a/Feature:-Allow.md +++ b/Feature:-Allow.md @@ -13,4 +13,7 @@ It is nicer if one can just supply the new words without having to maintain a co Released in [0.0.16-alpha](https://github.com/check-spelling/check-spelling/releases/tag/0.0.16-alpha) as: `allow`. -Note that this is distinct from [[expect|Feature: Expectlist]]. +Note that this is distinct from [expect](./Feature:-Expectlist.md). + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Area-dictionaries.md b/Feature:-Area-dictionaries.md index a6bcf14..9410e83 100644 --- a/Feature:-Area-dictionaries.md +++ b/Feature:-Area-dictionaries.md @@ -102,7 +102,7 @@ Testing in prerelease versions of check-spelling/spell-check-this may start in 2 ## Future work -[[Suggest Area dictionaries|Feature: Suggest Area Dictionaries]] +[Suggest Area dictionaries](./Feature:-Suggest-Area-Dictionaries.md) ## Potential Areas @@ -160,3 +160,6 @@ Testing in prerelease versions of check-spelling/spell-check-this may start in 2 - MPL - GPL - ... + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Autodetect-noisy-files.md b/Feature:-Autodetect-noisy-files.md index d31faf5..8896572 100644 --- a/Feature:-Autodetect-noisy-files.md +++ b/Feature:-Autodetect-noisy-files.md @@ -15,11 +15,14 @@ Look for new filename extensions? ## See also -- [[Detect non text files|Feature: Detect non text files]] -- [[Detect binary files|Feature: Detect binary files]] +- [Detect non text files](./Feature:-Detect-non-text-files.md) +- [Detect binary files](./Feature:-Detect-binary-files.md) ## Escape path If this feature trips on files you need scanned, see: -[[Scan noisy files|Feature: Scan noisy files]] +[Scan noisy files](./Feature:-Scan-noisy-files.md) + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Autodetect-valid-word-lengths.md b/Feature:-Autodetect-valid-word-lengths.md index 3ffb2af..5427c9d 100644 --- a/Feature:-Autodetect-valid-word-lengths.md +++ b/Feature:-Autodetect-valid-word-lengths.md @@ -1,6 +1,6 @@ # Autodetect valid word lengths -With [[Heuristic exclude suggestions|Feature: Heuristic exclude suggestions]], I've started reviewing what's worth checking. +With [Heuristic exclude suggestions](./Feature:-Heuristic-exclude-suggestions.md), I've started reviewing what's worth checking. For one, a significant portion of the two letter space is already in the dictionary. @@ -19,3 +19,6 @@ There are now two flags to configure the length of "words": - `shortest_word` -- you can set this to `"2"` to restore the old behavior - `longest_word` -- you could set this to some obscene number like `"32767"` to get closer to the old behavior + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Automatically-truncate-comment.md b/Feature:-Automatically-truncate-comment.md index 8c108fe..50dde33 100644 --- a/Feature:-Automatically-truncate-comment.md +++ b/Feature:-Automatically-truncate-comment.md @@ -23,3 +23,6 @@ I'm currently truncating first the stale items, and then the misspelled items. Generally during first run, the first thing to do is to tune `excludes`, and thus the focus should be on either adding excludes or adding dictionaries. Currently these two are not automatically truncated. If I get feedback that someone managed to have too many exclude suggestions, then I may add support for truncating that as well. The log should include the truncated content. + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Block-Ignore.md b/Feature:-Block-Ignore.md index bb5e29f..a4eac8f 100644 --- a/Feature:-Block-Ignore.md +++ b/Feature:-Block-Ignore.md @@ -65,3 +65,6 @@ Draft support in a file `block-delimiters.list`, format: ``` This is not yet implemented as of [v0.0.22](https://github.com/check-spelling/check-spelling/releases/tag/v0.0.22) + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Cache-dictionaries.md b/Feature:-Cache-dictionaries.md index bd4e54c..5d72465 100644 --- a/Feature:-Cache-dictionaries.md +++ b/Feature:-Cache-dictionaries.md @@ -69,3 +69,6 @@ urls/ 1. detect any `directory/{sha}` for which there is no urls/{\*}/sha containing that value and delete it. 2. detect any `urls/{*}/sha` for which there's more than one `urls/{*}` with the same `sha` file value and warn about it. + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Cap-reports-per-unknown-word.md b/Feature:-Cap-reports-per-unknown-word.md index 93f9fa3..4f92919 100644 --- a/Feature:-Cap-reports-per-unknown-word.md +++ b/Feature:-Cap-reports-per-unknown-word.md @@ -1,5 +1,8 @@ # Cap reports per unknown word -[`unknown_word_limit`](https://github.com/check-spelling/check-spelling/wiki/Configuration#unknown_word_limit) +[`unknown_word_limit`](Configuration.md#unknown-word-limit) Each unknown word will only be reported this many times. + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Character-Encoding-Auto-Detection.md b/Feature:-Character-Encoding-Auto-Detection.md index 8e120e8..7c2cf6c 100644 --- a/Feature:-Character-Encoding-Auto-Detection.md +++ b/Feature:-Character-Encoding-Auto-Detection.md @@ -1,6 +1,6 @@ In [v0.0.21](https://github.com/check-spelling/check-spelling/releases/tag/v0.0.21), check-spelling assumes ASCII encoding and roughly ignores anything outside `[a-zA-Z']`. -In order to support [[non-English languages|Feature: Non English languages]], the acceptable character-set will have to grow to include: +In order to support [non-English languages](./Feature:-Non-English-languages.md), the acceptable character-set will have to grow to include: - Spanish (plus uppercase): á é í ó ú ü ñ ¿ ¡ - French (plus uppercase): é à è ù â ê î ô û ä ë ü ç @@ -12,3 +12,6 @@ It would be nice to support `latin-1`, `utf-*`/`ucs-*`, and possibly some altern One approach would be t recognize some sentinel bytes, and once those are present, switch to a mode where the file might be worth checking again in an alternate encoding. In that mode, if the file has a words vs non-words comparison that is close to the normal threshold, it can be re-checked w/ another encoding, and if that pushes it into the right category, it can be added w/ a hint to add it to a pattern mapping to the selected encoding. This would require adding a second threshold for truly non-word files (currently a single threshold exists for binary files where non-words exceeds words). + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Check-commit-messages.md b/Feature:-Check-commit-messages.md index 60b64b9..a6f5bd3 100644 --- a/Feature:-Check-commit-messages.md +++ b/Feature:-Check-commit-messages.md @@ -6,7 +6,7 @@ If a repository has enabled incremental checking, then it wouldn't be terribly h This would be _optional_, and I **don't expect** it to be on by default (although I may enable it in spell-check-this's workflow). -It's somewhat similar to [[Feature: Check filenames and paths]]. +It's somewhat similar to [Feature: Check filenames and paths](./Feature:-Check-filenames-and-paths.md). ## Status @@ -14,7 +14,7 @@ It's somewhat similar to [[Feature: Check filenames and paths]]. See [Future work](#future-work) for thoughts on how to improve the implementation. -If you choose to use this feature today, you should either use [`only_check_changed_files`](../Configuration#only_check_changed_files) or include text in [`advice.md`](../Configuration#advice) suggesting that commit message / PR items be added to [`allow.txt`](../Configuration#allow) instead of [`expect.txt`](../Configuration#expect). +If you choose to use this feature today, you should either use [`only_check_changed_files`](./Configuration.md#only-check-changed-files) or include text in [`advice.md`](./Configuration.md#advice) suggesting that commit message / PR items be added to [`allow.txt`](./Configuration.md#allow) instead of [`expect.txt`](./Configuration.md#expect). ## Implemented modes @@ -48,4 +48,7 @@ Use [`$GITHUB_STEP_SUMMARY`](https://github.blog/2022-05-09-supercharging-github ## Potential additional modes - n commits - This is trivial to implement, but without a use case, I don't intend to implement it -- commits since a specific sha or branch - This might be necessary in order to support adding items to [`expect.txt`](../Configuration#expect), although I'm convinced it makes more sense to use [`allow.txt`](../Configuration#allow) or [`patterns.txt`](../Configuration#patterns). +- commits since a specific sha or branch - This might be necessary in order to support adding items to [`expect.txt`](./Configuration.md#expect), although I'm convinced it makes more sense to use [`allow.txt`](./Configuration.md#allow) or [`patterns.txt`](./Configuration.md#patterns). + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Check-filenames-and-paths.md b/Feature:-Check-filenames-and-paths.md index f2001aa..5637831 100644 --- a/Feature:-Check-filenames-and-paths.md +++ b/Feature:-Check-filenames-and-paths.md @@ -20,8 +20,11 @@ While this tool was written to catch misspellings within files, it's actually fa ## Improvements in v0.0.21 -- [`check-file-path`](https://github.com/check-spelling/check-spelling/wiki/Event-descriptions#noisy-file-list) +- [`check-file-path`](Event-descriptions.md#noisy-file-list) ## Improvements in v0.0.22 -- [`noisy-file-list`](https://github.com/check-spelling/check-spelling/wiki/Event-descriptions#noisy-file-list) +- [`noisy-file-list`](Event-descriptions.md#noisy-file-list) + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Collapse-older-check-comments.md b/Feature:-Collapse-older-check-comments.md index 9a05ad0..b7991a6 100644 --- a/Feature:-Collapse-older-check-comments.md +++ b/Feature:-Collapse-older-check-comments.md @@ -9,3 +9,6 @@ In v0.0.18, when one asks the bot to apply changes, the changes suggestion and r The implementation uses GraphQL to ask for the right comment and some filtering to find the comment node. With the comment node, it's trivial to call the collapsing code. + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Concurrency.md b/Feature:-Concurrency.md index 1f69e0a..5ef82bf 100644 --- a/Feature:-Concurrency.md +++ b/Feature:-Concurrency.md @@ -1,6 +1,6 @@ # Concurrency -Documented for [v0.0.20](https://github.com/check-spelling/check-spelling/releases/tag/v0.0.20) and included in the [recommended workflow](https://github.com/check-spelling/spell-check-this/blob/main/.github/workflows/spelling.yml) +Documented for [v0.0.20](https://github.com/check-spelling/check-spelling/releases/tag/v0.0.20) and included in the [recommended workflow](https://raw.githubusercontent.com/check-spelling/spell-check-this/main/.github/workflows/spelling.yml) ## Background @@ -10,9 +10,9 @@ You're welcome to use this however you choose. Note that at the time this page w ## Recommended implementation -If you aren't using [[Only changes|Feature: Only changes]], you probably want to use `cancel-in-progress: true` for the main spell check job. +If you aren't using [Only changes](./Feature:-Only-changes.md), you probably want to use `cancel-in-progress: true` for the main spell check job. -For [[Update expect list|Feature: Update expect list]], my recommended flow is to let both run but use concurrency to serialize the updates. I'm not sure if this is the right answer in general, and I don't know if this is the right answer for your project. I'm welcome implementation experience. +For [Update expect list](./Feature:-Update-expect-list.md), my recommended flow is to let both run but use concurrency to serialize the updates. I'm not sure if this is the right answer in general, and I don't know if this is the right answer for your project. I'm welcome implementation experience. ## Note @@ -23,3 +23,6 @@ You can see an implementation of it in [spell-check-this](https://github.com/che When triggered, you'll get an event like this: > Canceling since a higher priority waiting request for 'spelling-refs/heads/prerelease' exists + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Configurable-file-size-limits.md b/Feature:-Configurable-file-size-limits.md index f955c5c..17cf351 100644 --- a/Feature:-Configurable-file-size-limits.md +++ b/Feature:-Configurable-file-size-limits.md @@ -14,7 +14,7 @@ Whether they're actually text files isn't relevant to check-spelling, unless the Default is to exclude files over 1 mb. -Configurable via [`largest_file`](https://github.com/check-spelling/check-spelling/wiki/Configuration#largest_file). +Configurable via [`largest_file`](Configuration.md#largest-file). Reported as `large-file`. @@ -23,3 +23,6 @@ Files that are too large will be suggested for exclusion. ## Future I might also want to have check-spelling time itself and warn when it takes too long to scan a file. -- This would also be configurable. + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Configurable-word-characters.md b/Feature:-Configurable-word-characters.md index b99d68b..0e1cb20 100644 --- a/Feature:-Configurable-word-characters.md +++ b/Feature:-Configurable-word-characters.md @@ -1,6 +1,6 @@ # Configurable word characters -In [v0.0.21](https://github.com/check-spelling/check-spelling/releases/tag/v0.0.21), check-spelling only looks at `/[A-Za-z']/` and generally with a [minimum run length of 3](Configuration#shortest_word). +In [v0.0.21](https://github.com/check-spelling/check-spelling/releases/tag/v0.0.21), check-spelling only looks at `/[A-Za-z']/` and generally with a [minimum run length of 3](Configuration.md#shortest-word). ## Caveats @@ -100,3 +100,6 @@ In order for this to work reasonably well, support for hunspell `.dic` and `.aff ## Related Right now, characters that fall outside the recognized set are effectively blanked (replaced with a non-word character, currently `=`). I might switch to only parsing characters that match the regex. That'd save me a pass. + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Content-Mappings.md b/Feature:-Content-Mappings.md index 9258a6e..bd4187b 100644 --- a/Feature:-Content-Mappings.md +++ b/Feature:-Content-Mappings.md @@ -2,7 +2,7 @@ Currently there are a couple of [hard-coded](#hard-coded) aliases in the word splitter. -There are a couple of others that probably [should be offered](#Future), and it'd be better if this were something that users could configure instead of requiring a new release each time. +There are a couple of others that probably [should be offered](#future), and it'd be better if this were something that users could configure instead of requiring a new release each time. ## Proposal @@ -61,3 +61,6 @@ apostrophe (`'`) ```pl s/\\(aq/'/g ``` + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Correct-misspelling.md b/Feature:-Correct-misspelling.md index 947a7fa..4f54948 100644 --- a/Feature:-Correct-misspelling.md +++ b/Feature:-Correct-misspelling.md @@ -14,7 +14,7 @@ This is obviously appealing, but at present it's fairly low on my list of things As long as you have a local repository (and I usually do, although of late I've been taking advantage of the GitHub editor to skip this), it's pretty easy to fix things yourself. -At the present time, you can use [[jsoref/spelling|https://github.com/jsoref/spelling]]'s `rs` command for this or various other things. +At the present time, you can use [jsoref/spelling](https://github.com/jsoref/spelling)'s `rs` command for this or various other things. ### Renaming files @@ -29,3 +29,6 @@ That would be a good step toward being able to ingest a list of corrections. ## Picking corrections in a semi automated manner For reference, at present, I have a Google Sheets spreadsheet which constructs the `rs` commands automatically (just running Sheets's Spell Check and accepting its corrections generates the commands). – At some point, I'll publish this as well. Sheets makes case aware corrections which is incredibly handy and its corrections tend to be better than Google Chrome/Google Search Suggest. + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Custom-escape-mappings.md b/Feature:-Custom-escape-mappings.md index 10d61f3..39bca74 100644 --- a/Feature:-Custom-escape-mappings.md +++ b/Feature:-Custom-escape-mappings.md @@ -18,3 +18,6 @@ Right now, `\\[nrt]` are effectively mapped to space, and some patterns are mapp I'm not sure I like this at all as the parsing will be painful. I could use JSON, but, I don't think that really improves things. + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Customer-satisfaction-survey.md b/Feature:-Customer-satisfaction-survey.md index 1f7d8bf..88b696b 100644 --- a/Feature:-Customer-satisfaction-survey.md +++ b/Feature:-Customer-satisfaction-survey.md @@ -16,4 +16,7 @@ It'd be nice to be able to provide something like this: In a Comment or a Step Summary, the form could also prefill the url for the PR / commit. But for a Comment, there really wouldn't be enough space. -As such, this probably won't be implemented until after switching to [[Job Summaries|Behavior change: Job Summaries]]. +As such, this probably won't be implemented until after switching to [Job Summaries](./Behavior-change:-Job-Summaries.md). + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Detect-binary-files.md b/Feature:-Detect-binary-files.md index b549fb4..91fc557 100644 --- a/Feature:-Detect-binary-files.md +++ b/Feature:-Detect-binary-files.md @@ -14,3 +14,6 @@ To enable, include: ``` This will be available in [v0.0.21](https://github.com/check-spelling/check-spelling/releases/tag/v0.0.21) + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Detect-non-text-files.md b/Feature:-Detect-non-text-files.md index 2410d88..902c604 100644 --- a/Feature:-Detect-non-text-files.md +++ b/Feature:-Detect-non-text-files.md @@ -10,7 +10,7 @@ It would be nice if the tool could recognize files that aren't interesting to it If a file has more _non-words_ than dictionary _words_, it's a good candidate for exclusion. -This is implemented in [v0.0.21](https://github.com/check-spelling/check-spelling/releases/tag/v0.0.21) as part of [[Autodetect noisy files|Feature: Autodetect noisy files]] +This is implemented in [v0.0.21](https://github.com/check-spelling/check-spelling/releases/tag/v0.0.21) as part of [Autodetect noisy files](./Feature:-Autodetect-noisy-files.md) ### Implementation @@ -22,7 +22,7 @@ This is implemented in [v0.0.21](https://github.com/check-spelling/check-spellin ## File patterns -This is implemented in [v0.0.22](https://github.com/check-spelling/check-spelling/releases/tag/v0.0.22) as part of [[Heuristic exclude suggestions|Feature: Heuristic exclude suggestions]] +This is implemented in [v0.0.22](https://github.com/check-spelling/check-spelling/releases/tag/v0.0.22) as part of [Heuristic exclude suggestions](./Feature:-Heuristic-exclude-suggestions.md) Totals for files could be checked by _file extension_, _file infix_, _file prefix_, and _directory name_ @@ -42,3 +42,6 @@ Suggestions could be made based on each of those categories: # test-data directory: /test-data/ ``` + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Dictionaries-with-unique-value.md b/Feature:-Dictionaries-with-unique-value.md index fed89c0..1b3228a 100644 --- a/Feature:-Dictionaries-with-unique-value.md +++ b/Feature:-Dictionaries-with-unique-value.md @@ -62,3 +62,6 @@ Where _unique matching entries_ + _common matching entries_ = _matching entry co An entry in a dictionary would be scored into _unique matching entries_ only if it isn't present in other dictionaries. https://github.com/check-spelling/zio-flow/commit/b5b7d5f991d234c67f309bc98499c2f86d431bba#commitcomment-84656084 is an example of a single unknown word and many expected words; this example, more than most, drives home the question "would any of these dictionaries reduce this list" -- consider columns for both expected words and unknown words. + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Dictionary-deltas.md b/Feature:-Dictionary-deltas.md index 085828f..09d081c 100644 --- a/Feature:-Dictionary-deltas.md +++ b/Feature:-Dictionary-deltas.md @@ -6,7 +6,7 @@ At least one project has identified words that they'd like to remove from the di As the initial implementation includes a `whitelist` of acceptable words, it seems reasonable to handle rejecting words by adding a `blacklist` which would remove words from the dictionary (instead of removing them from the corpus). -⚠️ See caveat about [[Avoid using colors in names|Feature: Expectlist]]. +⚠️ See caveat about [Avoid using colors in names](./Feature:-Expectlist.md). As this feature hasn't shipped, and as there's a desire/need for both additions and removals, I think I'm going to go with: @@ -18,3 +18,6 @@ The order of operations will be: - (base `dictionary` + `allow`) - `reject` This means that if a word is in both `allow` and `reject`, it will end up _not_ being in the dictionary. + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Disable-word-collating.md b/Feature:-Disable-word-collating.md index 18914c0..e1d2a3b 100644 --- a/Feature:-Disable-word-collating.md +++ b/Feature:-Disable-word-collating.md @@ -23,3 +23,6 @@ There are actually two places where check-spelling does folding: ## Sample consumers [cspell compact-dictionaries workflow](https://github.com/check-spelling/cspell-dicts/commit/2a5b8bb057f4580749933060b29c466e92c93400#diff-f38bd48888fa3290eb90897dc1e21411b2bcf12a6538cd72bb583e7608787698R88) + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Disclaimer-about-missing-status.md b/Feature:-Disclaimer-about-missing-status.md index 8dc10c8..d50e27e 100644 --- a/Feature:-Disclaimer-about-missing-status.md +++ b/Feature:-Disclaimer-about-missing-status.md @@ -1,5 +1,8 @@ # Disclaimer about missing status -If you're using [[Update expect list|Feature: Update expect list]], unfortunately at this time the status will retain its ❌ until an additional commit is added by something other than the GitHub bot. +If you're using [Update expect list](./Feature:-Update-expect-list.md), unfortunately at this time the status will retain its ❌ until an additional commit is added by something other than the GitHub bot. An extra comment will be added to explain this and make it easier to work around this restriction. + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Duplicate-word-detection.md b/Feature:-Duplicate-word-detection.md index 38485b8..e74cad0 100644 --- a/Feature:-Duplicate-word-detection.md +++ b/Feature:-Duplicate-word-detection.md @@ -6,7 +6,7 @@ The classic example is `the the quick` ## Proposal -This is possible using [[Forbidden patterns|Feature: Forbidden patterns]]: +This is possible using [Forbidden patterns](./Feature:-Forbidden-patterns.md): `line_objections.patterns`: @@ -17,3 +17,6 @@ This is possible using [[Forbidden patterns|Feature: Forbidden patterns]]: ### Cons I fully expect this to have a significant performance penalty (and it has to be done fairly early, before any other parsing...) + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Easier-bootstrapping.md b/Feature:-Easier-bootstrapping.md index a58279b..19f1626 100644 --- a/Feature:-Easier-bootstrapping.md +++ b/Feature:-Easier-bootstrapping.md @@ -16,3 +16,6 @@ Prior to 0.0.17, in order to get the shiny features from check-spelling, to get With 0.0.17, `bucket` and `project` are replaced by `config` which defaults to `.github/actions/spelling` (as if one had specified `bucket: .github/actions` and `project: spelling`). Note that `bucket` and `project` are still supported (and to retain backwards compatibility these override `config`). With 0.0.17, the action will provide comments when it runs even if there is no `expect` (or similar) file. This should lead to a more natural flow. + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Easier-to-understand-filenames.md b/Feature:-Easier-to-understand-filenames.md index 25ada0d..885c8bd 100644 --- a/Feature:-Easier-to-understand-filenames.md +++ b/Feature:-Easier-to-understand-filenames.md @@ -23,14 +23,17 @@ GitHub Markdown | txt | md Category | Task | Format | Current | Proposed -|-|-|-|- -Dictionary | [Replace base dictionary](https://github.com/check-spelling/check-spelling/wiki/Feature:-Dictionary-deltas) | words | dictionary | dictionary -Dictionary | [Add items to dictionary](https://github.com/check-spelling/check-spelling/wiki/Feature:-Allow) | words | allow | dictionary_additions -Dictionary | [Remove items from dictionary](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples:-reject) | patterns | reject | dictionary_removals -Files | [Ignore files](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples:-excludes) | patterns | excludes | file_ignore -Files | [Limit file checking](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples:-only) | patterns | only | file_exclusive -Content | [Mask file content](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples:-patterns) | patterns | patterns | line_masks -Content | [Forbidden patterns](https://github.com/check-spelling/check-spelling/wiki/Feature:-Forbidden-patterns) | patterns | line_forbidden | line_objections -Output | [Acknowledge some word-like things that aren't in the dictionary](https://github.com/check-spelling/check-spelling/wiki/Configuration#expect) | words | expect | word_expectations -Output | [Help users respond to the bot](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples:-advice) | md | advice | `?` +Dictionary | [Replace base dictionary](./Feature:-Dictionary-deltas.md) | words | dictionary | dictionary +Dictionary | [Add items to dictionary](./Feature:-Allow.md) | words | allow | dictionary_additions +Dictionary | [Remove items from dictionary](./Configuration-Examples:-reject.md) | patterns | reject | dictionary_removals +Files | [Ignore files](./Configuration-Examples:-excludes.md) | patterns | excludes | file_ignore +Files | [Limit file checking](./Configuration-Examples:-only.md) | patterns | only | file_exclusive +Content | [Mask file content](./Configuration-Examples:-patterns.md) | patterns | patterns | line_masks +Content | [Forbidden patterns](./Feature:-Forbidden-patterns.md) | patterns | line_forbidden | line_objections +Output | [Acknowledge some word-like things that aren't in the dictionary](Configuration.md#expect) | words | expect | word_expectations +Output | [Help users respond to the bot](./Configuration-Examples:-advice.md) | md | advice | `?` Raised in https://github.com/check-spelling/check-spelling/issues/10 + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Expectlist.md b/Feature:-Expectlist.md index ff3552d..9f6ff31 100644 --- a/Feature:-Expectlist.md +++ b/Feature:-Expectlist.md @@ -11,3 +11,6 @@ I've made this the primary term and am offering the old one for backward compati In some ways, `expect` is actually more accurate as the action tries to prune the list of things which are no longer necessary. Released in [0.0.16-alpha](https://github.com/check-spelling/check-spelling/releases/tag/0.0.16-alpha) + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-First-run-advice.md b/Feature:-First-run-advice.md index 6f00186..dcca7b0 100644 --- a/Feature:-First-run-advice.md +++ b/Feature:-First-run-advice.md @@ -13,3 +13,6 @@ This isn't particularly good... If there's an `expect` file and no `excludes` file, I think I'll have it suggest an `excludes` file. If there's an `expect` and an `excludes`, I might have it suggest a `patterns` file. + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Forbidden-patterns.md b/Feature:-Forbidden-patterns.md index 62f5663..4f03dc0 100644 --- a/Feature:-Forbidden-patterns.md +++ b/Feature:-Forbidden-patterns.md @@ -45,3 +45,6 @@ Add as `\bMicroSoft\b` # Reject duplicate words \b(\w{3,})\s\g{-1}\b ``` + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Handle-GitHub-Varnish-failures.md b/Feature:-Handle-GitHub-Varnish-failures.md index c6b6e48..b5feb3d 100644 --- a/Feature:-Handle-GitHub-Varnish-failures.md +++ b/Feature:-Handle-GitHub-Varnish-failures.md @@ -1117,3 +1117,6 @@ content-length: 9 This was not handled by check-spelling [v0.0.22](https://github.com/check-spelling/check-spelling/releases/tag/v0.0.22) as a `503` was expected. [v0.0.23](https://github.com/check-spelling/check-spelling/releases/tag/v0.0.23) will tolerate `502` as well. + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Heuristic-exclude-suggestions.md b/Feature:-Heuristic-exclude-suggestions.md index 629ac36..66f5884 100644 --- a/Feature:-Heuristic-exclude-suggestions.md +++ b/Feature:-Heuristic-exclude-suggestions.md @@ -196,3 +196,6 @@ Like File extensions, but instead of capturing the rhs of the `.` for the filena 6. Go to the next candidate, subtract out no longer interesting files, and check its current count against the next candidate count 7. If it's still highest, select it 8. If it isn't, queue it to be rechecked at approximately where it should be in the scoring world and go to the next candidate + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Highlight-homophones-and-case-botches.md b/Feature:-Highlight-homophones-and-case-botches.md index 861477d..3350eda 100644 --- a/Feature:-Highlight-homophones-and-case-botches.md +++ b/Feature:-Highlight-homophones-and-case-botches.md @@ -16,3 +16,6 @@ - [greater _than_](https://github.com/check-spelling/spell-check-this/blob/6b13bdb3994f3dcb77147c4a06b128fe6d1fe8c8/.github/actions/spelling/line_forbidden.patterns#L54) - [less _than_](https://github.com/check-spelling/spell-check-this/blob/6b13bdb3994f3dcb77147c4a06b128fe6d1fe8c8/.github/actions/spelling/line_forbidden.patterns#L80) - [rather _than_](https://github.com/check-spelling/spell-check-this/blob/6b13bdb3994f3dcb77147c4a06b128fe6d1fe8c8/.github/actions/spelling/line_forbidden.patterns#L92) + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Honor-gitattributes.md b/Feature:-Honor-gitattributes.md index e37ce70..6385ab1 100644 --- a/Feature:-Honor-gitattributes.md +++ b/Feature:-Honor-gitattributes.md @@ -5,3 +5,6 @@ GitHub Linguist recognizes [vendored code](https://github.com/github/linguist#ve Since this action is designed to run in GitHub repositories, it is quite possible people will add `linguist-vendored` or `linguist-generated` annotations. It'd be nice if these were automatically recognized instead of relying on people to add them to `excludes`. + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Hunspell-dictionary-support.md b/Feature:-Hunspell-dictionary-support.md index 4b4dd55..990e94d 100644 --- a/Feature:-Hunspell-dictionary-support.md +++ b/Feature:-Hunspell-dictionary-support.md @@ -57,3 +57,6 @@ You can add any Hunspell `.dic` to `extra_dictionaries`: ``` When check-spelling sees an instruction to use `.dic` file, it will automatically retrieve the corresponding `.aff` file as well. + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-IDE-Integration.md b/Feature:-IDE-Integration.md index 42c8cdc..1a610eb 100644 --- a/Feature:-IDE-Integration.md +++ b/Feature:-IDE-Integration.md @@ -14,3 +14,6 @@ Things to try: ``` - Ref: [streetsidesoftware/vscode-spell-checker#681](https://github.com/streetsidesoftware/vscode-spell-checker/issues/681) + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Improve-suggested-dictionaries-order.md b/Feature:-Improve-suggested-dictionaries-order.md index a916735..f99ecfd 100644 --- a/Feature:-Improve-suggested-dictionaries-order.md +++ b/Feature:-Improve-suggested-dictionaries-order.md @@ -18,3 +18,6 @@ The implementation is basically: 1. sort the union of all suggested dictionaries retaining only unique words 2. for each dictionary, score any word that is in that list + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-JSON-configuration.md b/Feature:-JSON-configuration.md index 66180de..93cc648 100644 --- a/Feature:-JSON-configuration.md +++ b/Feature:-JSON-configuration.md @@ -15,7 +15,7 @@ The last point means that check-spelling needs a json parser in order to do anyt ## Proposal -Instead of having lots of lines of config in the `action.yml` file, and similar lines in the reusable workflow, I'm contemplating having just one or two configurable items in the `action.yml` -- mostly the path to the config directory [`config`](https://github.com/check-spelling/check-spelling/wiki/Configuration#config) and the [`custom_task`](https://github.com/check-spelling/check-spelling/wiki/Configuration#custom_task)). +Instead of having lots of lines of config in the `action.yml` file, and similar lines in the reusable workflow, I'm contemplating having just one or two configurable items in the `action.yml` -- mostly the path to the config directory [`config`](Configuration.md#config) and the [`custom_task`](Configuration.md#custom-task)). A new file will be added (tentatively `config.json`) containing the other configuration that used to be defined in `action.yml` and specified in the workflow. @@ -27,3 +27,6 @@ Using `toJSON(inputs)` allows me to capture the current inputs (and thus greatly - Configuration doesn't need to be specified 2+ times (spelling, comment, optional update phase). - Only the pieces of configuration that are used by a given path would need to be parsed (currently the action.yml has to convert all inputs into env vars before the action actually starts running). + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Learn-from-corrections.md b/Feature:-Learn-from-corrections.md index 381593b..1e13dc8 100644 --- a/Feature:-Learn-from-corrections.md +++ b/Feature:-Learn-from-corrections.md @@ -2,6 +2,9 @@ There are some tools which just correct someone's list of commonly misspelled and corrected words. -[[@jsoref|https://github.com/jsoref]] has hundreds of repositories worth of corrections. It would be nice to try to perform some heuristic / analysis / machine learning / insert buzzword here in order to develop a common list of suggested fixes. +[@jsoref](https://github.com/jsoref) has hundreds of repositories worth of corrections. It would be nice to try to perform some heuristic / analysis / machine learning / insert buzzword here in order to develop a common list of suggested fixes. This is obviously appealing, but it's not something I'm likely to work on anytime soon. I'd be interested in talking w/ someone about implementing something in this area. + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Limit-schedule-branches.md b/Feature:-Limit-schedule-branches.md index 9b5cfa4..6c05838 100644 --- a/Feature:-Limit-schedule-branches.md +++ b/Feature:-Limit-schedule-branches.md @@ -9,7 +9,7 @@ Support for `schedule` will be removed before `1.0.0`. 1. Users should be able to get spell checking feedback without creating a PR. - Solution: use `push` to trigger spell checking 1. If one uses both `push` and `pull_request`, then things run twice, which looks bad (and is fairly confusing) - - Solution: [[Suppress push for open pull request|Configuration#suppress_push_for_open_pull_request]] + - Solution: [Suppress push for open pull request](Configuration.md#suppress-push-for-open-pull-request) 1. If users create forks that don't enable actions, then the `push` trigger can easily not run. - This is a social problem. Once a user interacts with an upstream, they can be encouraged to enable workflows in their fork. @@ -25,4 +25,7 @@ I think `schedule` can be suppressed by adding an `only.txt` file to a target br If I retain `schedule`, I probably need to introduce a way to define branches to check/ignore. -I expect that before a 1.0.0 release I will remove support for `schedule`. I've resolved the interaction between `push` and `pull_request_target` using [[Suppress push for open pull request|Configuration#suppress_push_for_open_pull_request]]. +I expect that before a 1.0.0 release I will remove support for `schedule`. I've resolved the interaction between `push` and `pull_request_target` using [Suppress push for open pull request](Configuration.md#suppress-push-for-open-pull-request). + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git "a/Feature:-Managed-To\342\200\220Do-list.md" "b/Feature:-Managed-To\342\200\220Do-list.md" index fff4654..9342df2 100644 --- "a/Feature:-Managed-To\342\200\220Do-list.md" +++ "b/Feature:-Managed-To\342\200\220Do-list.md" @@ -3,3 +3,6 @@ ## See Also - [rubocop](https://docs.rubocop.org/rubocop/): [automatically-generated-configuration](https://docs.rubocop.org/rubocop/configuration.html#automatically-generated-configuration) + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Matrix-support.md b/Feature:-Matrix-support.md index bacd39e..9723df3 100644 --- a/Feature:-Matrix-support.md +++ b/Feature:-Matrix-support.md @@ -19,7 +19,7 @@ You almost certainly want `fail-fast: false`, otherwise the first matrix branch ```yaml with: - report_title_suffix: (${{matrix.category}}) + report_title_suffix: (${% raw %}{{{% endraw %}matrix.category}}) ``` ## Example @@ -38,32 +38,35 @@ jobs: fail-fast: false matrix: category: ["other", "runtime", "test"] - name: Spell checking (${{matrix.category}}) + name: Spell checking (${% raw %}{{{% endraw %}matrix.category}}) steps: - name: checkout-merge if: "contains(github.event_name, 'pull_request')" uses: actions/checkout@v2.0.0 with: - ref: refs/pull/${{github.event.pull_request.number}}/merge + ref: refs/pull/${% raw %}{{{% endraw %}github.event.pull_request.number}}/merge - name: checkout - if: ${{ github.event_name == 'push' || + if: ${% raw %}{{{% endraw %} github.event_name == 'push' || (contains(github.event.comment.body, '@check-spelling-bot apply') && contains(github.event.comment.body, matrix.category) ) }} uses: actions/checkout@v2.0.0 - uses: check-spelling/check-spelling@prerelease id: spelling - if: ${{ github.event_name != 'issue_comment' || + if: ${% raw %}{{{% endraw %} github.event_name != 'issue_comment' || (contains(github.event.comment.body, '@check-spelling-bot apply') && contains(github.event.comment.body, matrix.category) ) }} with: - config: .github/actions/spelling-${{matrix.category}} + config: .github/actions/spelling-${% raw %}{{{% endraw %}matrix.category}} experimental_apply_changes_via_bot: 1 suppress_push_for_open_pull_request: 1 - report_title_suffix: (${{matrix.category}}) + report_title_suffix: (${% raw %}{{{% endraw %}matrix.category}}) ``` ### See also -- [[Configuration: Multiple programming languages]] +- [Configuration: Multiple programming languages](./Configuration:-Multiple-programming-languages.md) + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Minified-file-detection.md b/Feature:-Minified-file-detection.md index 2de55f2..2d3a628 100644 --- a/Feature:-Minified-file-detection.md +++ b/Feature:-Minified-file-detection.md @@ -13,3 +13,6 @@ https://github.com/check-spelling/check-spelling/issues/53 ### opt out To disable, add `minified-file` to `disable_checks`, and please file a bug with a sample where you think it makes sense to check the file. + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Non-English-languages.md b/Feature:-Non-English-languages.md index c0c4adc..068591b 100644 --- a/Feature:-Non-English-languages.md +++ b/Feature:-Non-English-languages.md @@ -10,7 +10,7 @@ For everything else, if it works on something, it's probably just the English pr At some point in the distant future, I can try to figure out how to refactor things to deal w/ character sets and things (I suspect I'll require all content to be in Unicode, since I really don't want to have to deal with encodings, and Unicode still gives me enough headaches with UTF-8/UTF-16/UCS-2/UTF-32/UCS-4, endianness, and normalization). -- See [[Feature: Character Encoding Auto Detection]] for some thoughts. +- See [Feature: Character Encoding Auto Detection](./Feature:-Character-Encoding-Auto-Detection.md) for some thoughts. The simplification makes the code much easier to work with and lets me work on things a piece at a time. Any character roughly not in that set is effectively equivalent to a ` ` by the time the spell checker starts looking for words. @@ -27,7 +27,7 @@ I think the following (untested) `patterns.txt` entry should work: I'd love to hear if it does. Note that it will prevent the auto-detection in 0.0.18-alpha from working, but that's not a big deal. -If it does, I'll probably add it to sample patterns, and add it commented out to spell-check-this. -- It conflicts w/ [[auto-detecting files to skip|Feature: Autodetect noisy files]], so I wouldn't want it on by default. +If it does, I'll probably add it to sample patterns, and add it commented out to spell-check-this. -- It conflicts w/ [auto-detecting files to skip](./Feature:-Autodetect-noisy-files.md), so I wouldn't want it on by default. ## Unicode @@ -63,5 +63,8 @@ while (<>) { ### See also -- [[Character Encoding Auto Detection|Feature: Character Encoding Auto Detection]] -- [[Configurable word characters|Feature: Configurable word characters]] +- [Character Encoding Auto Detection](./Feature:-Character-Encoding-Auto-Detection.md) +- [Configurable word characters](./Feature:-Configurable-word-characters.md) + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Only-changes.md b/Feature:-Only-changes.md index 573cf3d..4d18dab 100644 --- a/Feature:-Only-changes.md +++ b/Feature:-Only-changes.md @@ -24,7 +24,7 @@ There are two modes: ### Incompatible with -- [[Concurrency|Feature: Concurrency]] -> `cancel-in-progress` +- [Concurrency](./Feature:-Concurrency.md) -> `cancel-in-progress` ## Future Work @@ -33,3 +33,6 @@ There are two modes: It could look at the _removed_ side of diffs and use that to keep a list of items from `expect` -- anything that it doesn't find in the _added_ side could be treated as suspect. It could then do one round of checking the unchecked files (or all files if the initial check pass is only on the _added_ line hunks and not the entirety of the changed files) for just the that subset of `expect`. I think that should be faster than the full parse path, but I'd definitely make it an optional thing, and I'd probably implement it later. + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Only-check-changed-hunks.md b/Feature:-Only-check-changed-hunks.md index 3608ad0..47fdeee 100644 --- a/Feature:-Only-check-changed-hunks.md +++ b/Feature:-Only-check-changed-hunks.md @@ -4,10 +4,13 @@ Some workflows would like to be able to only send feedback to contributors about ## Background -As of [v0.0.21](https://github.com/check-spelling/check-spelling/releases/tag/v0.0.21), you can use [`only_check_changed_files: true`](https://github.com/check-spelling/check-spelling/wiki/Configuration#only_check_changed_files) to limit spell checking to changed files. +As of [v0.0.21](https://github.com/check-spelling/check-spelling/releases/tag/v0.0.21), you can use [`only_check_changed_files: true`](Configuration.md#only-check-changed-files) to limit spell checking to changed files. ## Implementation It should be fairly easy to use the equivalent of `git blame BASE..HEAD -- file` to identify which line numbers should be checked and only check them. (It's possible the implementation will use porcelain output as opposed to actually using the naive `git blame BASE..HEAD`, but that's a minor implementation detail.) + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Other-shells.md b/Feature:-Other-shells.md index 8a50640..90c38d6 100644 --- a/Feature:-Other-shells.md +++ b/Feature:-Other-shells.md @@ -9,3 +9,6 @@ Released in [0.0.16-alpha](https://github.com/check-spelling/check-spelling/rele ⚠️ I don't actively test support for non-posix shells, so this probably will break periodically. I'm still thinking through the best approach for this. One is to offer a client that's responsible for consuming this output, another is relying on talk-to-the-bot. At some point, I might add a test-suite to make sure this feature doesn't break, but it isn't high on my todo list. + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Pantsbuild-plugin.md b/Feature:-Pantsbuild-plugin.md index 670c98d..b4dfa53 100644 --- a/Feature:-Pantsbuild-plugin.md +++ b/Feature:-Pantsbuild-plugin.md @@ -5,3 +5,6 @@ It would be nice if I could offer check-spelling. No ETA, but this is dependent on new documentation for Pants v2 plugins... + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Parallel-dictionary-retrieval.md b/Feature:-Parallel-dictionary-retrieval.md index 35ec7ca..81ac85c 100644 --- a/Feature:-Parallel-dictionary-retrieval.md +++ b/Feature:-Parallel-dictionary-retrieval.md @@ -3,3 +3,6 @@ There are dozens of dictionaries, and while they're relatively small, performing sequential network i/o for all of them isn't particularly cheap. In parallel, they getting all of them should cost <8s. + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Parsing-Timeouts.md b/Feature:-Parsing-Timeouts.md index 33aa31b..5a63633 100644 --- a/Feature:-Parsing-Timeouts.md +++ b/Feature:-Parsing-Timeouts.md @@ -28,3 +28,6 @@ env: ``` ... to provide a splitter_timeout. The default is `30` (seconds) per file. + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Perl-module-testing.md b/Feature:-Perl-module-testing.md index a3d0075..093f9f5 100644 --- a/Feature:-Perl-module-testing.md +++ b/Feature:-Perl-module-testing.md @@ -23,3 +23,6 @@ It also provides a roadmap for more test coverage. ## Future steps I might try [Devel::Cover](https://metacpan.org/pod/Devel::Cover) + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Reject-patterns.md b/Feature:-Reject-patterns.md index f54ae59..a55a463 100644 --- a/Feature:-Reject-patterns.md +++ b/Feature:-Reject-patterns.md @@ -1,3 +1,6 @@ # Reject specific patterns -See [[Forbidden patterns|Feature: Forbidden patterns]]. +See [Forbidden patterns](./Feature:-Forbidden-patterns.md). + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Report-associated-comment-for-forbidden-patterns.md b/Feature:-Report-associated-comment-for-forbidden-patterns.md index 1623dfe..f7a17af 100644 --- a/Feature:-Report-associated-comment-for-forbidden-patterns.md +++ b/Feature:-Report-associated-comment-for-forbidden-patterns.md @@ -4,7 +4,7 @@ Currently, forbidden patterns just report the line / match with a forbidden patt ## Related features -For [[Feature: Suggest patterns]] (which was implemented after [[Feature: Forbidden patterns]]), if there's a comment preceding a pattern, the output includes the comment. +For [Feature: Suggest patterns](./Feature:-Suggest-patterns.md) (which was implemented after [Feature: Forbidden patterns](./Feature:-Forbidden-patterns.md)), if there's a comment preceding a pattern, the output includes the comment. ## Proposal @@ -13,3 +13,6 @@ It seems like it'd be valuable to try to offer the same sort of output for forbi Note that the features aren't quite the same in that pattern suggestions are lumped together in a single blob in a report, whereas, in general, forbidden patterns are reported on a per-file-per-line bases and _generally_ only support a single line of output. I think that I'll implement this by adding a section to the report containing each of the tripped forbidden patterns and their comments. + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Restricted-Permissions.md b/Feature:-Restricted-Permissions.md index d298464..8c8534c 100644 --- a/Feature:-Restricted-Permissions.md +++ b/Feature:-Restricted-Permissions.md @@ -27,4 +27,7 @@ It's better from a security perspective to use "least privilege". ## Workflow -- https://github.com/check-spelling/spell-check-this/blob/main/.github/workflows/spelling.yml defines a workflow that is compatible with these requirements +- https://raw.githubusercontent.com/check-spelling/spell-check-this/main/.github/workflows/spelling.yml defines a workflow that is compatible with these requirements + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Reusable-Workflows.md b/Feature:-Reusable-Workflows.md index 0ef1025..24fe0c6 100644 --- a/Feature:-Reusable-Workflows.md +++ b/Feature:-Reusable-Workflows.md @@ -9,3 +9,6 @@ I looked into this in the summer of 2022 and found it didn't really reduce the s That said. It _sounds_ appealing and there's definitely interest. I'm hoping to work w/ a couple of people who are trying to make it work and we'll see if we can put something together before summer 2023 (hopefully sooner, but...). + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Run-in-GitLab.md b/Feature:-Run-in-GitLab.md index d06fedb..f2c0e4a 100644 --- a/Feature:-Run-in-GitLab.md +++ b/Feature:-Run-in-GitLab.md @@ -11,3 +11,6 @@ https://gitlab.com/yaook/meta/-/jobs/3267487105 It's unclear why. I think this was a regression in nektos/act that was fixed in https://github.com/nektos/act/pull/1493 + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Run-in-Gitea.md b/Feature:-Run-in-Gitea.md index b9fff39..e377769 100644 --- a/Feature:-Run-in-Gitea.md +++ b/Feature:-Run-in-Gitea.md @@ -3,3 +3,6 @@ Gitea announced [feature preview GitHub Actions](https://blog.gitea.io/2022/12/feature-preview-gitea-actions/) I'd like to test it and confirm it works... + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Run-locally.md b/Feature:-Run-locally.md index 36e6f5a..2547d59 100644 --- a/Feature:-Run-locally.md +++ b/Feature:-Run-locally.md @@ -3,8 +3,8 @@ Possible approaches: - [Act](#act) -- [Single script](#Single-script) -- [Docker image](#Docker-image) +- [Single script](#single-script) +- [Docker image](#docker-image) ## Act @@ -134,3 +134,6 @@ I investigated using Docker directly and did in the initial versions. Support was removed in an [v0.0.20](https://github.com/check-spelling/check-spelling/releases/tag/v0.0.20). If you want to use check-spelling in Docker, please consider using `act` which wraps Docker... + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Sarif-output.md b/Feature:-Sarif-output.md index fab2077..57ff25e 100644 --- a/Feature:-Sarif-output.md +++ b/Feature:-Sarif-output.md @@ -8,7 +8,7 @@ When data is published to GitHub in this format, GitHub is supposed to automatic Release | Features -|- -[v0.0.21](https://github.com/check-spelling/check-spelling/releases/tag/v0.0.21) | [Initial support](#Enabling) +[v0.0.21](https://github.com/check-spelling/check-spelling/releases/tag/v0.0.21) | [Initial support](#enabling) [v0.0.22](https://github.com/check-spelling/check-spelling/releases/tag/v0.0.22) | [Adjusting sarif.json](#adjusting-sarifjson) ## Enabling @@ -63,9 +63,18 @@ https://github.com/check-spelling/check-spelling/issues/43 ## Implementation plan -- [x] Generate Sarif json -- [x] Support uploading it using [github/codeql-action/upload-sarif@releases/v2](https://github.com/github/codeql-action/tree/releases/v2/upload-sarif) -- [x] Decide on how to opt-in/opt-out of using this format -- currently `use_sarif: 1` -- [x] Test in the check-spelling org -- in progress -- [x] Trial it in other repositories -- [ ] Iterate +☑ Generate Sarif json + +☑ Support uploading it using [github/codeql-action/upload-sarif@releases/v2](https://github.com/github/codeql-action/tree/releases/v2/upload-sarif) + +☑ Decide on how to opt-in/opt-out of using this format -- currently `use_sarif: 1` + +☑ Test in the check-spelling org -- in progress + +☑ Trial it in other repositories + +☐ Iterate + + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Scan-noisy-files.md b/Feature:-Scan-noisy-files.md index dd4eaea..67ff9da 100644 --- a/Feature:-Scan-noisy-files.md +++ b/Feature:-Scan-noisy-files.md @@ -2,7 +2,7 @@ Sometimes you may want to scan a file even if it has more unrecognized words than recognized words. -By default, the [[Autodetect noisy files|Feature: Autodetect noisy files]] feature would talk about these files, +By default, the [Autodetect noisy files](./Feature:-Autodetect-noisy-files.md) feature would talk about these files, and suggest adding them to `excludes.txt`. If, you need these files to be checked, you can add: @@ -17,3 +17,6 @@ to your configuration. ## Sample consumers [cspell compact-dictionaries workflow](https://github.com/check-spelling/cspell-dicts/commit/2a5b8bb057f4580749933060b29c466e92c93400#diff-f38bd48888fa3290eb90897dc1e21411b2bcf12a6538cd72bb583e7608787698R88) + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Security-Polling.md b/Feature:-Security-Polling.md index 963108f..11b0f51 100644 --- a/Feature:-Security-Polling.md +++ b/Feature:-Security-Polling.md @@ -28,3 +28,6 @@ If there's a reported security advisory, you should read it and take a recommend Do this at your own risk. Ideally, you should upgrade to a fixed version. + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Smarter-scheduling-2021-October.md b/Feature:-Smarter-scheduling-2021-October.md index 245467d..ea22ee5 100644 --- a/Feature:-Smarter-scheduling-2021-October.md +++ b/Feature:-Smarter-scheduling-2021-October.md @@ -20,6 +20,9 @@ Instead of checking 8 files at a time, I'm splitting the work into approximately ## Future work -I've been toying with sorting the check list to put the largest files first. [[Configurable file size limits|Feature: Configurable file size limits]] means that the meta analyzer potentially has access to this information before it starts assigning files to workers. +I've been toying with sorting the check list to put the largest files first. [Configurable file size limits](./Feature:-Configurable-file-size-limits.md) means that the meta analyzer potentially has access to this information before it starts assigning files to workers. In theory this could reduce the likelihood that the last worker will be stuck working on a really large file. + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Spelling-comments-without-config.md b/Feature:-Spelling-comments-without-config.md index 4b81605..d55e47d 100644 --- a/Feature:-Spelling-comments-without-config.md +++ b/Feature:-Spelling-comments-without-config.md @@ -2,7 +2,7 @@ ## Past -Through [[0.0.16-alpha|https://github.com/check-spelling/check-spelling/releases/tag/0.0.16-alpha]], if you didn't create an `expect` file, the output listing unrecognized words (and the command to create the `expect` file) was only available in the Action run logs. +Through [0.0.16-alpha](https://github.com/check-spelling/check-spelling/releases/tag/0.0.16-alpha), if you didn't create an `expect` file, the output listing unrecognized words (and the command to create the `expect` file) was only available in the Action run logs. I had a model of assuming people would want to review things and use the output before merging somewhere. @@ -21,3 +21,6 @@ In those cases, one will probably want to write some `exclude` entries (or `only This change shouldn't impact existing users as they're already set up with an `expect` file. It should only impact the onboarding process hopefully making it smoother. + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Step-Summary.md b/Feature:-Step-Summary.md index c7b2ad0..8a242ee 100644 --- a/Feature:-Step-Summary.md +++ b/Feature:-Step-Summary.md @@ -16,8 +16,11 @@ Because I didn't see `summary_raw`, the integration for check-spelling involves Roughly, the output is the same as the comment output. Unlike comments, it doesn't enforce the 64k limit. I'm not currently enforcing a 1mb limit, so if you manage to generate >1mb, the summary will fail -- if you run into this, please file a bug, I'd like to think about what to do when this happens instead of just writing something up. -See [[Behavior change: Job Summaries]]. +See [Behavior change: Job Summaries](./Behavior-change:-Job-Summaries.md). ## Possible changes I _might_ add support for retrieving the data from `summary_raw` instead. But, I don't know that I will. + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Subrepos.md b/Feature:-Subrepos.md index 82d3769..a868fdc 100644 --- a/Feature:-Subrepos.md +++ b/Feature:-Subrepos.md @@ -19,3 +19,6 @@ Caveats aside, a naive implementation that ignores all the likely problems and a If you need something before this feature is implemented, you can basically remove the `.git` directory, do a `git init`, a `git add .`, and a `git commit` before check-spelling runs. See https://github.com/Lombiq/GitHub-Actions/blob/50a53552bd3e62309cf44ce962fe0fd41abe28ba/.github/workflows/spelling.yml#L70-L79 + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Suggest-Area-Dictionaries.md b/Feature:-Suggest-Area-Dictionaries.md index 6832dd5..2ea89be 100644 --- a/Feature:-Suggest-Area-Dictionaries.md +++ b/Feature:-Suggest-Area-Dictionaries.md @@ -3,7 +3,7 @@ Included in [v0.0.20](https://github.com/check-spelling/check-spelling/releases/tag/v0.0.20) To make the out-of-the-box flow better, it'd be helpful if the tool -automatically suggested [[Area Dictionaries|Feature: Area Dictionaries]] to enable. +automatically suggested [Area Dictionaries](./Feature:-Area-Dictionaries.md) to enable. As the work to parallelize the spell checker yields lists of unknown words, it's possible to check a number of potential supplemental dictionaries against @@ -52,3 +52,6 @@ You might wonder "why did the spell checker suggest lua?", the answer is that [L ## Future work I intend to work through at least the cpp dictionary to weed out some portion of the misspelled words. Sadly, the dictionary has >100k entries, and thus it is a fairly daunting task. + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Suggest-commit-after-expect-update.md b/Feature:-Suggest-commit-after-expect-update.md index c75698e..ab9b3ef 100644 --- a/Feature:-Suggest-commit-after-expect-update.md +++ b/Feature:-Suggest-commit-after-expect-update.md @@ -6,7 +6,7 @@ Included in [v0.0.20](https://github.com/check-spelling/check-spelling/releases/ 1. User creates a PR. 2. This triggers a workflow which could add a ❌ status. -3. User uses [[Update expect list|Feature: Update expect list]] which triggers an additional commit. +3. User uses [Update expect list](./Feature:-Update-expect-list.md) which triggers an additional commit. 4. This doesn't trigger a new workflow run because [GitHub doesn't want to risk triggering a loop](https://docs.github.com/en/actions/reference/authentication-in-a-workflow#using-the-github_token-in-a-workflow). Thus, at this point it's likely that spell check would pass "now", but doesn't currently have a ✅ status. @@ -24,3 +24,6 @@ Users can just edit the `expect` file and add a blank line. ## Plan The action will add a comment suggesting adding that blank line to trigger a new check pass (until a better approach is added). + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Suggest-corrections.md b/Feature:-Suggest-corrections.md index 222e65f..a1fdc97 100644 --- a/Feature:-Suggest-corrections.md +++ b/Feature:-Suggest-corrections.md @@ -1,8 +1,11 @@ # Suggest corrections -While [[Correct misspelled words within GitHub|Feature: Correct misspelling]] would let people fix things, it'd also be nice to at least have the tool make those suggestions (and those might be slightly separate tasks). +While [Correct misspelled words within GitHub](./Feature:-Correct-misspelling.md) would let people fix things, it'd also be nice to at least have the tool make those suggestions (and those might be slightly separate tasks). -My tentative idea for this is to rely on https://github.com/laurikari/tre's aspell tool and suggest the one best match if such a thing exists. I've done some [[back of the napkin|Notes on suggested replacements]] work on this. +My tentative idea for this is to rely on https://github.com/laurikari/tre's aspell tool and suggest the one best match if such a thing exists. I've done some [back of the napkin](Notes-on-suggested-replacements.md) work on this. In the interim, I've shared a [Google Sheet](https://docs.google.com/spreadsheets/d/1ehtjuiKF5mHUq_eVuz3lYB2Ui7XztEFBgnNjOmb9R20/edit) that I use that works pretty well. + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Suggest-dictionaries-when-dictionaries-aren't-available.md b/Feature:-Suggest-dictionaries-when-dictionaries-aren't-available.md index e108a08..5fb07c1 100644 --- a/Feature:-Suggest-dictionaries-when-dictionaries-aren't-available.md +++ b/Feature:-Suggest-dictionaries-when-dictionaries-aren't-available.md @@ -17,3 +17,6 @@ It's possible for check-spelling to reset its `cspell` alias, its `extra_diction Instead of discarding all dictionaries, it can use a file to report the original names of all the dictionaries it couldn't resolve. That'll make it possible to retain the resolved dictionaries, clean up the code a bit, and get to the next part. When it's done, it can suggest removing the unavailable dictionaries and users can select from the suggested dictionaries. + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Suggest-patterns.md b/Feature:-Suggest-patterns.md index 5439519..1ca02e4 100644 --- a/Feature:-Suggest-patterns.md +++ b/Feature:-Suggest-patterns.md @@ -29,7 +29,7 @@ After finding a word, in order to report the word's position in the unmasked lin If a pattern is bad, it could introduce unrecognized words that aren't naturally present. - Suggestions should be curated, so this shouldn't be a real problem. -This turned out to be a bit of a problem which is partially addressed in [v0.0.22](https://github.com/check-spelling/check-spelling/releases/tag/v0.0.22) with the introduction of [`token-is-substring`](https://github.com/check-spelling/check-spelling/wiki/Event-descriptions#token-is-substring). +This turned out to be a bit of a problem which is partially addressed in [v0.0.22](https://github.com/check-spelling/check-spelling/releases/tag/v0.0.22) with the introduction of [`token-is-substring`](Event-descriptions.md#token-is-substring). ## Poor patterns @@ -96,3 +96,6 @@ The above would trigger this erroneous suggestion: ### [v0.0.22](https://github.com/check-spelling/check-spelling/releases/tag/v0.0.22) The way pattern suggestions are calculated has been improved such that these erroneous suggestions should not happen. + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Summary-Table.md b/Feature:-Summary-Table.md index f440008..ba94952 100644 --- a/Feature:-Summary-Table.md +++ b/Feature:-Summary-Table.md @@ -1,14 +1,14 @@ # Summary Table -Include a section in the [[Step Summary|Feature: Step Summary]] with links to individual lines for report items similar to the links that would be available from [[Sarif output|Feature: Sarif output]]. +Include a section in the [Step Summary](./Feature:-Step-Summary.md) with links to individual lines for report items similar to the links that would be available from [Sarif output](./Feature:-Sarif-output.md). ## Background -The [[Sarif output|Feature: Sarif output]] feature generally only works for repository members, so, while it's quite fancy, it's problematic for open source repositories. +The [Sarif output](./Feature:-Sarif-output.md) feature generally only works for repository members, so, while it's quite fancy, it's problematic for open source repositories. ## Implementation -Where possible, each [[Event category|Event descriptions]] reported by check-spelling will be given its own expandable section with a table containing a row per entry with a link to the relevant line. +Where possible, each [Event category](Event-descriptions.md) reported by check-spelling will be given its own expandable section with a table containing a row per entry with a link to the relevant line. ## Considerations @@ -25,3 +25,6 @@ Artifacts | ? When check-spelling creates comments, it has an algorithm for trimming sections to avoid running afoul of the 64 kb limit. The Step Summary feature has some basic code to avoid tripping on the 1 mb limit. In testing, that limit has been hit. In order to avoid losing the entire Step Summary when this feature is enabled, sections will be omitted if they would push the report over the size limit. + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Support-for-non-English-languages.md b/Feature:-Support-for-non-English-languages.md index 576a22d..95ede23 100644 --- a/Feature:-Support-for-non-English-languages.md +++ b/Feature:-Support-for-non-English-languages.md @@ -6,7 +6,7 @@ Previously, you could add dictionaries from other languages, but unless all the ## Implementation details -By adding [[Configurable word characters|Feature: Configurable word characters]], check-spelling can be tuned to accept a different range of word characters, enabling it to check words with accent marks as well as, for example, words with Arabic or Cyrillic letters. +By adding [Configurable word characters](./Feature:-Configurable-word-characters.md), check-spelling can be tuned to accept a different range of word characters, enabling it to check words with accent marks as well as, for example, words with Arabic or Cyrillic letters. ## Available dictionaries @@ -61,3 +61,6 @@ You can pull in any of these hunspell dictionaries from [`cspell`](https://githu ``` When check-spelling sees an instruction to use `.dic` file, it will automatically retrieve the corresponding `.aff` file as well. + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Support-gitignore.md b/Feature:-Support-gitignore.md index 45c771b..0b8f809 100644 --- a/Feature:-Support-gitignore.md +++ b/Feature:-Support-gitignore.md @@ -15,3 +15,6 @@ If you have specific cases where you feel a need for this feature, please feel f # ETA None at this time. I'm still thinking it over. But it'll probably just happen one day. + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Support-pull_request_target.md b/Feature:-Support-pull_request_target.md index 7cee376..d17d1eb 100644 --- a/Feature:-Support-pull_request_target.md +++ b/Feature:-Support-pull_request_target.md @@ -28,7 +28,7 @@ on: ```yaml - uses: actions/checkout@v2 with: - ref: ${{ github.event.pull_request.head.sha }} + ref: ${% raw %}{{{% endraw %} github.event.pull_request.head.sha }} ``` ## Security considerations @@ -45,5 +45,8 @@ I don't believe that check-spelling is insecure (that's what everyone says, righ Released in [0.0.17-alpha](https://github.com/check-spelling/check-spelling/releases/tag/0.0.17-alpha). -[[Breaking change: Dropping support for on: schedule]] should occur after +[Breaking change: Dropping support for on: schedule](./Breaking-change:-Dropping-support-for-on:-schedule.md) should occur after [v0.0.22](https://github.com/check-spelling/check-spelling/releases/tag/v0.0.22). + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Suppress-PR-check-when-workflow-changes.md b/Feature:-Suppress-PR-check-when-workflow-changes.md index c0fa93c..5b4a941 100644 --- a/Feature:-Suppress-PR-check-when-workflow-changes.md +++ b/Feature:-Suppress-PR-check-when-workflow-changes.md @@ -2,16 +2,19 @@ ## Background -Normally in a repository, it makes sense to skip running CI on a push if there's an open PR for the same source branch (see [`suppress_push_for_open_pull_request`](https://github.com/check-spelling/check-spelling/wiki/Configuration#suppress_push_for_open_pull_request)) -- otherwise one can get two slightly conflicting reports and in general the reports from the PR side are more accurate wrt what a user should do. +Normally in a repository, it makes sense to skip running CI on a push if there's an open PR for the same source branch (see [`suppress_push_for_open_pull_request`](Configuration.md#suppress-push-for-open-pull-request)) -- otherwise one can get two slightly conflicting reports and in general the reports from the PR side are more accurate wrt what a user should do. If the workflow itself changes and the PR would rely on `pull_request_target`, then the validity of the PR check is void. ## Simple workaround -Using `suppress_push_for_open_pull_request: ${{ github.actor != 'dependabot[bot]' && 1 }}` as in https://github.com/check-spelling/spell-check-this/commit/f9705e2732464173a9bbf92dadd978c75460c41a will result in new branches created by dependabot being checked which is a good start. +Using `suppress_push_for_open_pull_request: ${% raw %}{{{% endraw %} github.actor != 'dependabot[bot]' && 1 }}` as in https://github.com/check-spelling/spell-check-this/commit/f9705e2732464173a9bbf92dadd978c75460c41a will result in new branches created by dependabot being checked which is a good start. A smarter implementation would be for the engine itself to check to see if the workflow file has changed in the `push` handler and then ignore `suppress_push_for_open_pull_request`. ## See Also -Note that the above doesn't actually solve problems for PRs from forks, that will need to be addressed by [[Tolerate engine upgrades|Feature: Tolerate engine upgrades]] +Note that the above doesn't actually solve problems for PRs from forks, that will need to be addressed by [Tolerate engine upgrades](./Feature:-Tolerate-engine-upgrades.md) + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Suppress-comments.md b/Feature:-Suppress-comments.md index 93519f9..74419e3 100644 --- a/Feature:-Suppress-comments.md +++ b/Feature:-Suppress-comments.md @@ -23,10 +23,13 @@ The logs would still have the reporting. ## Comment after the fact -An artifact can be generated containing enough information to produce a comment. As of [v0.0.20](https://github.com/check-spelling/check-spelling/releases/tag/v0.0.20), the [recommended workflow](https://github.com/check-spelling/spell-check-this/blob/main/.github/workflows/spelling.yml) uses this artifact to produce a comment. +An artifact can be generated containing enough information to produce a comment. As of [v0.0.20](https://github.com/check-spelling/check-spelling/releases/tag/v0.0.20), the [recommended workflow](https://raw.githubusercontent.com/check-spelling/spell-check-this/main/.github/workflows/spelling.yml) uses this artifact to produce a comment. It would be possible to generate a compatible artifact and then comment after the fact... I could probably also once I turn on talk-to-bot include an option for `@check-spelling-bot report` or similar to have the bot post the comment. Or possibly even `@check-spelling-bot report REFERENCE` if the bot persists enough to be able to regenerate the comment w/o doing the work (this is something I'm close to doing for other stuff). It's unlikely that I'll do this, as I'm more likely to work on GITHUB_STEP_SUMMARY support. + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Suppress-push-comment-for-open-PRs.md b/Feature:-Suppress-push-comment-for-open-PRs.md index 5b092e0..849fa9e 100644 --- a/Feature:-Suppress-push-comment-for-open-PRs.md +++ b/Feature:-Suppress-push-comment-for-open-PRs.md @@ -27,3 +27,6 @@ As this is a new feature, and it's possible it has bugs, it is currently opt-in. with: suppress_push_for_open_pull_request: 1 ``` + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Timing-Report.md b/Feature:-Timing-Report.md index e6b2c51..16e78a8 100644 --- a/Feature:-Timing-Report.md +++ b/Feature:-Timing-Report.md @@ -7,3 +7,6 @@ ``` Expected release: [v0.0.22](https://github.com/check-spelling/check-spelling/releases/tag/v0.0.22) + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Tolerate-engine-upgrades.md b/Feature:-Tolerate-engine-upgrades.md index 65caf68..f38f3dc 100644 --- a/Feature:-Tolerate-engine-upgrades.md +++ b/Feature:-Tolerate-engine-upgrades.md @@ -23,4 +23,7 @@ New environment variables from the new `action.yml` file won't be available and ## See Also -[[Suppress PR check when workflow changes|Feature: Suppress PR check when workflow changes]] +[Suppress PR check when workflow changes](./Feature:-Suppress-PR-check-when-workflow-changes.md) + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Treat-specific-errors-as-warnings.md b/Feature:-Treat-specific-errors-as-warnings.md index 3721897..7cb1f04 100644 --- a/Feature:-Treat-specific-errors-as-warnings.md +++ b/Feature:-Treat-specific-errors-as-warnings.md @@ -9,10 +9,10 @@ It's understood that not every user will agree with which items should be errors ## Implementation As of [v0.0.20](https://github.com/check-spelling/check-spelling/releases/tag/v0.0.20), -you can specify which [[events|Event descriptions]] should be treated as warnings using the `warnings` parameter. +you can specify which [events](Event-descriptions.md) should be treated as warnings using the `warnings` parameter. As of [v0.0.21](https://github.com/check-spelling/check-spelling/releases/tag/v0.0.21), -you can specify which [[events|Event descriptions]] should be treated as notices using the `notices` parameter. +you can specify which [events](Event-descriptions.md) should be treated as notices using the `notices` parameter. ## Default settings @@ -34,3 +34,6 @@ If you wanted to treat `unrecognized-spelling` as a warning and `deprecated-feat with: warnings: unrecognized-spelling,bad-regex,binary-file,large-file,limited-references,no-newline-at-eof,noisy-file,non-alpha-in-dictionary,unexpected-line-ending,whitespace-in-dictionary,minified-file,unsupported-configuration ``` + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Update-base-branch.md b/Feature:-Update-base-branch.md index be552a0..a9624b1 100644 --- a/Feature:-Update-base-branch.md +++ b/Feature:-Update-base-branch.md @@ -23,3 +23,6 @@ An alternative workflow is (check-spelling is not integrated into the base repo) 1. Teach classic to recognize the case (as talk-to-the-bot already does) and have it suggest patches to BASE instead of HEAD 2. Teach talk-to-the-bot how to update HEAD instead of BASE -- this requires considering the permissions model a lot more. It might also involve a different set of commands, since the default is to both Add and Remove items from `expect.txt`. I'd be tempted to have it default to only adding, and require a fancier command for removal. A lot of work is required here. + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Update-expect-command-line.md b/Feature:-Update-expect-command-line.md index 0638396..f424bcf 100644 --- a/Feature:-Update-expect-command-line.md +++ b/Feature:-Update-expect-command-line.md @@ -13,17 +13,26 @@ A lot of users were hoping for a stable script one could get from the check-spel ## Goals -- [x] Support URLs pointing to Markdown flavored comments -- [x] Support URLs pointing to GitHub action check logs -- [x] Support simple lists of adds/removes -- [x] Support excludes -- [x] Support spell-check-this -- [x] Support private repositories (you can't use `curl` to retrieve content from these w/o a token, and I don't want to task users for a token) -- [x] Enable switching from using a `comment` to using `github_step_summary` +☑ Support URLs pointing to Markdown flavored comments -- [x] Switch reported shell script / logged shell script to use this script instead +☑ Support URLs pointing to GitHub action check logs (requires [Log Check Run URL](./Todo:-Log-Check-Run-URL.md)) + +☑ Support simple lists of adds/removes + +☑ Support excludes + +☑ Support spell-check-this + +☑ Support private repositories (you can't use `curl` to retrieve content from these w/o a token, and I don't want to task users for a token) + +☑ Enable switching from using a `comment` to using `github_step_summary` + + +☑ Switch reported shell script / logged shell script to use this script instead + + +☑ Support running on Windows -- [x] Support running on Windows ## Design choices @@ -36,9 +45,14 @@ A lot of users were hoping for a stable script one could get from the check-spel ## Status -- [x] `main` generates something like `curl -L 'https://raw.githubusercontent.com/check-spelling/check-spelling/prerelease/apply.pl' | +☑ `main` generates something like `curl -L 'https://raw.githubusercontent.com/check-spelling/check-spelling/prerelease/apply.pl' | + perl - 'https://github.com/check-spelling/lit/actions/runs/3319354094/attempts/1'` -- [x] `main` talk-to-bot can handle such a url +☑ `main` talk-to-bot can handle such a url + - [x] `main` validates that the url corresponds to its PR - [x] `main` consumes the url (and handle errors) -- [x] `main` generates comments of this form +☑ `main` generates comments of this form + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Update-expect-list.md b/Feature:-Update-expect-list.md index 26cfade..3b7a9ea 100644 --- a/Feature:-Update-expect-list.md +++ b/Feature:-Update-expect-list.md @@ -27,7 +27,7 @@ This is implemented today in prerelease: ### Commit implementation 1. Retrieve the shell script from the comment, run its equivalent, git add -u, commit. -1. The command (which used to be **posix shell**) is now [[Perl|Feature: Other shells]] +1. The command (which used to be **posix shell**) is now [Perl](./Feature:-Other-shells.md) 1. With the command retrieved from the comment 1. Perform the command equivalent (the command is refactored so that the same code can be shared between the two code paths) 1. I don't intend to delete empty files, as they represent structure even if they're temporarily empty. @@ -61,15 +61,15 @@ One can push to GitHub using two mechanisms: Historically HTTPS tokens could have been a user's password, but support for that was [removed a while back](https://github.blog/2020-12-15-token-authentication-requirements-for-git-operations/). -HTTPS tokens can be a [personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) with various arbitrary permissions or the [`GITHUB_TOKEN`](#github_token). +HTTPS tokens can be a [personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) with various arbitrary permissions or the [`GITHUB_TOKEN`](#github-token). ##### `GITHUB_TOKEN` The [`GITHUB_TOKEN`](https://docs.github.com/en/actions/security-guides/automatic-token-authentication). can allow pushes, but when used, it [doesn't trigger other workflows](https://docs.github.com/en/actions/security-guides/automatic-token-authentication#using-the-github_token-in-a-workflow), which means it's problematic for automatic updates. -This mode will trigger a [[Disclaimer about missing status|Feature: Disclaimer about missing status]]. +This mode will trigger a [Disclaimer about missing status](./Feature:-Disclaimer-about-missing-status.md). -To enable a smoother approach, the repository can be configured to use a [[read-write deploy key|Feature:-Update-with-deploy-key]]. +To enable a smoother approach, the repository can be configured to use a [read-write deploy key](./Feature:-Update-with-deploy-key.md). #### SSH keys @@ -93,7 +93,7 @@ Essentially, this involves: - name: checkout uses: actions/checkout@v3 with: - ssh-key: "${{ secrets.CHECK_SPELLING }}" + ssh-key: "${% raw %}{{{% endraw %} secrets.CHECK_SPELLING }}" ``` ###### read-write deploy key limitations @@ -153,3 +153,6 @@ The best dummy change is a blank line in the expect file itself. It will have mi I see a lot of people running the commands blindly and missing the fact that there are real misspellings in the output. - Part of this is that they aren't used to looking at the output. + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Update-with-deploy-key.md b/Feature:-Update-with-deploy-key.md index 027a37d..c6e4941 100644 --- a/Feature:-Update-with-deploy-key.md +++ b/Feature:-Update-with-deploy-key.md @@ -47,19 +47,19 @@ rm -rf "$scratch" contents: write pull-requests: write runs-on: ubuntu-latest - if: ${{ + if: ${% raw %}{{{% endraw %} github.event_name == 'issue_comment' && github.event.issue.pull_request && contains(github.event.comment.body, '@check-spelling-bot apply') }} concurrency: - group: spelling-update-${{ github.event.issue.number }} + group: spelling-update-${% raw %}{{{% endraw %} github.event.issue.number }} cancel-in-progress: false steps: - name: checkout uses: actions/checkout@v2 + with: -+ ssh-key: "${{ secrets.CHECK_SPELLING }}" ++ ssh-key: "${% raw %}{{{% endraw %} secrets.CHECK_SPELLING }}" - name: check-spelling uses: check-spelling/check-spelling@main with: @@ -69,3 +69,6 @@ rm -rf "$scratch" ## Improvements in [v0.0.21](https://github.com/check-spelling/check-spelling/releases/tag/v0.0.21) The advice is now tailored to based on the workflow configuration. + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-User-visible-warning-codes.md b/Feature:-User-visible-warning-codes.md index 1df34cc..d3026c0 100644 --- a/Feature:-User-visible-warning-codes.md +++ b/Feature:-User-visible-warning-codes.md @@ -2,8 +2,11 @@ Through [0.0.19](https://github.com/check-spelling/check-spelling/releases/tag/0.0.19), while check-spelling had an internal warning code, GitHub didn't surface the code to end users. -There is a wiki page that describes the [[Warning descriptions]]. +There is a wiki page that describes the [Warning descriptions](Warning-descriptions.md). But, without the warning code, it's a bit hard to known how a given warning message maps to the table. As of [0.0.20 alpha 4](https://github.com/check-spelling/check-spelling/releases/tag/0.0.20-alpha4), the warning code is now included in the log as shown by GitHub in the pretty view (it was always present in the action log, but while it was tagged to GitHub, GitHub didn't do anything with that information). + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Versioned-dictionaries.md b/Feature:-Versioned-dictionaries.md index f671815..9bfa7dd 100644 --- a/Feature:-Versioned-dictionaries.md +++ b/Feature:-Versioned-dictionaries.md @@ -1,12 +1,15 @@ -Currently, by default check-spelling retrieves [https://github.com/check-spelling/check-spelling/blob/dictionary/dict.txt](https://github.com/check-spelling/check-spelling/blob/dictionary/dict.txt) and then consumers can replace (using `dictionary`) or augment (`allow`) / redact (`reject`) additional words. +Currently, by default check-spelling retrieves [https://raw.githubusercontent.com/check-spelling/check-spelling/dictionary/dict.txt](https://raw.githubusercontent.com/check-spelling/check-spelling/dictionary/dict.txt) and then consumers can replace (using `dictionary`) or augment (`allow`) / redact (`reject`) additional words. I plan to make to changes: 1. Only download the dictionary if users aren't supplying their own (using `dictionary`) 1. Give the dictionary a tag and have each release download a release pinned version -Going forward, this will enable me to update the dictionary by, e.g. removing [Archaic words](Archaic-words) or adding words that are commonly used by consumers. +Going forward, this will enable me to update the dictionary by, e.g. removing [Archaic words](Archaic-words.md) or adding words that are commonly used by consumers. When I make such updates, I'll be able to include the list of changes in the release notes 😄 🛠️ This is ready for release in 0.0.17-alpha + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Visual-Studio-Code-plugin.md b/Feature:-Visual-Studio-Code-plugin.md index 64de8dc..a6eeb0b 100644 --- a/Feature:-Visual-Studio-Code-plugin.md +++ b/Feature:-Visual-Studio-Code-plugin.md @@ -7,3 +7,6 @@ The biggest problem is dealing with how to package something written in Shell+Pe It's possible to only offer to work if `Perl`/`Docker` or an equivalent are present. I don't have any particular plans to implement this, but as I'm starting to use VSCode, it's something I'm thinking about. + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Warning-about-substring-matches.md b/Feature:-Warning-about-substring-matches.md index f9733f0..494bada 100644 --- a/Feature:-Warning-about-substring-matches.md +++ b/Feature:-Warning-about-substring-matches.md @@ -113,3 +113,6 @@ Here, adding some `\b`s will work magic: -[a-z,0-9]{12} +\b[a-z,0-9]{12}\b ``` + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Feature:-Workaround-broken-dependencies.md b/Feature:-Workaround-broken-dependencies.md index ccbd00c..e4145e8 100644 --- a/Feature:-Workaround-broken-dependencies.md +++ b/Feature:-Workaround-broken-dependencies.md @@ -33,3 +33,6 @@ triggered warnings between the release of [`v0.0.20`](https://github.com/check-s As of `v0.0.21`, there are no workarounds in active deployment. A future release may rely on this feature... + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git "a/Feature:-`base\342\200\220path`.md" "b/Feature:-`base\342\200\220path`.md" index ee483e5..86207be 100644 --- "a/Feature:-`base\342\200\220path`.md" +++ "b/Feature:-`base\342\200\220path`.md" @@ -7,3 +7,6 @@ Tentatively, all paths in `excludes` and `only` would be relative to `base-path` ## Requested https://github.com/ceph/ceph/pull/46824#issuecomment-1523640048 + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Helpful-scripts.md b/Helpful-scripts.md index 1ecc17f..03e875c 100644 --- a/Helpful-scripts.md +++ b/Helpful-scripts.md @@ -1,12 +1,15 @@ # Helpful scripts -- [[Warnings to line excerpts|Warnings to line excerpts]] -- [[Looking for items locally|Looking for items locally]] -- [[Use local check spelling|Use local check spelling]] -- [Update branch using deploy key](https://github.com/check-spelling/check-spelling/wiki/Feature:-Update-with-deploy-key#script) -- [[Rebasing spelling PRs|Rebasing spelling PRs]] -- [[Parallel check CI failures]] -- [[Script: Files to Excludes]] -- [[Script: Staging PRs]] -- [[What does each dictionary cover]] -- [[Miscellaneous commands]] +- [Warnings to line excerpts](Warnings-to-line-excerpts.md) +- [Looking for items locally](Looking-for-items-locally.md) +- [Use local check spelling](Use-local-check-spelling.md) +- [Update branch using deploy key](./Feature:-Update-with-deploy-key.md#script) +- [Rebasing spelling PRs](Rebasing-spelling-PRs.md) +- [Parallel check CI failures](Parallel-check-CI-failures.md) +- [Script: Files to Excludes](./Script:-Files-to-Excludes.md) +- [Script: Staging PRs](./Script:-Staging-PRs.md) +- [What does each dictionary cover](What-does-each-dictionary-cover.md) +- [Miscellaneous commands](Miscellaneous-commands.md) + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Known-Issues.md b/Known-Issues.md index c9aa4eb..d282aaf 100644 --- a/Known-Issues.md +++ b/Known-Issues.md @@ -1,12 +1,12 @@ # Known Issues - [Only changed doesn't work when PRs are initially created from forks](#only-changed-doesnt-work-when-prs-are-initially-created-from-forks) -- [Too many unrecognized words](#Too_many_unrecognized_words) +- [Too many unrecognized words](#too-many-unrecognized-words) - [@dependabot can't comment](#dependabot-cant-comment) ## Only changed doesn't work when PRs are initially created from forks -When using [`only_check_changed_files`](https://github.com/check-spelling/check-spelling/wiki/Configuration#only_check_changed_files) and a PR is _created_ from a **fork**, the initial check will probably not find files to check, producing a warning: +When using [`only_check_changed_files`](Configuration.md#only-check-changed-files) and a PR is _created_ from a **fork**, the initial check will probably not find files to check, producing a warning: > ⚠️ Was not provided any regular readable files @@ -43,7 +43,7 @@ Usually this happens when a bunch of binary files are added and are not in `excl ### Resolution -See [[Automatically truncate comment|Feature: Automatically truncate comment]] +See [Automatically truncate comment](./Feature:-Automatically-truncate-comment.md) 👷 Upgrade to [v0.0.20](https://github.com/check-spelling/check-spelling/releases/v0.0.20) (or newer) @@ -55,4 +55,7 @@ See [[Automatically truncate comment|Feature: Automatically truncate comment]] ### Resolution -See [[@dependabot]] +See [@dependabot](@dependabot.md) + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Looking-for-items-locally.md b/Looking-for-items-locally.md index 35051b8..d72aa21 100644 --- a/Looking-for-items-locally.md +++ b/Looking-for-items-locally.md @@ -128,3 +128,6 @@ search > .github/actions/spell*/expect.txt ```sh review .github/actions/spell*/expect.txt ``` + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Miscellaneous-commands.md b/Miscellaneous-commands.md index 794bd97..0f2033c 100644 --- a/Miscellaneous-commands.md +++ b/Miscellaneous-commands.md @@ -18,3 +18,6 @@ for a in $(git ls-remote $1|perl -pne 's/^\S*\s+/:/'); do git push $1 $a 2>/dev/ ```sh git remote add $ORG -t $BRANCH --no-tags $(git remote get-url origin |perl -pne 's{:.*/}{:'$ORG'/}') ``` + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Notes-on-suggested-replacements.md b/Notes-on-suggested-replacements.md index aab8eb1..fb92dbf 100644 --- a/Notes-on-suggested-replacements.md +++ b/Notes-on-suggested-replacements.md @@ -2,9 +2,9 @@ ## Simple script -- [Input description](#Input-description) -- [Observations](#Observations) -- [Command run](#Command-run) +- [Input description](#input-description) +- [Observations](#observations) +- [Command run](#command-run) ### Input description @@ -14,7 +14,7 @@ I haven't created a PR for the repository yet because the list was so large. ### Observations -This output is a good argument in favor of a smaller dictionary along with [[Area dictionaries|Feature: Area dictionaries]]. +This output is a good argument in favor of a smaller dictionary along with [Area dictionaries](./Feature:-Area-dictionaries.md). ### Command run @@ -952,3 +952,6 @@ ZDUMMY --> dummy zplan .> IPLAN PLAN plan ZRANK .> arank brank crank drank Frank frank grank prank Rank rank trank ``` + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Onboarding.md b/Onboarding.md index 0c10ffd..952dbab 100644 --- a/Onboarding.md +++ b/Onboarding.md @@ -1,11 +1,11 @@ # Onboarding -The easiest way to get started is by following the [[Quick Start]] instructions. +The easiest way to get started is by following the [Quick Start](Quick-Start.md) instructions. If you do this before people create forks of your repository, things should go fairly smoothly. As of v0.0.21 (but hopefully not the next release), if a user creates a branch from before check-spelling is added, -but creates a PR to the repository with check-spelling as configured by [spell-check-this in `.github/workflows/spelling.yml`](https://github.com/check-spelling/spell-check-this/blob/6b83ae39834cdf4e64ffff2b8693afe0536c5823/.github/workflows/spelling.yml), +but creates a PR to the repository with check-spelling as configured by [spell-check-this in `.github/workflows/spelling.yml`](https://raw.githubusercontent.com/check-spelling/spell-check-this/6b83ae39834cdf4e64ffff2b8693afe0536c5823/.github/workflows/spelling.yml), check-spelling will run but not find its configuration. Because it won't find its configuration, it will almost certainly get somewhat upset with users and lead them to be at least a little bit confused. @@ -31,3 +31,6 @@ Thus, if your repository is `octocat/Spoon-Knife` and you're adding check-spelli ``` The active assumption here is that any PRs to branches that are created after check-spelling is added to `octocat/Spoon-Knife@main` will be created based on commits that already include check-spelling, and thus the `spell_check_this` codepath won't be used. + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/PR-Template.md b/PR-Template.md index f633d86..4ad03ef 100644 --- a/PR-Template.md +++ b/PR-Template.md @@ -7,3 +7,6 @@ The misspellings have been reported at {link-to-comment} The action reports that the changes in this PR would make it happy: {link-to-passing-commit} Note: this PR does not include the action. If you're interested in running a spell check on every PR and push, that can be offered separately. + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Parallel-check-CI-failures.md b/Parallel-check-CI-failures.md index f695d43..9c2a942 100644 --- a/Parallel-check-CI-failures.md +++ b/Parallel-check-CI-failures.md @@ -38,3 +38,6 @@ If a branch fails, one can resample that set to find the problem. If a branch doesn't fail, one can exclude all of its commits and resample the remainder to find the problem. Since this generates 4 lists, one should be able to perform some intersections to get a fairly small list of potential culprits. + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Possible-features.md b/Possible-features.md index f1d3ead..f0063e1 100644 --- a/Possible-features.md +++ b/Possible-features.md @@ -6,46 +6,48 @@ ## In progress -- 👓 [[Suppress PR check when workflow changes|Feature: Suppress PR check when workflow changes]] -- 🧪 [[Regression testing]] -- 😄 [[Easier to understand filenames|Feature: Easier to understand filenames]] -- ↪️ [[Content Mappings|Feature: Content Mappings]] -- ⚙️ [[JSON configuration|Feature: JSON configuration]] -- 🔧 [[Replace jq|Task: Replace jq]] -- 🏦 [[Cache dictionaries|Feature: Cache dictionaries]] -- 💬 [[Report associated comment for forbidden patterns|Feature: Report associated comment for forbidden patterns]] -- 🧱 [[Block/Multiline Ignore|Feature: Block Ignore]] -- 🌉 [[IDE Integration|Feature: IDE Integration]] +- 👓 [Suppress PR check when workflow changes](./Feature:-Suppress-PR-check-when-workflow-changes.md) +- 🧪 [Regression testing](Regression-testing.md) +- 😄 [Easier to understand filenames](./Feature:-Easier-to-understand-filenames.md) +- ↪️ [Content Mappings](./Feature:-Content-Mappings.md) +- ⚙️ [JSON configuration](./Feature:-JSON-configuration.md) +- 🔧 [Replace jq](./Task:-Replace-jq.md) +- 🏦 [Cache dictionaries](./Feature:-Cache-dictionaries.md) +- 💬 [Report associated comment for forbidden patterns](./Feature:-Report-associated-comment-for-forbidden-patterns.md) +- 🙈 [Block Ignore](./Feature:-Block-Ignore.md) ## Near term -- [[🩸Breaking change: Dropping support for on: schedule|Breaking change: Dropping support for on: schedule]] -- [[👪Behavior change: case changes in expect|Behavior change: case changes in expect]] -- [[🗜️Breaking change: Smaller dictionary|Breaking change: Smaller dictionary]] -- [[🪆Subrepos|Feature: Subrepos]] -- [[🪜base‐path|Feature: \`base‐path\`]] -- [[🪄Honor gitattributes|Feature: Honor gitattributes]] -- [[🙈Support gitignore|Feature: Support gitignore]] -- [[↬Update base branch|Feature: Update base branch]] -- [[↕️Behavior change: Log output order|Behavior change: Log output order]] -- [[♻️Workflow: retest support|Workflow: retest support]] -- [[🏃Run in GitLab|Feature: Run in GitLab]] -- [[🏃Run in Gitea|Feature: Run in Gitea]] -- [[📄Reusable Workflows|Feature: Reusable Workflows]] -- [[😸Customer satisfaction survey|Feature: Customer satisfaction survey]] -- [[🍪Only check changed hunks|Feature: Only check changed hunks]] +- [🩸Breaking change: Dropping support for on: schedule](./Breaking-change:-Dropping-support-for-on:-schedule.md) +- [👪Behavior change: case changes in expect](./Behavior-change:-case-changes-in-expect.md) +- [🗜️Breaking change: Smaller dictionary](./Breaking-change:-Smaller-dictionary.md) +- [🪆Subrepos](./Feature:-Subrepos.md) +- [🪜base‐path](./Feature:-\`base‐path\`.md) +- [🪄Honor gitattributes](./Feature:-Honor-gitattributes.md) +- [🙈Support gitignore](./Feature:-Support-gitignore.md) +- [↬Update base branch](./Feature:-Update-base-branch.md) +- [↕️Behavior change: Log output order](./Behavior-change:-Log-output-order.md) +- [♻️Workflow: retest support](./Workflow:-retest-support.md) +- [🏃Run in GitLab](./Feature:-Run-in-GitLab.md) +- [🏃Run in Gitea](./Feature:-Run-in-Gitea.md) +- [📄Reusable Workflows](./Feature:-Reusable-Workflows.md) +- [😸Customer satisfaction survey](./Feature:-Customer-satisfaction-survey.md) +- [🍪Only check changed hunks](./Feature:-Only-check-changed-hunks.md) +- [🧱Block/Multiline Ignore](./Feature:-Block-Ignore.md) ## Distant future -- [[Tolerate engine upgrades|Feature: Tolerate engine upgrades]] -- [[Correct misspelled words within GitHub|Feature: Correct misspelling]] -- [[Learn from corrections|Feature: Learn from corrections]] -- [[Plug into Pantsbuild|Feature: Pantsbuild plugin]] -- [[Plug into Visual Studio Code|Feature: Visual Studio Code plugin]] -- [[Custom escape mappings|Feature: Custom escape mappings]] -- [Managed To‐Do list](https://github.com/check-spelling/check-spelling/wiki/Feature:-Managed-To%E2%80%90Do-list) +- [Tolerate engine upgrades](./Feature:-Tolerate-engine-upgrades.md) +- [Correct misspelled words within GitHub](./Feature:-Correct-misspelling.md) +- [Learn from corrections](./Feature:-Learn-from-corrections.md) +- [Plug into Pantsbuild](./Feature:-Pantsbuild-plugin.md) +- [Plug into Visual Studio Code](./Feature:-Visual-Studio-Code-plugin.md) +- [Custom escape mappings](./Feature:-Custom-escape-mappings.md) ## Related but currently out of scope -- [[Suggest corrections|Feature: Suggest corrections]] -- [[Generate .git-blame-ignore-revs|Wishlist: .git blame ignore revs]] +- [Suggest corrections](./Feature:-Suggest-corrections.md) +- [Generate .git-blame-ignore-revs](./Wishlist:-.git-blame-ignore-revs.md) + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Quick-Start.md b/Quick-Start.md index 68bc1b1..9a33bba 100644 --- a/Quick-Start.md +++ b/Quick-Start.md @@ -2,7 +2,7 @@ ## Instructions -1. Clone the [[https://github.com/check-spelling/spell-check-this/]] template repository +1. Clone the [https://github.com/check-spelling/spell-check-this/](https://github.com/check-spelling/spell-check-this/) template repository 2. Copy the contents of `.github/` into your repository 3. `git add .github/` 4. `git commit` @@ -12,7 +12,7 @@ This will give you handling for `push`, `pull_request_target`, and example files with a `README.md` describing the files and linking to more examples in this wiki. -- If you have existing forks, you should see [[Onboarding]] for information about tweaks you can make to the workflow in order to improve the experience for PRs from those existing forks. +- If you have existing forks, you should see [Onboarding](Onboarding.md) for information about tweaks you can make to the workflow in order to improve the experience for PRs from those existing forks. - Best-practice for workflows is to use a pinned version. @@ -26,3 +26,6 @@ This will give you handling for `push`, `pull_request_target`, and example files ℹ️ In general, a file `task.ext` can be replaced with a directory `task/` containing multiple files ending with `.ext` if you prefer -- the files will be merged together. + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Rebasing-spelling-PRs.md b/Rebasing-spelling-PRs.md index 07cdcc9..00e1d0e 100644 --- a/Rebasing-spelling-PRs.md +++ b/Rebasing-spelling-PRs.md @@ -1,6 +1,6 @@ # Rebasing spelling PRs -These scripts require functions from [[Looking for items locally|Looking for items locally]] +These scripts require functions from [Looking for items locally](Looking-for-items-locally.md) - `what_was_removed` is vaguely helpful to search for hunks that moved outside of merge conflicts - `where_are_they_now` is the counterpart to `what_was_removed` -- when this happens, use `rs what_was_removed replacement commit_word` -- if there's more than one, then use `git reset HEAD~` and repeat @@ -97,3 +97,6 @@ what_needs_to_be_fixed() { review } ``` + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Regression-testing.md b/Regression-testing.md index 21fbb44..453b3ee 100644 --- a/Regression-testing.md +++ b/Regression-testing.md @@ -27,3 +27,6 @@ Right now, most check-spelling testing is done through live use of the action ## Timeline Uncertain + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Release-notes.md b/Release-notes.md index 0a20cfd..f6fdec2 100644 --- a/Release-notes.md +++ b/Release-notes.md @@ -28,86 +28,87 @@ [v0.0.22](https://github.com/check-spelling/check-spelling/releases/tag/v0.0.22) -- ❄️ [[Dictionaries with unique value|Feature: Dictionaries with unique value]] -- 🥷 [[Suggest dictionaries when dictionaries aren't available|Feature: Suggest dictionaries when dictionaries aren't available]] -- 🐫 [[Parallel dictionary retrieval|Feature: Parallel dictionary retrieval]] -- 🍳 [[Reorganized cspell Dictionaries in v0.0.22|Breaking Change: Reorganized cspell Dictionaries in v0.0.22]] -- 🗑️ [[Removed Dictionaries]] -- 📗 [[K8s|Dictionary: K8s]] -- 📙 [[Lisp|Dictionary: Lisp]] -- 📊 [[Improve suggested dictionaries order|Feature: Improve suggested dictionaries order]] -- 🎨 [Adjust Sarif output](https://github.com/check-spelling/check-spelling/wiki/Feature:-Sarif-output#adjusting-sarifjson) -- 🧾 [[Summary Table|Feature: Summary Table]] -- ⏱️ [[Timing Report|Feature: Timing Report]] -- 🃏 [[Warning about substring matches|Feature: Warning about substring matches]] -- 🙊 [Masked content will be excluded from minified file detection](https://github.com/check-spelling/check-spelling/wiki/Feature:-Minified-file-detection#masked-content-will-be-excluded-from-accounting) -- 🐣 [[Breaking change: Dropping printf special cases]] -- 📝 [[Report instances of items that used to be covered by a now missing expect entry|Bug fix: Report instances of items that used to be covered by a now missing expect entry]] -- 🔢 [[Fix error counts for Check filenames and paths|Feature: Check filenames and paths]] -- ⌛ [[Parsing Timeouts|Feature: Parsing Timeouts]] -- 🙈 [Advanced exclusion suggestions](https://github.com/check-spelling/check-spelling/wiki/Feature:-Heuristic-exclude-suggestions#advanced-exclusion-suggestions) -- 🔁 [[Handle GitHub Varnish failures|Feature: Handle GitHub Varnish failures]] -- 🗒️ [Plain text version of expect updates for people who do not want to run perl](https://github.com/check-spelling/check-spelling/wiki/Accepting-Suggestions#preformatted-commit-v0022) -- 💔 [[Breaking Change: Dropping support for broken act]] -- 📆 [[🗣️ Breaking change: Dropping support for on: schedule|Breaking change: Dropping support for on: schedule]] -- 🗣️ [[Support for non English languages|Feature: Support for non English languages]] -- 🗣️ [[Non-English languages|Feature: Non-English languages]] -- 🚆 [[Hunspell dictionary support|Feature: Hunspell dictionary support]] -- 🔢 [[Configurable word characters|Feature: Configurable word characters]] -- 🧙 [[Character Encoding Auto Detection|Feature: Character Encoding Auto Detection]] -- 🩹 [Pattern suggestions shouldn't trip over active patterns](https://github.com/check-spelling/check-spelling/wiki/Feature:-Suggest-patterns#multiple-patterns-for-a-line) +- ❄️ [Dictionaries with unique value](./Feature:-Dictionaries-with-unique-value.md) +- 🥷 [Suggest dictionaries when dictionaries aren't available](./Feature:-Suggest-dictionaries-when-dictionaries-aren't-available.md) +- 🐫 [Parallel dictionary retrieval](./Feature:-Parallel-dictionary-retrieval.md) +- 🍳 [Reorganized cspell Dictionaries in v0.0.22](./Breaking-Change:-Reorganized-cspell-Dictionaries-in-v0.0.22.md) +- 🗑️ [Removed Dictionaries](Removed-Dictionaries.md) +- 📗 [K8s](./Dictionary:-K8s.md) +- 📙 [Lisp](./Dictionary:-Lisp.md) +- 📊 [Improve suggested dictionaries order](./Feature:-Improve-suggested-dictionaries-order.md) +- 🎨 [Adjust Sarif output](./Feature:-Sarif-output.md#adjusting-sarifjson) +- 🧾 [Summary Table](./Feature:-Summary-Table.md) +- ⏱️ [Timing Report](./Feature:-Timing-Report.md) +- 🃏 [Warning about substring matches](./Feature:-Warning-about-substring-matches.md) +- 🙊 [Masked content will be excluded from minified file detection](./Feature:-Minified-file-detection.md#masked-content-will-be-excluded-from-accounting) +- 🐣 [Breaking change: Dropping printf special cases](./Breaking-change:-Dropping-printf-special-cases.md) +- 📝 [Report instances of items that used to be covered by a now missing expect entry](./Bug-fix:-Report-instances-of-items-that-used-to-be-covered-by-a-now-missing-expect-entry.md) +- 🔢 [Fix error counts for Check filenames and paths](./Feature:-Check-filenames-and-paths.md) +- ⌛ [Parsing Timeouts](./Feature:-Parsing-Timeouts.md) +- 🙈 [Advanced exclusion suggestions](./Feature:-Heuristic-exclude-suggestions.md#advanced-exclusion-suggestions) +- 🔁 [Handle GitHub Varnish failures](./Feature:-Handle-GitHub-Varnish-failures.md) +- 🗒️ [Plain text version of expect updates for people who do not want to run perl](Accepting-Suggestions.md#preformatted-commit-v0022) +- 💔 [Breaking Change: Dropping support for broken act](./Breaking-Change:-Dropping-support-for-broken-act.md) +- 📆 [🗣️ Breaking change: Dropping support for on: schedule](./Breaking-change:-Dropping-support-for-on:-schedule.md) +- 🗣️ [Support for non English languages](./Feature:-Support-for-non-English-languages.md) +- 🗣️ [Non-English languages](./Feature:-Non-English-languages.md) +- 🚆 [Hunspell dictionary support](./Feature:-Hunspell-dictionary-support.md) +- 🔢 [Configurable word characters](./Feature:-Configurable-word-characters.md) +- 🧙 [Character Encoding Auto Detection](./Feature:-Character-Encoding-Auto-Detection.md) +- 🩹 [Pattern suggestions shouldn't trip over active patterns](./Feature:-Suggest-patterns.md#multiple-patterns-for-a-line) - 🏃 Performance fix for workflows that don't use patterns / forbidden / candidates - 🔧 Matrixes generate archives that the latest apply.pl can consume (fixes regression in [v0.0.21](https://github.com/check-spelling/check-spelling/releases/tag/v0.0.21)) - 🔧 Matrixes generate SARIF reports with distinct categories enabling them all to render properly (fixes bug in [v0.0.21](https://github.com/check-spelling/check-spelling/releases/tag/v0.0.21)) + ## v0.0.21 [v0.0.21](https://github.com/check-spelling/check-spelling/releases/tag/v0.0.21) -- [[Breaking change: Smaller cspell dictionaries]] -- [[Behavior change: File line column notation]] -- [[Step Summary|Feature: Step Summary]] -- [[Sarif output|Feature: Sarif output]] -- [[Suggest patterns|Feature: Suggest patterns]] -- [[Update expect command-line|Feature: Update expect command-line]] -- [[Check commit messages|Feature: Check commit messages]] -- [[Restricted Permissions|Feature: Restricted Permissions]] -- [[Minified file detection|Feature: Minified file detection]] -- [Check filenames and paths `check-file-path`](https://github.com/check-spelling/check-spelling/wiki/Feature%3A-Check-filenames-and-paths#improvements-in-v0021) -- [[Detect binary files|Feature: Detect binary files]] -- [[Disable word collating|Feature: Disable word collating]] -- [[Scan noisy files|Feature: Scan noisy files]] -- [[Workaround broken dependencies|Feature: Workaround broken dependencies]] +- [Breaking change: Smaller cspell dictionaries](./Breaking-change:-Smaller-cspell-dictionaries.md) +- [Behavior change: File line column notation](./Behavior-change:-File-line-column-notation.md) +- [Step Summary](./Feature:-Step-Summary.md) +- [Sarif output](./Feature:-Sarif-output.md) +- [Suggest patterns](./Feature:-Suggest-patterns.md) +- [Update expect command-line](./Feature:-Update-expect-command-line.md) +- [Check commit messages](./Feature:-Check-commit-messages.md) +- [Restricted Permissions](./Feature:-Restricted-Permissions.md) +- [Minified file detection](./Feature:-Minified-file-detection.md) +- [Check filenames and paths `check-file-path`](Feature%3A-Check-filenames-and-paths.md#improvements-in-v0021) +- [Detect binary files](./Feature:-Detect-binary-files.md) +- [Disable word collating](./Feature:-Disable-word-collating.md) +- [Scan noisy files](./Feature:-Scan-noisy-files.md) +- [Workaround broken dependencies](./Feature:-Workaround-broken-dependencies.md) ## v0.0.20 [v0.0.20](https://github.com/check-spelling/check-spelling/releases/tag/v0.0.20) -- [[Behavior change: Patterns masking character|Behavior change: Patterns masking character]] -- [[Behavior change: Consumed line endings]] -- [[Smarter scheduling 2021 October|Feature: Smarter scheduling 2021 October]] -- [[Suppress push comment for open PRs|Feature: Suppress push comment for open PRs]] -- [[Treat specific errors as warnings|Feature: Treat specific errors as warnings]] -- [[Run locally|Feature: Run locally]] using `act` (note: support for `act` is a bit of a moving target, but in general it should work) -- [[Area dictionaries|Feature: Area dictionaries]] -- [[Suggest Area dictionaries|Feature: Suggest Area Dictionaries]] -- [[Suppress comments|Feature: Suppress comments]] -- [[Matrix support|Feature: Matrix support]] -- [[Only changes|Feature: Only-changes]] -- [[Collapse older check comments|Feature: Collapse older check comments]] -- [[Restricted Permissions|Feature: Restricted Permissions]] -- [[Bug fix: Case changes should fail]] -- [Play nice with `@dependabot`](https://github.com/check-spelling/check-spelling/wiki/@dependabot) -- [[Check filenames and paths|Feature: check filenames and paths]] -- [[Automatically truncate comment|Feature: Automatically truncate comment]] -- [[Perl module testing|Feature: Perl module testing]] -- [[Suggest commit after expect update|Feature: Suggest commit after expect update]] -- [[Forbidden patterns|Feature: Forbidden patterns]] -- [[Configurable file size limits|Feature: Configurable file size limits]] -- [[Duplicate word detection|Feature: Duplicate word detection]] -- [[Update with deploy key|Feature: Update with deploy key]] -- [[Artifacts are zipped|Breaking change: Artifacts are zipped]] -- [[User visible warning codes|Feature: User visible warning codes]] +- [Behavior change: Patterns masking character](./Behavior-change:-Patterns-masking-character.md) +- [Behavior change: Consumed line endings](./Behavior-change:-Consumed-line-endings.md) +- [Smarter scheduling 2021 October](./Feature:-Smarter-scheduling-2021-October.md) +- [Suppress push comment for open PRs](./Feature:-Suppress-push-comment-for-open-PRs.md) +- [Treat specific errors as warnings](./Feature:-Treat-specific-errors-as-warnings.md) +- [Run locally](./Feature:-Run-locally.md) using `act` (note: support for `act` is a bit of a moving target, but in general it should work) +- [Area dictionaries](./Feature:-Area-dictionaries.md) +- [Suggest Area dictionaries](./Feature:-Suggest-Area-Dictionaries.md) +- [Suppress comments](./Feature:-Suppress-comments.md) +- [Matrix support](./Feature:-Matrix-support.md) +- [Only changes](./Feature:-Only-changes.md) +- [Collapse older check comments](./Feature:-Collapse-older-check-comments.md) +- [Restricted Permissions](./Feature:-Restricted-Permissions.md) +- [Bug fix: Case changes should fail](./Bug-fix:-Case-changes-should-fail.md) +- [Play nice with `@dependabot`](@dependabot.md) +- [Check filenames and paths](./Feature:-check-filenames-and-paths.md) +- [Automatically truncate comment](./Feature:-Automatically-truncate-comment.md) +- [Perl module testing](./Feature:-Perl-module-testing.md) +- [Suggest commit after expect update](./Feature:-Suggest-commit-after-expect-update.md) +- [Forbidden patterns](./Feature:-Forbidden-patterns.md) +- [Configurable file size limits](./Feature:-Configurable-file-size-limits.md) +- [Duplicate word detection](./Feature:-Duplicate-word-detection.md) +- [Update with deploy key](./Feature:-Update-with-deploy-key.md) +- [Artifacts are zipped](./Breaking-change:-Artifacts-are-zipped.md) +- [User visible warning codes](./Feature:-User-visible-warning-codes.md) ## v0.0.19 @@ -119,23 +120,23 @@ Information is available in [GHSA-g86g-chm8-7r2p](https://github.com/check-spell [v0.0.18](https://github.com/check-spelling/check-spelling/releases/tag/v0.0.18) -- [[Behavior change: Dropping word stemming]] -- [[Behavior change: Ignoring two letter words]] -- [[Update expect list|Feature: Update expect list]] -- [[Collapse older check comments|Feature: Collapse older check comments]] -- [[Suggest adding files to exclude|Feature: Heuristic exclude suggestions]] -- [[First run advice|Feature: First run advice]] +- [Behavior change: Dropping word stemming](./Behavior-change:-Dropping-word-stemming.md) +- [Behavior change: Ignoring two letter words](./Behavior-change:-Ignoring-two-letter-words.md) +- [Update expect list](./Feature:-Update-expect-list.md) +- [Collapse older check comments](./Feature:-Collapse-older-check-comments.md) +- [Suggest adding files to exclude](./Feature:-Heuristic-exclude-suggestions.md) +- [First run advice](./Feature:-First-run-advice.md) - All unrecognized words are reported in the log, instead of just the ones introduced by the current changes. ## v0.0.17 [0.0.17-alpha](https://github.com/check-spelling/check-spelling/releases/tag/0.0.17-alpha) -- [[Feature: Easier bootstrapping]] -- [[Feature: Spelling comments without config]] -- [[Feature: Run locally]] -- [[Feature: Versioned dictionaries]] -- [[Feature: Support pull_request_target]] +- [Feature: Easier bootstrapping](./Feature:-Easier-bootstrapping.md) +- [Feature: Spelling comments without config](./Feature:-Spelling-comments-without-config.md) +- [Feature: Run locally](./Feature:-Run-locally.md) +- [Feature: Versioned dictionaries](./Feature:-Versioned-dictionaries.md) +- [Feature: Support pull_request_target](./Feature:-Support-pull_request_target.md) ### Known issues @@ -145,7 +146,10 @@ If you're using a private repository, the `push` event won't work correctly. [0.0.16-alpha](https://github.com/check-spelling/check-spelling/releases/tag/0.0.16-alpha) -- [[Feature: Allow]] -- [[Feature: Expectlist]] -- [[Feature: Dictionary deltas]] -- [[Feature: Other shells]] +- [Feature: Allow](./Feature:-Allow.md) +- [Feature: Expectlist](./Feature:-Expectlist.md) +- [Feature: Dictionary deltas](./Feature:-Dictionary-deltas.md) +- [Feature: Other shells](./Feature:-Other-shells.md) + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Removed-Dictionaries.md b/Removed-Dictionaries.md index b765966..cc88475 100644 --- a/Removed-Dictionaries.md +++ b/Removed-Dictionaries.md @@ -12,3 +12,6 @@ These two dictionaries include too many typos to be worth suggesting: They're still supported in that the underlying repository still retains the files, so users upgrading to this version will not break. The visible change for users is that by default these dictionaries will not be suggested by check-spelling. + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Script:-Files-to-Excludes.md b/Script:-Files-to-Excludes.md index 8f25c10..84f7a68 100644 --- a/Script:-Files-to-Excludes.md +++ b/Script:-Files-to-Excludes.md @@ -3,3 +3,6 @@ ```sh perl -pne 's{\.}{\\.}g;s/^/^/;s/$/\$/' ``` + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Script:-Staging-PRs.md b/Script:-Staging-PRs.md index 13d7968..6d8acf5 100644 --- a/Script:-Staging-PRs.md +++ b/Script:-Staging-PRs.md @@ -35,3 +35,6 @@ for $branch (@branches) { 1. `git remote add origin upstream-url` 2. `git remote add check-spelling testing-fork-url` 3. `migrate-prs` + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Security.md b/Security.md index 45f8eba..d8083c5 100644 --- a/Security.md +++ b/Security.md @@ -6,7 +6,7 @@ Spammers do periodically attack GitHub wikis and at least a couple of attacks ha ## Security Polling -Check Spelling performs [[Security Polling|Feature: Security Polling]] to verify that the running version isn't known insecure. +Check Spelling performs [Security Polling](./Feature:-Security-Polling.md) to verify that the running version isn't known insecure. ## Policy @@ -27,3 +27,6 @@ There is a single legacy JavaScript file which replaced Docker and has been repl [actions/shellcheck](https://github.com/marketplace/actions/shellcheck) will probably be added eventually. It's expected that making it happy will require a non-trivial amount of effort. + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Showcase.md b/Showcase.md index dfc141c..c66794b 100644 --- a/Showcase.md +++ b/Showcase.md @@ -25,3 +25,6 @@ Here are some samples of what you can expect when using the action ![Code scanning list](https://raw.githubusercontent.com/check-spelling/art/main/output/github-code-scanning-list.png) ![Code scanning entry](https://raw.githubusercontent.com/check-spelling/art/main/output/github-code-scanning-alert.png) + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Task:-Replace-jq.md b/Task:-Replace-jq.md index 315aa8c..6ece3b3 100644 --- a/Task:-Replace-jq.md +++ b/Task:-Replace-jq.md @@ -7,11 +7,22 @@ Evaluating then becomes a problem for Perl instead of another programming langua ## Tasks -- [x] `--slurpfile` is pretty magical, but it's only used in one place -- [ ] `wrap_in_json` is a function, so replacing it should be pretty easy -- [ ] `wrap_file_in_json` is a function, so replacing it should be pretty easy -- [ ] `jq -s` is used once -- [ ] `jq --arg` is used once in a call curl which could be replaced by `gh` -- [ ] `jq length` is used once -- [ ] `jq` w/o `-r` has a handful of other uses which probably should all have `-r` -- [ ] `jq -r` is used >80 times -- they're all fairly simple, but replacing them will probably happen as more code is refactored from shell to perl +☑ `--slurpfile` is pretty magical, but it's only used in one place + +☐ `wrap_in_json` is a function, so replacing it should be pretty easy + +☐ `wrap_file_in_json` is a function, so replacing it should be pretty easy + +☐ `jq -s` is used once + +☐ `jq --arg` is used once in a call curl which could be replaced by `gh` + +☐ `jq length` is used once + +☐ `jq` w/o `-r` has a handful of other uses which probably should all have `-r` + +☐ `jq -r` is used >80 times -- they're all fairly simple, but replacing them will probably happen as more code is refactored from shell to perl + + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Todos.md b/Todos.md index 0876ff1..418f368 100644 --- a/Todos.md +++ b/Todos.md @@ -1,3 +1,6 @@ # Todo -See [[Possible features]] +See [Possible features](Possible-features.md) + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Use-local-check-spelling.md b/Use-local-check-spelling.md index d43541c..2c05fbe 100644 --- a/Use-local-check-spelling.md +++ b/Use-local-check-spelling.md @@ -32,3 +32,6 @@ $spellchecker/fast-install.pl && $spellchecker/unknown-words.sh ## Alternatives For most people, using [nektos/act](https://github.com/nektos/act) should work well enough that one shouldn't need to use this script. + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Warning-descriptions.md b/Warning-descriptions.md index 0ae3474..87d116b 100644 --- a/Warning-descriptions.md +++ b/Warning-descriptions.md @@ -1 +1,4 @@ -See [[Event descriptions]] +See [Event descriptions](Event-descriptions.md) + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Warnings-to-line-excerpts.md b/Warnings-to-line-excerpts.md index f8d5347..a840b41 100644 --- a/Warnings-to-line-excerpts.md +++ b/Warnings-to-line-excerpts.md @@ -90,3 +90,6 @@ If you set `$show_context = 0`, you'll get only the matching content. This is us Will yield output like this: > samples/client/petstore/java/okhttp-gson-parcelableModel/src/main/java/org/openapitools/client/model/FileSchemaTestClass.java:222: JsonArray json**Arrayfiles** = jsonObj.getAsJsonArray("files"); + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/What-does-each-dictionary-cover.md b/What-does-each-dictionary-cover.md index b558c36..e62baee 100644 --- a/What-does-each-dictionary-cover.md +++ b/What-does-each-dictionary-cover.md @@ -18,6 +18,9 @@ This would understandably be quite tedious. ## Script -It's possible to leverage [[Looking for items locally]] to merge the contents of `expect.txt` (or `expect/*.txt`) and then use it to effectively _grep_ (using `perl` as there are a number of quirks which means _grep_ won't work) against each dictionary. +It's possible to leverage [Looking for items locally](Looking-for-items-locally.md) to merge the contents of `expect.txt` (or `expect/*.txt`) and then use it to effectively _grep_ (using `perl` as there are a number of quirks which means _grep_ won't work) against each dictionary. (Script to follow, hopefully...) + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Wishlist:-.git-blame-ignore-revs.md b/Wishlist:-.git-blame-ignore-revs.md index 4a23e0a..64136b9 100644 --- a/Wishlist:-.git-blame-ignore-revs.md +++ b/Wishlist:-.git-blame-ignore-revs.md @@ -29,3 +29,6 @@ generated a PR (or just a commit) to update the file. It seems like a pretty neat small project, which someone could/should do. + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Workflow-Permissions.md b/Workflow-Permissions.md index b8ad3d2..effc60d 100644 --- a/Workflow-Permissions.md +++ b/Workflow-Permissions.md @@ -29,7 +29,7 @@ or ## `pull-requests: read` -In order to stop early when configured with [`suppress_push_for_open_pull_request`](https://github.com/check-spelling/check-spelling/wiki/Configuration#suppress_push_for_open_pull_request), +In order to stop early when configured with [`suppress_push_for_open_pull_request`](Configuration.md#suppress-push-for-open-pull-request), check-spelling needs to be able to check for pull requests. ### Permissions @@ -41,7 +41,7 @@ permissions: ## `actions: read` -In order to retrieve artifacts with [post_comment](https://github.com/check-spelling/check-spelling/wiki/Configuration#post_comment), check-spelling will need `actions: read`. +In order to retrieve artifacts with [post_comment](Configuration.md#post-comment), check-spelling will need `actions: read`. The normal way to do that is with: @@ -51,3 +51,6 @@ The normal way to do that is with: permissions: actions: read ``` + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Workflow:-retest-support.md b/Workflow:-retest-support.md index 57aea55..d7d5355 100644 --- a/Workflow:-retest-support.md +++ b/Workflow:-retest-support.md @@ -17,7 +17,7 @@ on: jobs: spelling: - if: ${{ + if: ${% raw %}{{{% endraw %} contains(github.event_name, 'pull_request') || github.event_name == 'push' || github.event_name == 'issue_comment' && @@ -29,3 +29,6 @@ jobs: To do this, a bit more glue would be necessary to teach the action side to treat this comment as a pull_request event... I'm not entirely sure how much plumbing would be necessary from the action's side, there's already an event aliases option which might help a bit to map the comment to the pull_request handling... + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/_Footer.md b/_Footer.md index abeb95c..0657ce6 100644 --- a/_Footer.md +++ b/_Footer.md @@ -1 +1 @@ -[[FAQ]] | [[Showcase]] | [[Event descriptions]] | [[Configuration information]] | [[Known Issues]] | [[Possible features]] | [[Deprecations]] | [[Release notes]] | [[Helpful scripts]] +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md) diff --git a/Home.md b/index.md similarity index 50% rename from Home.md rename to index.md index a92baf9..ba87613 100644 --- a/Home.md +++ b/index.md @@ -1,4 +1,4 @@ -# check-spelling logo check spelling action +# check-spelling logo check spelling action The [check-spelling](https://github.com/marketplace/actions/check-spelling) GitHub action enables you to catch misspellings. @@ -13,13 +13,16 @@ with a really high false-positive rate, people don't tend to enable spellcheckin at all. This action's tools are capable of tolerating all of those variations. -Specifically, [w](https://github.com/jsoref/spelling/blob/main/w) understands +Specifically, [w](https://raw.githubusercontent.com/jsoref/spelling/main/w) understands enough about how programmers name things that it can split the above conventions into word-like things for checking against a dictionary. -- [[Quick Start]] -- [[Showcase]] -- [[Event descriptions]] -- [[Configuration information]] -- [[Possible features]] -- [[Security|Security]] +- [Quick Start](Quick-Start.md) +- [Showcase](Showcase.md) +- [Event descriptions](Event-descriptions.md) +- [Configuration information](Configuration-information.md) +- [Possible features](Possible-features.md) +- [Security](Security.md) + +--- +[FAQ](FAQ.md) | [Showcase](Showcase.md) | [Event descriptions](Event-descriptions.md) | [Configuration information](Configuration-information.md) | [Known Issues](Known-Issues.md) | [Possible features](Possible-features.md) | [Deprecations](Deprecations.md) | [Release notes](Release-notes.md) | [Helpful scripts](Helpful-scripts.md)