Skip to content

Commit 67053fc

Browse files
tlindsay42tlindsay42
committed
docs: Update generated auto_properties.md
* Changes found when running `pnpm gen-docs` while working on streetsidesoftware#7094
1 parent 479735c commit 67053fc

File tree

1 file changed

+105
-1
lines changed

1 file changed

+105
-1
lines changed

‎website/docs/Configuration/auto_properties.md

+105-1
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ format: md
3434
| [globRoot](#settings-globroot) | [`FSPathResolvable`](#fspathresolvable) | The root to use for glob patterns found in this configuration. |
3535
| [id](#settings-id) | `string` | Optional identifier. |
3636
| [ignorePaths](#settings-ignorepaths) | [`Glob`](#glob)​`[]` | Glob patterns of files to be ignored. |
37+
| [ignoreRandomStrings](#settings-ignorerandomstrings) | `boolean` | Ignore sequences of characters that look like random strings. |
3738
| [ignoreRegExpList](#settings-ignoreregexplist) | [`RegExpPatternList`](#regexppatternlist) | List of regular expression patterns or pattern names to exclude from spell checking. |
3839
| [ignoreWords](#settings-ignorewords) | `string`​`[]` | List of words to be ignored. An ignored word will not show up as an error, even if it is |
3940
| [import](#settings-import) | [`FsPath`](#fspath)<br />[`FsPath`](#fspath)&ZeroWidthSpace;`[]` | Allows this configuration to inherit configuration for one or more other files. |
@@ -44,6 +45,7 @@ format: md
4445
| [loadDefaultConfiguration](#settings-loaddefaultconfiguration) | `boolean` | By default, the bundled dictionary configurations are loaded. Explicitly setting this to `false` |
4546
| [maxDuplicateProblems](#settings-maxduplicateproblems) | `number` | The maximum number of times the same word can be flagged as an error in a file. |
4647
| [maxNumberOfProblems](#settings-maxnumberofproblems) | `number` | The maximum number of problems to report in a file. |
48+
| [minRandomLength](#settings-minrandomlength) | `number` | The minimum length of a random string to be ignored. |
4749
| [minWordLength](#settings-minwordlength) | `number` | The minimum length of a word before checking it against a dictionary. |
4850
| [name](#settings-name) | `string` | Optional name of configuration. |
4951
| [noConfigSearch](#settings-noconfigsearch) | `boolean` | Prevents searching for local configuration when checking individual documents. |
@@ -657,6 +659,31 @@ Glob patterns are relative to the [globRoot](#globroot) of the configuration f
657659

658660

659661

662+
---
663+
664+
#### `ignoreRandomStrings` {#settings-ignorerandomstrings}
665+
666+
667+
<dl>
668+
669+
<dt>Description</dt>
670+
<dd>
671+
672+
Ignore sequences of characters that look like random strings.
673+
674+
</dd>
675+
676+
<dt>Type</dt>
677+
<dd>
678+
679+
`boolean`
680+
681+
</dd>
682+
</dl>
683+
684+
685+
686+
660687
---
661688

662689
#### `ignoreRegExpList` {#settings-ignoreregexplist}
@@ -948,6 +975,31 @@ The maximum number of problems to report in a file.
948975

949976

950977

978+
---
979+
980+
#### `minRandomLength` {#settings-minrandomlength}
981+
982+
983+
<dl>
984+
985+
<dt>Description</dt>
986+
<dd>
987+
988+
The minimum length of a random string to be ignored.
989+
990+
</dd>
991+
992+
<dt>Type</dt>
993+
<dd>
994+
995+
`number`
996+
997+
</dd>
998+
</dl>
999+
1000+
1001+
1002+
9511003
---
9521004

9531005
#### `minWordLength` {#settings-minwordlength}
@@ -1697,8 +1749,8 @@ Store the results of processed files in order to only operate on the changed one
16971749
<dd>
16981750

16991751
The Strategy to use to detect if a file has changed.
1700-
- `metadata` - uses the file system timestamp and size to detect changes (fastest).
17011752
- `content` - uses a hash of the file content to check file changes (slower - more accurate).
1753+
- `metadata` - uses the file system timestamp and size to detect changes (fastest, may not work in CI).
17021754

17031755
</dd>
17041756

@@ -6235,6 +6287,7 @@ This is a written language locale like: `en`, `en-GB`, `fr`, `es`, `de` or `en,f
62356287
| [filename](#overridesettings-filename) | [`Glob`](#glob)<br />[`Glob`](#glob)&ZeroWidthSpace;`[]` | Glob pattern or patterns to match against. |
62366288
| [flagWords](#overridesettings-flagwords) | `string`&ZeroWidthSpace;`[]` | List of words to always be considered incorrect. Words found in `flagWords` override `words`. |
62376289
| [id](#overridesettings-id) | `string` | Optional identifier. |
6290+
| [ignoreRandomStrings](#overridesettings-ignorerandomstrings) | `boolean` | Ignore sequences of characters that look like random strings. |
62386291
| [ignoreRegExpList](#overridesettings-ignoreregexplist) | [`RegExpPatternList`](#regexppatternlist) | List of regular expression patterns or pattern names to exclude from spell checking. |
62396292
| [ignoreWords](#overridesettings-ignorewords) | `string`&ZeroWidthSpace;`[]` | List of words to be ignored. An ignored word will not show up as an error, even if it is |
62406293
| [includeRegExpList](#overridesettings-includeregexplist) | [`RegExpPatternList`](#regexppatternlist) | List of regular expression patterns or defined pattern names to match for spell checking. |
@@ -6244,6 +6297,7 @@ This is a written language locale like: `en`, `en-GB`, `fr`, `es`, `de` or `en,f
62446297
| [loadDefaultConfiguration](#overridesettings-loaddefaultconfiguration) | `boolean` | By default, the bundled dictionary configurations are loaded. Explicitly setting this to `false` |
62456298
| [maxDuplicateProblems](#overridesettings-maxduplicateproblems) | `number` | The maximum number of times the same word can be flagged as an error in a file. |
62466299
| [maxNumberOfProblems](#overridesettings-maxnumberofproblems) | `number` | The maximum number of problems to report in a file. |
6300+
| [minRandomLength](#overridesettings-minrandomlength) | `number` | The minimum length of a random string to be ignored. |
62476301
| [minWordLength](#overridesettings-minwordlength) | `number` | The minimum length of a word before checking it against a dictionary. |
62486302
| [name](#overridesettings-name) | `string` | Optional name of configuration. |
62496303
| [noSuggestDictionaries](#overridesettings-nosuggestdictionaries) | [`DictionaryReference`](#dictionaryreference)&ZeroWidthSpace;`[]` | Optional list of dictionaries that will not be used for suggestions. |
@@ -6630,6 +6684,31 @@ Optional identifier.
66306684

66316685

66326686

6687+
---
6688+
6689+
#### `ignoreRandomStrings` {#overridesettings-ignorerandomstrings}
6690+
6691+
6692+
<dl>
6693+
6694+
<dt>Description</dt>
6695+
<dd>
6696+
6697+
Ignore sequences of characters that look like random strings.
6698+
6699+
</dd>
6700+
6701+
<dt>Type</dt>
6702+
<dd>
6703+
6704+
`boolean`
6705+
6706+
</dd>
6707+
</dl>
6708+
6709+
6710+
6711+
66336712
---
66346713

66356714
#### `ignoreRegExpList` {#overridesettings-ignoreregexplist}
@@ -6888,6 +6967,31 @@ The maximum number of problems to report in a file.
68886967

68896968

68906969

6970+
---
6971+
6972+
#### `minRandomLength` {#overridesettings-minrandomlength}
6973+
6974+
6975+
<dl>
6976+
6977+
<dt>Description</dt>
6978+
<dd>
6979+
6980+
The minimum length of a random string to be ignored.
6981+
6982+
</dd>
6983+
6984+
<dt>Type</dt>
6985+
<dd>
6986+
6987+
`number`
6988+
6989+
</dd>
6990+
</dl>
6991+
6992+
6993+
6994+
68916995
---
68926996

68936997
#### `minWordLength` {#overridesettings-minwordlength}

0 commit comments

Comments
 (0)