codespell-project/actions-codespell
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add syntax highlighting for readability (#64)
Testing / Run tests (codespell, false) (push) Successful in 8s
Testing / Run tests (git+https://github.com/codespell-project/codespell.git, false) (push) Successful in 11s
Testing / Test run action (push) Successful in 8s
Testing / Diagnose bats (codespell) (push) Skipped
Testing / Diagnose bats (git+https://github.com/codespell-project/codespell.git) (push) Skipped
Publish stable image / Publish stable image (push) Failing after 29s
Testing / Check for spelling errors (push) Successful in 14s

Browse Source
This commit is contained in:
Hugo van Kemenade
2023-04-28 09:14:47 -04:00
committed by GitHub
parent 57beb9f38f
commit 94259cd8be
1 changed files with 11 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+11 -11
View File
@@ -5,7 +5,7 @@ Any warnings or errors will be annotated in the Pull Request.
## Usage
```
```yml
uses: codespell-project/actions-codespell@v1
```
@@ -15,7 +15,7 @@ If set, check file names for spelling mistakes as well.
This parameter is optional; by default `codespell` will only check the file contents.
```
```yml
uses: codespell-project/actions-codespell@v1
with:
check_filenames: true
@@ -27,7 +27,7 @@ If set, check hidden files (those starting with ".") for spelling mistakes as we
This parameter is optional; by default `codespell` will not check hidden files.
```
```yml
uses: codespell-project/actions-codespell@v1
with:
check_hidden: true
@@ -39,7 +39,7 @@ File with lines that should not be checked for spelling mistakes.
This parameter is optional; by default `codespell` will check all lines.
```
```yml
uses: codespell-project/actions-codespell@v1
with:
exclude_file: src/foo
@@ -51,7 +51,7 @@ Comma-separated list of files to skip (it accepts globs as well).
This parameter is optional; by default `codespell` won't skip any files.
```
```yml
uses: codespell-project/actions-codespell@v1
with:
skip: foo,bar
@@ -63,7 +63,7 @@ Comma-separated list of builtin dictionaries to use.
This parameter is optional; by default `codespell` will use its default selection of built in dictionaries.
```
```yml
uses: codespell-project/actions-codespell@v1
with:
builtin: clear,rare
@@ -76,7 +76,7 @@ Words are case sensitive based on how they are written in the dictionary file.
This parameter is optional; by default `codespell` will check all words for typos.
```
```yml
uses: codespell-project/actions-codespell@v1
with:
ignore_words_file: .codespellignore
@@ -89,7 +89,7 @@ Words are case sensitive based on how they are written in the dictionary file.
This parameter is optional; by default `codespell` will check all words for typos.
```
```yml
uses: codespell-project/actions-codespell@v1
with:
ignore_words_list: abandonned,ackward
@@ -103,7 +103,7 @@ If set to "*", all misspelling in URIs and emails will be ignored.
This parameter is optional; by default `codespell` will check all URIs and emails for typos.
```
```yml
uses: codespell-project/actions-codespell@v1
with:
uri_ignore_words_list: abandonned
@@ -116,7 +116,7 @@ This can be useful if your project has code you don't want to spell check for so
This parameter is optional; by default `codespell` will run on your whole repository.
```
```yml
uses: codespell-project/actions-codespell@v1
with:
path: src
@@ -130,7 +130,7 @@ All errors and warnings are annotated in Pull Requests, but it will act like eve
This parameter is optional; setting this to any value will enable it.
```
```yml
uses: codespell-project/actions-codespell@v1
with:
only_warn: 1