forked from sonar-scala/sonar-scala
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathsonar-scala-metadata.json
4892 lines (4892 loc) · 229 KB
/
sonar-scala-metadata.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
{
"repositories": {
"sonar-scala-scalastyle": {
"key": "sonar-scala-scalastyle",
"name": "Scalastyle",
"rules": [
{
"description": "*Checks that block imports are not used.*\n\nBlock imports, e.g. `import a.{b, c}` can lead to annoying merge errors in large code bases that are maintained by lot of developers. This rule allows to ensure that only single imports are used in order to minimize merge errors in import declarations.",
"key": "org.scalastyle.scalariform.BlockImportChecker",
"name": "Avoid block imports",
"params": [
{
"default": "org.scalastyle.scalariform.BlockImportChecker",
"description": "Scalastyle's rule (checker) class name.",
"name": "ruleClass",
"typ": "String"
}
],
"severity": "Minor",
"template": false
},
{
"description": "*Checks that curlies imports are not used.*\n\nCurlies imports, e.g. `import a.{b, c}`, can lead to annoying merge errors in large code bases that are maintained by lot of developers. This rule allows to ensure that only single imports, no renaming and no hiding imports are used in order to minimize merge errors in import declarations.",
"key": "org.scalastyle.scalariform.CurliesImportChecker",
"name": "Avoid curlies imports",
"params": [
{
"default": "org.scalastyle.scalariform.CurliesImportChecker",
"description": "Scalastyle's rule (checker) class name.",
"name": "ruleClass",
"typ": "String"
}
],
"severity": "Minor",
"template": false
},
{
"description": "*Avoid wildcard imports.*\n\nImporting all classes from a package or static members from a class leads to tight coupling between packages or classes and might lead to problems when a new version of a library introduces name clashes.",
"key": "org.scalastyle.scalariform.UnderscoreImportChecker",
"name": "Avoid wildcard imports",
"params": [
{
"default": "org.scalastyle.scalariform.UnderscoreImportChecker",
"description": "Scalastyle's rule (checker) class name.",
"name": "ruleClass",
"typ": "String"
}
],
"severity": "Minor",
"template": false
},
{
"description": "*Check that class names match a regular expression.*\n\nThe Scala style guide recommends that class names conform to certain standards.",
"key": "org.scalastyle.scalariform.ClassNamesChecker-template",
"name": "Class name",
"params": [
{
"default": "^[A-Z][A-Za-z]*$",
"description": "Regular expression: The class names must match this regular expression.",
"name": "regex",
"typ": "String"
},
{
"default": "org.scalastyle.scalariform.ClassNamesChecker",
"description": "Scalastyle's rule (checker) class name.",
"name": "ruleClass",
"typ": "String"
}
],
"severity": "Minor",
"template": true
},
{
"description": "*Check that class names match a regular expression.*\n\nThe Scala style guide recommends that class names conform to certain standards.",
"key": "org.scalastyle.scalariform.ClassNamesChecker",
"name": "Class name",
"params": [
{
"default": "^[A-Z][A-Za-z]*$",
"description": "Regular expression: The class names must match this regular expression.",
"name": "regex",
"typ": "String"
},
{
"default": "org.scalastyle.scalariform.ClassNamesChecker",
"description": "Scalastyle's rule (checker) class name.",
"name": "ruleClass",
"typ": "String"
}
],
"severity": "Minor",
"template": false
},
{
"description": "*Checks that type parameter to a class matches a regular expression.*\n\nScala generic type names are generally single upper case letters. This check checks for classes and traits. Note that this check only checks the innermost type parameter, to allow for `List[T]`.",
"key": "org.scalastyle.scalariform.ClassTypeParameterChecker-template",
"name": "Class type parameter name",
"params": [
{
"default": "^[A-Z_]$",
"description": "Regular expression: Standard Scala regular expression syntax.",
"name": "regex",
"typ": "String"
},
{
"default": "org.scalastyle.scalariform.ClassTypeParameterChecker",
"description": "Scalastyle's rule (checker) class name.",
"name": "ruleClass",
"typ": "String"
}
],
"severity": "Minor",
"template": true
},
{
"description": "*Checks that type parameter to a class matches a regular expression.*\n\nScala generic type names are generally single upper case letters. This check checks for classes and traits. Note that this check only checks the innermost type parameter, to allow for `List[T]`.",
"key": "org.scalastyle.scalariform.ClassTypeParameterChecker",
"name": "Class type parameter name",
"params": [
{
"default": "^[A-Z_]$",
"description": "Regular expression: Standard Scala regular expression syntax.",
"name": "regex",
"typ": "String"
},
{
"default": "org.scalastyle.scalariform.ClassTypeParameterChecker",
"description": "Scalastyle's rule (checker) class name.",
"name": "ruleClass",
"typ": "String"
}
],
"severity": "Minor",
"template": false
},
{
"description": "*Check that classes and objects do not define the clone() method.*\n\nThe clone method is difficult to get right. You can use the copy constructor of case classes rather than implementing clone. For more information on `clone()`, see Effective Java by Joshua Bloch pages.",
"key": "org.scalastyle.scalariform.NoCloneChecker",
"name": "Clone method",
"params": [
{
"default": "org.scalastyle.scalariform.NoCloneChecker",
"description": "Scalastyle's rule (checker) class name.",
"name": "ruleClass",
"typ": "String"
}
],
"severity": "Minor",
"template": false
},
{
"description": "*Check that classes and objects do not define equals without overriding equals(java.lang.Object).*\n\nMistakenly defining a covariant `equals()` method without overriding method `equals(java.lang.Object)` can produce unexpected runtime behaviour.",
"key": "org.scalastyle.scalariform.CovariantEqualsChecker",
"name": "Covariant equals",
"params": [
{
"default": "org.scalastyle.scalariform.CovariantEqualsChecker",
"description": "Scalastyle's rule (checker) class name.",
"name": "ruleClass",
"typ": "String"
}
],
"severity": "Minor",
"template": false
},
{
"description": "*Checks that the cyclomatic complexity of a method does exceed a value.*\n\nIf the code is too complex, then this can make code hard to read.",
"key": "org.scalastyle.scalariform.CyclomaticComplexityChecker-template",
"name": "Cyclomatic complexity",
"params": [
{
"default": "10",
"description": "Maximum: Maximum cyclomatic complexity to allow for a method.",
"name": "maximum",
"typ": "Integer"
},
{
"default": "true",
"description": "Count Cases: If true, each case increases method complexity, else only match keyword is considered.",
"name": "countCases",
"typ": "Boolean"
},
{
"default": "org.scalastyle.scalariform.CyclomaticComplexityChecker",
"description": "Scalastyle's rule (checker) class name.",
"name": "ruleClass",
"typ": "String"
}
],
"severity": "Minor",
"template": true
},
{
"description": "*Checks that the cyclomatic complexity of a method does exceed a value.*\n\nIf the code is too complex, then this can make code hard to read.",
"key": "org.scalastyle.scalariform.CyclomaticComplexityChecker",
"name": "Cyclomatic complexity",
"params": [
{
"default": "10",
"description": "Maximum: Maximum cyclomatic complexity to allow for a method.",
"name": "maximum",
"typ": "Integer"
},
{
"default": "true",
"description": "Count Cases: If true, each case increases method complexity, else only match keyword is considered.",
"name": "countCases",
"typ": "Boolean"
},
{
"default": "org.scalastyle.scalariform.CyclomaticComplexityChecker",
"description": "Scalastyle's rule (checker) class name.",
"name": "ruleClass",
"typ": "String"
}
],
"severity": "Minor",
"template": false
},
{
"description": "*The interpolation for this string literal is not necessary.*\n\nEmpty interpolated strings are harder to read and not necessary.",
"key": "org.scalastyle.scalariform.EmptyInterpolatedStringChecker",
"name": "Empty interpolated string",
"params": [
{
"default": "org.scalastyle.scalariform.EmptyInterpolatedStringChecker",
"description": "Scalastyle's rule (checker) class name.",
"name": "ruleClass",
"typ": "String"
}
],
"severity": "Minor",
"template": false
},
{
"description": "*Check that if a class implements either equals or hashCode, it should implement the other.*\n\nDefining either equals or hashCode in a class without defining the is a known source of bugs. Usually, when you define one, you should also define the other.",
"key": "org.scalastyle.scalariform.EqualsHashCodeChecker",
"name": "Equals hashCode",
"params": [
{
"default": "org.scalastyle.scalariform.EqualsHashCodeChecker",
"description": "Scalastyle's rule (checker) class name.",
"name": "ruleClass",
"typ": "String"
}
],
"severity": "Minor",
"template": false
},
{
"description": "*Check that field names match a regular expression.*\n\nA consistent naming convention for field names can make code easier to read and understand.",
"key": "org.scalastyle.scalariform.FieldNamesChecker-template",
"name": "Field name",
"params": [
{
"default": "^[a-z][A-Za-z0-9]*$",
"description": "Regular expression: The field names must match this regular expression.",
"name": "regex",
"typ": "String"
},
{
"default": "^[A-Z][A-Za-z0-9]*$",
"description": "Regular expression for constants: The object field (constant) names must match this regular expression.",
"name": "objectFieldRegex",
"typ": "String"
},
{
"default": "org.scalastyle.scalariform.FieldNamesChecker",
"description": "Scalastyle's rule (checker) class name.",
"name": "ruleClass",
"typ": "String"
}
],
"severity": "Minor",
"template": true
},
{
"description": "*Check that field names match a regular expression.*\n\nA consistent naming convention for field names can make code easier to read and understand.",
"key": "org.scalastyle.scalariform.FieldNamesChecker",
"name": "Field name",
"params": [
{
"default": "^[a-z][A-Za-z0-9]*$",
"description": "Regular expression: The field names must match this regular expression.",
"name": "regex",
"typ": "String"
},
{
"default": "^[A-Z][A-Za-z0-9]*$",
"description": "Regular expression for constants: The object field (constant) names must match this regular expression.",
"name": "objectFieldRegex",
"typ": "String"
},
{
"default": "org.scalastyle.scalariform.FieldNamesChecker",
"description": "Scalastyle's rule (checker) class name.",
"name": "ruleClass",
"typ": "String"
}
],
"severity": "Minor",
"template": false
},
{
"description": "*Check the number of lines in a file.*\n\nFiles which are too long can be hard to read and understand.",
"key": "org.scalastyle.file.FileLengthChecker-template",
"name": "File length",
"params": [
{
"default": "1500",
"description": "Maximum file length: Maximum number of lines in a file.",
"name": "maxFileLength",
"typ": "Integer"
},
{
"default": "org.scalastyle.file.FileLengthChecker",
"description": "Scalastyle's rule (checker) class name.",
"name": "ruleClass",
"typ": "String"
}
],
"severity": "Minor",
"template": true
},
{
"description": "*Check the number of lines in a file.*\n\nFiles which are too long can be hard to read and understand.",
"key": "org.scalastyle.file.FileLengthChecker",
"name": "File length",
"params": [
{
"default": "1500",
"description": "Maximum file length: Maximum number of lines in a file.",
"name": "maxFileLength",
"typ": "Integer"
},
{
"default": "org.scalastyle.file.FileLengthChecker",
"description": "Scalastyle's rule (checker) class name.",
"name": "ruleClass",
"typ": "String"
}
],
"severity": "Minor",
"template": false
},
{
"description": "*Check the number of characters in a line.*\n\nLines that are too long can be hard to read and horizontal scrolling is annoying.",
"key": "org.scalastyle.file.FileLineLengthChecker-template",
"name": "File line length",
"params": [
{
"default": "160",
"description": "Maximum line length: Maximum number of characters in a line.",
"name": "maxLineLength",
"typ": "Integer"
},
{
"default": "4",
"description": "Tab size: Number of characters that a tab represents.",
"name": "tabSize",
"typ": "Integer"
},
{
"default": "false",
"description": "Ignore import statements: Ignore import statements.",
"name": "ignoreImports",
"typ": "Boolean"
},
{
"default": "org.scalastyle.file.FileLineLengthChecker",
"description": "Scalastyle's rule (checker) class name.",
"name": "ruleClass",
"typ": "String"
}
],
"severity": "Minor",
"template": true
},
{
"description": "*Check the number of characters in a line.*\n\nLines that are too long can be hard to read and horizontal scrolling is annoying.",
"key": "org.scalastyle.file.FileLineLengthChecker",
"name": "File line length",
"params": [
{
"default": "160",
"description": "Maximum line length: Maximum number of characters in a line.",
"name": "maxLineLength",
"typ": "Integer"
},
{
"default": "4",
"description": "Tab size: Number of characters that a tab represents.",
"name": "tabSize",
"typ": "Integer"
},
{
"default": "false",
"description": "Ignore import statements: Ignore import statements.",
"name": "ignoreImports",
"typ": "Boolean"
},
{
"default": "org.scalastyle.file.FileLineLengthChecker",
"description": "Scalastyle's rule (checker) class name.",
"name": "ruleClass",
"typ": "String"
}
],
"severity": "Minor",
"template": false
},
{
"description": "*Check that classes and objects do not define the finalize() method.*\n\n`finalize()` is called when the object is garbage collected, and garbage collection is not guaranteed to happen. It is therefore unwise to rely on code in `finalize()` method.",
"key": "org.scalastyle.scalariform.NoFinalizeChecker",
"name": "Finalize method",
"params": [
{
"default": "org.scalastyle.scalariform.NoFinalizeChecker",
"description": "Scalastyle's rule (checker) class name.",
"name": "ruleClass",
"typ": "String"
}
],
"severity": "Minor",
"template": false
},
{
"description": "*Checks that imports are grouped together, not throughout the file.*\n\nIf imports are spread throughout the file, knowing what is in scope at any one place can be difficult to work out.",
"key": "org.scalastyle.scalariform.ImportGroupingChecker",
"name": "Group imports",
"params": [
{
"default": "org.scalastyle.scalariform.ImportGroupingChecker",
"description": "Scalastyle's rule (checker) class name.",
"name": "ruleClass",
"typ": "String"
}
],
"severity": "Minor",
"template": false
},
{
"description": "*Checks that if statements have braces.*\n\nSome people find if clauses with braces easier to read.\n\nThe `singleLineAllowed` property allows if constructions of the type:\n\n```scala\nif (bool_expression) expression1 else expression2\n```\n\nThe `doubleLineAllowed` property allows if constructions of the type:\n\n```scala\nif (bool_expression) expression1 else expression2\n```\n\nNote: If you intend to enable only if expressions in the format below, disable the IfBraceChecker altogether.\n\n```scala\nif (bool_expression) expression1 else expression2\n```",
"key": "org.scalastyle.scalariform.IfBraceChecker-template",
"name": "If block braces",
"params": [
{
"default": "true",
"description": "Single Line Allowed: If without braces allowed if everything is on one line.",
"name": "singleLineAllowed",
"typ": "Boolean"
},
{
"default": "false",
"description": "Double Line Allowed: If without braces allowed if everything is on one line or two lines.",
"name": "doubleLineAllowed",
"typ": "Boolean"
},
{
"default": "org.scalastyle.scalariform.IfBraceChecker",
"description": "Scalastyle's rule (checker) class name.",
"name": "ruleClass",
"typ": "String"
}
],
"severity": "Minor",
"template": true
},
{
"description": "*Checks that if statements have braces.*\n\nSome people find if clauses with braces easier to read.\n\nThe `singleLineAllowed` property allows if constructions of the type:\n\n```scala\nif (bool_expression) expression1 else expression2\n```\n\nThe `doubleLineAllowed` property allows if constructions of the type:\n\n```scala\nif (bool_expression) expression1 else expression2\n```\n\nNote: If you intend to enable only if expressions in the format below, disable the IfBraceChecker altogether.\n\n```scala\nif (bool_expression) expression1 else expression2\n```",
"key": "org.scalastyle.scalariform.IfBraceChecker",
"name": "If block braces",
"params": [
{
"default": "true",
"description": "Single Line Allowed: If without braces allowed if everything is on one line.",
"name": "singleLineAllowed",
"typ": "Boolean"
},
{
"default": "false",
"description": "Double Line Allowed: If without braces allowed if everything is on one line or two lines.",
"name": "doubleLineAllowed",
"typ": "Boolean"
},
{
"default": "org.scalastyle.scalariform.IfBraceChecker",
"description": "Scalastyle's rule (checker) class name.",
"name": "ruleClass",
"typ": "String"
}
],
"severity": "Minor",
"template": false
},
{
"description": "*Check that a class does not import certain classes.*\n\nUse of some classes can be discouraged for a project. For instance, use of `sun._` is generally discouraged because they are internal to the JDK and can be changed.",
"key": "org.scalastyle.scalariform.IllegalImportsChecker-template",
"name": "Illegal imports",
"params": [
{
"default": "sun._,java.awt._",
"description": "Illegal Imports: The comma separated list of illegal imports, wildcards allowed.",
"name": "illegalImports",
"typ": "String"
},
{
"default": "org.scalastyle.scalariform.IllegalImportsChecker",
"description": "Scalastyle's rule (checker) class name.",
"name": "ruleClass",
"typ": "String"
}
],
"severity": "Minor",
"template": true
},
{
"description": "*Check that a class does not import certain classes.*\n\nUse of some classes can be discouraged for a project. For instance, use of `sun._` is generally discouraged because they are internal to the JDK and can be changed.",
"key": "org.scalastyle.scalariform.IllegalImportsChecker",
"name": "Illegal imports",
"params": [
{
"default": "sun._,java.awt._",
"description": "Illegal Imports: The comma separated list of illegal imports, wildcards allowed.",
"name": "illegalImports",
"typ": "String"
},
{
"default": "org.scalastyle.scalariform.IllegalImportsChecker",
"description": "Scalastyle's rule (checker) class name.",
"name": "ruleClass",
"typ": "String"
}
],
"severity": "Minor",
"template": false
},
{
"description": "*Checks that imports are grouped and ordered according to the style configuration.*\n\nConsistent import ordering improves code readability and reduces unrelated changes in patches.",
"key": "org.scalastyle.scalariform.ImportOrderChecker",
"name": "Import Order",
"params": [
{
"default": "org.scalastyle.scalariform.ImportOrderChecker",
"description": "Scalastyle's rule (checker) class name.",
"name": "ruleClass",
"typ": "String"
}
],
"severity": "Minor",
"template": false
},
{
"description": "*Check that there are no tabs in a file.*\n\nSome say that tabs are evil.",
"key": "org.scalastyle.file.FileTabChecker",
"name": "Line contains Tab",
"params": [
{
"default": "org.scalastyle.file.FileTabChecker",
"description": "Scalastyle's rule (checker) class name.",
"name": "ruleClass",
"typ": "String"
}
],
"severity": "Minor",
"template": false
},
{
"description": "*Checks that argument literals are named.*\n\nNameless literals make code harder to understand (consider `updateEntity(1, true)` and `updateEntity(id = 1, enabled = true)`).",
"key": "org.scalastyle.scalariform.NamedArgumentChecker-template",
"name": "Literal passed as argument without name",
"params": [
{
"default": "false",
"description": "Check string literals: If true, also checks that string literal arguments are named.",
"name": "checkString",
"typ": "Boolean"
},
{
"default": "^set.+$",
"description": "Ignore methods by pattern: Pattern to ignore method calls by name.",
"name": "ignoreMethod",
"typ": "String"
},
{
"default": "org.scalastyle.scalariform.NamedArgumentChecker",
"description": "Scalastyle's rule (checker) class name.",
"name": "ruleClass",
"typ": "String"
}
],
"severity": "Minor",
"template": true
},
{
"description": "*Checks that argument literals are named.*\n\nNameless literals make code harder to understand (consider `updateEntity(1, true)` and `updateEntity(id = 1, enabled = true)`).",
"key": "org.scalastyle.scalariform.NamedArgumentChecker",
"name": "Literal passed as argument without name",
"params": [
{
"default": "false",
"description": "Check string literals: If true, also checks that string literal arguments are named.",
"name": "checkString",
"typ": "Boolean"
},
{
"default": "^set.+$",
"description": "Ignore methods by pattern: Pattern to ignore method calls by name.",
"name": "ignoreMethod",
"typ": "String"
},
{
"default": "org.scalastyle.scalariform.NamedArgumentChecker",
"description": "Scalastyle's rule (checker) class name.",
"name": "ruleClass",
"typ": "String"
}
],
"severity": "Minor",
"template": false
},
{
"description": "*Checks that if a long literal is used, then an uppercase L is used.*\n\nA lowercase L (l) can look similar to a number 1 with some fonts.",
"key": "org.scalastyle.scalariform.UppercaseLChecker",
"name": "Long literal uppercase L",
"params": [
{
"default": "org.scalastyle.scalariform.UppercaseLChecker",
"description": "Scalastyle's rule (checker) class name.",
"name": "ruleClass",
"typ": "String"
}
],
"severity": "Minor",
"template": false
},
{
"description": "*Checks that a case statement pattern match is not lower case, as this can cause confusion.*\n\nA lower case pattern match clause with no other tokens is the same as `_`; this is not true for patterns which start with an upper case letter. This can cause confusion, and may not be what was intended:\n\n```scala\nval foo = \"foo\"\nval Bar = \"bar\"\n\"bar\" match { case Bar => \"we got bar\" } // result = \"we got bar\"\n\"bar\" match { case foo => \"we got foo\" } // result = \"we got foo\"\n\"bar\" match { case `foo` => \"we got foo\" } // result = MatchError\n```\n\nThis checker raises a warning with the second match. To fix it, use an identifier which starts with an upper case letter (best), use `case _` or, if you wish to refer to the value, add a type `: Any`, e.g.:\n\n```scala\nval lc = \"lc\"\n\"something\" match { case lc: Any => \"lc\" } // result = \"lc\"\n\"something\" match { case _ => \"lc\" } // result = \"lc\"\n```",
"key": "org.scalastyle.scalariform.LowercasePatternMatchChecker",
"name": "Lowercase pattern match",
"params": [
{
"default": "org.scalastyle.scalariform.LowercasePatternMatchChecker",
"description": "Scalastyle's rule (checker) class name.",
"name": "ruleClass",
"typ": "String"
}
],
"severity": "Minor",
"template": false
},
{
"description": "*Checks for use of magic numbers.*\n\nReplacing a magic number with a named constant can make code easier to read and understand, and can avoid some subtle bugs.\n\nA simple assignment to a val is not considered to be a magic number, for example: `val foo = 4` is not a magic number, but `var foo = 4` is considered to be a magic number.",
"key": "org.scalastyle.scalariform.MagicNumberChecker-template",
"name": "Magic Number",
"params": [
{
"default": "-1,0,1,2",
"description": "Ignore: The comma separated list of numbers to ignore when used as magic numbers.",
"name": "ignore",
"typ": "String"
},
{
"default": "org.scalastyle.scalariform.MagicNumberChecker",
"description": "Scalastyle's rule (checker) class name.",
"name": "ruleClass",
"typ": "String"
}
],
"severity": "Minor",
"template": true
},
{
"description": "*Checks for use of magic numbers.*\n\nReplacing a magic number with a named constant can make code easier to read and understand, and can avoid some subtle bugs.\n\nA simple assignment to a val is not considered to be a magic number, for example: `val foo = 4` is not a magic number, but `var foo = 4` is considered to be a magic number.",
"key": "org.scalastyle.scalariform.MagicNumberChecker",
"name": "Magic Number",
"params": [
{
"default": "-1,0,1,2",
"description": "Ignore: The comma separated list of numbers to ignore when used as magic numbers.",
"name": "ignore",
"typ": "String"
},
{
"default": "org.scalastyle.scalariform.MagicNumberChecker",
"description": "Scalastyle's rule (checker) class name.",
"name": "ruleClass",
"typ": "String"
}
],
"severity": "Minor",
"template": false
},
{
"description": "*Check the first lines of each file matches the text.*\n\nA lot of projects require a header with a copyright notice, or they require a license in each file. This does a simple text comparison between the header and the first lines of the file. You can have multiple lines, but make sure you surround the text with a `CDATA` section. You can also specify a regular expression, as long as you set the regex parameter to `true`.",
"key": "org.scalastyle.file.HeaderMatchesChecker-template",
"name": "Match Header",
"params": [
{
"default": "",
"description": "Header: The lines to compare against.",
"name": "header",
"typ": "String"
},
{
"default": "false",
"description": "Header Regex: Whether to treat the header string as a regular expression.",
"name": "regex",
"typ": "Boolean"
},
{
"default": "org.scalastyle.file.HeaderMatchesChecker",
"description": "Scalastyle's rule (checker) class name.",
"name": "ruleClass",
"typ": "String"
}
],
"severity": "Minor",
"template": true
},
{
"description": "*Maximum number of parameters for a method.*\n\nA method which has more than a certain number of parameters can be hard to understand.",
"key": "org.scalastyle.scalariform.ParameterNumberChecker-template",
"name": "Maximum parameters",
"params": [
{
"default": "8",
"description": "Maximum Number: The maximum number of parameters.",
"name": "maxParameters",
"typ": "Integer"
},
{
"default": "org.scalastyle.scalariform.ParameterNumberChecker",
"description": "Scalastyle's rule (checker) class name.",
"name": "ruleClass",
"typ": "String"
}
],
"severity": "Minor",
"template": true
},
{
"description": "*Maximum number of parameters for a method.*\n\nA method which has more than a certain number of parameters can be hard to understand.",
"key": "org.scalastyle.scalariform.ParameterNumberChecker",
"name": "Maximum parameters",
"params": [
{
"default": "8",
"description": "Maximum Number: The maximum number of parameters.",
"name": "maxParameters",
"typ": "Integer"
},
{
"default": "org.scalastyle.scalariform.ParameterNumberChecker",
"description": "Scalastyle's rule (checker) class name.",
"name": "ruleClass",
"typ": "String"
}
],
"severity": "Minor",
"template": false
},
{
"description": "*Check that method argument names match a regular expression.*\n\nThe Scala style guide recommends that method argument names conform to certain standards.",
"key": "org.scalastyle.scalariform.MethodArgumentNamesChecker-template",
"name": "Method argument name",
"params": [
{
"default": "^[a-z][A-Za-z0-9]*$",
"description": "Regular expression: The method argument names must match this regular expression.",
"name": "regex",
"typ": "String"
},
{
"default": "^$",
"description": "Regular expression to ignore: Method argument names which match this regular expression will be ignored.",
"name": "ignoreRegex",
"typ": "String"
},
{
"default": "org.scalastyle.scalariform.MethodArgumentNamesChecker",
"description": "Scalastyle's rule (checker) class name.",
"name": "ruleClass",
"typ": "String"
}
],
"severity": "Minor",
"template": true
},
{
"description": "*Check that method argument names match a regular expression.*\n\nThe Scala style guide recommends that method argument names conform to certain standards.",
"key": "org.scalastyle.scalariform.MethodArgumentNamesChecker",
"name": "Method argument name",
"params": [
{
"default": "^[a-z][A-Za-z0-9]*$",
"description": "Regular expression: The method argument names must match this regular expression.",
"name": "regex",
"typ": "String"
},
{
"default": "^$",
"description": "Regular expression to ignore: Method argument names which match this regular expression will be ignored.",
"name": "ignoreRegex",
"typ": "String"
},
{
"default": "org.scalastyle.scalariform.MethodArgumentNamesChecker",
"description": "Scalastyle's rule (checker) class name.",
"name": "ruleClass",
"typ": "String"
}
],
"severity": "Minor",
"template": false
},
{
"description": "*Checks that methods do not exceed a maximum length.*\n\nLong methods can be hard to read and understand.",
"key": "org.scalastyle.scalariform.MethodLengthChecker-template",
"name": "Method length",
"params": [
{
"default": "50",
"description": "Maximum length: Maximum number of lines allowed for a method.",
"name": "maxLength",
"typ": "Integer"
},
{
"default": "false",
"description": "Ignore comments: If set to true, comment lines in method body won't be counted.",
"name": "ignoreComments",
"typ": "Boolean"
},
{
"default": "false",
"description": "Ignore empty lines: If set to true, empty lines in method body won't be counted.",
"name": "ignoreEmpty",
"typ": "Boolean"
},
{
"default": "org.scalastyle.scalariform.MethodLengthChecker",
"description": "Scalastyle's rule (checker) class name.",
"name": "ruleClass",
"typ": "String"
}
],
"severity": "Minor",
"template": true
},
{
"description": "*Checks that methods do not exceed a maximum length.*\n\nLong methods can be hard to read and understand.",
"key": "org.scalastyle.scalariform.MethodLengthChecker",
"name": "Method length",
"params": [
{
"default": "50",
"description": "Maximum length: Maximum number of lines allowed for a method.",
"name": "maxLength",
"typ": "Integer"
},
{
"default": "false",
"description": "Ignore comments: If set to true, comment lines in method body won't be counted.",
"name": "ignoreComments",
"typ": "Boolean"
},
{
"default": "false",
"description": "Ignore empty lines: If set to true, empty lines in method body won't be counted.",
"name": "ignoreEmpty",
"typ": "Boolean"
},
{
"default": "org.scalastyle.scalariform.MethodLengthChecker",
"description": "Scalastyle's rule (checker) class name.",
"name": "ruleClass",
"typ": "String"
}
],
"severity": "Minor",
"template": false
},
{
"description": "*Check that method names match a regular expression.*\n\nThe Scala style guide recommends that method names conform to certain standards. If the methods are overriding another method, and the overridden method cannot be changed, then use the `ignoreOverride` parameter.",
"key": "org.scalastyle.scalariform.MethodNamesChecker-template",
"name": "Method name",
"params": [
{
"default": "^[a-z][A-Za-z0-9]*(_=)?$",
"description": "Regular expression: The method names must match this regular expression.",
"name": "regex",
"typ": "String"
},
{
"default": "^$",
"description": "Regular expression to ignore: Method names which match this regular expression will be ignored.",
"name": "ignoreRegex",
"typ": "String"
},
{
"default": "false",
"description": "Ignore override: If set to true, methods which have the override modifier are ignored.",
"name": "ignoreOverride",
"typ": "Boolean"
},
{
"default": "org.scalastyle.scalariform.MethodNamesChecker",
"description": "Scalastyle's rule (checker) class name.",
"name": "ruleClass",
"typ": "String"
}
],
"severity": "Minor",
"template": true
},
{
"description": "*Check that method names match a regular expression.*\n\nThe Scala style guide recommends that method names conform to certain standards. If the methods are overriding another method, and the overridden method cannot be changed, then use the `ignoreOverride` parameter.",
"key": "org.scalastyle.scalariform.MethodNamesChecker",
"name": "Method name",
"params": [
{
"default": "^[a-z][A-Za-z0-9]*(_=)?$",
"description": "Regular expression: The method names must match this regular expression.",
"name": "regex",
"typ": "String"
},
{
"default": "^$",
"description": "Regular expression to ignore: Method names which match this regular expression will be ignored.",
"name": "ignoreRegex",
"typ": "String"
},
{
"default": "false",
"description": "Ignore override: If set to true, methods which have the override modifier are ignored.",
"name": "ignoreOverride",
"typ": "Boolean"
},
{
"default": "org.scalastyle.scalariform.MethodNamesChecker",
"description": "Scalastyle's rule (checker) class name.",
"name": "ruleClass",
"typ": "String"
}
],
"severity": "Minor",
"template": false
},
{
"description": "*Checks that the ScalaDoc on documentable members is well-formed.*\n\nScaladoc is generally considered a good thing. Within reason.\n\nIgnore tokens is a comma separated string that may include the following: `PatDefOrDcl` (variables), `TmplDef` (classes, traits), `TypeDefOrDcl` (type definitions), `FunDefOrDcl` (functions). Supported indentation styles are \"scaladoc\" (for ScalaDoc-style comments, with two spaces before the asterisk), \"javadoc\" (for JavaDoc-style comments, with a single space before the asterisk) or \"anydoc\" to support any style (any number of spaces before the asterisk). For backwards compatibility, if left empty, \"anydoc\" will be assumed.",
"key": "org.scalastyle.scalariform.ScalaDocChecker-template",
"name": "Missing or badly formed ScalaDoc",
"params": [
{
"default": "^$",
"description": "Regular expression: Class names matching this regular expression will be ignored.",
"name": "ignoreRegex",
"typ": "String"
},
{
"default": "^$",
"description": "Comma Separated String: Include the following to ignore : PatDefOrDcl (variables), TmplDef (classes, traits), TypeDefOrDcl (type definitions), FunDefOrDcl (functions).",
"name": "ignoreTokenTypes",
"typ": "String"
},
{
"default": "false",
"description": "Ignore override: If set to true, methods which have the override modifier are ignored.",
"name": "ignoreOverride",
"typ": "Boolean"
},
{
"default": "anydoc",
"description": "Force indent style: Possible values: scaladoc - 2 spaces before *, javadoc - 1 space before *.",
"name": "indentStyle",
"typ": "String"
},
{
"default": "org.scalastyle.scalariform.ScalaDocChecker",
"description": "Scalastyle's rule (checker) class name.",
"name": "ruleClass",
"typ": "String"
}
],
"severity": "Minor",
"template": true
},
{
"description": "*Checks that a string literal does not appear multiple times.*\n\nCode duplication makes maintenance more difficult, so it can be better to replace the multiple occurrences with a constant.",
"key": "org.scalastyle.scalariform.MultipleStringLiteralsChecker-template",
"name": "Multiple string literals",
"params": [
{
"default": "1",
"description": "Maximum occurences allowed: Maximum number of occurences allowed.",
"name": "allowed",
"typ": "Integer"
},
{
"default": "^\"\"$",