dsp-testing/Check Spelling
Spell check code and commits
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stalelast commit Nov 27, 2023
- License
- MIT
Pinned Snippet
uses: dsp-testing/check-spelling@26b46adbdebd5dd0b34c7155113d50c40f43fb22 # no releases — HEAD as of 2026-07-11tags can be moved; commit SHAs can't. why a SHA?
Inputs
| name | description | required | default |
|---|---|---|---|
| GITHUB_TOKEN | The GITHUB_TOKEN secret | yes | ${{ github.token }} |
| bucket | Container for spelling configuration | no | — |
| project | Folder/Branch within bucket containing spelling configuration | no | — |
| config | Spelling configuration directory | no | .github/actions/spelling |
| experimental_path | Directory root to check for spelling (note that bucket/project/config are independent of this) | no | . |
| dictionary_url | Location of dictionary (if you aren't providing one in your repository) | no | https://raw.githubusercontent.com/check-spelling/check-spelling/dictionary-$DICTIONARY_VERSION/dict.txt |
| dictionary_version | Version of the dictionary (only used if the url includes $DICTIONARY_VERSION) | no | 20200211 |
| debug | Debug | no | — |
| experimental_apply_changes_via_bot | (Experimental) Allow users to quote-reply to the bot comment to update the PR | no | 0 |
| experimental_parallel_jobs | Number of CPUs available for running checks | no | 2 |
| post_comment | Post comment with report | no | 1 |
| capture_output_unknown_words | — | no | "" |
| capture_output_stale_words | — | no | "" |
| capture_output_skipped_files | — | no | "" |
| dictionary_source_prefixes | JSON map of prefixes for dictionary urls | no | {"cspell": "https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20230509/dictionaries/"} |
| extra_dictionaries | Space delimited list of URLs (or `prefix:`+path) to additional word lists | no | "" |
| check_extra_dictionaries | Compare unknown tokens against these dictionaries and suggest if applicable | no | cspell:ada/dict/ada.txt cspell:aws/aws.txt cspell:clojure/src/clojure.txt cspell:companies/src/companies.txt cspell:cpp/src/compiler-clang-attributes.txt cspell:cpp/src/compiler-gcc.txt cspell:cpp/src/compiler-msvc.txt cspell:cpp/src/ecosystem.txt cspell:cpp/src/lang-jargon.txt cspell:cpp/src/lang-keywords.txt cspell:cpp/src/people.txt cspell:cpp/src/stdlib-c.txt cspell:cpp/src/stdlib-cerrno.txt cspell:cpp/src/stdlib-cmath.txt cspell:cpp/src/stdlib-cpp.txt cspell:cpp/src/template-strings.txt cspell:cryptocurrencies/cryptocurrencies.txt cspell:csharp/csharp.txt cspell:css/dict/css.txt cspell:dart/src/dart.txt cspell:django/dict/django.txt cspell:django/requirements.txt cspell:docker/src/docker-words.txt cspell:dotnet/dict/dotnet.txt cspell:elixir/dict/elixir.txt cspell:filetypes/filetypes.txt cspell:fonts/fonts.txt cspell:fullstack/dict/fullstack.txt cspell:gaming-terms/dict/gaming-terms.txt cspell:golang/dict/go.txt cspell:haskell/dict/haskell.txt cspell:html-symbol-entities/entities.txt cspell:html/dict/html.txt cspell:html/src/svg.txt cspell:java/src/java-terms.txt cspell:java/src/java.txt cspell:k8s/dict/k8s.txt cspell:latex/dict/latex.txt cspell:latex/samples/sample-words.txt cspell:lisp/lisp.txt cspell:lorem-ipsum/dictionary.txt cspell:lua/dict/lua.txt cspell:mnemonics/src/mnemonics.txt cspell:monkeyc/src/monkeyc_keywords.txt cspell:node/dict/node.txt cspell:npm/dict/npm.txt cspell:php/dict/php.txt cspell:powershell/dict/powershell.txt cspell:public-licenses/src/additional-licenses.txt cspell:public-licenses/src/generated/public-licenses.txt cspell:python/src/additional_words.txt cspell:python/src/common/extra.txt cspell:python/src/python/python-lib.txt cspell:python/src/python/python.txt cspell:r/src/r.txt cspell:redis/dict/redis.txt cspell:ruby/dict/ruby.txt cspell:rust/dict/rust.txt cspell:scala/dict/scala.txt cspell:shell/dict/shell-all-words.txt cspell:software-terms/dict/softwareTerms.txt cspell:software-terms/dict/webServices.txt cspell:sql/src/sql.txt cspell:sql/src/tsql.txt cspell:svelte/dict/svelte.txt cspell:swift/src/swift.txt cspell:typescript/dict/typescript.txt |
| extra_dictionary_limit | Limit the number of suggested extra dictionaries. | no | 5 |
| event_aliases | Try to treat a GitHub event "a" as GitHub event "b" (JSON map). If this flag was available before this tool recognized `pull_request_target`, `{"pull_request_target":"pull_request"}` would have mapped it to `pull_request`. | no | "" |
| shortest_word | Shortest word | no | 3 |
| longest_word | Longest word | no | "" |
| experimental_commit_note | If set, commit updates to expect automatically with this note | no | "" |
| suppress_push_for_open_pull_request | If set, do not do work in response to `push` if there is an open `pull` request to the repository for the branch (this assumes there's a `pull_request_target` event configured). | no | "" |
| report_title_suffix | Suffix for report title (useful if you are using a matrix strategy or are using experimental_path) | no | "" |
| only_check_changed_files | If set, only check files changed since the last push | no | "" |
| custom_task | Run an internal task instead of responding to a GitHub event. Values: "comment" | no | "" |
| internal_state_directory | Used for passing internal state from the (default) check mode to the comment module | no | "" |
| check_file_names | Spell check file paths | no | "" |
| check_commit_messages | List of extra text to check (latest `commit` message, messages for pending `commits`, PR `title`, PR `description`) | no | "" |
| anonymize_secpoll_source | Perform secpoll queries via a public dns server | no | "" |
| ignore_security_advisory | Set to the value of the current security advisory to accept the reported risk -- value must match -- do not set if there is no current advisory | no | "" |
| largest_file | File size limit | no | 1048576 |
| unknown_word_limit | Only report an unknown word this many times | no | 5 |
| warnings | List of events that are warnings (items that are neither warnings nor notices will result in an :x:) | no | bad-regex,binary-file,deprecated-feature,large-file,limited-references,no-newline-at-eof,noisy-file,non-alpha-in-dictionary,token-is-substring,unexpected-line-ending,whitespace-in-dictionary,minified-file,unsupported-configuration |
| notices | List of events that are notices (items that are neither warnings nor notices will result in an :x:) | no | candidate-pattern |
| quit_without_error | Suppress failure code exit code -- it will be available via outputs.result_code | no | "" |
| spell_check_this | Repository with default configuration to use if no configuration is found in a .github/actions/spelling directory | no | "" |
| ssh_key | Key for checking out / pushing to updates (and trigger workflow cascades) | no | "" |
| checkout | Whether to check out a repository | no | "" |
| task | Task to perform (spelling, comment, ...) | no | "" |
| disable_checks | Some heuristics might not do what you want, it may be possible to suppress them | no | "" |
| alternate_engine | Alternate engine to use | no | "" |
| alternate_engine_key | ssh key to retrieve alternate engine | no | "" |
| use_sarif | Publish Sarif report | no | "" |
| use_magic_file | Use magic file to skip binary files | no | "" |
| caller_container | Hack for nektos/act - pass the outputs.docker_container to give check-spelling a way to retrieve data it needs to report a comment | no | — |
| candidate_example_limit | Control the number of examples shown for candidate patterns | no | 3 |
| summary_table | Provide item table (paths, content) | no | 1 |
| ignore-pattern | Word Splitter Ignore Pattern | no | [^a-zA-Z'] |
| upper-pattern | Word Splitter Upper Pattern | no | [A-Z] |
| lower-pattern | Word Splitter Lower Pattern | no | [a-z] |
| not-lower-pattern | Word Splitter Not Lower Pattern | no | [^a-z] |
| not-upper-or-lower-pattern | Word Splitter Not Upper or Lower Pattern | no | [^A-Za-z] |
| punctuation-pattern | Word Splitter Punctuation Pattern | no | ' |
| report-timing | Report processing time for files | no | "" |
| cache-dictionaries | Cache dictionaries | no | 1 |
Outputs
| name | description |
|---|---|
| unknown_words | Unrecognized words (should be added to expect.txt) |
| stale_words | Stale words (should be removed from expect.txt) as an output |
| skipped_files | Skipped files (could be added to excludes.txt) |
| suggested_dictionaries | Suggested dictionaries (could be added to extra_dictionaries) |
| warnings | Warnings |
| internal_state_directory | Used for passing internal state from the (default) check mode to the comment module |
| result_code | Result (indicates unrecognized words were found or comment needs to be collapsed) |
| followup | Next task |
| docker_container | Hack for nektos/act - pass to inputs.caller_container to give check-spelling a way to retrieve data it needs to report a comment |