Skip to content

Commit

Permalink
fix: Remove @markdownDescription from types (#4818)
Browse files Browse the repository at this point in the history
  • Loading branch information
Jason3S committed Sep 10, 2023
1 parent ac0cffe commit 3ba8eed
Show file tree
Hide file tree
Showing 13 changed files with 10,951 additions and 288 deletions.
1 change: 1 addition & 0 deletions .eslintrc.js
Expand Up @@ -42,6 +42,7 @@ const config = {
'test-packages/*/test-cspell-eslint-plugin/**',
'test-packages/yarn/**',
'website',
'**/lib-bundled/**',
'website/**', // checked with a different config
],
parserOptions: {
Expand Down
1 change: 1 addition & 0 deletions .prettierignore
Expand Up @@ -30,3 +30,4 @@ test-fixtures/**
api.d.ts
**/*.d.cts
**/*.cjs
lib-bundled
1 change: 1 addition & 0 deletions cspell.json
Expand Up @@ -57,6 +57,7 @@
"integration-tests/repositories/**",
"integration-tests/snapshots/**",
"lcov.info",
"lib-bundled",
"package.json",
"*-lock.{json,yaml}",
"packages/*/fixtures/**",
Expand Down
413 changes: 313 additions & 100 deletions cspell.schema.json

Large diffs are not rendered by default.

12 changes: 6 additions & 6 deletions packages/cspell-eslint-plugin/assets/options.schema.json
Expand Up @@ -39,11 +39,11 @@
"properties": {
"allowCompoundWords": {
"default": false,
"description": "True to enable compound word checking. See https://cspell.org/docs/case-sensitive/ for more details.",
"description": "True to enable compound word checking. See [Case Sensitivity](https://cspell.org/docs/case-sensitive/) for more details.",
"type": "boolean"
},
"dictionaries": {
"description": "Optional list of dictionaries to use. Each entry should match the name of the dictionary.",
"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.",
"items": {
"description": "Reference to a dictionary by name. One of:\n- {@link DictionaryRef } \n- {@link DictionaryNegRef }",
"type": "string"
Expand Down Expand Up @@ -111,14 +111,14 @@
"type": "boolean"
},
"flagWords": {
"description": "List of words to always be considered incorrect. Words found in `flagWords` override `words`.",
"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\" ] ```",
"items": {
"type": "string"
},
"type": "array"
},
"ignoreRegExpList": {
"description": "List of regular expression patterns or pattern names to exclude from spell checking.",
"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).",
"items": {
"description": "A PatternRef is a Pattern or PatternId.",
"type": "string"
Expand Down Expand Up @@ -146,10 +146,10 @@
"type": "array"
}
],
"description": "Allows this configuration to inherit configuration for one or more other files.\n\nSee https://cspell.org/configuration/imports/ for more details."
"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."
},
"includeRegExpList": {
"description": "List of regular expression patterns or defined pattern names to match for spell checking.",
"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).",
"items": {
"description": "A PatternRef is a Pattern or PatternId.",
"type": "string"
Expand Down

0 comments on commit 3ba8eed

Please sign in to comment.