mirror of
https://github.com/VictoriaMetrics/VictoriaMetrics.git
synced 2024-11-21 14:44:00 +00:00
c454084eb1
### Describe Your Changes
This is a follow-up PR containing workflow related part of the initial
[PR#6362](https://github.com/VictoriaMetrics/VictoriaMetrics/pull/6362).
It adds spell checking control based on
[cspell](https://github.com/streetsidesoftware/cspell). The related
configs are consolidated under `cspell` directory.
You can add VictoriaMetrics specific terms into `cspell/custom-dict.txt`
(it contains ~30 items atm). All other absent commonly used terms should
be added directly to respective
[cspell-dicts](https://github.com/streetsidesoftware/cspell-dicts/blob/main/CONTRIBUTING.md).
### 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>
(cherry picked from commit 92b22581e6)
88 lines
1.9 KiB
JSON
88 lines
1.9 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",
|
|
"python",
|
|
"rust",
|
|
"ru_RU",
|
|
"software-terms",
|
|
"uk_UA",
|
|
"win32"
|
|
],
|
|
"enabled": true,
|
|
"files": ["**/*.{example,md}"],
|
|
"ignorePaths": [
|
|
".dockerignore",
|
|
".github",
|
|
".gitignore",
|
|
"*.excalidraw",
|
|
"*.yml",
|
|
"app/**",
|
|
"CODE_OF_CONDUCT_RU.md",
|
|
"cspell.json",
|
|
"cspell/**",
|
|
"dashboards/**",
|
|
"deployment/**",
|
|
"docs/Gemfile",
|
|
"docs/googlec3812dcf278679ec.html",
|
|
"go.mod",
|
|
"go.sum",
|
|
"lib/**",
|
|
"Makefile",
|
|
"package/**",
|
|
"ports/**",
|
|
"snap/**",
|
|
"vendor/**"
|
|
],
|
|
"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": [
|
|
"@cspell/dict-aws/cspell-ext.json",
|
|
"@cspell/dict-companies/cspell-ext.json",
|
|
"@cspell/dict-data-science/cspell-ext.json",
|
|
"@cspell/dict-en_us/cspell-ext.json",
|
|
"@cspell/dict-fullstack/cspell-ext.json",
|
|
"@cspell/dict-golang/cspell-ext.json",
|
|
"@cspell/dict-k8s/cspell-ext.json",
|
|
"@cspell/dict-software-terms/cspell-ext.json",
|
|
"@cspell/dict-ru_ru/cspell-ext.json",
|
|
"@cspell/dict-uk-ua/cspell-ext.json",
|
|
"@cspell/dict-win32/cspell-ext.json"
|
|
],
|
|
"useGitignore": true
|
|
}
|