@@ -5,7 +5,7 @@ Any warnings or errors will be annotated in the Pull Request.
5
5
6
6
## Usage
7
7
8
- ```
8
+ ``` yml
9
9
uses : codespell-project/actions-codespell@v1
10
10
` ` `
11
11
@@ -15,7 +15,7 @@ If set, check file names for spelling mistakes as well.
15
15
16
16
This parameter is optional; by default ` codespell` will only check the file contents.
17
17
18
- ```
18
+ ` ` ` yml
19
19
uses: codespell-project/actions-codespell@v1
20
20
with:
21
21
check_filenames: true
@@ -27,7 +27,7 @@ If set, check hidden files (those starting with ".") for spelling mistakes as we
27
27
28
28
This parameter is optional; by default `codespell` will not check hidden files.
29
29
30
- ```
30
+ ` ` ` yml
31
31
uses: codespell-project/actions-codespell@v1
32
32
with:
33
33
check_hidden: true
@@ -39,7 +39,7 @@ File with lines that should not be checked for spelling mistakes.
39
39
40
40
This parameter is optional; by default `codespell` will check all lines.
41
41
42
- ```
42
+ ` ` ` yml
43
43
uses: codespell-project/actions-codespell@v1
44
44
with:
45
45
exclude_file: src/foo
@@ -51,7 +51,7 @@ Comma-separated list of files to skip (it accepts globs as well).
51
51
52
52
This parameter is optional; by default `codespell` won't skip any files.
53
53
54
- ```
54
+ ` ` ` yml
55
55
uses: codespell-project/actions-codespell@v1
56
56
with:
57
57
skip: foo,bar
@@ -63,7 +63,7 @@ Comma-separated list of builtin dictionaries to use.
63
63
64
64
This parameter is optional; by default `codespell` will use its default selection of built in dictionaries.
65
65
66
- ```
66
+ ` ` ` yml
67
67
uses: codespell-project/actions-codespell@v1
68
68
with:
69
69
builtin: clear,rare
@@ -76,7 +76,7 @@ Words are case sensitive based on how they are written in the dictionary file.
76
76
77
77
This parameter is optional; by default `codespell` will check all words for typos.
78
78
79
- ```
79
+ ` ` ` yml
80
80
uses: codespell-project/actions-codespell@v1
81
81
with:
82
82
ignore_words_file: .codespellignore
@@ -89,7 +89,7 @@ Words are case sensitive based on how they are written in the dictionary file.
89
89
90
90
This parameter is optional; by default `codespell` will check all words for typos.
91
91
92
- ```
92
+ ` ` ` yml
93
93
uses: codespell-project/actions-codespell@v1
94
94
with:
95
95
ignore_words_list: abandonned,ackward
@@ -103,7 +103,7 @@ If set to "*", all misspelling in URIs and emails will be ignored.
103
103
104
104
This parameter is optional; by default `codespell` will check all URIs and emails for typos.
105
105
106
- ```
106
+ ` ` ` yml
107
107
uses: codespell-project/actions-codespell@v1
108
108
with:
109
109
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
116
116
117
117
This parameter is optional; by default `codespell` will run on your whole repository.
118
118
119
- ```
119
+ ` ` ` yml
120
120
uses: codespell-project/actions-codespell@v1
121
121
with:
122
122
path: src
@@ -130,7 +130,7 @@ All errors and warnings are annotated in Pull Requests, but it will act like eve
130
130
131
131
This parameter is optional; setting this to any value will enable it.
132
132
133
- ```
133
+ ` ` ` yml
134
134
uses: codespell-project/actions-codespell@v1
135
135
with:
136
136
only_warn: 1
0 commit comments