This repository has been archived by the owner on May 20, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathtslint.report.available.json
7873 lines (7873 loc) · 346 KB
/
tslint.report.available.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
{
"adjacent-overload-signatures": {
"id": "./node_modules/tslint:adjacent-overload-signatures",
"description": "Enforces function overloads to be consecutive.",
"rationale": "Improves readability and organization by grouping naturally related items together.",
"type": "typescript",
"typescriptOnly": true,
"documentation": "https://palantir.github.io/tslint/rules/adjacent-overload-signatures",
"path": "./node_modules/tslint/lib/rules/adjacentOverloadSignaturesRule.js",
"ruleName": "adjacent-overload-signatures",
"source": "tslint",
"sourcePath": "./node_modules/tslint"
},
"align": {
"id": "./node_modules/tslint:align",
"description": "Enforces vertical alignment.",
"hasFix": true,
"rationale": "\nHelps maintain a readable, consistent style in your codebase.\n\nConsistent alignment for code statements helps keep code readable and clear.\nStatements misaligned from the standard can be harder to read and understand.",
"optionsDescription": "\nFive arguments may be optionally provided:\n\n* `\"parameters\"` checks alignment of function parameters.\n* `\"arguments\"` checks alignment of function call arguments.\n* `\"statements\"` checks alignment of statements.\n* `\"members\"` checks alignment of members of classes, interfaces, type literal, object literals and\nobject destructuring.\n* `\"elements\"` checks alignment of elements of array literals, array destructuring and tuple types.",
"options": {
"type": "array",
"items": {
"type": "string",
"enum": [
"arguments",
"elements",
"members",
"parameters",
"statements"
]
},
"minLength": 1,
"maxLength": 5
},
"optionExamples": [
[
true,
"parameters",
"statements"
]
],
"type": "formatting",
"typescriptOnly": false,
"documentation": "https://palantir.github.io/tslint/rules/align",
"path": "./node_modules/tslint/lib/rules/alignRule.js",
"ruleName": "align",
"source": "tslint",
"sourcePath": "./node_modules/tslint"
},
"array-bracket-spacing": {
"id": "./node_modules/tslint-eslint-rules:array-bracket-spacing",
"description": "enforce consistent spacing inside array brackets",
"rationale": "\nA number of style guides require or disallow spaces between array brackets and other tokens.\nThis rule applies to both array literals and destructuring assignments (ECMAScript 6).\n",
"optionsDescription": "\nThe rule takes one or two options. The first is a string, which can be:\n\n- `\"never\"` (default) disallows spaces inside array brackets\n- `\"always\"`requires one or more spaces or newlines inside array brackets\n\nThe second option is an object for exceptions to the `\"never\"` option:\n\n- `\"singleValue\": true` requires one or more spaces or newlines inside brackets of array\n literals that contain a single element\n- `\"objectsInArrays\": true` requires one or more spaces or newlines between brackets of\n array literals and braces of their object literal elements\n `[ {` or `} ]`\n- `\"arraysInArrays\": true` requires one or more spaces or newlines between brackets of\n array literals and brackets of their array literal elements\n `[ [` or `] ]`\n\nWhen using the `\"always\"` option the second option takes on these exceptions:\n\n- `\"singleValue\": false` disallows spaces inside brackets of array literals that contain a\n single element\n- `\"objectsInArrays\": false` disallows spaces between brackets of array literals and braces\n of their object literal elements `[ {` or `} ]`\n- `\"arraysInArrays\": false` disallows spaces between brackets of array literals and brackets\n of their array literal elements `[ [` or `] ]`\n\nThis rule has build-in exceptions:\n\n- `\"never\"` (and also the exceptions to the `\"always\"` option) allows newlines inside\n array brackets, because this is a common pattern\n- `\"always\"` does not require spaces or newlines in empty array literals `[]`\n",
"options": {
"anyOf": [
{
"type": "array",
"items": [
{
"enum": [
"always",
"never"
]
}
],
"minItems": 0,
"maxItems": 1
},
{
"type": "object",
"properties": {
"singleValue": {
"type": "boolean"
},
"objectsInArrays": {
"type": "boolean"
},
"arraysInArrays": {
"type": "boolean"
}
},
"additionalProperties": false
}
]
},
"optionExamples": [
"\n\"array-bracket-spacing\": [true, \"always\"]\n",
"\n\"array-bracket-spacing\": [true, \"never\"]\n",
"\n\"array-bracket-spacing\": [true, \"never\", {\n \"arraysInArrays\": true\n}]\n"
],
"typescriptOnly": false,
"type": "style",
"documentation": "https://eslint.org/docs/rules/array-bracket-spacing",
"path": "./node_modules/tslint-eslint-rules/dist/rules/arrayBracketSpacingRule.js",
"ruleName": "array-bracket-spacing",
"source": "tslint-eslint-rules",
"sourcePath": "./node_modules/tslint-eslint-rules"
},
"array-type": {
"id": "./node_modules/tslint:array-type",
"description": "Requires using either 'T[]' or 'Array<T>' for arrays.",
"hasFix": true,
"optionsDescription": "\nOne of the following arguments must be provided:\n\n* `\"array\"` enforces use of `T[]` for all types T.\n* `\"generic\"` enforces use of `Array<T>` for all types T.\n* `\"array-simple\"` enforces use of `T[]` if `T` is a simple type (primitive or type reference).",
"options": {
"type": "string",
"enum": [
"array",
"generic",
"array-simple"
]
},
"optionExamples": [
[
true,
"array"
],
[
true,
"generic"
],
[
true,
"array-simple"
]
],
"type": "style",
"typescriptOnly": true,
"documentation": "https://palantir.github.io/tslint/rules/array-type",
"path": "./node_modules/tslint/lib/rules/arrayTypeRule.js",
"ruleName": "array-type",
"source": "tslint",
"sourcePath": "./node_modules/tslint"
},
"arrow-parens": {
"id": "./node_modules/tslint:arrow-parens",
"description": "Requires parentheses around the parameters of arrow function definitions.",
"hasFix": true,
"rationale": "Maintains stylistic consistency with other arrow function definitions.",
"optionsDescription": "\nIf `ban-single-arg-parens` is specified, then arrow functions with one parameter\nmust not have parentheses if removing them is allowed by TypeScript.",
"options": {
"type": "string",
"enum": [
"ban-single-arg-parens"
]
},
"optionExamples": [
true,
[
true,
"ban-single-arg-parens"
]
],
"type": "formatting",
"typescriptOnly": false,
"documentation": "https://palantir.github.io/tslint/rules/arrow-parens",
"path": "./node_modules/tslint/lib/rules/arrowParensRule.js",
"ruleName": "arrow-parens",
"source": "tslint",
"sourcePath": "./node_modules/tslint"
},
"arrow-return-shorthand": {
"id": "./node_modules/tslint:arrow-return-shorthand",
"description": "Suggests to convert `() => { return x; }` to `() => x`.",
"hasFix": true,
"optionsDescription": "\nIf `multiline` is specified, then this will warn even if the function spans multiple lines.",
"options": {
"type": "string",
"enum": [
"multiline"
]
},
"optionExamples": [
true,
[
true,
"multiline"
]
],
"rationale": "\nIt's unnecessary to include `return` and `{}` brackets in arrow lambdas.\nLeaving them out results in simpler and easier to read code.\n ",
"type": "style",
"typescriptOnly": false,
"codeExamples": [
{
"description": "Enforces usage of the shorthand return syntax when an arrow function's body does not span multiple lines.",
"config": "\n\"rules\": { \"arrow-return-shorthand\": true }\n ",
"pass": "\nconst calc = (x: number, y: number) => ({ add: x + y, sub: x - y, mul: x * y });\nconst calc2 = (x: number, y: number) => {\n return { add: x + y, sub: x - y, mul: x * y }\n};\n ",
"fail": "\nconst calc = (x: number, y: number) => { return { add: x + y, sub: x - y, mul: x * y } };\nconst calc2 = (x: number, y: number) => {\n return { add: x + y, sub: x - y, mul: x * y }\n};\n "
},
{
"description": "Enforces usage of the shorthand return syntax even when an arrow function's body spans multiple lines.",
"config": "\n\"rules\": { \"arrow-return-shorthand\": [true, \"multiline\"] }\n ",
"pass": "\nconst calc = (x: number, y: number) => ({ add: x + y, sub: x - y, mul: x * y });\nconst calc2 = (x: number, y: number) =>\n ({ add: x + y, sub: x - y, mul: x * y });\n ",
"fail": "\nconst calc = (x: number, y: number) => { return { add: x + y, sub: x - y, mul: x * y } };\nconst calc2 = (x: number, y: number) => {\n return { add: x + y, sub: x - y, mul: x * y }\n};\n "
}
],
"documentation": "https://palantir.github.io/tslint/rules/arrow-return-shorthand",
"path": "./node_modules/tslint/lib/rules/arrowReturnShorthandRule.js",
"ruleName": "arrow-return-shorthand",
"source": "tslint",
"sourcePath": "./node_modules/tslint"
},
"await-promise": {
"id": "./node_modules/tslint:await-promise",
"description": "Warns for an awaited value that is not a Promise.",
"optionsDescription": "\nA list of 'string' names of any additional classes that should also be treated as Promises.\nFor example, if you are using a class called 'Future' that implements the Thenable interface,\nyou might tell the rule to consider type references with the name 'Future' as valid Promise-like\ntypes. Note that this rule doesn't check for type assignability or compatibility; it just checks\ntype reference names.\n ",
"options": {
"type": "list",
"listType": {
"type": "array",
"items": {
"type": "string"
}
}
},
"optionExamples": [
true,
[
true,
"Thenable"
]
],
"rationale": "\nWhile it is valid JavaScript to await a non-Promise-like value (it will resolve immediately),\nthis pattern is often a programmer error and the resulting semantics can be unintuitive.\n\nAwaiting non-Promise-like values often is an indication of programmer error, such as\nforgetting to add parenthesis to call a function that returns a Promise.\n ",
"type": "functionality",
"typescriptOnly": true,
"requiresTypeInfo": true,
"documentation": "https://palantir.github.io/tslint/rules/await-promise",
"path": "./node_modules/tslint/lib/rules/awaitPromiseRule.js",
"ruleName": "await-promise",
"source": "tslint",
"sourcePath": "./node_modules/tslint"
},
"ban": {
"id": "./node_modules/tslint:ban",
"description": "Bans the use of specific functions or global methods.",
"optionsDescription": "\nA list of banned functions or methods in the following format:\n\n* banning functions:\n * just the name of the function: `\"functionName\"`\n * the name of the function in an array with one element: `[\"functionName\"]`\n * an object in the following format: `{\"name\": \"functionName\", \"message\": \"optional explanation message\"}`\n* banning methods:\n * an array with the object name, method name and optional message: `[\"objectName\", \"methodName\", \"optional message\"]`\n * an object in the following format: `{\"name\": [\"objectName\", \"methodName\"], \"message\": \"optional message\"}`\n * you can also ban deeply nested methods: `{\"name\": [\"foo\", \"bar\", \"baz\"]}` bans `foo.bar.baz()`\n * the first element can contain a wildcard (`*`) that matches everything. `{\"name\": [\"*\", \"forEach\"]}` bans `[].forEach(...)`, `$(...).forEach(...)`, `arr.forEach(...)`, etc.\n",
"options": {
"type": "list",
"listType": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
},
"minLength": 1,
"maxLength": 3
},
{
"type": "object",
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
},
"minLength": 1
}
]
},
"message": {
"type": "string"
}
},
"required": [
"name"
]
}
]
}
},
"optionExamples": [
[
true,
"eval",
{
"name": "$",
"message": "please don't"
},
[
"describe",
"only"
],
{
"name": [
"it",
"only"
],
"message": "don't focus tests"
},
{
"name": [
"chai",
"assert",
"equal"
],
"message": "Use 'strictEqual' instead."
},
{
"name": [
"*",
"forEach"
],
"message": "Use a regular for loop instead."
},
{
"name": [
"*",
"_id",
"toString"
],
"message": "Use 'toHexString' instead."
}
]
],
"type": "functionality",
"typescriptOnly": false,
"documentation": "https://palantir.github.io/tslint/rules/ban",
"path": "./node_modules/tslint/lib/rules/banRule.js",
"ruleName": "ban",
"source": "tslint",
"sourcePath": "./node_modules/tslint"
},
"ban-comma-operator": {
"id": "./node_modules/tslint:ban-comma-operator",
"description": "Disallows the comma operator to be used.",
"descriptionDetails": "[Read more about the comma operator here](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Comma_Operator).",
"rationale": "\nUsing the comma operator can create a potential for many non-obvious bugs or lead to misunderstanding of code.\n\n### Examples\n```\nfoo((bar, baz)); // evaluates to 'foo(baz)' because of the extra parens - confusing and not obvious\n```\n\n```\nswitch (foo) {\n case 1, 2: // equals 'case 2' - probably intended 'case 1: case2:'\n return true;\n case 3:\n return false;\n}\n```\n\n```\nlet x = (y = 1, z = 2); // x is equal to 2 - this may not be immediately obvious.\n```\n ",
"type": "functionality",
"typescriptOnly": false,
"documentation": "https://palantir.github.io/tslint/rules/ban-comma-operator",
"path": "./node_modules/tslint/lib/rules/banCommaOperatorRule.js",
"ruleName": "ban-comma-operator",
"source": "tslint",
"sourcePath": "./node_modules/tslint"
},
"ban-ts-ignore": {
"id": "./node_modules/tslint:ban-ts-ignore",
"description": "Bans \"// @ts-ignore\" comments from being used.",
"type": "typescript",
"typescriptOnly": true,
"codeExamples": [
{
"description": "Disallows the use of \"@ts-ignore\"",
"config": "\n\"rules\": { \"ban-ts-ignore\": true }\n ",
"pass": "\nif (false) {\n // Compiler warns about unreachable code error\n console.log(\"hello\");\n}\n ",
"fail": "\nif (false) {\n // @ts-ignore: Unreachable code error\n console.log(\"hello\");\n}\n "
}
],
"documentation": "https://palantir.github.io/tslint/rules/ban-ts-ignore",
"path": "./node_modules/tslint/lib/rules/banTsIgnoreRule.js",
"ruleName": "ban-ts-ignore",
"source": "tslint",
"sourcePath": "./node_modules/tslint"
},
"ban-types": {
"id": "./node_modules/tslint:ban-types",
"description": "\nBans specific types from being used. Does not ban the\ncorresponding runtime objects from being used.",
"options": {
"type": "list",
"listType": {
"type": "array",
"items": {
"type": "string"
},
"minLength": 1,
"maxLength": 2
}
},
"optionsDescription": "\nA list of `[\"regex\", \"optional explanation here\"]`, which bans\ntypes that match `regex`",
"optionExamples": [
[
true,
[
"Object",
"Use {} instead."
],
[
"String"
]
]
],
"type": "typescript",
"typescriptOnly": true,
"documentation": "https://palantir.github.io/tslint/rules/ban-types",
"path": "./node_modules/tslint/lib/rules/banTypesRule.js",
"ruleName": "ban-types",
"source": "tslint",
"sourcePath": "./node_modules/tslint"
},
"binary-expression-operand-order": {
"id": "./node_modules/tslint:binary-expression-operand-order",
"description": "\nIn a binary expression, a literal should always be on the right-hand side if possible.\nFor example, prefer 'x + 1' over '1 + x'.",
"rationale": "\nExpressions like `1 + x` are sometimes referred to as \"Yoda\" expressions because they read\nopposite to how we would normally speak the expression.\n\nSticking to a consistent grammar for conditions helps keep code readable and understandable.\n ",
"type": "style",
"typescriptOnly": false,
"documentation": "https://palantir.github.io/tslint/rules/binary-expression-operand-order",
"path": "./node_modules/tslint/lib/rules/binaryExpressionOperandOrderRule.js",
"ruleName": "binary-expression-operand-order",
"source": "tslint",
"sourcePath": "./node_modules/tslint"
},
"block-spacing": {
"id": "./node_modules/tslint-eslint-rules:block-spacing",
"documentation": "https://eslint.org/docs/rules/block-spacing",
"path": "./node_modules/tslint-eslint-rules/dist/rules/blockSpacingRule.js",
"ruleName": "block-spacing",
"source": "tslint-eslint-rules",
"sourcePath": "./node_modules/tslint-eslint-rules"
},
"brace-style": {
"id": "./node_modules/tslint-eslint-rules:brace-style",
"documentation": "https://eslint.org/docs/rules/brace-style",
"path": "./node_modules/tslint-eslint-rules/dist/rules/braceStyleRule.js",
"ruleName": "brace-style",
"source": "tslint-eslint-rules",
"sourcePath": "./node_modules/tslint-eslint-rules"
},
"callable-types": {
"id": "./node_modules/tslint:callable-types",
"description": "An interface or literal type with just a call signature can be written as a function type.",
"rationale": "style",
"type": "style",
"typescriptOnly": true,
"hasFix": true,
"documentation": "https://palantir.github.io/tslint/rules/callable-types",
"path": "./node_modules/tslint/lib/rules/callableTypesRule.js",
"ruleName": "callable-types",
"source": "tslint",
"sourcePath": "./node_modules/tslint"
},
"chai-prefer-contains-to-index-of": {
"id": "./node_modules/tslint-microsoft-contrib:chai-prefer-contains-to-index-of",
"type": "maintainability",
"description": "Avoid Chai assertions that invoke indexOf and compare for a -1 result.",
"typescriptOnly": true,
"issueClass": "Non-SDL",
"issueType": "Warning",
"severity": "Important",
"level": "Opportunity for Excellence",
"group": "Clarity",
"commonWeaknessEnumeration": "398, 710",
"documentation": "https://github.com/Microsoft/tslint-microsoft-contrib#supported-rules",
"path": "./node_modules/tslint-microsoft-contrib/chaiPreferContainsToIndexOfRule.js",
"ruleName": "chai-prefer-contains-to-index-of",
"source": "tslint-microsoft-contrib",
"sourcePath": "./node_modules/tslint-microsoft-contrib"
},
"chai-vague-errors": {
"id": "./node_modules/tslint-microsoft-contrib:chai-vague-errors",
"type": "maintainability",
"description": "Avoid Chai assertions that result in vague errors",
"typescriptOnly": true,
"issueClass": "Non-SDL",
"issueType": "Warning",
"severity": "Important",
"level": "Opportunity for Excellence",
"group": "Clarity",
"commonWeaknessEnumeration": "398, 710",
"documentation": "https://github.com/Microsoft/tslint-microsoft-contrib#supported-rules",
"path": "./node_modules/tslint-microsoft-contrib/chaiVagueErrorsRule.js",
"ruleName": "chai-vague-errors",
"source": "tslint-microsoft-contrib",
"sourcePath": "./node_modules/tslint-microsoft-contrib"
},
"class-name": {
"id": "./node_modules/tslint:class-name",
"description": "Enforces PascalCased class and interface names.",
"rationale": "\nMakes it easy to differentiate classes from regular variables at a glance.\n\nJavaScript and general programming convention is to refer to classes in PascalCase.\nIt's confusing to use camelCase or other conventions for class names.\n ",
"type": "style",
"typescriptOnly": false,
"codeExamples": [
{
"description": "Enforces PascalCased class and interface names.",
"config": "\n\"rules\": { \"class-name\": true }\n ",
"pass": "\nclass MyClass { }\ninterface MyInterface { }\n ",
"fail": "\nclass myClass { }\ninterface myInterface { }\n "
}
],
"documentation": "https://palantir.github.io/tslint/rules/class-name",
"path": "./node_modules/tslint/lib/rules/classNameRule.js",
"ruleName": "class-name",
"source": "tslint",
"sourcePath": "./node_modules/tslint"
},
"comment-format": {
"id": "./node_modules/tslint:comment-format",
"description": "Enforces formatting rules for single-line comments.",
"rationale": "Helps maintain a consistent, readable style in your codebase.",
"optionsDescription": "\nThree arguments may be optionally provided:\n\n* `\"check-space\"` requires that all single-line comments must begin with a space, as in `// comment`\n * note that for comments starting with multiple slashes, e.g. `///`, leading slashes are ignored\n * TypeScript reference comments are ignored completely\n* `\"check-lowercase\"` requires that the first non-whitespace character of a comment must be lowercase, if applicable.\n* `\"check-uppercase\"` requires that the first non-whitespace character of a comment must be uppercase, if applicable.\n\nExceptions to `\"check-lowercase\"` or `\"check-uppercase\"` can be managed with object that may be passed as last argument.\n\nOne of two options can be provided in this object:\n\n * `\"ignore-words\"` - array of strings - words that will be ignored at the beginning of the comment.\n * `\"ignore-pattern\"` - string - RegExp pattern that will be ignored at the beginning of the comment.\n",
"options": {
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"enum": [
"check-space",
"check-lowercase",
"check-uppercase"
]
},
{
"type": "object",
"properties": {
"ignore-words": {
"type": "array",
"items": {
"type": "string"
}
},
"ignore-pattern": {
"type": "string"
}
},
"minProperties": 1,
"maxProperties": 1
}
]
},
"minLength": 1,
"maxLength": 4
},
"optionExamples": [
[
true,
"check-space",
"check-uppercase"
],
[
true,
"check-lowercase",
{
"ignore-words": [
"TODO",
"HACK"
]
}
],
[
true,
"check-lowercase",
{
"ignore-pattern": "STD\\w{2,3}\\b"
}
]
],
"type": "style",
"typescriptOnly": false,
"hasFix": true,
"documentation": "https://palantir.github.io/tslint/rules/comment-format",
"path": "./node_modules/tslint/lib/rules/commentFormatRule.js",
"ruleName": "comment-format",
"source": "tslint",
"sourcePath": "./node_modules/tslint"
},
"comment-type": {
"id": "./node_modules/tslint:comment-type",
"description": "Allows a limited set of comment types",
"optionsDescription": "\nOne or more of the following mutually exclusive comment types may be provided:\n\n* `singleline`: Comments starting with `//`\n* `multiline`: Comments between `/*` and `*/` but are not doc comments\n* `doc`: Multiline comments that start with `/**`\n* 'directive': Triple-slash directives that are singleline comments starting with `///`",
"options": {
"type": "array",
"items": {
"type": "string",
"enum": [
"singleline",
"multiline",
"doc",
"directive"
]
},
"uniqueItems": true
},
"optionExamples": [
[
true,
"doc",
"singleline"
],
[
true,
"singleline"
],
[
true,
"multiline"
]
],
"hasFix": false,
"type": "style",
"typescriptOnly": false,
"documentation": "https://palantir.github.io/tslint/rules/comment-type",
"path": "./node_modules/tslint/lib/rules/commentTypeRule.js",
"ruleName": "comment-type",
"source": "tslint",
"sourcePath": "./node_modules/tslint"
},
"completed-docs": {
"id": "./node_modules/tslint:completed-docs",
"description": "Enforces JSDoc comments for important items be filled out.",
"optionsDescription": "\n`true` to enable for `[classes, functions, methods, properties]`,\nor an array with each item in one of two formats:\n\n* `string` to enable for that type\n* `object` keying types to when their documentation is required:\n * `\"methods\"` and `\"properties\"` may specify:\n * `\"privacies\"`:\n * `\"all\"`\n * `\"private\"`\n * `\"protected\"`\n * `\"public\"`\n * `\"locations\"`:\n * `\"all\"`\n * `\"instance\"`\n * `\"static\"`\n * Other types may specify `\"visibilities\"`:\n * `\"all\"`\n * `\"exported\"`\n * `\"internal\"`\n * All types may also provide `\"tags\"`\n with members specifying tags that allow the docs to not have a body.\n * `\"content\"`: Object mapping tags to `RegExp` bodies content allowed to count as complete docs.\n * `\"existence\"`: Array of tags that must only exist to count as complete docs.\n\nTypes that may be enabled are:\n\n* `\"classes\"`\n* `\"enums\"`\n* `\"enum-members\"`\n* `\"functions\"`\n* `\"interfaces\"`\n* `\"methods\"`\n* `\"namespaces\"`\n* `\"properties\"`\n* `\"types\"`\n* `\"variables\"`",
"options": {
"type": "array",
"items": {
"anyOf": [
{
"options": [
"classes",
"enums",
"functions",
"interfaces",
"methods",
"namespaces",
"properties",
"types",
"variables"
],
"type": "string"
},
{
"type": "object",
"properties": {
"classes": {
"properties": {
"tags": {
"properties": {
"content": {
"items": {
"type": "string"
},
"type": "object"
},
"existence": {
"items": {
"type": "string"
},
"type": "array"
}
}
},
"visibilities": {
"enum": [
"all",
"exported",
"internal"
],
"type": "string"
}
},
"type": "object"
},
"enums": {
"properties": {
"tags": {
"properties": {
"content": {
"items": {
"type": "string"
},
"type": "object"
},
"existence": {
"items": {
"type": "string"
},
"type": "array"
}
}
},
"visibilities": {
"enum": [
"all",
"exported",
"internal"
],
"type": "string"
}
},
"type": "object"
},
"enum-members": {
"properties": {
"tags": {
"properties": {
"content": {
"items": {
"type": "string"
},
"type": "object"
},
"existence": {
"items": {
"type": "string"
},
"type": "array"
}
}
},
"visibilities": {
"enum": [
"all",
"exported",
"internal"
],
"type": "string"
}
},
"type": "object"
},
"functions": {
"properties": {
"tags": {
"properties": {
"content": {
"items": {
"type": "string"
},
"type": "object"
},
"existence": {
"items": {
"type": "string"
},
"type": "array"
}
}
},
"visibilities": {
"enum": [
"all",
"exported",
"internal"
],
"type": "string"
}
},
"type": "object"
},
"interfaces": {
"properties": {
"tags": {
"properties": {
"content": {
"items": {
"type": "string"
},
"type": "object"
},
"existence": {
"items": {
"type": "string"
},
"type": "array"
}
}
},
"visibilities": {
"enum": [
"all",
"exported",
"internal"
],
"type": "string"
}
},
"type": "object"
},
"methods": {
"properties": {
"tags": {
"properties": {
"content": {
"items": {
"type": "string"
},
"type": "object"
},
"existence": {
"items": {
"type": "string"
},
"type": "array"
}
}
},
"locations": {
"enum": [
"all",
"instance",
"static"
],
"type": "string"
},
"privacies": {
"enum": [
"all",
"private",
"protected",
"public"
],
"type": "string"
}
},
"type": "object"
},
"namespaces": {
"properties": {
"tags": {
"properties": {
"content": {
"items": {
"type": "string"
},
"type": "object"
},
"existence": {
"items": {
"type": "string"
},
"type": "array"
}
}
},
"visibilities": {
"enum": [
"all",
"exported",
"internal"
],
"type": "string"
}
},
"type": "object"
},
"properties": {
"properties": {
"tags": {
"properties": {
"content": {
"items": {
"type": "string"
},
"type": "object"
},
"existence": {
"items": {
"type": "string"
},
"type": "array"
}
}
},
"locations": {
"enum": [
"all",
"instance",
"static"
],
"type": "string"
},
"privacies": {
"enum": [
"all",
"private",
"protected",
"public"
],
"type": "string"
}
},
"type": "object"
},
"types": {
"properties": {
"tags": {
"properties": {
"content": {
"items": {
"type": "string"
},
"type": "object"
},
"existence": {
"items": {
"type": "string"
},
"type": "array"
}
}
},
"visibilities": {
"enum": [
"all",
"exported",
"internal"
],
"type": "string"
}
},
"type": "object"
},
"variables": {
"properties": {
"tags": {
"properties": {
"content": {
"items": {
"type": "string"
},
"type": "object"
},
"existence": {
"items": {
"type": "string"
},
"type": "array"
}
}
},
"visibilities": {
"enum": [
"all",
"exported",
"internal"
],
"type": "string"
}
},
"type": "object"
}
}
}
]
}
},
"optionExamples": [
true,
[
true,
"enums",
"functions",
"methods"
],
[
true,
{
"enums": true,
"functions": {
"visibilities": [
"exported"
]
},
"methods": {
"locations": "instance",
"privacies": [
"public",
"protected"
]
},
"properties": {
"tags": {
"content": {
"see": [
"#.*"
]
},
"existence": [
"inheritdoc"
]
}
}
}
]
],
"rationale": "\nHelps ensure important components are documented.\n\nNote: use this rule sparingly. It's better to have self-documenting names on components with single, consice responsibilities.\nComments that only restate the names of variables add nothing to code, and can easily become outdated.\n ",
"type": "style",
"typescriptOnly": false,
"documentation": "https://palantir.github.io/tslint/rules/completed-docs",
"path": "./node_modules/tslint/lib/rules/completedDocsRule.js",
"ruleName": "completed-docs",
"source": "tslint",
"sourcePath": "./node_modules/tslint"
},
"curly": {
"id": "./node_modules/tslint:curly",
"description": "Enforces braces for `if`/`for`/`do`/`while` statements.",
"rationale": "\n```ts\nif (foo === bar)\n foo++;\n bar++;\n```\n\nIn the code above, the author almost certainly meant for both `foo++` and `bar++`\nto be executed only if `foo === bar`. However, they forgot braces and `bar++` will be executed\nno matter what. This rule could prevent such a mistake.",
"optionsDescription": "\nOne of the following options may be provided:\n\n* `\"as-needed\"` forbids any unnecessary curly braces.\n* `\"ignore-same-line\"` skips checking braces for control-flow statements\nthat are on one line and start on the same line as their control-flow keyword\n ",
"options": {
"type": "array",
"items": {
"type": "string",