Skip to content

Commit 3ba8eed

Browse files
authored
fix: Remove @markdownDescription from types (#4818)
1 parent ac0cffe commit 3ba8eed

File tree

13 files changed

+10951
-288
lines changed

13 files changed

+10951
-288
lines changed

.eslintrc.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ const config = {
4242
'test-packages/*/test-cspell-eslint-plugin/**',
4343
'test-packages/yarn/**',
4444
'website',
45+
'**/lib-bundled/**',
4546
'website/**', // checked with a different config
4647
],
4748
parserOptions: {

.prettierignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,3 +30,4 @@ test-fixtures/**
3030
api.d.ts
3131
**/*.d.cts
3232
**/*.cjs
33+
lib-bundled

cspell.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,7 @@
5757
"integration-tests/repositories/**",
5858
"integration-tests/snapshots/**",
5959
"lcov.info",
60+
"lib-bundled",
6061
"package.json",
6162
"*-lock.{json,yaml}",
6263
"packages/*/fixtures/**",

cspell.schema.json

Lines changed: 313 additions & 100 deletions
Large diffs are not rendered by default.

packages/cspell-eslint-plugin/assets/options.schema.json

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -39,11 +39,11 @@
3939
"properties": {
4040
"allowCompoundWords": {
4141
"default": false,
42-
"description": "True to enable compound word checking. See https://cspell.org/docs/case-sensitive/ for more details.",
42+
"description": "True to enable compound word checking. See [Case Sensitivity](https://cspell.org/docs/case-sensitive/) for more details.",
4343
"type": "boolean"
4444
},
4545
"dictionaries": {
46-
"description": "Optional list of dictionaries to use. Each entry should match the name of the dictionary.",
46+
"description": "Optional list of dictionaries to use. Each entry should match the name of the dictionary.\n\nTo remove a dictionary from the list, add `!` before the name.\n\nFor example, `!typescript` will turn off the dictionary with the name `typescript`.\n\nSee the [Dictionaries](https://cspell.org/docs/dictionaries/) and [Custom Dictionaries](https://cspell.org/docs/dictionaries-custom/) for more details.",
4747
"items": {
4848
"description": "Reference to a dictionary by name. One of:\n- {@link DictionaryRef } \n- {@link DictionaryNegRef }",
4949
"type": "string"
@@ -111,14 +111,14 @@
111111
"type": "boolean"
112112
},
113113
"flagWords": {
114-
"description": "List of words to always be considered incorrect. Words found in `flagWords` override `words`.",
114+
"description": "List of words to always be considered incorrect. Words found in `flagWords` override `words`.\n\nFormat of `flagWords`\n- single word entry - `word`\n- with suggestions - `word:suggestion` or `word->suggestion, suggestions`\n\nExample: ```ts \"flagWords\": [ \"color: colour\", \"incase: in case, encase\", \"canot->cannot\", \"cancelled->canceled\" ] ```",
115115
"items": {
116116
"type": "string"
117117
},
118118
"type": "array"
119119
},
120120
"ignoreRegExpList": {
121-
"description": "List of regular expression patterns or pattern names to exclude from spell checking.",
121+
"description": "List of regular expression patterns or pattern names to exclude from spell checking.\n\nExample: `[\"href\"]` - to exclude html href pattern.\n\nRegular expressions use JavaScript regular expression syntax.\n\nExample: to ignore ALL-CAPS words\n\nJSON ```json \"ignoreRegExpList\": [\"/\\\\b[A-Z]+\\\\b/g\"] ```\n\nYAML ```yaml ignoreRegExpList: - >- /\\b[A-Z]+\\b/g ```\n\nBy default, several patterns are excluded. See [Configuration](https://cspell.org/configuration/patterns) for more details.\n\nWhile you can create your own patterns, you can also leverage several patterns that are [built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html).",
122122
"items": {
123123
"description": "A PatternRef is a Pattern or PatternId.",
124124
"type": "string"
@@ -146,10 +146,10 @@
146146
"type": "array"
147147
}
148148
],
149-
"description": "Allows this configuration to inherit configuration for one or more other files.\n\nSee https://cspell.org/configuration/imports/ for more details."
149+
"description": "Allows this configuration to inherit configuration for one or more other files.\n\nSee [Importing / Extending Configuration](https://cspell.org/configuration/imports/) for more details."
150150
},
151151
"includeRegExpList": {
152-
"description": "List of regular expression patterns or defined pattern names to match for spell checking.",
152+
"description": "List of regular expression patterns or defined pattern names to match for spell checking.\n\nIf this property is defined, only text matching the included patterns will be checked.\n\nWhile you can create your own patterns, you can also leverage several patterns that are [built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html).",
153153
"items": {
154154
"description": "A PatternRef is a Pattern or PatternId.",
155155
"type": "string"

0 commit comments

Comments
 (0)