-
-
Notifications
You must be signed in to change notification settings - Fork 91
/
cspell.schema.json
2090 lines (2090 loc) · 137 KB
/
cspell.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#",
"additionalProperties": false,
"allowTrailingCommas": true,
"definitions": {
"CacheFormat": {
"enum": [
"legacy",
"universal"
],
"type": "string"
},
"CacheSettings": {
"additionalProperties": false,
"properties": {
"cacheFormat": {
"$ref": "#/definitions/CacheFormat",
"default": "legacy",
"description": "Format of the cache file.\n- `legacy` - use absolute paths in the cache file\n- `universal` - use a sharable format.",
"markdownDescription": "Format of the cache file.\n- `legacy` - use absolute paths in the cache file\n- `universal` - use a sharable format."
},
"cacheLocation": {
"$ref": "#/definitions/FSPathResolvable",
"description": "Path to the cache location. Can be a file or a directory. If none specified `.cspellcache` will be used. Relative paths are relative to the config file in which it is defined.\n\nA prefix of `${cwd}` is replaced with the current working directory.",
"markdownDescription": "Path to the cache location. Can be a file or a directory.\nIf none specified `.cspellcache` will be used.\nRelative paths are relative to the config file in which it\nis defined.\n\nA prefix of `${cwd}` is replaced with the current working directory."
},
"cacheStrategy": {
"$ref": "#/definitions/CacheStrategy",
"default": "metadata",
"description": "Strategy to use for detecting changed files, default: metadata",
"markdownDescription": "Strategy to use for detecting changed files, default: metadata"
},
"useCache": {
"default": false,
"description": "Store the results of processed files in order to only operate on the changed ones.",
"markdownDescription": "Store the results of processed files in order to only operate on the changed ones.",
"type": "boolean"
}
},
"type": "object"
},
"CacheStrategy": {
"description": "The Strategy to use to detect if a file has changed.\n- `metadata` - uses the file system timestamp and size to detect changes (fastest).\n- `content` - uses a hash of the file content to check file changes (slower - more accurate).",
"enum": [
"metadata",
"content"
],
"markdownDescription": "The Strategy to use to detect if a file has changed.\n- `metadata` - uses the file system timestamp and size to detect changes (fastest).\n- `content` - uses a hash of the file content to check file changes (slower - more accurate).",
"type": "string"
},
"CharacterSet": {
"description": "This is a set of characters that can include `-` or `|`\n- `-` - indicates a range of characters: `a-c` => `abc`\n- `|` - is a group separator, indicating that the characters on either side are not related.",
"markdownDescription": "This is a set of characters that can include `-` or `|`\n- `-` - indicates a range of characters: `a-c` => `abc`\n- `|` - is a group separator, indicating that the characters on either side\n are not related.",
"type": "string"
},
"CharacterSetCosts": {
"additionalProperties": false,
"properties": {
"characters": {
"$ref": "#/definitions/CharacterSet",
"description": "This is a set of characters that can include `-` or `|`\n- `-` - indicates a range of characters: `a-c` => `abc`\n- `|` - is a group separator, indicating that the characters on either side are not related.",
"markdownDescription": "This is a set of characters that can include `-` or `|`\n- `-` - indicates a range of characters: `a-c` => `abc`\n- `|` - is a group separator, indicating that the characters on either side\n are not related."
},
"cost": {
"description": "the cost to insert / delete / replace / swap the characters in a group",
"markdownDescription": "the cost to insert / delete / replace / swap the characters in a group",
"type": "number"
},
"penalty": {
"description": "The penalty cost to apply if the accent is used. This is used to discourage",
"markdownDescription": "The penalty cost to apply if the accent is used.\nThis is used to discourage",
"type": "number"
}
},
"required": [
"characters",
"cost"
],
"type": "object"
},
"CostMapDefInsDel": {
"additionalProperties": false,
"properties": {
"description": {
"description": "A description to describe the purpose of the map.",
"markdownDescription": "A description to describe the purpose of the map.",
"type": "string"
},
"insDel": {
"description": "The cost to insert/delete one of the substrings in the map. Note: insert/delete costs are symmetrical.",
"markdownDescription": "The cost to insert/delete one of the substrings in the map. Note: insert/delete costs are symmetrical.",
"type": "number"
},
"map": {
"description": "The set of substrings to map, these are generally single character strings.\n\nMultiple sets can be defined by using a `|` to separate them.\n\nExample: `\"eéê|aåá\"` contains two different sets.\n\nTo add a multi-character substring use `()`.\n\nExample: `\"f(ph)(gh)\"` results in the following set: `f`, `ph`, `gh`.\n\n- To match the beginning of a word, use `^`: `\"(^I)\"\"`.\n- To match the end of a word, use `$`: `\"(e$)(ing$)\"`.",
"markdownDescription": "The set of substrings to map, these are generally single character strings.\n\nMultiple sets can be defined by using a `|` to separate them.\n\nExample: `\"eéê|aåá\"` contains two different sets.\n\nTo add a multi-character substring use `()`.\n\nExample: `\"f(ph)(gh)\"` results in the following set: `f`, `ph`, `gh`.\n\n- To match the beginning of a word, use `^`: `\"(^I)\"\"`.\n- To match the end of a word, use `$`: `\"(e$)(ing$)\"`.",
"type": "string"
},
"penalty": {
"description": "Add a penalty to the final cost. This is used to discourage certain suggestions.\n\nExample: ```yaml # Match adding/removing `-` to the end of a word. map: \"$(-$)\" replace: 50 penalty: 100 ```\n\nThis makes adding a `-` to the end of a word more expensive.\n\nThink of it as taking the toll way for speed but getting the bill later.",
"markdownDescription": "Add a penalty to the final cost.\nThis is used to discourage certain suggestions.\n\nExample:\n```yaml\n# Match adding/removing `-` to the end of a word.\nmap: \"$(-$)\"\nreplace: 50\npenalty: 100\n```\n\nThis makes adding a `-` to the end of a word more expensive.\n\nThink of it as taking the toll way for speed but getting the bill later.",
"type": "number"
},
"replace": {
"description": "The cost to replace of of the substrings in the map with another substring in the map. Example: Map['a', 'i'] This would be the cost to substitute `a` with `i`: Like `bat` to `bit` or the reverse.",
"markdownDescription": "The cost to replace of of the substrings in the map with another substring in the map.\nExample: Map['a', 'i']\nThis would be the cost to substitute `a` with `i`: Like `bat` to `bit` or the reverse.",
"type": "number"
},
"swap": {
"description": "The cost to swap two adjacent substrings found in the map. Example: Map['e', 'i'] This represents the cost to change `ei` to `ie` or the reverse.",
"markdownDescription": "The cost to swap two adjacent substrings found in the map.\nExample: Map['e', 'i']\nThis represents the cost to change `ei` to `ie` or the reverse.",
"type": "number"
}
},
"required": [
"insDel",
"map"
],
"type": "object"
},
"CostMapDefReplace": {
"additionalProperties": false,
"properties": {
"description": {
"description": "A description to describe the purpose of the map.",
"markdownDescription": "A description to describe the purpose of the map.",
"type": "string"
},
"insDel": {
"description": "The cost to insert/delete one of the substrings in the map. Note: insert/delete costs are symmetrical.",
"markdownDescription": "The cost to insert/delete one of the substrings in the map. Note: insert/delete costs are symmetrical.",
"type": "number"
},
"map": {
"description": "The set of substrings to map, these are generally single character strings.\n\nMultiple sets can be defined by using a `|` to separate them.\n\nExample: `\"eéê|aåá\"` contains two different sets.\n\nTo add a multi-character substring use `()`.\n\nExample: `\"f(ph)(gh)\"` results in the following set: `f`, `ph`, `gh`.\n\n- To match the beginning of a word, use `^`: `\"(^I)\"\"`.\n- To match the end of a word, use `$`: `\"(e$)(ing$)\"`.",
"markdownDescription": "The set of substrings to map, these are generally single character strings.\n\nMultiple sets can be defined by using a `|` to separate them.\n\nExample: `\"eéê|aåá\"` contains two different sets.\n\nTo add a multi-character substring use `()`.\n\nExample: `\"f(ph)(gh)\"` results in the following set: `f`, `ph`, `gh`.\n\n- To match the beginning of a word, use `^`: `\"(^I)\"\"`.\n- To match the end of a word, use `$`: `\"(e$)(ing$)\"`.",
"type": "string"
},
"penalty": {
"description": "Add a penalty to the final cost. This is used to discourage certain suggestions.\n\nExample: ```yaml # Match adding/removing `-` to the end of a word. map: \"$(-$)\" replace: 50 penalty: 100 ```\n\nThis makes adding a `-` to the end of a word more expensive.\n\nThink of it as taking the toll way for speed but getting the bill later.",
"markdownDescription": "Add a penalty to the final cost.\nThis is used to discourage certain suggestions.\n\nExample:\n```yaml\n# Match adding/removing `-` to the end of a word.\nmap: \"$(-$)\"\nreplace: 50\npenalty: 100\n```\n\nThis makes adding a `-` to the end of a word more expensive.\n\nThink of it as taking the toll way for speed but getting the bill later.",
"type": "number"
},
"replace": {
"description": "The cost to replace of of the substrings in the map with another substring in the map. Example: Map['a', 'i'] This would be the cost to substitute `a` with `i`: Like `bat` to `bit` or the reverse.",
"markdownDescription": "The cost to replace of of the substrings in the map with another substring in the map.\nExample: Map['a', 'i']\nThis would be the cost to substitute `a` with `i`: Like `bat` to `bit` or the reverse.",
"type": "number"
},
"swap": {
"description": "The cost to swap two adjacent substrings found in the map. Example: Map['e', 'i'] This represents the cost to change `ei` to `ie` or the reverse.",
"markdownDescription": "The cost to swap two adjacent substrings found in the map.\nExample: Map['e', 'i']\nThis represents the cost to change `ei` to `ie` or the reverse.",
"type": "number"
}
},
"required": [
"map",
"replace"
],
"type": "object"
},
"CostMapDefSwap": {
"additionalProperties": false,
"properties": {
"description": {
"description": "A description to describe the purpose of the map.",
"markdownDescription": "A description to describe the purpose of the map.",
"type": "string"
},
"insDel": {
"description": "The cost to insert/delete one of the substrings in the map. Note: insert/delete costs are symmetrical.",
"markdownDescription": "The cost to insert/delete one of the substrings in the map. Note: insert/delete costs are symmetrical.",
"type": "number"
},
"map": {
"description": "The set of substrings to map, these are generally single character strings.\n\nMultiple sets can be defined by using a `|` to separate them.\n\nExample: `\"eéê|aåá\"` contains two different sets.\n\nTo add a multi-character substring use `()`.\n\nExample: `\"f(ph)(gh)\"` results in the following set: `f`, `ph`, `gh`.\n\n- To match the beginning of a word, use `^`: `\"(^I)\"\"`.\n- To match the end of a word, use `$`: `\"(e$)(ing$)\"`.",
"markdownDescription": "The set of substrings to map, these are generally single character strings.\n\nMultiple sets can be defined by using a `|` to separate them.\n\nExample: `\"eéê|aåá\"` contains two different sets.\n\nTo add a multi-character substring use `()`.\n\nExample: `\"f(ph)(gh)\"` results in the following set: `f`, `ph`, `gh`.\n\n- To match the beginning of a word, use `^`: `\"(^I)\"\"`.\n- To match the end of a word, use `$`: `\"(e$)(ing$)\"`.",
"type": "string"
},
"penalty": {
"description": "Add a penalty to the final cost. This is used to discourage certain suggestions.\n\nExample: ```yaml # Match adding/removing `-` to the end of a word. map: \"$(-$)\" replace: 50 penalty: 100 ```\n\nThis makes adding a `-` to the end of a word more expensive.\n\nThink of it as taking the toll way for speed but getting the bill later.",
"markdownDescription": "Add a penalty to the final cost.\nThis is used to discourage certain suggestions.\n\nExample:\n```yaml\n# Match adding/removing `-` to the end of a word.\nmap: \"$(-$)\"\nreplace: 50\npenalty: 100\n```\n\nThis makes adding a `-` to the end of a word more expensive.\n\nThink of it as taking the toll way for speed but getting the bill later.",
"type": "number"
},
"replace": {
"description": "The cost to replace of of the substrings in the map with another substring in the map. Example: Map['a', 'i'] This would be the cost to substitute `a` with `i`: Like `bat` to `bit` or the reverse.",
"markdownDescription": "The cost to replace of of the substrings in the map with another substring in the map.\nExample: Map['a', 'i']\nThis would be the cost to substitute `a` with `i`: Like `bat` to `bit` or the reverse.",
"type": "number"
},
"swap": {
"description": "The cost to swap two adjacent substrings found in the map. Example: Map['e', 'i'] This represents the cost to change `ei` to `ie` or the reverse.",
"markdownDescription": "The cost to swap two adjacent substrings found in the map.\nExample: Map['e', 'i']\nThis represents the cost to change `ei` to `ie` or the reverse.",
"type": "number"
}
},
"required": [
"map",
"swap"
],
"type": "object"
},
"CustomDictionaryPath": {
"$ref": "#/definitions/FsDictionaryPath",
"description": "A File System Path to a dictionary file.",
"markdownDescription": "A File System Path to a dictionary file."
},
"CustomDictionaryScope": {
"description": "Specifies the scope of a dictionary.",
"enum": [
"user",
"workspace",
"folder"
],
"markdownDescription": "Specifies the scope of a dictionary.",
"type": "string"
},
"DictionaryDefinition": {
"anyOf": [
{
"$ref": "#/definitions/DictionaryDefinitionPreferred"
},
{
"$ref": "#/definitions/DictionaryDefinitionCustom"
},
{
"$ref": "#/definitions/DictionaryDefinitionAugmented"
},
{
"$ref": "#/definitions/DictionaryDefinitionInline"
},
{
"$ref": "#/definitions/DictionaryDefinitionAlternate"
}
]
},
"DictionaryDefinitionAlternate": {
"additionalProperties": false,
"deprecated": true,
"deprecationMessage": "Use {@link DictionaryDefinitionPreferred } instead.",
"description": "Only for legacy dictionary definitions.",
"markdownDescription": "Only for legacy dictionary definitions.",
"properties": {
"description": {
"description": "Optional description of the contents / purpose of the dictionary.",
"markdownDescription": "Optional description of the contents / purpose of the dictionary.",
"type": "string"
},
"file": {
"$ref": "#/definitions/DictionaryPath",
"deprecated": true,
"deprecationMessage": "Use `path` instead.",
"description": "Path to the file, only for legacy dictionary definitions.",
"markdownDescription": "Path to the file, only for legacy dictionary definitions."
},
"name": {
"$ref": "#/definitions/DictionaryId",
"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 `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.",
"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 `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`."
},
"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.",
"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.",
"type": "boolean"
},
"repMap": {
"$ref": "#/definitions/ReplaceMap",
"description": "Replacement pairs.",
"markdownDescription": "Replacement pairs."
},
"type": {
"$ref": "#/definitions/DictionaryFileTypes",
"default": "S",
"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.",
"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."
},
"useCompounds": {
"description": "Use Compounds.",
"markdownDescription": "Use Compounds.",
"type": "boolean"
}
},
"required": [
"file",
"name"
],
"type": "object"
},
"DictionaryDefinitionAugmented": {
"additionalProperties": false,
"description": "Used to provide extra data related to the dictionary",
"markdownDescription": "Used to provide extra data related to the dictionary",
"properties": {
"description": {
"description": "Optional description of the contents / purpose of the dictionary.",
"markdownDescription": "Optional description of the contents / purpose of the dictionary.",
"type": "string"
},
"dictionaryInformation": {
"$ref": "#/definitions/DictionaryInformation"
},
"name": {
"$ref": "#/definitions/DictionaryId",
"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 `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.",
"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 `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`."
},
"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.",
"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.",
"type": "boolean"
},
"path": {
"$ref": "#/definitions/DictionaryPath",
"description": "Path to the file.",
"markdownDescription": "Path to the file."
},
"repMap": {
"$ref": "#/definitions/ReplaceMap",
"description": "Replacement pairs.",
"markdownDescription": "Replacement pairs."
},
"type": {
"$ref": "#/definitions/DictionaryFileTypes",
"default": "S",
"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.",
"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."
},
"useCompounds": {
"description": "Use Compounds.",
"markdownDescription": "Use Compounds.",
"type": "boolean"
}
},
"required": [
"name",
"path"
],
"type": "object"
},
"DictionaryDefinitionCustom": {
"additionalProperties": false,
"description": "For Defining Custom dictionaries. They are generally scoped to a `user`, `workspace`, or `folder`. When `addWords` is true, indicates that the spell checker can add words to the file.\n\nNote: only plain text files with one word per line are supported at this moment.",
"markdownDescription": "For Defining Custom dictionaries. They are generally scoped to a\n`user`, `workspace`, or `folder`.\nWhen `addWords` is true, indicates that the spell checker can add words\nto the file.\n\nNote: only plain text files with one word per line are supported at this moment.",
"properties": {
"addWords": {
"description": "When `true`, let's the spell checker know that words can be added to this dictionary.",
"markdownDescription": "When `true`, let's the spell checker know that words can be added to this dictionary.",
"type": "boolean"
},
"description": {
"description": "Optional description of the contents / purpose of the dictionary.",
"markdownDescription": "Optional description of the contents / purpose of the dictionary.",
"type": "string"
},
"name": {
"$ref": "#/definitions/DictionaryId",
"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 `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.",
"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 `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`."
},
"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.",
"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.",
"type": "boolean"
},
"path": {
"$ref": "#/definitions/CustomDictionaryPath",
"description": "Path to custom dictionary text file.",
"markdownDescription": "Path to custom dictionary text file."
},
"repMap": {
"$ref": "#/definitions/ReplaceMap",
"description": "Replacement pairs.",
"markdownDescription": "Replacement pairs."
},
"scope": {
"anyOf": [
{
"$ref": "#/definitions/CustomDictionaryScope"
},
{
"items": {
"$ref": "#/definitions/CustomDictionaryScope"
},
"type": "array"
}
],
"description": "Defines the scope for when words will be added to the dictionary.\n\nScope values: `user`, `workspace`, `folder`.",
"markdownDescription": "Defines the scope for when words will be added to the dictionary.\n\nScope values: `user`, `workspace`, `folder`."
},
"type": {
"$ref": "#/definitions/DictionaryFileTypes",
"default": "S",
"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.",
"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."
},
"useCompounds": {
"description": "Use Compounds.",
"markdownDescription": "Use Compounds.",
"type": "boolean"
}
},
"required": [
"addWords",
"name",
"path"
],
"type": "object"
},
"DictionaryDefinitionInline": {
"anyOf": [
{
"$ref": "#/definitions/DictionaryDefinitionInlineWords"
},
{
"$ref": "#/definitions/DictionaryDefinitionInlineIgnoreWords"
},
{
"$ref": "#/definitions/DictionaryDefinitionInlineFlagWords"
},
{
"$ref": "#/definitions/DictionaryDefinitionInlineSuggestWords"
}
],
"description": "Inline Dictionary Definitions",
"markdownDescription": "Inline Dictionary Definitions"
},
"DictionaryDefinitionInlineFlagWords": {
"additionalProperties": false,
"properties": {
"description": {
"description": "Optional description of the contents / purpose of the dictionary.",
"markdownDescription": "Optional description of the contents / purpose of the dictionary.",
"type": "string"
},
"flagWords": {
"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"
},
"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```",
"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"
},
"markdownDescription": "List of words to be ignored. An ignored word will not show up as an error, even if it is\nalso in the `flagWords`.",
"type": "array"
},
"name": {
"$ref": "#/definitions/DictionaryId",
"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 `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.",
"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 `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`."
},
"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.",
"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.",
"type": "boolean"
},
"repMap": {
"$ref": "#/definitions/ReplaceMap",
"description": "Replacement pairs.",
"markdownDescription": "Replacement pairs."
},
"suggestWords": {
"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`",
"items": {
"type": "string"
},
"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`",
"type": "array"
},
"type": {
"$ref": "#/definitions/DictionaryFileTypes",
"default": "S",
"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.",
"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."
},
"useCompounds": {
"description": "Use Compounds.",
"markdownDescription": "Use Compounds.",
"type": "boolean"
},
"words": {
"description": "List of words to be considered correct.",
"items": {
"type": "string"
},
"markdownDescription": "List of words to be considered correct.",
"type": "array"
}
},
"required": [
"flagWords",
"name"
],
"type": "object"
},
"DictionaryDefinitionInlineIgnoreWords": {
"additionalProperties": false,
"properties": {
"description": {
"description": "Optional description of the contents / purpose of the dictionary.",
"markdownDescription": "Optional description of the contents / purpose of the dictionary.",
"type": "string"
},
"flagWords": {
"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"
},
"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```",
"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"
},
"markdownDescription": "List of words to be ignored. An ignored word will not show up as an error, even if it is\nalso in the `flagWords`.",
"type": "array"
},
"name": {
"$ref": "#/definitions/DictionaryId",
"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 `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.",
"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 `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`."
},
"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.",
"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.",
"type": "boolean"
},
"repMap": {
"$ref": "#/definitions/ReplaceMap",
"description": "Replacement pairs.",
"markdownDescription": "Replacement pairs."
},
"suggestWords": {
"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`",
"items": {
"type": "string"
},
"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`",
"type": "array"
},
"type": {
"$ref": "#/definitions/DictionaryFileTypes",
"default": "S",
"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.",
"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."
},
"useCompounds": {
"description": "Use Compounds.",
"markdownDescription": "Use Compounds.",
"type": "boolean"
},
"words": {
"description": "List of words to be considered correct.",
"items": {
"type": "string"
},
"markdownDescription": "List of words to be considered correct.",
"type": "array"
}
},
"required": [
"ignoreWords",
"name"
],
"type": "object"
},
"DictionaryDefinitionInlineSuggestWords": {
"additionalProperties": false,
"properties": {
"description": {
"description": "Optional description of the contents / purpose of the dictionary.",
"markdownDescription": "Optional description of the contents / purpose of the dictionary.",
"type": "string"
},
"flagWords": {
"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"
},
"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```",
"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"
},
"markdownDescription": "List of words to be ignored. An ignored word will not show up as an error, even if it is\nalso in the `flagWords`.",
"type": "array"
},
"name": {
"$ref": "#/definitions/DictionaryId",
"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 `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.",
"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 `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`."
},
"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.",
"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.",
"type": "boolean"
},
"repMap": {
"$ref": "#/definitions/ReplaceMap",
"description": "Replacement pairs.",
"markdownDescription": "Replacement pairs."
},
"suggestWords": {
"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`",
"items": {
"type": "string"
},
"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`",
"type": "array"
},
"type": {
"$ref": "#/definitions/DictionaryFileTypes",
"default": "S",
"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.",
"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."
},
"useCompounds": {
"description": "Use Compounds.",
"markdownDescription": "Use Compounds.",
"type": "boolean"
},
"words": {
"description": "List of words to be considered correct.",
"items": {
"type": "string"
},
"markdownDescription": "List of words to be considered correct.",
"type": "array"
}
},
"required": [
"name",
"suggestWords"
],
"type": "object"
},
"DictionaryDefinitionInlineWords": {
"additionalProperties": false,
"properties": {
"description": {
"description": "Optional description of the contents / purpose of the dictionary.",
"markdownDescription": "Optional description of the contents / purpose of the dictionary.",
"type": "string"
},
"flagWords": {
"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"
},
"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```",
"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"
},
"markdownDescription": "List of words to be ignored. An ignored word will not show up as an error, even if it is\nalso in the `flagWords`.",
"type": "array"
},
"name": {
"$ref": "#/definitions/DictionaryId",
"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 `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.",
"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 `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`."
},
"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.",
"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.",
"type": "boolean"
},
"repMap": {
"$ref": "#/definitions/ReplaceMap",
"description": "Replacement pairs.",
"markdownDescription": "Replacement pairs."
},
"suggestWords": {
"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`",
"items": {
"type": "string"
},
"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`",
"type": "array"
},
"type": {
"$ref": "#/definitions/DictionaryFileTypes",
"default": "S",
"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.",
"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."
},
"useCompounds": {
"description": "Use Compounds.",
"markdownDescription": "Use Compounds.",
"type": "boolean"
},
"words": {
"description": "List of words to be considered correct.",
"items": {
"type": "string"
},
"markdownDescription": "List of words to be considered correct.",
"type": "array"
}
},
"required": [
"name",
"words"
],
"type": "object"
},
"DictionaryDefinitionPreferred": {
"additionalProperties": false,
"properties": {
"description": {
"description": "Optional description of the contents / purpose of the dictionary.",
"markdownDescription": "Optional description of the contents / purpose of the dictionary.",
"type": "string"
},
"name": {
"$ref": "#/definitions/DictionaryId",
"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 `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.",
"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 `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`."
},
"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.",
"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.",
"type": "boolean"
},
"path": {
"$ref": "#/definitions/DictionaryPath",
"description": "Path to the file.",
"markdownDescription": "Path to the file."
},
"repMap": {
"$ref": "#/definitions/ReplaceMap",
"description": "Replacement pairs.",
"markdownDescription": "Replacement pairs."
},
"type": {
"$ref": "#/definitions/DictionaryFileTypes",
"default": "S",
"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.",
"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."
},
"useCompounds": {
"description": "Use Compounds.",
"markdownDescription": "Use Compounds.",
"type": "boolean"
}
},
"required": [
"name",
"path"
],
"type": "object"
},
"DictionaryFileTypes": {
"enum": [
"S",
"W",
"C",
"T"
],
"type": "string"
},
"DictionaryId": {
"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 `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.",
"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 `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.",
"pattern": "^(?=[^!*,;{}[\\]~\\n]+$)(?=(.*\\w)).+$",
"type": "string"
},
"DictionaryInformation": {
"additionalProperties": false,
"description": "Use by dictionary authors to help improve the quality of suggestions given from the dictionary.\n\nAdded with `v5.16.0`.",
"markdownDescription": "Use by dictionary authors to help improve the quality of suggestions\ngiven from the dictionary.\n\nAdded with `v5.16.0`.",
"properties": {
"accents": {
"anyOf": [
{
"$ref": "#/definitions/CharacterSet"
},
{
"items": {
"$ref": "#/definitions/CharacterSetCosts"
},
"type": "array"
}
],
"description": "The accent characters.\n\nDefault: `\"\\u0300-\\u0341\"`",
"markdownDescription": "The accent characters.\n\nDefault: `\"\\u0300-\\u0341\"`"
},
"adjustments": {
"description": "A collection of patterns to test against the suggested words. If the word matches the pattern, then the penalty is applied.",
"items": {
"$ref": "#/definitions/PatternAdjustment"
},
"markdownDescription": "A collection of patterns to test against the suggested words.\nIf the word matches the pattern, then the penalty is applied.",
"type": "array"
},
"alphabet": {
"anyOf": [
{
"$ref": "#/definitions/CharacterSet"
},
{
"items": {
"$ref": "#/definitions/CharacterSetCosts"
},
"type": "array"
}
],
"default": "a-zA-Z",
"description": "The alphabet to use.",
"markdownDescription": "The alphabet to use."
},
"costs": {
"$ref": "#/definitions/EditCosts",
"description": "Define edit costs.",
"markdownDescription": "Define edit costs."
},
"hunspellInformation": {
"$ref": "#/definitions/HunspellInformation",
"description": "Used by dictionary authors",
"markdownDescription": "Used by dictionary authors"
},
"ignore": {
"$ref": "#/definitions/CharacterSet",
"description": "An optional set of characters that can possibly be removed from a word before checking it.\n\nThis is useful in languages like Arabic where Harakat accents are optional.\n\nNote: All matching characters are removed or none. Partial removal is not supported.",
"markdownDescription": "An optional set of characters that can possibly be removed from a word before\nchecking it.\n\nThis is useful in languages like Arabic where Harakat accents are optional.\n\nNote: All matching characters are removed or none. Partial removal is not supported."
},
"locale": {
"description": "The locale of the dictionary. Example: `nl,nl-be`",
"markdownDescription": "The locale of the dictionary.\nExample: `nl,nl-be`",
"type": "string"
},
"suggestionEditCosts": {
"$ref": "#/definitions/SuggestionCostsDefs",
"description": "Used in making suggestions. The lower the value, the more likely the suggestion will be near the top of the suggestion list.",
"markdownDescription": "Used in making suggestions. The lower the value, the more likely the suggestion\nwill be near the top of the suggestion list."
}
},
"type": "object"
},
"DictionaryNegRef": {
"description": "This a negative reference to a named dictionary.\n\nIt is used to exclude or include a dictionary by name.\n\nThe reference starts with 1 or more `!`.\n- `!<dictionary_name>` - Used to exclude the dictionary matching `<dictionary_name>`.\n- `!!<dictionary_name>` - Used to re-include a dictionary matching `<dictionary_name>`. Overrides `!<dictionary_name>`.\n- `!!!<dictionary_name>` - Used to exclude a dictionary matching `<dictionary_name>`. Overrides `!!<dictionary_name>`.",
"markdownDescription": "This a negative reference to a named dictionary.\n\nIt is used to exclude or include a dictionary by name.\n\nThe reference starts with 1 or more `!`.\n- `!<dictionary_name>` - Used to exclude the dictionary matching `<dictionary_name>`.\n- `!!<dictionary_name>` - Used to re-include a dictionary matching `<dictionary_name>`.\n Overrides `!<dictionary_name>`.\n- `!!!<dictionary_name>` - Used to exclude a dictionary matching `<dictionary_name>`.\n Overrides `!!<dictionary_name>`.",
"pattern": "^(?=!+[^!*,;{}[\\]~\\n]+$)(?=(.*\\w)).+$",
"type": "string"
},
"DictionaryPath": {
"description": "A File System Path to a dictionary file. Pattern: `^.*\\.(?:txt|trie|dic)(?:\\.gz)?$`",
"markdownDescription": "A File System Path to a dictionary file.\nPattern: `^.*\\.(?:txt|trie|dic)(?:\\.gz)?$`",
"type": "string"
},
"DictionaryRef": {
"$ref": "#/definitions/DictionaryId",
"description": "This a reference to a named dictionary. It is expected to match the name of a dictionary.",
"markdownDescription": "This a reference to a named dictionary.\nIt is expected to match the name of a dictionary."
},
"DictionaryReference": {
"anyOf": [
{
"$ref": "#/definitions/DictionaryRef"
},
{
"$ref": "#/definitions/DictionaryNegRef"
}
],
"description": "Reference to a dictionary by name. One of:\n- {@link DictionaryRef } \n- {@link DictionaryNegRef }",
"markdownDescription": "Reference to a dictionary by name.\nOne of:\n- {@link DictionaryRef } \n- {@link DictionaryNegRef }"
},
"EditCosts": {
"additionalProperties": false,
"properties": {
"accentCosts": {
"default": 1,
"description": "The cost to add / remove an accent This should be very cheap, it helps with fixing accent issues.",
"markdownDescription": "The cost to add / remove an accent\nThis should be very cheap, it helps with fixing accent issues.",
"type": "number"
},
"baseCost": {
"default": 100,
"description": "This is the base cost for making an edit.",
"markdownDescription": "This is the base cost for making an edit.",
"type": "number"
},
"capsCosts": {
"default": 1,
"description": "The cost to change capitalization. This should be very cheap, it helps with fixing capitalization issues.",
"markdownDescription": "The cost to change capitalization.\nThis should be very cheap, it helps with fixing capitalization issues.",
"type": "number"
},
"firstLetterPenalty": {
"default": 4,
"description": "The extra cost incurred for changing the first letter of a word. This value should be less than `100 - baseCost`.",
"markdownDescription": "The extra cost incurred for changing the first letter of a word.\nThis value should be less than `100 - baseCost`.",
"type": "number"
},
"nonAlphabetCosts": {
"default": 110,
"description": "This is the cost for characters not in the alphabet.",
"markdownDescription": "This is the cost for characters not in the alphabet.",
"type": "number"
}
},
"type": "object"
},
"FSPathResolvable": {
"$ref": "#/definitions/FsPath",
"description": "A File System Path.\n\nSpecial Properties:\n- `${cwd}` prefix - will be replaced with the current working directory.\n- Relative paths are relative to the configuration file.",
"markdownDescription": "A File System Path.\n\nSpecial Properties:\n- `${cwd}` prefix - will be replaced with the current working directory.\n- Relative paths are relative to the configuration file."
},
"FeatureEnableOnly": {
"type": "boolean"
},
"Features": {
"additionalProperties": false,
"description": "Features are behaviors or settings that can be explicitly configured.",
"markdownDescription": "Features are behaviors or settings that can be explicitly configured.",
"properties": {
"weighted-suggestions": {
"$ref": "#/definitions/FeatureEnableOnly",
"description": "Enable/disable using weighted suggestions.",
"markdownDescription": "Enable/disable using weighted suggestions."
}
},
"type": "object"
},
"FsDictionaryPath": {
"description": "A File System Path. Relative paths are relative to the configuration file.",
"markdownDescription": "A File System Path. Relative paths are relative to the configuration file.",
"type": "string"
},
"FsPath": {
"description": "A File System Path. Relative paths are relative to the configuration file.",
"markdownDescription": "A File System Path. Relative paths are relative to the configuration file.",
"type": "string"
},
"Glob": {
"$ref": "#/definitions/SimpleGlob",
"description": "These are glob expressions.",
"markdownDescription": "These are glob expressions."
},
"HunspellInformation": {
"additionalProperties": false,
"properties": {
"aff": {
"description": "Selected Hunspell AFF content. The content must be UTF-8\n\nSections:\n- TRY\n- MAP\n- REP\n- KEY\n- ICONV\n- OCONV\n\nExample: ```hunspell # Comment TRY aeistlunkodmrvpgjhäõbüoöfcwzxðqþ` MAP aàâäAÀÂÄ MAP eéèêëEÉÈÊË MAP iîïyIÎÏY MAP oôöOÔÖ MAP (IJ)(IJ) ```",
"markdownDescription": "Selected Hunspell AFF content.\nThe content must be UTF-8\n\nSections:\n- TRY\n- MAP\n- REP\n- KEY\n- ICONV\n- OCONV\n\nExample:\n```hunspell\n# Comment\nTRY aeistlunkodmrvpgjhäõbüoöfcwzxðqþ`\nMAP aàâäAÀÂÄ\nMAP eéèêëEÉÈÊË\nMAP iîïyIÎÏY\nMAP oôöOÔÖ\nMAP (IJ)(IJ)\n```",
"type": "string"
},
"costs": {
"additionalProperties": false,
"description": "The costs to apply when using the hunspell settings",
"markdownDescription": "The costs to apply when using the hunspell settings",
"properties": {
"accentCosts": {
"default": 1,
"description": "The cost to add / remove an accent This should be very cheap, it helps with fixing accent issues.",
"markdownDescription": "The cost to add / remove an accent\nThis should be very cheap, it helps with fixing accent issues.",
"type": "number"
},
"baseCost": {
"default": 100,
"description": "This is the base cost for making an edit.",
"markdownDescription": "This is the base cost for making an edit.",
"type": "number"
},
"capsCosts": {
"default": 1,
"description": "The cost to change capitalization. This should be very cheap, it helps with fixing capitalization issues.",
"markdownDescription": "The cost to change capitalization.\nThis should be very cheap, it helps with fixing capitalization issues.",
"type": "number"
},
"firstLetterPenalty": {
"default": 4,
"description": "The extra cost incurred for changing the first letter of a word. This value should be less than `100 - baseCost`.",
"markdownDescription": "The extra cost incurred for changing the first letter of a word.\nThis value should be less than `100 - baseCost`.",
"type": "number"
},
"ioConvertCost": {
"default": 30,
"description": "The cost to convert between convert pairs.\n\nThe value should be slightly higher than the mapCost.",
"markdownDescription": "The cost to convert between convert pairs.\n\nThe value should be slightly higher than the mapCost.",
"type": "number"
},
"keyboardCost": {
"default": 99,
"description": "The cost of replacing or swapping any adjacent keyboard characters.\n\nThis should be slightly cheaper than `tryCharCost`.",
"markdownDescription": "The cost of replacing or swapping any adjacent keyboard characters.\n\nThis should be slightly cheaper than `tryCharCost`.",
"type": "number"
},
"mapCost": {
"default": 25,