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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
|
{
"$schema": "http://json-schema.org/schema",
"$id": "latexindent-yaml-schema.json",
"title": "latexindent.pl YAML schema",
"description": "latexindent.pl YAML schema helper, V3.23.7 2024-03-16",
"type": "object",
"properties": {
"fileExtensionPreference": {
"description": "calling latexindent.pl to operate on myfile (without extension) is fine, and in which case the file extensions from this field will be used in order",
"type": "object",
"patternProperties": {
".*": {
"description": "integer specifying the order in which latexindent.pl will search for myfile ending with this extension",
"type": "integer"
}
}
},
"backupExtension": {
"description": "when the -w, --overwrite switch is active, a back-up file is created with this extension",
"type": "string"
},
"onlyOneBackUp": {
"description": "when the -w, --overwrite switch is active, the default is to create a back-up file for each call to latexindent.pl. Changing onlyOneBackUp to 1 means that only one back-up file is created",
"type": "integer",
"enum": [0, 1]
},
"maxNumberOfBackUps": {
"description": "when the -w, --overwrite switch is active, the default is to create a back-up file for each call to latexindent.pl. This field sets the maximum number of back-up files",
"type": "integer",
"minimum": 0
},
"cycleThroughBackUps": {
"description": "when the -w, --overwrite switch is active, back-up files can be overwritten in order; see also maxNumberOfBackUps",
"type": "integer",
"enum": [0, 1]
},
"logFilePreferences": {
"description": "latexindent.pl will write logging information to indent.log; the appearance of some of the information can be customised",
"type": "object",
"properties": {
"showEveryYamlRead": {
"description": "0/1, binary switch to show every YAML file's settings in indent.log",
"type": "integer",
"enum": [0, 1]
},
"showAmalgamatedSettings": {
"description": "0/1, binary switch to show the overall/amalgamated settings in indent.log",
"type": "integer",
"enum": [0, 1]
},
"showDecorationStartCodeBlockTrace": {
"description": "0/1, binary switch to show decorations at *start* of code block in indent.log when -t, -tt switches active",
"type": "integer",
"enum": [0, 1]
},
"showDecorationFinishCodeBlockTrace": {
"description": "0/1, binary switch to show decorations at *finish* of code block in indent.log when -t, -tt switches active",
"type": "integer",
"enum": [0, 1]
},
"endLogFileWith": {
"description": "string decoration to finish indent.log",
"type": "string"
},
"showGitHubInfoFooter": {
"description": "0/1, binary switch to show GitHub information in footer of indent.log",
"type": "integer",
"enum": [0, 1]
},
"Dumper": {
"description": "options to be passed to the Dumper module; most helpful when -t, -tt active.",
"type": "object",
"properties": {
"Terse": {
"type": "integer",
"enum": [0, 1]
},
"Indent": {
"type": "integer",
"enum": [0, 1]
},
"Useqq": {
"type": "integer",
"enum": [0, 1]
},
"Deparse": {
"type": "integer",
"enum": [0, 1]
},
"Quotekeys": {
"type": "integer",
"enum": [0, 1]
},
"Sortkeys": {
"type": "integer",
"enum": [0, 1]
},
"Pair": {
"type": "string"
}
}
}
}
},
"verbatimEnvironments": {
"description": "specify the names of verbatim environments in this field",
"type": "object",
"patternProperties": {
".*": {
"description": "0/1, binary switch to mean don't look for/look for this *environment*",
"type": "integer",
"enum": [0, 1]
}
}
},
"verbatimCommands": {
"description": "specify the names of verbatim *commands* in this field",
"type": "object",
"patternProperties": {
".*": {
"description": "0/1, binary switch to mean don't look for/look for this *command*",
"type": "integer",
"enum": [0, 1]
}
}
},
"noIndentBlock": {
"description": "specify the names of *noIndentBlock* in this field",
"type": "object",
"patternProperties": {
".*": {
"description": "0/1, binary switch to mean don't look for/look for this *noIndentBlock*",
"type": "integer",
"enum": [0, 1]
}
}
},
"fileContentsEnvironments": {
"description": "specify the names of *filecontents* in this field",
"type": "object",
"patternProperties": {
".*": {
"description": "0/1, binary switch to mean don't look for/look for this *filecontents* environment",
"type": "integer",
"enum": [0, 1]
}
}
},
"indentPreamble": {
"description": "0/1, binary switch to instruct latexindent.pl to operate on preamble or not",
"type": "integer",
"enum": [0, 1]
},
"lookForPreamble": {
"description": "list of extensions detailing which files latexindent.pl should look for preamble",
"type": "object",
"patternProperties": {
".*": {
"description": "0/1, binary switch for preamble search for this file type",
"type": "integer",
"enum": [0, 1]
}
}
},
"preambleCommandsBeforeEnvironments": {
"description": "0/1, binary switch to instruct latexindent.pl to search for commands before environments in preamble",
"type": "integer",
"enum": [0, 1]
},
"defaultIndent": {
"description": "default indentation, needs to be specified as horizontal space",
"type": "string"
},
"removeTrailingWhitespace": {
"description": "remove horizontal space at the *end* of lines",
"type": "object",
"properties": {
"beforeProcessing": {
"description": "0/1, binary switch to remove horizontal space *before* indenting",
"type": "integer",
"enum": [0, 1]
},
"afterProcessing": {
"description": "0/1, binary switch to remove horizontal space *after* indenting",
"type": "integer",
"enum": [0, 1]
}
}
},
"lookForAlignDelims": {
"description": "list of names of code blocks detailing that latexindent.pl should align at delimiters",
"type": "object",
"patternProperties": {
".*": {
"description": "0/1, binary switch to detail if this code block has delimiters. Option to specify this field in 'advanced' form",
"type": ["integer", "object"],
"properties": {
"delims": {
"description": "0/1, binary switch to look for delimiters",
"type": "integer",
"enum": [0, 1]
},
"alignDoubleBackSlash": {
"description": "0/1, binary switch to align the \\\\",
"type": "integer",
"enum": [0, 1]
},
"spacesBeforeDoubleBackSlash": {
"description": "integer detailing number of spaces *before* \\\\",
"type": "integer",
"minimum": 0
},
"multiColumnGrouping": {
"description": "0/1, binary switch to group alignment under \\multicolumn command",
"type": "integer",
"enum": [0, 1]
},
"alignRowsWithoutMaxDelims": {
"description": "0/1, binary switch to align rows without the maximum number of delimiters",
"type": "integer",
"enum": [0, 1]
},
"spacesBeforeAmpersand": {
"description": "integer detailing number of spaces *before* delimiter",
"type": "integer",
"minimum": 0
},
"spacesAfterAmpersand": {
"description": "integer detailing number of spaces *after* delimiter",
"type": "integer",
"minimum": 0
},
"justification": {
"description": "justification of cell",
"type": "string",
"enum": ["left", "right"]
},
"alignFinalDoubleBackSlash": {
"description": "0/1, binary switch to align final \\\\",
"type": "integer",
"enum": [0, 1]
},
"dontMeasure": {
"description": "entries not to be measured in the alignment routine; can also be set to 'largest'",
"type": ["integer", "string", "array"],
"items": {
"description": "entry not to be measured",
"type": ["string", "object"],
"properties": {
"this": {
"type": "string",
"description": "string containing the cell *not* to be measured"
},
"applyTo": {
"type": "string",
"enum": ["cell", "row"],
"description": "detail cell or row"
},
"regex": {
"type": "string",
"description": "regular expression to match cell or row"
}
}
}
},
"delimiterRegEx": {
"description": "delimiter regex. NOTE: the capturing ()",
"type": "string"
},
"delimiterJustification": {
"description": "delimiter justification",
"type": "string",
"enum": ["left", "right"]
},
"lookForChildCodeBlocks": {
"description": "0/1, binary switch to look for child code blocks",
"type": "integer",
"enum": [0, 1]
},
"alignContentAfterDoubleBackSlash": {
"description": "0/1, binary switch to align content after \\\\",
"type": "integer",
"enum": [0, 1]
},
"spacesAfterDoubleBackSlash": {
"description": "integer detailing number of spaces to be placed *after* \\\\ when alignContentAfterDoubleBackSlash is active",
"type": "integer",
"minimum": 0
}
}
}
}
},
"indentAfterItems": {
"description": "specify the names of environments that contain items",
"type": "object",
"patternProperties": {
".*": {
"description": "0/1, binary switch to mean don't look for/look for items in this environment",
"type": "integer",
"enum": [0, 1]
}
}
},
"itemNames": {
"description": "names of items",
"type": "object",
"patternProperties": {
".*": {
"description": "0/1, binary switch to mean don't look for/look for items",
"type": "integer",
"enum": [0, 1]
}
}
},
"specialBeginEnd": {
"description": "special code blocks have begin, end, and optionally 'middle' specified as regular expressions",
"type": "object",
"properties": {
"specialBeforeCommand": {
"description": "0/1, binary switch to look for commands before special code blocks",
"type": "integer",
"enum": [0, 1]
}
},
"patternProperties": {
".*": {
"description": "name of special code block",
"type": "object",
"properties": {
"begin": {
"type": "string",
"description": "regular expression containing the *beginning* part"
},
"middle": {
"type": "string",
"description": "optional: regular expression containing the *middle* part"
},
"end": {
"type": "string",
"description": "regular expression containing the *ending* part"
},
"body": {
"type": "string",
"description": "optional: regular expression containing the body of the block"
},
"lookForThis": {
"type": "integer",
"description": "optional: 0/1, binary switch detailing look for this or not. Default is 1 if not specified",
"enum": [0, 1]
}
}
}
}
},
"indentAfterHeadings": {
"description": "indentation after headings",
"type": "object",
"patternProperties": {
".*": {
"description": "name of heading",
"type": "object",
"properties": {
"indentAfterThisHeading": {
"type": "integer",
"description": "0/1, binary switch to look for heading or not",
"enum": [0, 1]
},
"level": {
"type": "integer",
"description": "level of the heading (minimum is 1)",
"minimum": 1
}
}
}
}
},
"maximumIndentation": {
"description": "maximum value of indentation; specify as horizontal space",
"type": ["string", "integer"]
},
"noAdditionalIndent": {
"description": "names of code blocks to not have additional indentation",
"type": "object",
"patternProperties": {
".*": {
"description": "0/1, binary switch to mean code block does not have/has additional indentation",
"type": "integer",
"enum": [0, 1]
}
}
},
"indentRules": {
"description": "per-code block indentation rule",
"type": "object",
"patternProperties": {
".*": {
"description": "indentation/horizontal space per-code block",
"type": "string"
}
}
},
"noAdditionalIndentGlobal": {
"description": "*types* of code blocks to not have additional indentation",
"type": "object",
"properties": {
"environments": {
"description": "0/1, binary switch to mean *type* of code block does not have/has additional indentation",
"type": "integer",
"enum": [0, 1]
},
"commands": {
"description": "0/1, binary switch to mean *type* of code block does not have/has additional indentation",
"type": "integer",
"enum": [0, 1]
},
"optionalArguments": {
"description": "0/1, binary switch to mean *type* of code block does not have/has additional indentation",
"type": "integer",
"enum": [0, 1]
},
"mandatoryArguments": {
"description": "0/1, binary switch to mean *type* of code block does not have/has additional indentation",
"type": "integer",
"enum": [0, 1]
},
"ifElseFi": {
"description": "0/1, binary switch to mean *type* of code block does not have/has additional indentation",
"type": "integer",
"enum": [0, 1]
},
"items": {
"description": "0/1, binary switch to mean *type* of code block does not have/has additional indentation",
"type": "integer",
"enum": [0, 1]
},
"keyEqualsValuesBracesBrackets": {
"description": "0/1, binary switch to mean *type* of code block does not have/has additional indentation",
"type": "integer",
"enum": [0, 1]
},
"namedGroupingBracesBrackets": {
"description": "0/1, binary switch to mean *type* of code block does not have/has additional indentation",
"type": "integer",
"enum": [0, 1]
},
"UnNamedGroupingBracesBrackets": {
"description": "0/1, binary switch to mean *type* of code block does not have/has additional indentation",
"type": "integer",
"enum": [0, 1]
},
"specialBeginEnd": {
"description": "0/1, binary switch to mean *type* of code block does not have/has additional indentation",
"type": "integer",
"enum": [0, 1]
},
"afterHeading": {
"description": "0/1, binary switch to mean *type* of code block does not have/has additional indentation",
"type": "integer",
"enum": [0, 1]
},
"filecontents": {
"description": "0/1, binary switch to mean *type* of code block does not have/has additional indentation",
"type": "integer",
"enum": [0, 1]
}
}
},
"indentRulesGlobal": {
"description": "*types* of code blocks indentation rules",
"type": "object",
"properties": {
"environments": {
"description": "indentation rules per *type* of code block",
"type": ["integer", "string"]
},
"commands": {
"description": "indentation rules per *type* of code block",
"type": ["integer", "string"]
},
"optionalArguments": {
"description": "indentation rules per *type* of code block",
"type": ["integer", "string"]
},
"mandatoryArguments": {
"description": "indentation rules per *type* of code block",
"type": ["integer", "string"]
},
"ifElseFi": {
"description": "indentation rules per *type* of code block",
"type": ["integer", "string"]
},
"items": {
"description": "indentation rules per *type* of code block",
"type": ["integer", "string"]
},
"keyEqualsValuesBracesBrackets": {
"description": "indentation rules per *type* of code block",
"type": ["integer", "string"]
},
"namedGroupingBracesBrackets": {
"description": "indentation rules per *type* of code block",
"type": ["integer", "string"]
},
"UnNamedGroupingBracesBrackets": {
"description": "indentation rules per *type* of code block",
"type": ["integer", "string"]
},
"specialBeginEnd": {
"description": "indentation rules per *type* of code block",
"type": ["integer", "string"]
},
"afterHeading": {
"description": "indentation rules per *type* of code block",
"type": ["integer", "string"]
},
"filecontents": {
"description": "indentation rules per *type* of code block",
"type": ["integer", "string"]
}
}
},
"commandCodeBlocks": {
"description": "command code blocks need some particular attention",
"type": "object",
"properties": {
"roundParenthesesAllowed": {
"description": "0/1, binary switch to not allow/allow round parenthesis () between arguments",
"type": "integer",
"enum": [0, 1]
},
"stringsAllowedBetweenArguments": {
"description": "strings allowed between arguments",
"type": ["integer", "array"],
"items": {
"description": "entry to be allowed between arguments",
"type": ["string", "object"],
"properties": {
"amalgamate": {
"description": "optional: 0/1, binary switch to add to/overwrite previously loaded items. Default is 1 if not specified",
"type": "integer",
"enum": [0, 1]
}
}
}
},
"commandNameSpecial": {
"description": "there are some particular commands that need individual attention",
"type": ["integer", "array"],
"items": {
"description": "entry for particular attention",
"type": ["string", "object"],
"properties": {
"amalgamate": {
"description": "optional: 0/1, binary switch to add to/overwrite previously loaded items. Default is 1 if not specified",
"type": "integer",
"enum": [0, 1]
}
}
}
}
}
},
"dos2unixlinebreaks": {
"description": "0/1, binary switch to convert dos line breaks to unix line breaks",
"type": "integer",
"enum": [0, 1]
},
"modifyLineBreaks": {
"description": "when -m switch active, latexindent.pl has ability to modify line breaks",
"type": "object",
"properties": {
"preserveBlankLines": {
"description": "0/1, binary switch to preserve blank lines or not",
"type": "integer",
"enum": [0, 1]
},
"condenseMultipleBlankLinesInto": {
"description": "condense multiple blank lines into this many blank lines",
"type": "integer",
"minimum": 0
},
"oneSentencePerLine": {
"properties": {
"manipulateSentences": {
"description": "0/1, binary switch to perform one sentence per line routine or not",
"type": "integer",
"enum": [0, 1]
},
"removeSentenceLineBreaks": {
"description": "0/1, binary switch to remove line breaks from within sentences or not",
"type": "integer",
"enum": [0, 1]
},
"multipleSpacesToSingle": {
"description": "0/1, binary switch to convert multiple spaces into single spaces or not",
"type": "integer",
"enum": [0, 1]
},
"textWrapSentences": {
"description": "0/1, binary switch to text wrap sentences or not",
"type": "integer",
"enum": [0, 1]
},
"sentenceIndent": {
"description": "horizontal space representing indentation within sentences",
"type": "string"
},
"sentencesFollow": {
"description": "things that sentences can follow",
"properties": {
"par": {
"description": "0/1, binary switch to determine if sentences can follow \\par or not",
"type": "integer",
"enum": [0, 1]
},
"blankLine": {
"description": "0/1, binary switch to determine if sentences can follow blank lines or not",
"type": "integer",
"enum": [0, 1]
},
"fullStop": {
"description": "0/1, binary switch to determine if sentences can follow blank lines or not",
"type": "integer",
"enum": [0, 1]
},
"exclamationMark": {
"description": "0/1, binary switch to determine if sentences can follow ! or not",
"type": "integer",
"enum": [0, 1]
},
"questionMark": {
"description": "0/1, binary switch to determine if sentences can follow ? or not",
"type": "integer",
"enum": [0, 1]
},
"rightBrace": {
"description": "0/1, binary switch to determine if sentences can follow } or not",
"type": "integer",
"enum": [0, 1]
},
"commentOnPreviousLine": {
"description": "0/1, binary switch to determine if sentences can follow % on previous line or not",
"type": "integer",
"enum": [0, 1]
},
"other": {
"description": "regular expression detailing what else sentences can follow",
"type": ["integer", "string"]
}
}
},
"sentencesBeginWith": {
"description": "things that sentences can begin with",
"properties": {
"A-Z": {
"description": "0/1, binary switch to determine if sentences can begin upper case letters or not",
"type": "integer",
"enum": [0, 1]
},
"a-z": {
"description": "0/1, binary switch to determine if sentences can begin lower case letters or not",
"type": "integer",
"enum": [0, 1]
},
"other": {
"description": "regular expression detailing what else sentences can begin with",
"type": ["integer", "string"]
}
}
},
"sentencesEndWith": {
"description": "things that sentences can end with",
"properties": {
"basicFullStop": {
"description": "0/1, binary switch to determine if sentences can end with basic full stop (period) or not",
"type": "integer",
"enum": [0, 1]
},
"betterFullStop": {
"description": "0/1, binary switch to determine if sentences can end with better full stop (period) or not (RECOMMENDED)",
"type": "integer",
"enum": [0, 1]
},
"exclamationMark": {
"description": "0/1, binary switch to determine if sentences can end with ! or not",
"type": "integer",
"enum": [0, 1]
},
"questionMark": {
"description": "0/1, binary switch to determine if sentences can end with ? or not",
"type": "integer",
"enum": [0, 1]
},
"other": {
"description": "regular expression detailing what else sentences can end with",
"type": ["integer", "string"]
}
}
},
"sentencesDoNOTcontain": {
"description": "things that sentences cannot contain",
"properties": {
"other": {
"description": "regular expression detailing what sentences cannot contain. Can be turned off by setting 0",
"type": ["integer", "string"]
}
}
}
}
},
"textWrapOptions": {
"description": "options for the text wrap routine",
"type": "object",
"properties": {
"columns": {
"description": "integer > 0 sets the number of columns for the text wrap routine, or if -1 then text wrap blocks simply have line breaks removed",
"type": "integer",
"minimum": -1
},
"multipleSpacesToSingle": {
"description": "0/1, binary switch to determine whether text wrap should convert multiple spaces to single space",
"type": "integer",
"enum": [0, 1]
},
"removeBlockLineBreaks": {
"description": "0/1, binary switch to determine whether text wrap should convert multiple spaces to single space",
"type": "integer",
"enum": [0, 1]
},
"when": {
"description": "optional: string specifying whether text wrapping should be made before/after code blocks have been found. Default is 'before' if not specified",
"type": "string",
"enum": ["before", "after"]
},
"comments": {
"description": "instructions for wrapping comments",
"type": "object",
"properties": {
"wrap": {
"description": "0/1, binary switch to determine whether comments should be combined and wrapped",
"type": "integer",
"enum": [0, 1]
},
"inheritLeadingSpace": {
"description": "0/1, binary switch to determine whether comments should inherit leading spaces",
"type": "integer",
"enum": [0, 1]
}
}
},
"blocksFollow": {
"description": "field containing switches that text wrap blocks *follow*",
"type": "object",
"properties": {
"headings": {
"description": "0/1, binary switch to instruct latexindent to find text wrap blocks after the fields listed in indentAfterHeading (regardless of the value of indentAfterThisHeading or level) or not. The heading command can, optionally, be followed by a label command",
"type": "integer",
"enum": [0, 1]
},
"commentOnPreviousLine": {
"description": "0/1, binary switch to instruct latexindent to find text wrap blocks after a comment on its own line or not",
"type": "integer",
"enum": [0, 1]
},
"par": {
"description": "0/1, binary switch to instruct latexindent to find text wrap blocks after \\par or not",
"type": "integer",
"enum": [0, 1]
},
"blankLine": {
"description": "0/1, binary switch to instruct latexindent to find text wrap blocks after a blank line or not",
"type": "integer",
"enum": [0, 1]
},
"verbatim": {
"description": "0/1, binary switch to instruct latexindent to find text wrap blocks after a verbatim block or not",
"type": "integer",
"enum": [0, 1]
},
"filecontents": {
"description": "0/1, binary switch to instruct latexindent to find text wrap blocks after a filecontents environment or not",
"type": "integer",
"enum": [0, 1]
},
"other": {
"description": "regular expression detailing what text wrap blocks should follow. Can be turned off by setting 0. The default value corresponds to the end of display math or an item command",
"type": "string"
}
}
},
"blocksBeginWith": {
"description": "field containing switches that text wrap blocks *begin with*",
"type": "object",
"properties": {
"A-Z": {
"description": "0/1, binary switch to determine whether text wrap block can begin with an uppercase letter or not",
"type": "integer",
"enum": [0, 1]
},
"a-z": {
"description": "0/1, binary switch to determine whether text wrap block can begin with a lowercase letter or not",
"type": "integer",
"enum": [0, 1]
},
"0-9": {
"description": "0/1, binary switch to determine whether text wrap block can begin with a digit or not",
"type": "integer",
"enum": [0, 1]
},
"other": {
"description": "regular expression detailing what text wrap blocks can begin with. Can be turned off by setting 0. Default is 0 if not specified",
"type": ["integer", "string"]
}
}
},
"blocksEndBefore": {
"description": "field containing switches that text wrap blocks *end before*",
"type": "object",
"properties": {
"commentOnOwnLine": {
"description": "0/1, binary switch to determine whether text wrap block should end before a comment on its own line or not",
"type": "integer",
"enum": [0, 1]
},
"verbatim": {
"description": "0/1, binary switch to determine whether text wrap block should end before a verbatim environment or not",
"type": "integer",
"enum": [0, 1]
},
"filecontents": {
"description": "0/1, binary switch to determine whether text wrap block should end before a filecontents environment or not",
"type": "integer",
"enum": [0, 1]
},
"other": {
"description": "regular expression detailing what text wrap blocks should end before. Can be turned off by setting 0. The default value corresponds to begin statements, display math, and end statements",
"type": "string"
}
}
},
"huge": {
"description": "WARNING: I don't recommend changing this from overflow; passed to Perl's Text::Wrap module",
"type": "string",
"enum": ["overflow", "wrap", "die"]
},
"tabstop": {
"description": "passed to Perl's Text::Wrap module",
"type": "integer"
},
"separator": {
"description": "passed to Perl's Text::Wrap module",
"type": "string"
},
"separator2": {
"description": "passed to Perl's Text::Wrap module",
"type": "string"
},
"break": {
"description": "passed to Perl's Text::Wrap module",
"type": "string"
},
"unexpand": {
"description": "passed to Perl's Text::Wrap module",
"type": "integer",
"enum": [0, 1]
}
}
},
"environments": {
"description": "poly-switches for environments (GLOBAL)",
"type": "object",
"properties": {
"BeginStartsOnOwnLine": {
"description": "poly-switch for line break before beginning of environments (GLOBAL)",
"type": "integer",
"enum": [-1, 0, 1, 2, 3, 4]
},
"BodyStartsOnOwnLine": {
"description": "poly-switch for line break before body of environments (GLOBAL)",
"type": "integer",
"enum": [-1, 0, 1, 2, 3, 4]
},
"EndStartsOnOwnLine": {
"description": "poly-switch for line break before end of environments (GLOBAL)",
"type": "integer",
"enum": [-1, 0, 1, 2, 3, 4]
},
"EndFinishesWithLineBreak": {
"description": "poly-switch for line break after end of environments (GLOBAL)",
"type": "integer",
"enum": [-1, 0, 1, 2, 3, 4]
}
},
"patternProperties": {
".*": {
"description": "poly-switches for environments (PER-NAME)",
"type": "object",
"properties": {
"BeginStartsOnOwnLine": {
"description": "poly-switch for line break before beginning of environments (PER-NAME)",
"type": "integer",
"enum": [-1, 0, 1, 2, 3, 4]
},
"BodyStartsOnOwnLine": {
"description": "poly-switch for line break before body of environments (PER-NAME)",
"type": "integer",
"enum": [-1, 0, 1, 2, 3, 4]
},
"EndStartsOnOwnLine": {
"description": "poly-switch for line break before end of environments (PER-NAME)",
"type": "integer",
"enum": [-1, 0, 1, 2, 3, 4]
},
"EndFinishesWithLineBreak": {
"description": "poly-switch for line break after end of environments (PER-NAME)",
"type": "integer",
"enum": [-1, 0, 1, 2, 3, 4]
}
}
}
}
},
"specialBeginEnd": {
"description": "poly-switches for specialBeginEnd (GLOBAL)",
"type": "object",
"properties": {
"SpecialBeginStartsOnOwnLine": {
"description": "poly-switch for line break before beginning of specialBeginEnd (GLOBAL)",
"type": "integer",
"enum": [-1, 0, 1, 2, 3, 4]
},
"SpecialBodyStartsOnOwnLine": {
"description": "poly-switch for line break before body of specialBeginEnd (GLOBAL)",
"type": "integer",
"enum": [-1, 0, 1, 2, 3, 4]
},
"SpecialEndStartsOnOwnLine": {
"description": "poly-switch for line break before end of specialBeginEnd (GLOBAL)",
"type": "integer",
"enum": [-1, 0, 1, 2, 3, 4]
},
"SpecialEndFinishesWithLineBreak": {
"description": "poly-switch for line break after end of specialBeginEnd (GLOBAL)",
"type": "integer",
"enum": [-1, 0, 1, 2, 3, 4]
}
},
"patternProperties": {
".*": {
"description": "poly-switches for specialBeginEnd (PER-NAME)",
"type": "object",
"properties": {
"SpecialBeginStartsOnOwnLine": {
"description": "poly-switch for line break before beginning of specialBeginEnd (PER-NAME)",
"type": "integer",
"enum": [-1, 0, 1, 2, 3, 4]
},
"SpecialBodyStartsOnOwnLine": {
"description": "poly-switch for line break before body of specialBeginEnd (PER-NAME)",
"type": "integer",
"enum": [-1, 0, 1, 2, 3, 4]
},
"SpecialEndStartsOnOwnLine": {
"description": "poly-switch for line break before end of specialBeginEnd (PER-NAME)",
"type": "integer",
"enum": [-1, 0, 1, 2, 3, 4]
},
"SpecialEndFinishesWithLineBreak": {
"description": "poly-switch for line break after end of specialBeginEnd (PER-NAME)",
"type": "integer",
"enum": [-1, 0, 1, 2, 3, 4]
}
}
}
}
},
"keyEqualsValuesBracesBrackets": {
"description": "poly-switches for key equals value (GLOBAL)",
"type": "object",
"properties": {
"KeyStartsOnOwnLine": {
"description": "poly-switch for line break before beginning of key equals value (GLOBAL)",
"type": "integer",
"enum": [-1, 0, 1, 2, 3, 4]
},
"EqualsStartsOnOwnLine": {
"description": "poly-switch for line break before = of key equals value (GLOBAL)",
"type": "integer",
"enum": [-1, 0, 1, 2, 3, 4]
},
"EqualsFinishesWithLineBreak": {
"description": "poly-switch for line break after = of key equals value (GLOBAL)",
"type": "integer",
"enum": [-1, 0, 1, 2, 3, 4]
}
},
"patternProperties": {
".*": {
"description": "poly-switches for key equals value (PER-NAME)",
"type": "object",
"properties": {
"KeyStartsOnOwnLine": {
"description": "poly-switch for line break before beginning of key equals value (PER-NAME)",
"type": "integer",
"enum": [-1, 0, 1, 2, 3, 4]
},
"EqualsStartsOnOwnLine": {
"description": "poly-switch for line break before = of key equals value (PER-NAME)",
"type": "integer",
"enum": [-1, 0, 1, 2, 3, 4]
},
"EqualsFinishesWithLineBreak": {
"description": "poly-switch for line break after = of key equals value (PER-NAME)",
"type": "integer",
"enum": [-1, 0, 1, 2, 3, 4]
}
}
}
}
},
"ifElseFi": {
"description": "poly-switches for ifElseFi (GLOBAL)",
"type": "object",
"properties": {
"IfStartsOnOwnLine": {
"description": "poly-switch for line break before beginning of ifElseFi (GLOBAL)",
"type": "integer",
"enum": [-1, 0, 1, 2, 3, 4]
},
"BodyStartsOnOwnLine": {
"description": "poly-switch for line break before body of ifElseFi (GLOBAL)",
"type": "integer",
"enum": [-1, 0, 1, 2, 3, 4]
},
"OrStartsOnOwnLine": {
"description": "poly-switch for line break before or statement of ifElseFi (GLOBAL)",
"type": "integer",
"enum": [-1, 0, 1, 2, 3, 4]
},
"OrFinishesWithLineBreak": {
"description": "poly-switch for line break after or statement of ifElseFi (GLOBAL)",
"type": "integer",
"enum": [-1, 0, 1, 2, 3, 4]
},
"ElseStartsOnOwnLine": {
"description": "poly-switch for line break before else statement of ifElseFi (GLOBAL)",
"type": "integer",
"enum": [-1, 0, 1, 2, 3, 4]
},
"ElseFinishesWithLineBreak": {
"description": "poly-switch for line break after else statement of ifElseFi (GLOBAL)",
"type": "integer",
"enum": [-1, 0, 1, 2, 3, 4]
},
"FiStartsOnOwnLine": {
"description": "poly-switch for line break before end of ifElseFi (GLOBAL)",
"type": "integer",
"enum": [-1, 0, 1, 2, 3, 4]
},
"FiFinishesWithLineBreak": {
"description": "poly-switch for line break after end of ifElseFi (GLOBAL)",
"type": "integer",
"enum": [-1, 0, 1, 2, 3, 4]
}
},
"patternProperties": {
".*": {
"description": "poly-switches for ifElseFi (PER-NAME)",
"type": "object",
"properties": {
"IfStartsOnOwnLine": {
"description": "poly-switch for line break before beginning of ifElseFi (PER-NAME)",
"type": "integer",
"enum": [-1, 0, 1, 2, 3, 4]
},
"BodyStartsOnOwnLine": {
"description": "poly-switch for line break before body of ifElseFi (PER-NAME)",
"type": "integer",
"enum": [-1, 0, 1, 2, 3, 4]
},
"OrStartsOnOwnLine": {
"description": "poly-switch for line break before or statement of ifElseFi (PER-NAME)",
"type": "integer",
"enum": [-1, 0, 1, 2, 3, 4]
},
"OrFinishesWithLineBreak": {
"description": "poly-switch for line break after or statement of ifElseFi (PER-NAME)",
"type": "integer",
"enum": [-1, 0, 1, 2, 3, 4]
},
"ElseStartsOnOwnLine": {
"description": "poly-switch for line break before else statement of ifElseFi (PER-NAME)",
"type": "integer",
"enum": [-1, 0, 1, 2, 3, 4]
},
"ElseFinishesWithLineBreak": {
"description": "poly-switch for line break after else statement of ifElseFi (PER-NAME)",
"type": "integer",
"enum": [-1, 0, 1, 2, 3, 4]
},
"FiStartsOnOwnLine": {
"description": "poly-switch for line break before end of ifElseFi (PER-NAME)",
"type": "integer",
"enum": [-1, 0, 1, 2, 3, 4]
},
"FiFinishesWithLineBreak": {
"description": "poly-switch for line break after end of ifElseFi (PER-NAME)",
"type": "integer",
"enum": [-1, 0, 1, 2, 3, 4]
}
}
}
}
},
"commands": {
"description": "poly-switches for commands (GLOBAL)",
"type": "object",
"properties": {
"CommandStartsOnOwnLine": {
"description": "poly-switch for line break before beginning of commands (GLOBAL)",
"type": "integer",
"enum": [-1, 0, 1, 2, 3, 4]
},
"CommandNameFinishesWithLineBreak": {
"description": "poly-switch for line break after end of commands (GLOBAL)",
"type": "integer",
"enum": [-1, 0, 1, 2, 3, 4]
}
},
"patternProperties": {
".*": {
"description": "poly-switches for commands (PER-NAME)",
"type": "object",
"properties": {
"CommandStartsOnOwnLine": {
"description": "poly-switch for line break before beginning of commands (PER-NAME)",
"type": "integer",
"enum": [-1, 0, 1, 2, 3, 4]
},
"CommandNameFinishesWithLineBreak": {
"description": "poly-switch for line break after end of commands (PER-NAME)",
"type": "integer",
"enum": [-1, 0, 1, 2, 3, 4]
}
}
}
}
},
"verbatim": {
"description": "poly-switches for verbatim (GLOBAL)",
"type": "object",
"properties": {
"VerbatimBeginStartsOnOwnLine": {
"description": "poly-switch for line break before beginning of verbatim (GLOBAL)",
"type": "integer",
"enum": [-1, 0, 1, 2, 3, 4]
},
"VerbatimEndFinishesWithLineBreak": {
"description": "poly-switch for line break after end of verbatim (GLOBAL)",
"type": "integer",
"enum": [-1, 0, 1, 2, 3, 4]
}
},
"patternProperties": {
".*": {
"description": "poly-switches for verbatim (PER-NAME)",
"type": "object",
"properties": {
"VerbatimBeginStartsOnOwnLine": {
"description": "poly-switch for line break before beginning of verbatim (GLOBAL)",
"type": "integer",
"enum": [-1, 0, 1, 2, 3, 4]
},
"VerbatimEndFinishesWithLineBreak": {
"description": "poly-switch for line break after end of verbatim (GLOBAL)",
"type": "integer",
"enum": [-1, 0, 1, 2, 3, 4]
}
}
}
}
},
"namedGroupingBracesBrackets": {
"description": "poly-switches for namedGroupingBracesBrackets (GLOBAL)",
"type": "object",
"properties": {
"NameStartsOnOwnLine": {
"description": "poly-switch for line break before beginning of namedGroupingBracesBrackets (GLOBAL)",
"type": "integer",
"enum": [-1, 0, 1, 2, 3, 4]
},
"NameFinishesWithLineBreak": {
"description": "poly-switch for line break after end of namedGroupingBracesBrackets (GLOBAL)",
"type": "integer",
"enum": [-1, 0, 1, 2, 3, 4]
}
},
"patternProperties": {
".*": {
"description": "poly-switches for commands (PER-NAME)",
"type": "object",
"properties": {
"NameStartsOnOwnLine": {
"description": "poly-switch for line break before beginning of namedGroupingBracesBrackets (GLOBAL)",
"type": "integer",
"enum": [-1, 0, 1, 2, 3, 4]
},
"NameFinishesWithLineBreak": {
"description": "poly-switch for line break after end of namedGroupingBracesBrackets (GLOBAL)",
"type": "integer",
"enum": [-1, 0, 1, 2, 3, 4]
}
}
}
}
},
"items": {
"description": "poly-switches for items (GLOBAL)",
"type": "object",
"properties": {
"ItemStartsOnOwnLine": {
"description": "poly-switch for line break before beginning of items (GLOBAL)",
"type": "integer",
"enum": [-1, 0, 1, 2, 3, 4]
},
"ItemFinishesWithLineBreak": {
"description": "poly-switch for line break after end of items (GLOBAL)",
"type": "integer",
"enum": [-1, 0, 1, 2, 3, 4]
}
},
"patternProperties": {
".*": {
"description": "poly-switches for items (PER-NAME)",
"type": "object",
"properties": {
"ItemStartsOnOwnLine": {
"description": "poly-switch for line break before beginning of items (PER-NAME)",
"type": "integer",
"enum": [-1, 0, 1, 2, 3, 4]
},
"ItemFinishesWithLineBreak": {
"description": "poly-switch for line break after end of items (PER-NAME)",
"type": "integer",
"enum": [-1, 0, 1, 2, 3, 4]
}
}
}
}
},
"optionalArguments": {
"description": "poly-switches for optional arguments (GLOBAL)",
"type": "object",
"properties": {
"LSqBStartsOnOwnLine": {
"description": "poly-switch for line break before beginning of optional arguments (GLOBAL)",
"type": "integer",
"enum": [-1, 0, 1, 2, 3, 4]
},
"OptArgBodyStartsOnOwnLine": {
"description": "poly-switch for line break before body of optional arguments (GLOBAL)",
"type": "integer",
"enum": [-1, 0, 1, 2, 3, 4]
},
"RSqBStartsOnOwnLine": {
"description": "poly-switch for line break before end of optional arguments (GLOBAL)",
"type": "integer",
"enum": [-1, 0, 1, 2, 3, 4]
},
"RSqBFinishesWithLineBreak": {
"description": "poly-switch for line break after end of optional arguments (GLOBAL)",
"type": "integer",
"enum": [-1, 0, 1, 2, 3, 4]
}
},
"patternProperties": {
".*": {
"description": "poly-switches for optional arguments (PER-NAME)",
"type": "object",
"properties": {
"LSqBStartsOnOwnLine": {
"description": "poly-switch for line break before beginning of optional arguments (PER-NAME)",
"type": "integer",
"enum": [-1, 0, 1, 2, 3, 4]
},
"OptArgBodyStartsOnOwnLine": {
"description": "poly-switch for line break before body of optional arguments (PER-NAME)",
"type": "integer",
"enum": [-1, 0, 1, 2, 3, 4]
},
"RSqBStartsOnOwnLine": {
"description": "poly-switch for line break before end of optional arguments (PER-NAME)",
"type": "integer",
"enum": [-1, 0, 1, 2, 3, 4]
},
"RSqBFinishesWithLineBreak": {
"description": "poly-switch for line break after end of optional arguments (PER-NAME)",
"type": "integer",
"enum": [-1, 0, 1, 2, 3, 4]
}
}
}
}
},
"mandatoryArguments": {
"description": "poly-switches for mandatory arguments (GLOBAL)",
"type": "object",
"properties": {
"LCuBStartsOnOwnLine": {
"description": "poly-switch for line break before beginning of mandatory arguments (GLOBAL)",
"type": "integer",
"enum": [-1, 0, 1, 2, 3, 4]
},
"MandArgBodyStartsOnOwnLine": {
"description": "poly-switch for line break before body of mandatory arguments (GLOBAL)",
"type": "integer",
"enum": [-1, 0, 1, 2, 3, 4]
},
"RCuBStartsOnOwnLine": {
"description": "poly-switch for line break before end of mandatory arguments (GLOBAL)",
"type": "integer",
"enum": [-1, 0, 1, 2, 3, 4]
},
"RCuBFinishesWithLineBreak": {
"description": "poly-switch for line break after end of mandatory arguments (GLOBAL)",
"type": "integer",
"enum": [-1, 0, 1, 2, 3, 4]
}
},
"patternProperties": {
".*": {
"description": "poly-switches for mandatory arguments (PER-NAME)",
"type": "object",
"properties": {
"LCuBStartsOnOwnLine": {
"description": "poly-switch for line break before beginning of mandatory arguments (PER-NAME)",
"type": "integer",
"enum": [-1, 0, 1, 2, 3, 4]
},
"MandArgBodyStartsOnOwnLine": {
"description": "poly-switch for line break before body of mandatory arguments (PER-NAME)",
"type": "integer",
"enum": [-1, 0, 1, 2, 3, 4]
},
"RCuBStartsOnOwnLine": {
"description": "poly-switch for line break before end of mandatory arguments (PER-NAME)",
"type": "integer",
"enum": [-1, 0, 1, 2, 3, 4]
},
"RCuBFinishesWithLineBreak": {
"description": "poly-switch for line break after end of mandatory arguments (PER-NAME)",
"type": "integer",
"enum": [-1, 0, 1, 2, 3, 4]
}
}
}
}
}
}
},
"replacements": {
"description": "replacements to be made; requires -r, -rr or -rv switch",
"type": "array",
"items": {
"description": "entry for replacement",
"type": "object",
"properties": {
"amalgamate": {
"description": "optional: 0/1, binary switch to add to/overwrite previously loaded items. Default is 1 if not specified",
"type": "integer",
"enum": [0, 1]
},
"this": {
"description": "string to be replaced",
"type": "string"
},
"that": {
"description": "string to replace with",
"type": "string"
},
"lookForThis": {
"description": "optional: 0/1, binary switch detailing look for this or not. Default is 1 if not specified",
"type": "integer",
"enum": [0, 1]
},
"when": {
"description": "optional: string specifying whether replacement should be made before/after indentation. Default is 'before' if not specified",
"type": "string",
"enum": ["before", "after"]
},
"substitution": {
"description": "regular expression of the form 's/regex/replacement/modifiers; works only if 'this' is blank",
"type": "string"
}
}
}
},
"fineTuning": {
"description": "fine tuning, proceed with caution!",
"type": "object",
"properties": {
"environments": {
"description": "fine tuning, for environments",
"type": "object",
"properties": {
"name": {
"description": "regular expression for environment name",
"type": "string"
}
}
},
"ifElseFi": {
"description": "fine tuning, for ifElseFi",
"type": "object",
"properties": {
"name": {
"description": "regular expression for ifElseFi name",
"type": "string"
}
}
},
"commands": {
"description": "fine tuning, for commands",
"type": "object",
"properties": {
"name": {
"description": "regular expression for commands name",
"type": "string"
}
}
},
"items": {
"description": "fine tuning, for items",
"type": "object",
"properties": {
"canBeFollowedBy": {
"description": "regular expression for what can follow items",
"type": "string"
}
}
},
"keyEqualsValuesBracesBrackets": {
"description": "fine tuning, for keyEqualsValuesBracesBrackets",
"type": "object",
"properties": {
"name": {
"description": "regular expression for key = value name",
"type": "string"
},
"follow": {
"description": "regular expression for what key = values follow",
"type": "string"
}
}
},
"namedGroupingBracesBrackets": {
"description": "fine tuning, for namedGroupingBracesBrackets",
"type": "object",
"properties": {
"name": {
"description": "regular expression for named grouping braces name",
"type": "string"
},
"follow": {
"description": "regular expression for what named grouping braces follow",
"type": "string"
}
}
},
"UnNamedGroupingBracesBrackets": {
"description": "fine tuning, for UnNamedGroupingBracesBrackets",
"type": "object",
"properties": {
"follow": {
"description": "regular expression for what UN named grouping braces follow",
"type": "string"
}
}
},
"arguments": {
"description": "fine tuning, for arguments",
"type": "object",
"properties": {
"before": {
"description": "regular expression for what can come BEFORE arguments",
"type": "string"
},
"between": {
"description": "regular expression for what can come BETWEEN arguments",
"type": "string"
}
}
},
"trailingComments": {
"description": "fine tuning, for trailing comments",
"type": "object",
"properties": {
"notPreceededBy": {
"description": "regular expression for what can NOT come before %, for example \\%",
"type": "string"
},
"afterComment": {
"description": "regular expression for what can come after %",
"type": "string"
}
}
},
"modifyLineBreaks": {
"description": "fine tuning for some of the -m switch based features",
"type": "object",
"properties": {
"betterFullStop": {
"description": "regular expression for the 'better full stop' in the one-sentence-per-line routine",
"type": "string"
},
"doubleBackSlash": {
"description": "regular expression for the double back slash used in the DBS poly-switches",
"type": "string"
},
"comma": {
"description": "regular expression for the comma used in the comma-based poly-switches",
"type": "string"
}
}
}
}
}
}
}
|