Skip to content

Commit 948d384

Browse files
authored
docs: add cspell example (#134)
* docs: add cspell example * chore: add words from example to cspell * docs: add link to our cspell dictionaries * docs: run prettier
1 parent 351d752 commit 948d384

File tree

2 files changed

+38
-1
lines changed

2 files changed

+38
-1
lines changed

.github/cspell.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,5 +15,5 @@
1515
}
1616
],
1717
"useGitignore": true,
18-
"words": ["endtemplate", "APPDATA", "brickhub", "noopener", "typecheck", "clsx", "Infima", "Csvg", "clsx", "xlink", "linecap"]
18+
"words": ["endtemplate", "APPDATA", "brickhub", "noopener", "typecheck", "clsx", "Infima", "Csvg", "clsx", "xlink", "linecap", "Contador", "localizable", "mostrado", "página", "Texto"]
1919
}

site/docs/workflows/spell_check.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,3 +70,40 @@ jobs:
7070
modified_files_only: false
7171
working_directory: examples/my_project
7272
```
73+
74+
## CSpell File Example
75+
76+
More information can be found in [cspell docs](https://cspell.org/configuration/).
77+
78+
Our custom dictionaries are available [here](https://github.com/verygoodopensource/very_good_dictionaries/) for everyone to use.
79+
80+
```json
81+
{
82+
"$schema": "https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json",
83+
"version": "0.2",
84+
// List of the names of the dictionaries to use.
85+
"dictionaries": ["vgv_allowed", "vgv_forbidden"],
86+
// List of custom dictionary definitions.
87+
"dictionaryDefinitions": [
88+
// Remote dictionary example. URLs will be retrieved via HTTP GET.
89+
{
90+
"name": "vgv_allowed",
91+
"path": "https://raw.githubusercontent.com/verygoodopensource/very_good_dictionaries/main/allowed.txt",
92+
"description": "Allowed VGV Spellings"
93+
},
94+
// Local dictionary example. Relative paths are relative to the config file.
95+
{
96+
"name": "vgv_forbidden",
97+
"path": "./vgv_forbidden.txt",
98+
"addWords": true
99+
}
100+
],
101+
// Ignores files found in .gitignore.
102+
"useGitignore": true,
103+
// List of allowed words that are not part of dictionaries.
104+
"words": ["Contador", "localizable", "mostrado", "página", "Texto"],
105+
// List of not-allowed words.
106+
// For example "hte" should be "the".
107+
"flagWords": ["hte"]
108+
}
109+
```

0 commit comments

Comments
 (0)