Skip to content

Commit e810917

Browse files
authored
docs: Add vscode spell check extension (#753)
Add spell check extension in VSCode for rst files. If required more file types(or all) can be enabled for spell checking. Signed-off-by: Nicolae Dicu <Nicolae.Dicu.ext@qorix.ai>
1 parent db6f2e6 commit e810917

File tree

2 files changed

+26
-2
lines changed

2 files changed

+26
-2
lines changed

.vscode/extensions.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,5 +14,8 @@
1414

1515
// Linting and formatting for Python (LSP via ruff server)
1616
"charliermarsh.ruff",
17+
18+
// Code Spell checker
19+
"streetsidesoftware.code-spell-checker",
1720
]
1821
}

.vscode/settings.json

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@
1010
"editor.rulers": [
1111
99
1212
],
13-
1413
"[python]": {
1514
// In python using 80 characters per line is the standard.
1615
"editor.rulers": [
@@ -84,5 +83,27 @@
8483
"run",
8584
"//tools/starpls:starpls",
8685
"--"
87-
]
86+
],
87+
"cSpell.enabledFileTypes": {
88+
"rst": true
89+
},
90+
"cSpell.words": [
91+
"__getitem__",
92+
"bazel",
93+
"metatags",
94+
"getstrt",
95+
"reqs"
96+
],
97+
"cSpell.ignoreRegExpList": [
98+
"/:\\w+:\\s+[`]?[^`,\n]+(?:,\\s*[^`,\n]+)*[`]?/", //ignore any words following :text:
99+
"/:\\w+:\\s*`[^`]+`/", //ignore any words following :text: inside backticks also
100+
"/\\.\\.\\s+\\w+::\\s+[`]?[^`,\\n]+(?:,\\s*[^`,\\n]+)*[`]?/", //ignore any words following .. text::
101+
"/workproduct(s)?/i", //ignore workproduct word and variations
102+
"/metamodel(s)?/i", //ignore metamodels word and variations
103+
"/memcheck?/i", //ignore memcheck word and variations
104+
"/\\.\\.\\s+\\w+/", //ignore .. word
105+
"/``[^`]+``/", //ignore words between double backticks
106+
"/\\*?need[a-zA-Z0-9_()]*\\*?/i", // ignore *needSomeWord*
107+
"/\\b[A-Z]+(?:_[A-Z]+)*\\b/", //ignore all CAPS, also if includes underscore
108+
]
88109
}

0 commit comments

Comments
 (0)