mirror of
https://github.com/VictoriaMetrics/VictoriaMetrics.git
synced 2024-12-24 03:06:48 +01:00
8645b2cc8e
### Describe Your Changes
Implement spellcheck command:
- add cspell configuration files
- dockerize spellchecking process
- add Makefile targets
This PR adds a standalone `make spellcheck` target to check `docs/*.md` files for spelling
errors. The target process is dockerized to be run in a separate npm environment.
Some `docs/` typo fixes also included.
### Checklist
The following checks are **mandatory**:
- [x] My change adheres [VictoriaMetrics contributing
guidelines](https://docs.victoriametrics.com/contributing/).
---------
Signed-off-by: Arkadii Yakovets <ark@victoriametrics.com>
Signed-off-by: hagen1778 <roman@victoriametrics.com>
Co-authored-by: hagen1778 <roman@victoriametrics.com>
(cherry picked from commit fabf0b928e)
68 lines
1.8 KiB
JSON
68 lines
1.8 KiB
JSON
{
|
|
"allowCompoundWords": true,
|
|
"caseSensitive": false,
|
|
"language": "en,ru,uk",
|
|
"minWordLength": 3,
|
|
"dictionaryDefinitions": [
|
|
{
|
|
"addWords": true,
|
|
"name": "custom-dict",
|
|
"path": "cspell/custom-dict.txt"
|
|
}
|
|
],
|
|
"dictionaries": [
|
|
"aws",
|
|
"bash",
|
|
"companies",
|
|
"cpp",
|
|
"css",
|
|
"custom-dict",
|
|
"data-science",
|
|
"docker",
|
|
"dotnet",
|
|
"en_us",
|
|
"en-common-misspelling",
|
|
"fonts",
|
|
"fullstack",
|
|
"golang",
|
|
"html",
|
|
"k8s",
|
|
"makefile",
|
|
"misc",
|
|
"npm",
|
|
"people-names",
|
|
"python",
|
|
"ru_RU",
|
|
"rust",
|
|
"software-terms",
|
|
"uk_UA",
|
|
"win32"
|
|
],
|
|
"enabled": true,
|
|
"files": ["docs/**/*.md"],
|
|
"ignoreRegExpList": [
|
|
// Github usernames
|
|
"/@[a-zA-Z0-9-_]+/i",
|
|
// Tokens
|
|
"/Authorization:\\sBearer\\s[a-zA-Z0-9-_=]+\\.[a-zA-Z0-9-_=]+\\.[a-zA-Z0-9-_=]+/",
|
|
"/(user|password|token):\\s\"?[a-zA-Z0-9-_<>=\\.]+\"?/",
|
|
// Victoria Metrics related names
|
|
"/vm[a-zA-Z0-9-_]+/i"
|
|
],
|
|
"import": [
|
|
"/home/node/node_modules/@cspell/dict-aws/cspell-ext.json",
|
|
"/home/node/node_modules/@cspell/dict-companies/cspell-ext.json",
|
|
"/home/node/node_modules/@cspell/dict-data-science/cspell-ext.json",
|
|
"/home/node/node_modules/@cspell/dict-en_us/cspell-ext.json",
|
|
"/home/node/node_modules/@cspell/dict-fullstack/cspell-ext.json",
|
|
"/home/node/node_modules/@cspell/dict-golang/cspell-ext.json",
|
|
"/home/node/node_modules/@cspell/dict-k8s/cspell-ext.json",
|
|
"/home/node/node_modules/@cspell/dict-people-names/cspell-ext.json",
|
|
"/home/node/node_modules/@cspell/dict-ru_ru/cspell-ext.json",
|
|
"/home/node/node_modules/@cspell/dict-software-terms/cspell-ext.json",
|
|
"/home/node/node_modules/@cspell/dict-uk-ua/cspell-ext.json",
|
|
"/home/node/node_modules/@cspell/dict-win32/cspell-ext.json"
|
|
],
|
|
"useGitignore": true
|
|
}
|