-
-
Notifications
You must be signed in to change notification settings - Fork 122
/
spell-checker-config.schema.json
1806 lines (1806 loc) · 94.2 KB
/
spell-checker-config.schema.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {},
"items": [
{
"additionalProperties": false,
"order": 0,
"properties": {
"cSpell.enabled": {
"default": true,
"description": "Enable / Disable the spell checker.",
"scope": "resource",
"type": "boolean"
}
},
"title": "Code Spell Checker",
"type": "object"
},
{
"additionalProperties": false,
"order": 18,
"properties": {
"cSpell.advanced.feature.useReferenceProviderRemove": {
"markdownDescription": "Used to work around bugs in Reference Providers and Rename Providers.\nAnything matching the provided Regular Expression will be removed from the text\nbefore sending it to the Rename Provider.\n\nSee: [Markdown: Fixing spelling issues in Header sections changes the entire line · Issue #1987](https://github.com/streetsidesoftware/vscode-spell-checker/issues/1987)\n\nIt is unlikely that you would need to edit this setting. If you need to, please open an issue at\n[Spell Checker Issues](https://github.com/streetsidesoftware/vscode-spell-checker/issues)\n\nThis feature is used in connection with `#cSpell.advanced.feature.useReferenceProviderWithRename#`",
"scope": "language-overridable",
"title": "Remove Matching Characters Before Rename",
"type": "string"
},
"cSpell.advanced.feature.useReferenceProviderWithRename": {
"default": false,
"markdownDescription": "Use the Reference Provider when fixing spelling issues with the Rename Provider.\nThis feature is used in connection with `#cSpell.fixSpellingWithRenameProvider#`",
"scope": "language-overridable",
"title": "Use Reference Provider During Rename",
"type": "boolean"
},
"cSpell.fixSpellingWithRenameProvider": {
"default": true,
"markdownDescription": "Use Rename Provider when fixing spelling issues.",
"scope": "language-overridable",
"type": "boolean"
},
"cSpell.logFile": {
"description": "Have the logs written to a file instead of to VS Code.",
"scope": "window",
"title": "Write Logs to a File",
"type": "string"
},
"cSpell.logLevel": {
"default": "Error",
"description": "Set the Debug Level for logging messages.",
"enum": [
"None",
"Error",
"Warning",
"Information",
"Debug"
],
"enumDescriptions": [
"Do not log",
"Log only errors",
"Log errors and warnings",
"Log errors, warnings, and info",
"Log everything (noisy)"
],
"scope": "window",
"title": "Set Logging Level",
"type": "string"
}
},
"title": "Advanced",
"type": "object"
},
{
"additionalProperties": false,
"order": 5,
"properties": {
"cSpell.ignoreRegExpList": {
"description": "",
"items": {
"description": "A PatternRef is a Pattern or PatternId.",
"type": "string"
},
"markdownDescription": "List of regular expressions or Pattern names (defined in `#cSpell.patterns#`) to exclude from spell checking.\n\n- When using the VS Code Preferences UI, it is not necessary to escape the `\\`, VS Code takes care of that.\n- When editing the VS Code `settings.json` file,\n it is necessary to escape `\\`.\n Each `\\` becomes `\\\\`.\n\nThe default regular expression flags are `gi`. Add `u` (`gui`), to enable Unicode.\n\n| VS Code UI | JSON | Description |\n| :------------------ | :-------------------- | :------------------------------------------- |\n| `/\\\\[a-z]+/gi` | `/\\\\\\\\[a-z]+/gi` | Exclude LaTeX command like `\\mapsto` |\n| `/\\b[A-Z]{3,5}\\b/g` | `/\\\\b[A-Z]{3,5}\\\\b/g` | Exclude full-caps acronyms of 3-5 length. |\n| `CStyleComment` | `CStyleComment` | A built in pattern |",
"scope": "resource",
"type": "array"
},
"cSpell.includeRegExpList": {
"description": "",
"items": {
"description": "A PatternRef is a Pattern or PatternId.",
"type": "string"
},
"markdownDescription": "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.",
"scope": "resource",
"type": "array"
},
"cSpell.overrides": {
"description": "",
"items": {
"additionalProperties": false,
"properties": {
"allowCompoundWords": {
"default": false,
"description": "True to enable compound word checking. See [Case Sensitivity](https://cspell.org/docs/case-sensitive/) for more details.",
"type": "boolean"
},
"caseSensitive": {
"default": false,
"description": "Determines if words must match case and accent rules.\n\n- `false` - Case is ignored and accents can be missing on the entire word. Incorrect accents or partially missing accents will be marked as incorrect.\n- `true` - Case and accents are enforced.",
"type": "boolean"
},
"description": {
"description": "Optional description of configuration.",
"type": "string"
},
"dictionaries": {
"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"
},
"type": "array"
},
"dictionaryDefinitions": {
"description": "Define additional available dictionaries.",
"items": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"description": {
"description": "Optional description.",
"type": "string"
},
"name": {
"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 `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.",
"type": "string"
},
"noSuggest": {
"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.",
"type": "boolean"
},
"path": {
"description": "Path to the file.",
"type": "string"
}
},
"required": [
"path",
"name"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"addWords": {
"description": "When `true`, let's the spell checker know that words can be added to this dictionary.",
"type": "boolean"
},
"description": {
"description": "Optional description.",
"type": "string"
},
"name": {
"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 `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.",
"type": "string"
},
"noSuggest": {
"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.",
"type": "boolean"
},
"path": {
"description": "Path to custom dictionary text file.",
"type": "string"
},
"scope": {
"anyOf": [
{
"description": "Specifies the scope of a dictionary.",
"enum": [
"user",
"workspace",
"folder"
],
"type": "string"
},
{
"items": {
"description": "Specifies the scope of a dictionary.",
"enum": [
"user",
"workspace",
"folder"
],
"type": "string"
},
"type": "array"
}
],
"description": "Defines the scope for when words will be added to the dictionary. Scope values: `user`, `workspace`, `folder`."
}
},
"required": [
"path",
"addWords",
"name"
],
"type": "object"
}
]
},
"scope": "resource",
"type": "array"
},
"enableFiletypes": {
"items": {
"description": "This can be '*', 'typescript', 'cpp', 'json', etc.",
"pattern": "^(!?[-\\w_\\s]+)|(\\*)$",
"type": "string"
},
"markdownDescription": "Enable / Disable checking file types (languageIds).\nThese are in additional to the file types specified by `cSpell.enabledLanguageIds`.\nTo disable a language, prefix with `!` as in `!json`,\n\nExample:\n```\njsonc // enable checking for jsonc\n!json // disable checking for json\nkotlin // enable checking for kotlin\n```",
"scope": "resource",
"title": "File Types to Check",
"type": "array",
"uniqueItems": true
},
"enabled": {
"default": true,
"description": "Is the spell checker enabled.",
"type": "boolean"
},
"enabledLanguageIds": {
"description": "languageIds for the files to spell check.",
"items": {
"description": "This can be '*', 'typescript', 'cpp', 'json', etc.",
"pattern": "^(!?[-\\w_\\s]+)|(\\*)$",
"type": "string"
},
"type": "array"
},
"filename": {
"anyOf": [
{
"description": "These are glob expressions.",
"type": "string"
},
{
"items": {
"description": "These are glob expressions.",
"type": "string"
},
"type": "array"
}
],
"description": "Glob pattern or patterns to match against."
},
"flagWords": {
"description": "List of words to always be considered incorrect.",
"items": {
"type": "string"
},
"type": "array"
},
"id": {
"description": "Optional identifier.",
"type": "string"
},
"ignoreRegExpList": {
"description": "List of regular expression patterns or pattern names to exclude from spell checking.\n\nExample: [\"href\"] - to exclude html href.\n\nBy default, several patterns are excluded. See [Configuration](https://cspell.org/configuration/#cspelljson-sections) for more details.\n\nWhile you can create your own patterns, you can also leverage several patterns that are [built-in to CSpell](https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-lib/src/Settings/DefaultSettings.ts#L22).",
"items": {
"description": "A PatternRef is a Pattern or PatternId.",
"type": "string"
},
"type": "array"
},
"ignoreWords": {
"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`.",
"items": {
"type": "string"
},
"type": "array"
},
"includeRegExpList": {
"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://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-lib/src/Settings/DefaultSettings.ts#L22).",
"items": {
"description": "A PatternRef is a Pattern or PatternId.",
"type": "string"
},
"type": "array"
},
"language": {
"description": "Sets the locale.",
"type": "string"
},
"languageId": {
"description": "Sets the programming language id.",
"type": "string"
},
"languageSettings": {
"description": "Additional settings for individual programming languages and locales.",
"items": {
"additionalProperties": false,
"properties": {
"allowCompoundWords": {
"default": false,
"description": "True to enable compound word checking. See [Case Sensitivity](https://cspell.org/docs/case-sensitive/) for more details.",
"type": "boolean"
},
"caseSensitive": {
"default": false,
"description": "Determines if words must match case and accent rules.\n\n- `false` - Case is ignored and accents can be missing on the entire word. Incorrect accents or partially missing accents will be marked as incorrect.\n- `true` - Case and accents are enforced.",
"type": "boolean"
},
"description": {
"description": "Optional description of configuration.",
"type": "string"
},
"dictionaries": {
"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"
},
"type": "array"
},
"dictionaryDefinitions": {
"description": "Define additional available dictionaries.",
"items": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"description": {
"description": "Optional description.",
"type": "string"
},
"name": {
"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 `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.",
"type": "string"
},
"noSuggest": {
"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.",
"type": "boolean"
},
"path": {
"description": "Path to the file.",
"type": "string"
}
},
"required": [
"path",
"name"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"addWords": {
"description": "When `true`, let's the spell checker know that words can be added to this dictionary.",
"type": "boolean"
},
"description": {
"description": "Optional description.",
"type": "string"
},
"name": {
"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 `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.",
"type": "string"
},
"noSuggest": {
"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.",
"type": "boolean"
},
"path": {
"description": "Path to custom dictionary text file.",
"type": "string"
},
"scope": {
"anyOf": [
{
"description": "Specifies the scope of a dictionary.",
"enum": [
"user",
"workspace",
"folder"
],
"type": "string"
},
{
"items": {
"description": "Specifies the scope of a dictionary.",
"enum": [
"user",
"workspace",
"folder"
],
"type": "string"
},
"type": "array"
}
],
"description": "Defines the scope for when words will be added to the dictionary. Scope values: `user`, `workspace`, `folder`."
}
},
"required": [
"path",
"addWords",
"name"
],
"type": "object"
}
]
},
"scope": "resource",
"type": "array"
},
"enabled": {
"default": true,
"description": "Is the spell checker enabled.",
"type": "boolean"
},
"flagWords": {
"description": "List of words to always be considered incorrect.",
"items": {
"type": "string"
},
"type": "array"
},
"id": {
"description": "Optional identifier.",
"type": "string"
},
"ignoreRegExpList": {
"description": "List of regular expression patterns or pattern names to exclude from spell checking.\n\nExample: [\"href\"] - to exclude html href.\n\nBy default, several patterns are excluded. See [Configuration](https://cspell.org/configuration/#cspelljson-sections) for more details.\n\nWhile you can create your own patterns, you can also leverage several patterns that are [built-in to CSpell](https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-lib/src/Settings/DefaultSettings.ts#L22).",
"items": {
"description": "A PatternRef is a Pattern or PatternId.",
"type": "string"
},
"type": "array"
},
"ignoreWords": {
"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`.",
"items": {
"type": "string"
},
"type": "array"
},
"includeRegExpList": {
"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://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-lib/src/Settings/DefaultSettings.ts#L22).",
"items": {
"description": "A PatternRef is a Pattern or PatternId.",
"type": "string"
},
"type": "array"
},
"languageId": {
"anyOf": [
{
"description": "This can be '*', 'typescript', 'cpp', 'json', etc.",
"pattern": "^(!?[-\\w_\\s]+)|(\\*)$",
"type": "string"
},
{
"description": "This can be 'typescript,cpp,json,literal haskell', etc.",
"pattern": "^([-\\w_\\s]+)(,[-\\w_\\s]+)*$",
"type": "string"
},
{
"description": "This can be 'typescript,cpp,json,literal haskell', etc.",
"pattern": "^(![-\\w_\\s]+)(,![-\\w_\\s]+)*$",
"type": "string"
},
{
"items": {
"description": "This can be '*', 'typescript', 'cpp', 'json', etc.",
"pattern": "^(!?[-\\w_\\s]+)|(\\*)$",
"type": "string"
},
"type": "array"
}
],
"description": "The language id. Ex: \"typescript\", \"html\", or \"php\". \"*\" -- will match all languages."
},
"locale": {
"anyOf": [
{
"description": "This is a written language locale like: 'en', 'en-GB', 'fr', 'es', 'de', etc.",
"type": "string"
},
{
"items": {
"description": "This is a written language locale like: 'en', 'en-GB', 'fr', 'es', 'de', etc.",
"type": "string"
},
"type": "array"
}
],
"description": "The locale filter, matches against the language. This can be a comma separated list. \"*\" will match all locales."
},
"name": {
"description": "Optional name of configuration.",
"type": "string"
},
"noSuggestDictionaries": {
"description": "Optional list of dictionaries that will not be used for suggestions. Words in these dictionaries 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 one of these dictionaries, it will be removed from the set of possible suggestions.",
"items": {
"description": "Reference to a dictionary by name. One of:\n- {@link DictionaryRef } \n- {@link DictionaryNegRef }",
"type": "string"
},
"type": "array"
},
"patterns": {
"description": "Defines a list of patterns that can be used with the `ignoreRegExpList` and `includeRegExpList` options.\n\nFor example:\n\n```javascript \"ignoreRegExpList\": [\"comments\"], \"patterns\": [ { \"name\": \"comment-single-line\", \"pattern\": \"/#.*/g\" }, { \"name\": \"comment-multi-line\", \"pattern\": \"/(?:\\\\/\\\\*[\\\\s\\\\S]*?\\\\*\\\\/)/g\" }, // You can also combine multiple named patterns into one single named pattern { \"name\": \"comments\", \"pattern\": [\"comment-single-line\", \"comment-multi-line\"] } ] ```",
"items": {
"additionalProperties": false,
"properties": {
"description": {
"description": "Description of the pattern.",
"type": "string"
},
"name": {
"description": "Pattern name, used as an identifier in ignoreRegExpList and includeRegExpList. It is possible to redefine one of the predefined patterns to override its value.",
"type": "string"
},
"pattern": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"description": "RegExp pattern or array of RegExp patterns."
}
},
"required": [
"name",
"pattern"
],
"type": "object"
},
"type": "array"
},
"words": {
"description": "List of words to be always considered correct.",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"languageId"
],
"type": "object"
},
"scope": "resource",
"type": "array"
},
"loadDefaultConfiguration": {
"default": true,
"description": "By default, the bundled dictionary configurations are loaded. Explicitly setting this to `false` will prevent ALL default configuration from being loaded.",
"type": "boolean"
},
"maxDuplicateProblems": {
"default": 5,
"description": "The maximum number of times the same word can be flagged as an error in a file.",
"type": "number"
},
"maxNumberOfProblems": {
"default": 100,
"description": "The maximum number of problems to report in a file.",
"type": "number"
},
"minWordLength": {
"default": 4,
"description": "The minimum length of a word before checking it against a dictionary.",
"type": "number"
},
"name": {
"description": "Optional name of configuration.",
"type": "string"
},
"noSuggestDictionaries": {
"description": "Optional list of dictionaries that will not be used for suggestions. Words in these dictionaries 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 one of these dictionaries, it will be removed from the set of possible suggestions.",
"items": {
"description": "Reference to a dictionary by name. One of:\n- {@link DictionaryRef } \n- {@link DictionaryNegRef }",
"type": "string"
},
"type": "array"
},
"numSuggestions": {
"default": 10,
"description": "Number of suggestions to make.",
"type": "number"
},
"patterns": {
"description": "Defines a list of patterns that can be used with the `ignoreRegExpList` and `includeRegExpList` options.\n\nFor example:\n\n```javascript \"ignoreRegExpList\": [\"comments\"], \"patterns\": [ { \"name\": \"comment-single-line\", \"pattern\": \"/#.*/g\" }, { \"name\": \"comment-multi-line\", \"pattern\": \"/(?:\\\\/\\\\*[\\\\s\\\\S]*?\\\\*\\\\/)/g\" }, // You can also combine multiple named patterns into one single named pattern { \"name\": \"comments\", \"pattern\": [\"comment-single-line\", \"comment-multi-line\"] } ] ```",
"items": {
"additionalProperties": false,
"properties": {
"description": {
"description": "Description of the pattern.",
"type": "string"
},
"name": {
"description": "Pattern name, used as an identifier in ignoreRegExpList and includeRegExpList. It is possible to redefine one of the predefined patterns to override its value.",
"type": "string"
},
"pattern": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"description": "RegExp pattern or array of RegExp patterns."
}
},
"required": [
"name",
"pattern"
],
"type": "object"
},
"type": "array"
},
"pnpFiles": {
"default": [
".pnp.js",
".pnp.cjs"
],
"description": "The PnP files to search for. Note: `.mjs` files are not currently supported.",
"items": {
"type": "string"
},
"type": "array"
},
"suggestionNumChanges": {
"default": 3,
"description": "The maximum number of changes allowed on a word to be considered a suggestions.\n\nFor example, appending an `s` onto `example` -> `examples` is considered 1 change.\n\nRange: between 1 and 5.",
"type": "number"
},
"suggestionsTimeout": {
"default": 500,
"description": "The maximum amount of time in milliseconds to generate suggestions for a word.",
"type": "number"
},
"usePnP": {
"default": false,
"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.",
"type": "boolean"
},
"words": {
"description": "List of words to be always considered correct.",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"filename"
],
"type": "object"
},
"markdownDescription": "Overrides are used to apply settings for specific files in your project.\n\n**Example:**\n\n```jsonc\n\"cSpell.overrides\": [\n // Force `*.hrr` and `*.crr` files to be treated as `cpp` files:\n {\n \"filename\": \"**/{*.hrr,*.crr}\",\n \"languageId\": \"cpp\"\n },\n // Force `dutch/**/*.txt` to be treated as Dutch (dictionary needs to be installed separately):\n {\n \"filename\": \"**/dutch/**/*.txt\",\n \"language\": \"nl\"\n }\n]\n```",
"scope": "resource",
"type": "array"
},
"cSpell.patterns": {
"description": "",
"items": {
"additionalProperties": false,
"properties": {
"description": {
"description": "Description of the pattern.",
"type": "string"
},
"name": {
"description": "Pattern name, used as an identifier in ignoreRegExpList and includeRegExpList. It is possible to redefine one of the predefined patterns to override its value.",
"type": "string"
},
"pattern": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"description": "RegExp pattern or array of RegExp patterns."
}
},
"required": [
"name",
"pattern"
],
"type": "object"
},
"markdownDescription": "Defines a list of patterns that can be used with the `#cSpell.ignoreRegExpList#` and\n`#cSpell.includeRegExpList#` options.\n\n**Example:**\n\n```jsonc\n\"cSpell.patterns\": [\n {\n \"name\": \"comment-single-line\",\n \"pattern\": \"/#.*/g\"\n },\n {\n \"name\": \"comment-multi-line\",\n \"pattern\": \"/(?:\\\\/\\\\*[\\\\s\\\\S]*?\\\\*\\\\/)/g\"\n }\n]\n```",
"scope": "resource",
"type": "array"
}
},
"title": "CSpell",
"type": "object"
},
{
"additionalProperties": false,
"order": 19,
"properties": {
"cSpell.experimental.enableRegexpView": {
"default": false,
"description": "Show Regular Expression Explorer",
"scope": "application",
"type": "boolean"
}
},
"title": "Experimental",
"type": "object"
},
{
"additionalProperties": false,
"order": 3,
"properties": {
"cSpell.allowedSchemas": {
"default": [
"file",
"gist",
"sftp",
"untitled",
"vscode",
"vscode-notebook-cell",
"vscode-userdata"
],
"items": {
"type": "string"
},
"markdownDescription": "Control which file schemas will be checked for spelling (VS Code must be restarted for this setting to take effect).\n\n\nSome schemas have special meaning like:\n- `untitled` - Used for new documents that have not yet been saved\n- `vscode-notebook-cell` - Used for validating segments of a Notebook.\n- `vscode-userdata` - Needed to spell check `.code-snippets`",
"scope": "window",
"title": "Define Allowed Schemas",
"type": "array"
},
"cSpell.checkOnlyEnabledFileTypes": {
"default": true,
"markdownDescription": "By default, the spell checker checks only enabled file types. Use `#cSpell.enableFiletypes#`\nto turn on / off various file types.\n\nWhen this setting is `false`, all file types are checked except for the ones disabled by `#cSpell.enableFiletypes#`.\nSee `#cSpell.enableFiletypes#` on how to disable a file type.",
"scope": "resource",
"title": "Check Only Enabled File Types",
"type": "boolean"
},
"cSpell.enableFiletypes": {
"items": {
"markdownDescription": "Enable / Disable checking file types (languageIds).\nTo disable a language, prefix with `!` as in `!json`,\n\n\nExample:\n```\njsonc // enable checking for jsonc\n!json // disable checking for json\nkotlin // enable checking for kotlin\n```",
"pattern": "(^!*(?!\\s)[\\s\\w_.\\-]+$)|(^!*[*]$)",
"patternErrorMessage": "Allowed characters are `a-zA-Z`, `.`, `-`, `_` and space.",
"type": "string"
},
"markdownDescription": "Enable / Disable checking file types (languageIds).\n\nThese are in additional to the file types specified by `#cSpell.enabledLanguageIds#`.\nTo disable a language, prefix with `!` as in `!json`,\n\n\n**Example: individual file types**\n\n```\njsonc // enable checking for jsonc\n!json // disable checking for json\nkotlin // enable checking for kotlin\n```\n\n**Example: enable all file types**\n\n```\n* // enable checking for all file types\n!json // except for json\n```",
"scope": "resource",
"title": "File Types to Check",
"type": "array",
"uniqueItems": true
},
"cSpell.files": {
"description": "",
"items": {
"description": "These are glob expressions.",
"type": "string"
},
"markdownDescription": "Glob patterns of files to be checked.\nGlob patterns are relative to the `#cSpell.globRoot#` of the configuration file that defines them.",
"scope": "resource",
"type": "array"
},
"cSpell.globRoot": {
"description": "",
"markdownDescription": "The root to use for glop patterns found in this configuration.\nDefault: The current workspace folder.\nUse `globRoot` to define a different location. `globRoot` can be relative to the location of this configuration file.\nDefining globRoot, does not impact imported configurations.\n\nSpecial Values:\n\n- `${workspaceFolder}` - Default - globs will be relative to the current workspace folder\\n\n- `${workspaceFolder:<name>}` - Where `<name>` is the name of the workspace folder.",
"scope": "resource",
"type": "string"
},
"cSpell.ignorePaths": {
"default": [
"package-lock.json",
"node_modules",
"vscode-extension",
".git/objects",
".vscode",
".vscode-insiders"
],
"description": "Glob patterns of files to be ignored.\n\nGlob patterns are relative to the `globRoot` of the configuration file that defines them.",
"items": {
"description": "Simple Glob string, the root will be globRoot.",
"type": "string"
},
"markdownDescription": "Glob patterns of files to be ignored. The patterns are relative to the `#cSpell.globRoot#` of the configuration file that defines them.",
"scope": "resource",
"title": "Glob patterns of files to be ignored",
"type": "array"
},
"cSpell.import": {
"description": "",
"items": {
"description": "A File System Path. Relative paths are relative to the configuration file.",
"type": "string"
},
"markdownDescription": "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.",
"scope": "resource",
"type": "array"
},
"cSpell.noConfigSearch": {
"description": "Prevents searching for local configuration when checking individual documents.",
"scope": "resource",
"type": "boolean"
},
"cSpell.spellCheckOnlyWorkspaceFiles": {
"default": false,
"markdownDescription": "Only spell check files that are in the currently open workspace.\nThis same effect can be achieved using the `#cSpell.files#` setting.\n\n\n```js\n\"cSpell.files\": [\"**\"]\n```",
"scope": "window",
"title": "Spell Check Only Workspace Files",
"type": "boolean"
},
"cSpell.useGitignore": {
"default": true,
"description": "Tells the spell checker to load `.gitignore` files and skip files that match the globs in the `.gitignore` files found.",
"scope": "window",
"type": "boolean"
},
"cSpell.usePnP": {
"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.",
"scope": "resource",
"type": "boolean"
},
"cSpell.workspaceRootPath": {
"markdownDescription": "Define the path to the workspace root folder in a multi-root workspace.\nBy default it is the first folder.\n\nThis is used to find the `cspell.json` file for the workspace.\n\n\n**Example: use the `client` folder**\n```\n${workspaceFolder:client}\n```",
"scope": "resource",
"title": "Workspace Root Folder Path",
"type": "string"
}
},
"title": "Files, Folders, and Workspaces",
"type": "object"
},
{
"additionalProperties": false,
"order": 1,
"properties": {
"cSpell.caseSensitive": {
"description": "",
"markdownDescription": "Determines if words must match case and accent rules.\n\n- `false` - Case is ignored and accents can be missing on the entire word.\n Incorrect accents or partially missing accents will be marked as incorrect.\n Note: Some languages like Portuguese have case sensitivity turned on by default.\n You must use `#cSpell.languageSettings#` to turn it off.\n- `true` - Case and accents are enforced by default.",
"scope": "resource",
"type": "boolean"
},
"cSpell.customDictionaries": {
"additionalProperties": {
"anyOf": [
{
"markdownDescription": "- `true` - turn on the named dictionary\n- `false` - turn off the named dictionary",
"title": "Named dictionary to be enabled / disabled",
"type": "boolean"
},
{
"additionalProperties": false,
"markdownDescription": "Define a custom dictionary to be included.",
"properties": {
"addWords": {
"default": true,
"markdownDescription": "Indicate if this custom dictionary should be used to store added words.",
"title": "Add Words to Dictionary",
"type": "boolean"
},
"description": {
"markdownDescription": "Optional: A human readable description.",
"title": "Description of the Dictionary",
"type": "string"
},
"name": {
"markdownDescription": "The reference name of the dictionary.\n\n\nExample: `My Words` or `custom`\n\n\nIf they name matches a pre-defined dictionary, it will override the pre-defined dictionary.\nIf you use: `typescript` it will replace the built-in TypeScript dictionary.",
"title": "Name of Dictionary",
"type": "string"
},
"path": {
"markdownDescription": "Define the path to the dictionary text file.\n\n\n**Note:** if path is `undefined` the `name`d dictionary is expected to be found\nin the `dictionaryDefinitions`.\n\n\nFile Format: Each line in the file is considered a dictionary entry.\n\n\nCase is preserved while leading and trailing space is removed.\n\n\nThe path should be absolute, or relative to the workspace.\n\n\n**Example:** relative to User's folder\n\n```\n~/dictionaries/custom_dictionary.txt\n```\n\n\n**Example:** relative to the `client` folder in a multi-root workspace\n\n```\n${workspaceFolder:client}/build/custom_dictionary.txt\n```\n\n\n**Example:** relative to the current workspace folder in a single-root workspace\n\n**Note:** this might no as expected in a multi-root workspace since it is based upon the relative\nworkspace for the currently open file.\n\n```\n${workspaceFolder}/build/custom_dictionary.txt\n```\n\n\n**Example:** relative to the workspace folder in a single-root workspace or the first folder in\na multi-root workspace\n\n```\n./build/custom_dictionary.txt\n```",
"title": "Path to Dictionary Text File",
"type": "string"
},
"scope": {
"anyOf": [
{
"description": "Specifies the scope of a dictionary.",
"enum": [
"user",
"workspace",
"folder"
],
"type": "string"
},
{
"items": {
"description": "Specifies the scope of a dictionary.",
"enum": [
"user",
"workspace",
"folder"
],
"type": "string"
},
"type": "array"
}
],
"markdownDescription": "Options are\n- `user` - words that apply to all projects and workspaces\n- `workspace` - words that apply to the entire workspace\n- `folder` - words that apply to only a workspace folder",
"title": "Scope of dictionary"
}
},
"title": "Custom Dictionary Entry",
"type": "object"
}
]
},
"markdownDescription": "Define custom dictionaries to be included by default.\nIf `addWords` is `true` words will be added to this dictionary.\n\n\n**Example:**\n\n```js\n\"cSpell.customDictionaries\": {\n \"project-words\": {\n \"name\": \"project-words\",\n \"path\": \"${workspaceRoot}/project-words.txt\",\n \"description\": \"Words used in this project\",\n \"addWords\": true\n },\n \"custom\": true, // Enable the `custom` dictionary\n \"internal-terms\": false // Disable the `internal-terms` dictionary\n}\n```",
"scope": "resource",
"title": "Custom Dictionaries",
"type": "object"
},
"cSpell.dictionaries": {
"description": "",
"items": {
"description": "Reference to a dictionary by name. One of:\n- {@link DictionaryRef } \n- {@link DictionaryNegRef }",
"type": "string"
},
"markdownDescription": "Optional list of dictionaries to use.\nEach entry should match the name of the dictionary.\nTo remove a dictionary from the list add `!` before the name.\ni.e. `!typescript` will turn off the dictionary with the name `typescript`.",
"scope": "resource",
"type": "array"
},
"cSpell.dictionaryDefinitions": {
"description": "Define additional available dictionaries.",
"items": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"description": {
"description": "Optional description.",
"type": "string"
},
"name": {
"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 `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.",
"type": "string"
},
"noSuggest": {
"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.",
"type": "boolean"
},
"path": {
"description": "Path to the file.",
"type": "string"
}
},
"required": [
"path",
"name"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"addWords": {
"description": "When `true`, let's the spell checker know that words can be added to this dictionary.",
"type": "boolean"
},
"description": {
"description": "Optional description.",
"type": "string"
},
"name": {
"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 `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.",
"type": "string"
},
"noSuggest": {
"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.",
"type": "boolean"
},
"path": {
"description": "Path to custom dictionary text file.",
"type": "string"