Spellchecker CLI
ActionsTags
(2)A simple, customizable wrapper around Spellchecker CLI for GitHub Actions workflows.
Check out Spellchecker CLI Summary for a full-featured Spellchecker CLI workflow that can leave comments and status checks on your PRs.
Catch spelling mistakes in your open-source software project's documentation as part of its continuous integration process.
Here is an example workflow definition. It uses actions/checkout to check out your repository's code, then tbroadley/spellchecker-cli-action to spellcheck it.
on: push
jobs:
spellcheck:
runs-on: ubuntu-latest
name: Spellcheck
steps:
- uses: actions/checkout@v3
- uses: tbroadley/spellchecker-cli-action@v1See Spellchecker CLI for more details about these inputs.
| Name | Description | Required? | Default Value |
|---|---|---|---|
files |
A list of files or globs to spellcheck, separated by spaces. | false | "**/*.txt **/*.md" |
language |
The language of the files. See Spellchecker CLI for details about default and available languages. | false | "en-US" |
dictionaries |
A list of files to combine into a personal dictionary, separated by spaces. | false | "" |
noGitignore |
Don't respect ignore files (.gitignore, .ignore, etc). | false | false |
ignore |
A list of regexes, separated by spaces. Spelling mistakes that match any of these regexes (after being wrapped with ^ and $) will be ignored. | false | "" |
plugins |
A list of retext plugins to use, separated by spaces. See Spellchecker CLI for details about available plugins. | false | "spell indefinite-article repeated-words syntax-mentions syntax-urls" |
noSuggestions |
Do not print suggested replacements for misspelled words. This option will improve Spellchecker CLI's runtime when many errors are detected. | false | false |
quiet |
Do not output anything for files that contain no spelling mistakes. | false | false |
frontmatterKeys |
A list of frontmatter keys whose values should be spellchecked, separated by spaces. By default, no values are spellchecked. Only valid when the frontmatter plugin is used. | false | "" |
reports |
A list of report files to generate, separated by spaces. The type of the report is based on the extension of the file. (Supported: .junit.xml and .json) | false | "" |
config |
A path to a config file. | false | "" |
Here's an example that uses inputs:
- uses: tbroadley/spellchecker-cli-action@v1
with:
files: "**/*.md !build/*.md"
quiet: trueSpellchecker CLI is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.
Tags
(2)Spellchecker CLI is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.