@cspell/cspell-types 9.0.1 → 9.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -228,6 +228,9 @@
228
228
  {
229
229
  "$ref": "#/definitions/DictionaryDefinitionInline"
230
230
  },
231
+ {
232
+ "$ref": "#/definitions/DictionaryDefinitionSimple"
233
+ },
231
234
  {
232
235
  "$ref": "#/definitions/DictionaryDefinitionAlternate"
233
236
  }
@@ -272,6 +275,12 @@
272
275
  "description": "Replacement pairs.",
273
276
  "markdownDescription": "Replacement pairs."
274
277
  },
278
+ "supportNonStrictSearches": {
279
+ "default": true,
280
+ "description": "Strip case and accents to allow for case insensitive searches and words without accents.\n\nNote: this setting only applies to word lists. It has no-impact on trie dictionaries.",
281
+ "markdownDescription": "Strip case and accents to allow for case insensitive searches and\nwords without accents.\n\nNote: this setting only applies to word lists. It has no-impact on trie\ndictionaries.",
282
+ "type": "boolean"
283
+ },
275
284
  "type": {
276
285
  "$ref": "#/definitions/DictionaryFileTypes",
277
286
  "default": "S",
@@ -328,6 +337,12 @@
328
337
  "description": "Replacement pairs.",
329
338
  "markdownDescription": "Replacement pairs."
330
339
  },
340
+ "supportNonStrictSearches": {
341
+ "default": true,
342
+ "description": "Strip case and accents to allow for case insensitive searches and words without accents.\n\nNote: this setting only applies to word lists. It has no-impact on trie dictionaries.",
343
+ "markdownDescription": "Strip case and accents to allow for case insensitive searches and\nwords without accents.\n\nNote: this setting only applies to word lists. It has no-impact on trie\ndictionaries.",
344
+ "type": "boolean"
345
+ },
331
346
  "type": {
332
347
  "$ref": "#/definitions/DictionaryFileTypes",
333
348
  "default": "S",
@@ -401,6 +416,12 @@
401
416
  "description": "Defines the scope for when words will be added to the dictionary.\n\nScope values: `user`, `workspace`, `folder`.",
402
417
  "markdownDescription": "Defines the scope for when words will be added to the dictionary.\n\nScope values: `user`, `workspace`, `folder`."
403
418
  },
419
+ "supportNonStrictSearches": {
420
+ "default": true,
421
+ "description": "Strip case and accents to allow for case insensitive searches and words without accents.\n\nNote: this setting only applies to word lists. It has no-impact on trie dictionaries.",
422
+ "markdownDescription": "Strip case and accents to allow for case insensitive searches and\nwords without accents.\n\nNote: this setting only applies to word lists. It has no-impact on trie\ndictionaries.",
423
+ "type": "boolean"
424
+ },
404
425
  "type": {
405
426
  "$ref": "#/definitions/DictionaryFileTypes",
406
427
  "default": "S",
@@ -436,7 +457,8 @@
436
457
  }
437
458
  ],
438
459
  "description": "Inline Dictionary Definitions",
439
- "markdownDescription": "Inline Dictionary Definitions"
460
+ "markdownDescription": "Inline Dictionary Definitions",
461
+ "since": "6.23.0"
440
462
  },
441
463
  "DictionaryDefinitionInlineFlagWords": {
442
464
  "additionalProperties": false,
@@ -454,11 +476,6 @@
454
476
  "markdownDescription": "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:\n```ts\n\"flagWords\": [\n \"color: colour\",\n \"incase: in case, encase\",\n \"canot->cannot\",\n \"cancelled->canceled\"\n]\n```",
455
477
  "type": "array"
456
478
  },
457
- "ignoreForbiddenWords": {
458
- "description": "Some dictionaries may contain forbidden words to prevent compounding from generating words that are not valid in the language. These are often words that are used in other languages or might be generated through compounding. This setting allows flagged words to be ignored when checking the dictionary. The effect is similar to the word not being in the dictionary.",
459
- "markdownDescription": "Some dictionaries may contain forbidden words to prevent compounding from generating\nwords that are not valid in the language. These are often\nwords that are used in other languages or might be generated through compounding.\nThis setting allows flagged words to be ignored when checking the dictionary.\nThe effect is similar to the word not being in the dictionary.",
460
- "type": "boolean"
461
- },
462
479
  "ignoreWords": {
463
480
  "description": "List of words to be ignored. An ignored word will not show up as an error, even if it is also in the `flagWords`.",
464
481
  "items": {
@@ -472,16 +489,6 @@
472
489
  "description": "This is the name of a dictionary.\n\nName Format:\n- Must contain at least 1 number or letter.\n- Spaces are allowed.\n- Leading and trailing space will be removed.\n- Names ARE case-sensitive.\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.",
473
490
  "markdownDescription": "This is the name of a dictionary.\n\nName Format:\n- Must contain at least 1 number or letter.\n- Spaces are allowed.\n- Leading and trailing space will be removed.\n- Names ARE case-sensitive.\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`."
474
491
  },
475
- "noSuggest": {
476
- "description": "Indicate that suggestions should not come from this dictionary. Words in this dictionary are considered correct, but will not be used when making spell correction suggestions.\n\nNote: if a word is suggested by another dictionary, but found in this dictionary, it will be removed from the set of possible suggestions.",
477
- "markdownDescription": "Indicate that suggestions should not come from this dictionary.\nWords in this dictionary are considered correct, but will not be\nused when making spell correction suggestions.\n\nNote: if a word is suggested by another dictionary, but found in\nthis dictionary, it will be removed from the set of\npossible suggestions.",
478
- "type": "boolean"
479
- },
480
- "repMap": {
481
- "$ref": "#/definitions/ReplaceMap",
482
- "description": "Replacement pairs.",
483
- "markdownDescription": "Replacement pairs."
484
- },
485
492
  "suggestWords": {
486
493
  "description": "A list of suggested replacements for words. Suggested words provide a way to make preferred suggestions on word replacements. To hint at a preferred change, but not to require it.\n\nFormat of `suggestWords`\n- Single suggestion (possible auto fix) - `word: suggestion` - `word->suggestion`\n- Multiple suggestions (not auto fixable) - `word: first, second, third` - `word->first, second, third`",
487
494
  "items": {
@@ -490,15 +497,10 @@
490
497
  "markdownDescription": "A list of suggested replacements for words.\nSuggested words provide a way to make preferred suggestions on word replacements.\nTo hint at a preferred change, but not to require it.\n\nFormat of `suggestWords`\n- Single suggestion (possible auto fix)\n - `word: suggestion`\n - `word->suggestion`\n- Multiple suggestions (not auto fixable)\n - `word: first, second, third`\n - `word->first, second, third`",
491
498
  "type": "array"
492
499
  },
493
- "type": {
494
- "$ref": "#/definitions/DictionaryFileTypes",
495
- "default": "S",
496
- "description": "Type of file:\n- S - single word per line,\n- W - each line can contain one or more words separated by space,\n- C - each line is treated like code (Camel Case is allowed).\n\nDefault is S.\n\nC is the slowest to load due to the need to split each line based upon code splitting rules.\n\nNote: this settings does not apply to inline dictionaries or `.trie` files.",
497
- "markdownDescription": "Type of file:\n- S - single word per line,\n- W - each line can contain one or more words separated by space,\n- C - each line is treated like code (Camel Case is allowed).\n\nDefault is S.\n\nC is the slowest to load due to the need to split each line based upon code splitting rules.\n\nNote: this settings does not apply to inline dictionaries or `.trie` files."
498
- },
499
- "useCompounds": {
500
- "description": "Use Compounds.",
501
- "markdownDescription": "Use Compounds.",
500
+ "supportNonStrictSearches": {
501
+ "default": true,
502
+ "description": "Strip case and accents to allow for case insensitive searches and words without accents.\n\nNote: this setting only applies to word lists. It has no-impact on trie dictionaries.",
503
+ "markdownDescription": "Strip case and accents to allow for case insensitive searches and\nwords without accents.\n\nNote: this setting only applies to word lists. It has no-impact on trie\ndictionaries.",
502
504
  "type": "boolean"
503
505
  },
504
506
  "words": {
@@ -532,11 +534,6 @@
532
534
  "markdownDescription": "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:\n```ts\n\"flagWords\": [\n \"color: colour\",\n \"incase: in case, encase\",\n \"canot->cannot\",\n \"cancelled->canceled\"\n]\n```",
533
535
  "type": "array"
534
536
  },
535
- "ignoreForbiddenWords": {
536
- "description": "Some dictionaries may contain forbidden words to prevent compounding from generating words that are not valid in the language. These are often words that are used in other languages or might be generated through compounding. This setting allows flagged words to be ignored when checking the dictionary. The effect is similar to the word not being in the dictionary.",
537
- "markdownDescription": "Some dictionaries may contain forbidden words to prevent compounding from generating\nwords that are not valid in the language. These are often\nwords that are used in other languages or might be generated through compounding.\nThis setting allows flagged words to be ignored when checking the dictionary.\nThe effect is similar to the word not being in the dictionary.",
538
- "type": "boolean"
539
- },
540
537
  "ignoreWords": {
541
538
  "description": "List of words to be ignored. An ignored word will not show up as an error, even if it is also in the `flagWords`.",
542
539
  "items": {
@@ -550,16 +547,6 @@
550
547
  "description": "This is the name of a dictionary.\n\nName Format:\n- Must contain at least 1 number or letter.\n- Spaces are allowed.\n- Leading and trailing space will be removed.\n- Names ARE case-sensitive.\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.",
551
548
  "markdownDescription": "This is the name of a dictionary.\n\nName Format:\n- Must contain at least 1 number or letter.\n- Spaces are allowed.\n- Leading and trailing space will be removed.\n- Names ARE case-sensitive.\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`."
552
549
  },
553
- "noSuggest": {
554
- "description": "Indicate that suggestions should not come from this dictionary. Words in this dictionary are considered correct, but will not be used when making spell correction suggestions.\n\nNote: if a word is suggested by another dictionary, but found in this dictionary, it will be removed from the set of possible suggestions.",
555
- "markdownDescription": "Indicate that suggestions should not come from this dictionary.\nWords in this dictionary are considered correct, but will not be\nused when making spell correction suggestions.\n\nNote: if a word is suggested by another dictionary, but found in\nthis dictionary, it will be removed from the set of\npossible suggestions.",
556
- "type": "boolean"
557
- },
558
- "repMap": {
559
- "$ref": "#/definitions/ReplaceMap",
560
- "description": "Replacement pairs.",
561
- "markdownDescription": "Replacement pairs."
562
- },
563
550
  "suggestWords": {
564
551
  "description": "A list of suggested replacements for words. Suggested words provide a way to make preferred suggestions on word replacements. To hint at a preferred change, but not to require it.\n\nFormat of `suggestWords`\n- Single suggestion (possible auto fix) - `word: suggestion` - `word->suggestion`\n- Multiple suggestions (not auto fixable) - `word: first, second, third` - `word->first, second, third`",
565
552
  "items": {
@@ -568,15 +555,10 @@
568
555
  "markdownDescription": "A list of suggested replacements for words.\nSuggested words provide a way to make preferred suggestions on word replacements.\nTo hint at a preferred change, but not to require it.\n\nFormat of `suggestWords`\n- Single suggestion (possible auto fix)\n - `word: suggestion`\n - `word->suggestion`\n- Multiple suggestions (not auto fixable)\n - `word: first, second, third`\n - `word->first, second, third`",
569
556
  "type": "array"
570
557
  },
571
- "type": {
572
- "$ref": "#/definitions/DictionaryFileTypes",
573
- "default": "S",
574
- "description": "Type of file:\n- S - single word per line,\n- W - each line can contain one or more words separated by space,\n- C - each line is treated like code (Camel Case is allowed).\n\nDefault is S.\n\nC is the slowest to load due to the need to split each line based upon code splitting rules.\n\nNote: this settings does not apply to inline dictionaries or `.trie` files.",
575
- "markdownDescription": "Type of file:\n- S - single word per line,\n- W - each line can contain one or more words separated by space,\n- C - each line is treated like code (Camel Case is allowed).\n\nDefault is S.\n\nC is the slowest to load due to the need to split each line based upon code splitting rules.\n\nNote: this settings does not apply to inline dictionaries or `.trie` files."
576
- },
577
- "useCompounds": {
578
- "description": "Use Compounds.",
579
- "markdownDescription": "Use Compounds.",
558
+ "supportNonStrictSearches": {
559
+ "default": true,
560
+ "description": "Strip case and accents to allow for case insensitive searches and words without accents.\n\nNote: this setting only applies to word lists. It has no-impact on trie dictionaries.",
561
+ "markdownDescription": "Strip case and accents to allow for case insensitive searches and\nwords without accents.\n\nNote: this setting only applies to word lists. It has no-impact on trie\ndictionaries.",
580
562
  "type": "boolean"
581
563
  },
582
564
  "words": {
@@ -610,11 +592,6 @@
610
592
  "markdownDescription": "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:\n```ts\n\"flagWords\": [\n \"color: colour\",\n \"incase: in case, encase\",\n \"canot->cannot\",\n \"cancelled->canceled\"\n]\n```",
611
593
  "type": "array"
612
594
  },
613
- "ignoreForbiddenWords": {
614
- "description": "Some dictionaries may contain forbidden words to prevent compounding from generating words that are not valid in the language. These are often words that are used in other languages or might be generated through compounding. This setting allows flagged words to be ignored when checking the dictionary. The effect is similar to the word not being in the dictionary.",
615
- "markdownDescription": "Some dictionaries may contain forbidden words to prevent compounding from generating\nwords that are not valid in the language. These are often\nwords that are used in other languages or might be generated through compounding.\nThis setting allows flagged words to be ignored when checking the dictionary.\nThe effect is similar to the word not being in the dictionary.",
616
- "type": "boolean"
617
- },
618
595
  "ignoreWords": {
619
596
  "description": "List of words to be ignored. An ignored word will not show up as an error, even if it is also in the `flagWords`.",
620
597
  "items": {
@@ -628,16 +605,6 @@
628
605
  "description": "This is the name of a dictionary.\n\nName Format:\n- Must contain at least 1 number or letter.\n- Spaces are allowed.\n- Leading and trailing space will be removed.\n- Names ARE case-sensitive.\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.",
629
606
  "markdownDescription": "This is the name of a dictionary.\n\nName Format:\n- Must contain at least 1 number or letter.\n- Spaces are allowed.\n- Leading and trailing space will be removed.\n- Names ARE case-sensitive.\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`."
630
607
  },
631
- "noSuggest": {
632
- "description": "Indicate that suggestions should not come from this dictionary. Words in this dictionary are considered correct, but will not be used when making spell correction suggestions.\n\nNote: if a word is suggested by another dictionary, but found in this dictionary, it will be removed from the set of possible suggestions.",
633
- "markdownDescription": "Indicate that suggestions should not come from this dictionary.\nWords in this dictionary are considered correct, but will not be\nused when making spell correction suggestions.\n\nNote: if a word is suggested by another dictionary, but found in\nthis dictionary, it will be removed from the set of\npossible suggestions.",
634
- "type": "boolean"
635
- },
636
- "repMap": {
637
- "$ref": "#/definitions/ReplaceMap",
638
- "description": "Replacement pairs.",
639
- "markdownDescription": "Replacement pairs."
640
- },
641
608
  "suggestWords": {
642
609
  "description": "A list of suggested replacements for words. Suggested words provide a way to make preferred suggestions on word replacements. To hint at a preferred change, but not to require it.\n\nFormat of `suggestWords`\n- Single suggestion (possible auto fix) - `word: suggestion` - `word->suggestion`\n- Multiple suggestions (not auto fixable) - `word: first, second, third` - `word->first, second, third`",
643
610
  "items": {
@@ -646,15 +613,10 @@
646
613
  "markdownDescription": "A list of suggested replacements for words.\nSuggested words provide a way to make preferred suggestions on word replacements.\nTo hint at a preferred change, but not to require it.\n\nFormat of `suggestWords`\n- Single suggestion (possible auto fix)\n - `word: suggestion`\n - `word->suggestion`\n- Multiple suggestions (not auto fixable)\n - `word: first, second, third`\n - `word->first, second, third`",
647
614
  "type": "array"
648
615
  },
649
- "type": {
650
- "$ref": "#/definitions/DictionaryFileTypes",
651
- "default": "S",
652
- "description": "Type of file:\n- S - single word per line,\n- W - each line can contain one or more words separated by space,\n- C - each line is treated like code (Camel Case is allowed).\n\nDefault is S.\n\nC is the slowest to load due to the need to split each line based upon code splitting rules.\n\nNote: this settings does not apply to inline dictionaries or `.trie` files.",
653
- "markdownDescription": "Type of file:\n- S - single word per line,\n- W - each line can contain one or more words separated by space,\n- C - each line is treated like code (Camel Case is allowed).\n\nDefault is S.\n\nC is the slowest to load due to the need to split each line based upon code splitting rules.\n\nNote: this settings does not apply to inline dictionaries or `.trie` files."
654
- },
655
- "useCompounds": {
656
- "description": "Use Compounds.",
657
- "markdownDescription": "Use Compounds.",
616
+ "supportNonStrictSearches": {
617
+ "default": true,
618
+ "description": "Strip case and accents to allow for case insensitive searches and words without accents.\n\nNote: this setting only applies to word lists. It has no-impact on trie dictionaries.",
619
+ "markdownDescription": "Strip case and accents to allow for case insensitive searches and\nwords without accents.\n\nNote: this setting only applies to word lists. It has no-impact on trie\ndictionaries.",
658
620
  "type": "boolean"
659
621
  },
660
622
  "words": {
@@ -688,11 +650,6 @@
688
650
  "markdownDescription": "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:\n```ts\n\"flagWords\": [\n \"color: colour\",\n \"incase: in case, encase\",\n \"canot->cannot\",\n \"cancelled->canceled\"\n]\n```",
689
651
  "type": "array"
690
652
  },
691
- "ignoreForbiddenWords": {
692
- "description": "Some dictionaries may contain forbidden words to prevent compounding from generating words that are not valid in the language. These are often words that are used in other languages or might be generated through compounding. This setting allows flagged words to be ignored when checking the dictionary. The effect is similar to the word not being in the dictionary.",
693
- "markdownDescription": "Some dictionaries may contain forbidden words to prevent compounding from generating\nwords that are not valid in the language. These are often\nwords that are used in other languages or might be generated through compounding.\nThis setting allows flagged words to be ignored when checking the dictionary.\nThe effect is similar to the word not being in the dictionary.",
694
- "type": "boolean"
695
- },
696
653
  "ignoreWords": {
697
654
  "description": "List of words to be ignored. An ignored word will not show up as an error, even if it is also in the `flagWords`.",
698
655
  "items": {
@@ -706,16 +663,6 @@
706
663
  "description": "This is the name of a dictionary.\n\nName Format:\n- Must contain at least 1 number or letter.\n- Spaces are allowed.\n- Leading and trailing space will be removed.\n- Names ARE case-sensitive.\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.",
707
664
  "markdownDescription": "This is the name of a dictionary.\n\nName Format:\n- Must contain at least 1 number or letter.\n- Spaces are allowed.\n- Leading and trailing space will be removed.\n- Names ARE case-sensitive.\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`."
708
665
  },
709
- "noSuggest": {
710
- "description": "Indicate that suggestions should not come from this dictionary. Words in this dictionary are considered correct, but will not be used when making spell correction suggestions.\n\nNote: if a word is suggested by another dictionary, but found in this dictionary, it will be removed from the set of possible suggestions.",
711
- "markdownDescription": "Indicate that suggestions should not come from this dictionary.\nWords in this dictionary are considered correct, but will not be\nused when making spell correction suggestions.\n\nNote: if a word is suggested by another dictionary, but found in\nthis dictionary, it will be removed from the set of\npossible suggestions.",
712
- "type": "boolean"
713
- },
714
- "repMap": {
715
- "$ref": "#/definitions/ReplaceMap",
716
- "description": "Replacement pairs.",
717
- "markdownDescription": "Replacement pairs."
718
- },
719
666
  "suggestWords": {
720
667
  "description": "A list of suggested replacements for words. Suggested words provide a way to make preferred suggestions on word replacements. To hint at a preferred change, but not to require it.\n\nFormat of `suggestWords`\n- Single suggestion (possible auto fix) - `word: suggestion` - `word->suggestion`\n- Multiple suggestions (not auto fixable) - `word: first, second, third` - `word->first, second, third`",
721
668
  "items": {
@@ -724,15 +671,10 @@
724
671
  "markdownDescription": "A list of suggested replacements for words.\nSuggested words provide a way to make preferred suggestions on word replacements.\nTo hint at a preferred change, but not to require it.\n\nFormat of `suggestWords`\n- Single suggestion (possible auto fix)\n - `word: suggestion`\n - `word->suggestion`\n- Multiple suggestions (not auto fixable)\n - `word: first, second, third`\n - `word->first, second, third`",
725
672
  "type": "array"
726
673
  },
727
- "type": {
728
- "$ref": "#/definitions/DictionaryFileTypes",
729
- "default": "S",
730
- "description": "Type of file:\n- S - single word per line,\n- W - each line can contain one or more words separated by space,\n- C - each line is treated like code (Camel Case is allowed).\n\nDefault is S.\n\nC is the slowest to load due to the need to split each line based upon code splitting rules.\n\nNote: this settings does not apply to inline dictionaries or `.trie` files.",
731
- "markdownDescription": "Type of file:\n- S - single word per line,\n- W - each line can contain one or more words separated by space,\n- C - each line is treated like code (Camel Case is allowed).\n\nDefault is S.\n\nC is the slowest to load due to the need to split each line based upon code splitting rules.\n\nNote: this settings does not apply to inline dictionaries or `.trie` files."
732
- },
733
- "useCompounds": {
734
- "description": "Use Compounds.",
735
- "markdownDescription": "Use Compounds.",
674
+ "supportNonStrictSearches": {
675
+ "default": true,
676
+ "description": "Strip case and accents to allow for case insensitive searches and words without accents.\n\nNote: this setting only applies to word lists. It has no-impact on trie dictionaries.",
677
+ "markdownDescription": "Strip case and accents to allow for case insensitive searches and\nwords without accents.\n\nNote: this setting only applies to word lists. It has no-impact on trie\ndictionaries.",
736
678
  "type": "boolean"
737
679
  },
738
680
  "words": {
@@ -783,6 +725,12 @@
783
725
  "description": "Replacement pairs.",
784
726
  "markdownDescription": "Replacement pairs."
785
727
  },
728
+ "supportNonStrictSearches": {
729
+ "default": true,
730
+ "description": "Strip case and accents to allow for case insensitive searches and words without accents.\n\nNote: this setting only applies to word lists. It has no-impact on trie dictionaries.",
731
+ "markdownDescription": "Strip case and accents to allow for case insensitive searches and\nwords without accents.\n\nNote: this setting only applies to word lists. It has no-impact on trie\ndictionaries.",
732
+ "type": "boolean"
733
+ },
786
734
  "type": {
787
735
  "$ref": "#/definitions/DictionaryFileTypes",
788
736
  "default": "S",
@@ -801,6 +749,33 @@
801
749
  ],
802
750
  "type": "object"
803
751
  },
752
+ "DictionaryDefinitionSimple": {
753
+ "additionalProperties": false,
754
+ "description": "An Empty Dictionary Definition",
755
+ "markdownDescription": "An Empty Dictionary Definition",
756
+ "properties": {
757
+ "description": {
758
+ "description": "Optional description of the contents / purpose of the dictionary.",
759
+ "markdownDescription": "Optional description of the contents / purpose of the dictionary.",
760
+ "type": "string"
761
+ },
762
+ "name": {
763
+ "$ref": "#/definitions/DictionaryId",
764
+ "description": "This is the name of a dictionary.\n\nName Format:\n- Must contain at least 1 number or letter.\n- Spaces are allowed.\n- Leading and trailing space will be removed.\n- Names ARE case-sensitive.\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.",
765
+ "markdownDescription": "This is the name of a dictionary.\n\nName Format:\n- Must contain at least 1 number or letter.\n- Spaces are allowed.\n- Leading and trailing space will be removed.\n- Names ARE case-sensitive.\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`."
766
+ },
767
+ "supportNonStrictSearches": {
768
+ "default": true,
769
+ "description": "Strip case and accents to allow for case insensitive searches and words without accents.\n\nNote: this setting only applies to word lists. It has no-impact on trie dictionaries.",
770
+ "markdownDescription": "Strip case and accents to allow for case insensitive searches and\nwords without accents.\n\nNote: this setting only applies to word lists. It has no-impact on trie\ndictionaries.",
771
+ "type": "boolean"
772
+ }
773
+ },
774
+ "required": [
775
+ "name"
776
+ ],
777
+ "type": "object"
778
+ },
804
779
  "DictionaryFileTypes": {
805
780
  "enum": [
806
781
  "S",
@@ -1239,6 +1214,13 @@
1239
1214
  "markdownDescription": "A list of suggested replacements for words.\nSuggested words provide a way to make preferred suggestions on word replacements.\nTo hint at a preferred change, but not to require it.\n\nFormat of `suggestWords`\n- Single suggestion (possible auto fix)\n - `word: suggestion`\n - `word->suggestion`\n- Multiple suggestions (not auto fixable)\n - `word: first, second, third`\n - `word->first, second, third`",
1240
1215
  "type": "array"
1241
1216
  },
1217
+ "unknownWords": {
1218
+ "$ref": "#/definitions/UnknownWordsChoices",
1219
+ "default": "report-all",
1220
+ "description": "Controls how unknown words are handled.\n\n- `report-all` - Report all unknown words (default behavior)\n- `report-simple` - Report unknown words that have simple spelling errors, typos, and flagged words.\n- `report-common-typos` - Report unknown words that are common typos and flagged words.\n- `report-flagged` - Report unknown words that are flagged.",
1221
+ "markdownDescription": "Controls how unknown words are handled.\n\n- `report-all` - Report all unknown words (default behavior)\n- `report-simple` - Report unknown words that have simple spelling errors, typos, and flagged words.\n- `report-common-typos` - Report unknown words that are common typos and flagged words.\n- `report-flagged` - Report unknown words that are flagged.",
1222
+ "since": "9.1.0"
1223
+ },
1242
1224
  "words": {
1243
1225
  "description": "List of words to be considered correct.",
1244
1226
  "items": {
@@ -1330,6 +1312,7 @@
1330
1312
  },
1331
1313
  "description": "Enable / Disable checking file types (languageIds).\n\nThis setting replaces: {@link Settings.enabledLanguageIds } and {@link Settings.enableFiletypes } .\n\nA Value of:\n- `true` - enable checking for the file type\n- `false` - disable checking for the file type\n\nA file type of `*` is a wildcard that enables all file types.\n\n**Example: enable all file types**\n\n| File Type | Enabled | Comment | | --------- | ------- | ------- | | `*` | `true` | Enable all file types. | | `json` | `false` | Disable checking for json files. |",
1332
1314
  "markdownDescription": "Enable / Disable checking file types (languageIds).\n\nThis setting replaces: {@link Settings.enabledLanguageIds } and {@link Settings.enableFiletypes } .\n\nA Value of:\n- `true` - enable checking for the file type\n- `false` - disable checking for the file type\n\nA file type of `*` is a wildcard that enables all file types.\n\n**Example: enable all file types**\n\n| File Type | Enabled | Comment |\n| --------- | ------- | ------- |\n| `*` | `true` | Enable all file types. |\n| `json` | `false` | Disable checking for json files. |",
1315
+ "since": "8.8.1",
1333
1316
  "title": "Enabled File Types to Check",
1334
1317
  "type": "object"
1335
1318
  },
@@ -1502,6 +1485,13 @@
1502
1485
  "markdownDescription": "The maximum amount of time in milliseconds to generate suggestions for a word.",
1503
1486
  "type": "number"
1504
1487
  },
1488
+ "unknownWords": {
1489
+ "$ref": "#/definitions/UnknownWordsChoices",
1490
+ "default": "report-all",
1491
+ "description": "Controls how unknown words are handled.\n\n- `report-all` - Report all unknown words (default behavior)\n- `report-simple` - Report unknown words that have simple spelling errors, typos, and flagged words.\n- `report-common-typos` - Report unknown words that are common typos and flagged words.\n- `report-flagged` - Report unknown words that are flagged.",
1492
+ "markdownDescription": "Controls how unknown words are handled.\n\n- `report-all` - Report all unknown words (default behavior)\n- `report-simple` - Report unknown words that have simple spelling errors, typos, and flagged words.\n- `report-common-typos` - Report unknown words that are common typos and flagged words.\n- `report-flagged` - Report unknown words that are flagged.",
1493
+ "since": "9.1.0"
1494
+ },
1505
1495
  "usePnP": {
1506
1496
  "default": false,
1507
1497
  "description": "Packages managers like Yarn 2 use a `.pnp.cjs` file to assist in loading packages stored in the repository.\n\nWhen true, the spell checker will search up the directory structure for the existence of a PnP file and load it.",
@@ -1749,6 +1739,17 @@
1749
1739
  },
1750
1740
  "type": "array"
1751
1741
  },
1742
+ "UnknownWordsChoices": {
1743
+ "description": "Possible choices for how to handle unknown words.",
1744
+ "enum": [
1745
+ "report-all",
1746
+ "report-simple",
1747
+ "report-common-typos",
1748
+ "report-flagged"
1749
+ ],
1750
+ "markdownDescription": "Possible choices for how to handle unknown words.",
1751
+ "type": "string"
1752
+ },
1752
1753
  "Version": {
1753
1754
  "anyOf": [
1754
1755
  {
@@ -1848,6 +1849,7 @@
1848
1849
  },
1849
1850
  "description": "Enable / Disable checking file types (languageIds).\n\nThis setting replaces: {@link Settings.enabledLanguageIds } and {@link Settings.enableFiletypes } .\n\nA Value of:\n- `true` - enable checking for the file type\n- `false` - disable checking for the file type\n\nA file type of `*` is a wildcard that enables all file types.\n\n**Example: enable all file types**\n\n| File Type | Enabled | Comment | | --------- | ------- | ------- | | `*` | `true` | Enable all file types. | | `json` | `false` | Disable checking for json files. |",
1850
1851
  "markdownDescription": "Enable / Disable checking file types (languageIds).\n\nThis setting replaces: {@link Settings.enabledLanguageIds } and {@link Settings.enableFiletypes } .\n\nA Value of:\n- `true` - enable checking for the file type\n- `false` - disable checking for the file type\n\nA file type of `*` is a wildcard that enables all file types.\n\n**Example: enable all file types**\n\n| File Type | Enabled | Comment |\n| --------- | ------- | ------- |\n| `*` | `true` | Enable all file types. |\n| `json` | `false` | Disable checking for json files. |",
1852
+ "since": "8.8.1",
1851
1853
  "title": "Enabled File Types to Check",
1852
1854
  "type": "object"
1853
1855
  },
@@ -1870,7 +1872,8 @@
1870
1872
  "features": {
1871
1873
  "$ref": "#/definitions/Features",
1872
1874
  "description": "Configure CSpell features.",
1873
- "markdownDescription": "Configure CSpell features."
1875
+ "markdownDescription": "Configure CSpell features.",
1876
+ "since": "5.16.0"
1874
1877
  },
1875
1878
  "files": {
1876
1879
  "description": "Glob patterns of files to be checked.\n\nGlob patterns are relative to the `globRoot` of the configuration file that defines them.",
@@ -2111,6 +2114,13 @@
2111
2114
  "markdownDescription": "The maximum amount of time in milliseconds to generate suggestions for a word.",
2112
2115
  "type": "number"
2113
2116
  },
2117
+ "unknownWords": {
2118
+ "$ref": "#/definitions/UnknownWordsChoices",
2119
+ "default": "report-all",
2120
+ "description": "Controls how unknown words are handled.\n\n- `report-all` - Report all unknown words (default behavior)\n- `report-simple` - Report unknown words that have simple spelling errors, typos, and flagged words.\n- `report-common-typos` - Report unknown words that are common typos and flagged words.\n- `report-flagged` - Report unknown words that are flagged.",
2121
+ "markdownDescription": "Controls how unknown words are handled.\n\n- `report-all` - Report all unknown words (default behavior)\n- `report-simple` - Report unknown words that have simple spelling errors, typos, and flagged words.\n- `report-common-typos` - Report unknown words that are common typos and flagged words.\n- `report-flagged` - Report unknown words that are flagged.",
2122
+ "since": "9.1.0"
2123
+ },
2114
2124
  "useGitignore": {
2115
2125
  "default": false,
2116
2126
  "description": "Tells the spell checker to load `.gitignore` files and skip files that match the globs in the `.gitignore` files found.",
@@ -1,127 +1,2 @@
1
- type ParserOptions = Record<string, unknown>;
2
- type ParserName = string;
3
- interface Parser {
4
- /** Name of parser */
5
- readonly name: ParserName;
6
- /**
7
- * Parse Method
8
- * @param content - full content of the file
9
- * @param filename - filename
10
- */
11
- parse(content: string, filename: string): ParseResult;
12
- }
13
- interface ParseResult {
14
- readonly content: string;
15
- readonly filename: string;
16
- readonly parsedTexts: Iterable<ParsedText>;
17
- }
18
- interface ParsedText {
19
- /**
20
- * The text extracted and possibly transformed
21
- */
22
- readonly text: string;
23
- /**
24
- * The raw text before it has been transformed
25
- */
26
- readonly rawText?: string | undefined;
27
- /**
28
- * start and end offsets of the text
29
- */
30
- readonly range: Range;
31
- /**
32
- * The Scope annotation for a segment of text.
33
- * Used by the spell checker to apply spell checking options
34
- * based upon the value of the scope.
35
- */
36
- readonly scope?: Scope | undefined;
37
- /**
38
- * The source map is used to support text transformations.
39
- *
40
- * See: {@link SourceMap}
41
- */
42
- readonly map?: SourceMap | undefined;
43
- /**
44
- * Used to delegate parsing the contents of `text` to another parser.
45
- *
46
- */
47
- readonly delegate?: DelegateInfo | undefined;
48
- }
49
- /**
50
- * A SourceMap is used to map transform a piece of text back to its original text.
51
- * This is necessary in order to report the correct location of a spelling issue.
52
- * An empty source map indicates that it was a 1:1 transformation.
53
- *
54
- * The values in a source map are number pairs (even, odd) relative to the beginning of each
55
- * string segment.
56
- * - even - offset in the source text
57
- * - odd - offset in the transformed text
58
- *
59
- * Offsets start a 0
60
- *
61
- * Example:
62
- *
63
- * - Original text: `Grand Caf\u00e9 Bj\u00f8rvika`
64
- * - Transformed text: `Grand Café Bjørvika`
65
- * - Map: [9, 9, 15, 10, 18, 13, 24, 14]
66
- *
67
- * | offset | original | offset | transformed |
68
- * | ------ | ----------- | ------ | ----------- |
69
- * | 0-9 | `Grand Caf` | 0-9 | `Grand Caf` |
70
- * | 9-15 | `\u00e9` | 9-10 | `é` |
71
- * | 15-18 | ` Bj` | 10-13 | ` Bj` |
72
- * | 18-24 | `\u00f8` | 13-14 | `ø` |
73
- * | 24-29 | `rvika` | 14-19 | `rvika` |
74
- *
75
- * <!--- cspell:ignore Bjørvika rvika --->
76
- */
77
- type SourceMap = number[];
78
- type Range = readonly [start: number, end: number];
79
- /**
80
- * DelegateInfo is used by a parser to delegate parsing a subsection of a document to
81
- * another parser. The following information is used by the spell checker to match
82
- * the parser.
83
- */
84
- interface DelegateInfo {
85
- /**
86
- * Proposed virtual file name including the extension.
87
- * Format: `./${source_filename}/${block_number}.${ext}
88
- * Example: `./README.md/1.js`
89
- */
90
- readonly filename: string;
91
- /**
92
- * The filename of the origin of the virtual file block.
93
- * Example: `./README.md`
94
- */
95
- readonly originFilename: string;
96
- /**
97
- * Proposed file extension
98
- * Example: `.js`
99
- */
100
- readonly extension: string;
101
- /**
102
- * Filetype to use
103
- * Example: `javascript`
104
- */
105
- readonly fileType?: string;
106
- }
107
- /**
108
- * Scope - chain of scope going from local to global
109
- *
110
- * Example:
111
- * ```
112
- * `comment.block.documentation.ts` -> `meta.interface.ts` -> `source.ts`
113
- * ```
114
- */
115
- interface ScopeChain {
116
- readonly value: string;
117
- readonly parent?: ScopeChain | undefined;
118
- }
119
- /**
120
- * A string representing a scope chain separated by spaces
121
- *
122
- * Example: `comment.block.documentation.ts meta.interface.ts source.ts`
123
- */
124
- type ScopeString = string;
125
- type Scope = ScopeChain | ScopeString;
126
-
127
- export type { DelegateInfo, ParseResult, ParsedText, Parser, ParserName, ParserOptions, Range, Scope, ScopeChain, ScopeString, SourceMap };
1
+ import { DelegateInfo, ParseResult, ParsedText, Parser, ParserName, ParserOptions, Range, Scope, ScopeChain, ScopeString, SourceMap } from "../index-B8R3-rR5.mjs";
2
+ export { DelegateInfo, ParseResult, ParsedText, Parser, ParserName, ParserOptions, Range, Scope, ScopeChain, ScopeString, SourceMap };