-
-
Notifications
You must be signed in to change notification settings - Fork 12
/
Copy pathcheckconfigurations.go
1394 lines (1389 loc) · 60.3 KB
/
checkconfigurations.go
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
// This file is part of arduino-check.
//
// Copyright 2020 ARDUINO SA (http://www.arduino.cc/)
//
// This software is released under the GNU General Public License version 3,
// which covers the main part of arduino-check.
// The terms of this license can be found at:
// https://www.gnu.org/licenses/gpl-3.0.en.html
//
// You can be released from the requirements of the above licenses by purchasing
// a commercial license. Buying such a license is mandatory if you want to
// modify or otherwise use the software for commercial activities involving the
// Arduino software without disclosing the source code of your own applications.
// To purchase a commercial license, send an email to [email protected].
/*
Package checkconfigurations defines the configuration of each check:
- metadata
- output template
- under which conditions it's enabled
- the level of a failure
- which function implements it
*/
package checkconfigurations
import (
"github.com/arduino/arduino-check/check/checkfunctions"
"github.com/arduino/arduino-check/configuration/checkmode"
"github.com/arduino/arduino-check/project/projecttype"
)
// Type is the type for check configurations.
type Type struct {
ProjectType projecttype.Type // The project type the check applies to.
// The following fields provide arbitrary text for the tool output associated with each check:
Category string
Subcategory string
ID string // Unique check identifier: <project type identifier (L|S|P|I)><category identifier><number>
Brief string // Short description of the check.
Description string // Supplemental information about the check.
MessageTemplate string // The warning/error message template displayed when the check fails. Will be filled by check function output.
// The following fields define under which tool configuration modes the check will run:
DisableModes []checkmode.Type // Check is disabled when tool is in any of these modes.
EnableModes []checkmode.Type // Check is only enabled when tool is in one of these modes.
// The following fields define the check level in each configuration mode:
InfoModes []checkmode.Type // Failure of the check only results in an informational message.
WarningModes []checkmode.Type // Failure of the check is considered a warning.
ErrorModes []checkmode.Type // Failure of the check is considered an error.
CheckFunction checkfunctions.Type // The function that implements the check.
}
// Configurations returns the slice of check configurations.
func Configurations() []Type {
return configurations
}
// configurations is an array of structs that define the configuration of each check.
var configurations = []Type{
{
ProjectType: projecttype.Library,
Category: "library.properties",
Subcategory: "general",
ID: "LP001",
Brief: "missing",
Description: `Although not required for 1.0 format libraries (AKA "legacy") not in Library Manager, metadata is useful, so it is recommended.`,
MessageTemplate: "Library has no library.properties metadata file. This file provides useful information and is required for admission to the Library Manager index. See: https://arduino.github.io/arduino-cli/latest/library-specification/#library-metadata",
DisableModes: nil,
EnableModes: []checkmode.Type{checkmode.Default},
InfoModes: nil,
WarningModes: []checkmode.Type{checkmode.Default},
ErrorModes: []checkmode.Type{checkmode.LibraryManagerSubmission, checkmode.LibraryManagerIndexed, checkmode.Strict},
CheckFunction: checkfunctions.LibraryPropertiesMissing,
},
{
ProjectType: projecttype.Library,
Category: "library.properties",
Subcategory: "general",
ID: "LP001",
Brief: "invalid format",
Description: "",
MessageTemplate: "library.properties has an invalid format: {{.}}",
DisableModes: nil,
EnableModes: []checkmode.Type{checkmode.Default},
InfoModes: nil,
WarningModes: nil,
ErrorModes: []checkmode.Type{checkmode.Default},
CheckFunction: checkfunctions.LibraryPropertiesFormat,
},
{
ProjectType: projecttype.Library,
Category: "library.properties",
Subcategory: "general",
ID: "",
Brief: "incorrect library.properties file name",
Description: "",
MessageTemplate: "Incorrectly spelled library.properties file name found: {{.}}. See: https://arduino.github.io/arduino-cli/latest/library-specification/#library-metadata",
DisableModes: nil,
EnableModes: []checkmode.Type{checkmode.Default},
InfoModes: nil,
WarningModes: []checkmode.Type{checkmode.Default},
ErrorModes: []checkmode.Type{checkmode.Strict},
CheckFunction: checkfunctions.MisspelledLibraryPropertiesFileName,
},
{
ProjectType: projecttype.Library,
Category: "library.properties",
Subcategory: "general",
ID: "",
Brief: "incorrect library.properties file name case",
Description: `This causes "1.5" format (AKA "recursive layout") libraries to not be recognized on filename case-sensitive operating systems.`,
MessageTemplate: "Incorrect library.properties file name case: {{.}}. See: https://arduino.github.io/arduino-cli/latest/library-specification/#library-metadata",
DisableModes: nil,
EnableModes: []checkmode.Type{checkmode.Default},
InfoModes: nil,
WarningModes: nil,
ErrorModes: []checkmode.Type{checkmode.Default},
CheckFunction: checkfunctions.IncorrectLibraryPropertiesFileNameCase,
},
{
ProjectType: projecttype.Library,
Category: "library.properties",
Subcategory: "general",
ID: "",
Brief: "redundant",
Description: "",
MessageTemplate: "Redundant library.properties file found at {{.}}. Only the file in the root of the library is used. See: https://arduino.github.io/arduino-cli/latest/library-specification/#library-metadata",
DisableModes: nil,
EnableModes: []checkmode.Type{checkmode.Default},
InfoModes: nil,
WarningModes: []checkmode.Type{checkmode.Permissive},
ErrorModes: []checkmode.Type{checkmode.Default},
CheckFunction: checkfunctions.RedundantLibraryProperties,
},
{
ProjectType: projecttype.Library,
Category: "library.properties",
Subcategory: "name field",
ID: "LP002",
Brief: "missing name field",
Description: "",
MessageTemplate: "missing name field in library.properties",
DisableModes: nil,
EnableModes: []checkmode.Type{checkmode.Default},
InfoModes: nil,
WarningModes: nil,
ErrorModes: []checkmode.Type{checkmode.Default},
CheckFunction: checkfunctions.LibraryPropertiesNameFieldMissing,
},
{
ProjectType: projecttype.Library,
Category: "library.properties",
Subcategory: "name field",
ID: "",
Brief: "name < min length",
Description: "",
MessageTemplate: "library.properties name value is less than minimum length.",
DisableModes: nil,
EnableModes: []checkmode.Type{checkmode.Default},
InfoModes: nil,
WarningModes: nil,
ErrorModes: []checkmode.Type{checkmode.Default},
CheckFunction: checkfunctions.LibraryPropertiesNameFieldLTMinLength,
},
{
ProjectType: projecttype.Library,
Category: "library.properties",
Subcategory: "name field",
ID: "",
Brief: "name > max length",
Description: "",
MessageTemplate: "library.properties name value {{.}} is longer than maximum length.",
DisableModes: nil,
EnableModes: []checkmode.Type{checkmode.Default},
InfoModes: nil,
WarningModes: nil,
ErrorModes: []checkmode.Type{checkmode.Default},
CheckFunction: checkfunctions.LibraryPropertiesNameFieldGTMaxLength,
},
{
ProjectType: projecttype.Library,
Category: "library.properties",
Subcategory: "name field",
ID: "",
Brief: "name > recommended length",
Description: "",
MessageTemplate: "library.properties name value {{.}} is longer than recommended max length.",
DisableModes: nil,
EnableModes: []checkmode.Type{checkmode.Default},
InfoModes: nil,
WarningModes: []checkmode.Type{checkmode.Default},
ErrorModes: []checkmode.Type{checkmode.Strict},
CheckFunction: checkfunctions.LibraryPropertiesNameFieldGTRecommendedLength,
},
{
ProjectType: projecttype.Library,
Category: "library.properties",
Subcategory: "name field",
ID: "LP003",
Brief: "disallowed characters",
Description: "",
MessageTemplate: "disallowed characters in library.properties name value: {{.}}. See: https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
DisableModes: nil,
EnableModes: []checkmode.Type{checkmode.Default},
InfoModes: nil,
WarningModes: nil,
ErrorModes: []checkmode.Type{checkmode.Default},
CheckFunction: checkfunctions.LibraryPropertiesNameFieldDisallowedCharacters,
},
{
ProjectType: projecttype.Library,
Category: "library.properties",
Subcategory: "name field",
ID: "",
Brief: "contains spaces",
Description: "Best practices is for the name value, installation folder, and primary header filename to all match, but this is not possible with names containing spaces.",
MessageTemplate: "library.properties name {{.}} contains spaces. Although supported, best practices is to not use spaces.",
DisableModes: nil,
EnableModes: []checkmode.Type{checkmode.Default},
InfoModes: nil,
WarningModes: []checkmode.Type{checkmode.Default},
ErrorModes: []checkmode.Type{checkmode.Strict},
CheckFunction: checkfunctions.LibraryPropertiesNameFieldHasSpaces,
},
{
ProjectType: projecttype.Library,
Category: "library.properties",
Subcategory: "name field",
ID: "",
Brief: `starts with "Arduino"`,
Description: `Case insensitive. 3rd party libraries added to Library Manager index prior to the enactment of this rule are "grandfathered".`,
MessageTemplate: `Library name {{.}} starts with "Arduino". These names are reserved for official libraries.`,
DisableModes: []checkmode.Type{checkmode.Official},
EnableModes: []checkmode.Type{checkmode.Default},
InfoModes: nil,
WarningModes: []checkmode.Type{checkmode.Default},
ErrorModes: []checkmode.Type{checkmode.LibraryManagerSubmission, checkmode.Strict},
CheckFunction: checkfunctions.LibraryPropertiesNameFieldStartsWithArduino,
},
{
ProjectType: projecttype.Library,
Category: "library.properties",
Subcategory: "name field",
ID: "",
Brief: "missing official prefix",
Description: "",
MessageTemplate: `Library name {{.}} is missing the "Arduino_" prefix. All new official library names must use this prefix.`,
DisableModes: []checkmode.Type{checkmode.Default},
EnableModes: []checkmode.Type{checkmode.Official},
InfoModes: nil,
WarningModes: []checkmode.Type{checkmode.Default},
ErrorModes: []checkmode.Type{checkmode.Strict},
CheckFunction: checkfunctions.LibraryPropertiesNameFieldMissingOfficialPrefix,
},
{
ProjectType: projecttype.Library,
Category: "library.properties",
Subcategory: "name field",
ID: "",
Brief: `contains "Arduino"`,
Description: "Case insensitive",
MessageTemplate: `Library name {{.}} contains "Arduino". This is superfluous.`,
DisableModes: []checkmode.Type{checkmode.Official},
EnableModes: []checkmode.Type{checkmode.Default},
InfoModes: nil,
WarningModes: []checkmode.Type{checkmode.Default},
ErrorModes: []checkmode.Type{checkmode.Strict},
CheckFunction: checkfunctions.LibraryPropertiesNameFieldContainsArduino,
},
{
ProjectType: projecttype.Library,
Category: "library.properties",
Subcategory: "name field",
ID: "",
Brief: `contains "library"`,
Description: "Case insensitive",
MessageTemplate: `Library name {{.}} contains "library". This is superfluous.`,
DisableModes: nil,
EnableModes: []checkmode.Type{checkmode.Default},
InfoModes: nil,
WarningModes: []checkmode.Type{checkmode.Default},
ErrorModes: []checkmode.Type{checkmode.Strict},
CheckFunction: checkfunctions.LibraryPropertiesNameFieldContainsLibrary,
},
{
ProjectType: projecttype.Library,
Category: "library.properties",
Subcategory: "name field",
ID: "LP005",
Brief: "duplicate name",
Description: "This requirement only applies to the library.properties name value. There is no requirement to change the repository or header file names.",
MessageTemplate: "Library name {{.}} is in use by a library in the Library Manager index. Each library must have a unique name value.",
DisableModes: []checkmode.Type{checkmode.LibraryManagerIndexed},
EnableModes: []checkmode.Type{checkmode.Default},
InfoModes: nil,
WarningModes: []checkmode.Type{checkmode.Default},
ErrorModes: []checkmode.Type{checkmode.LibraryManagerSubmission},
CheckFunction: checkfunctions.LibraryPropertiesNameFieldDuplicate,
},
{
ProjectType: projecttype.Library,
Category: "library.properties",
Subcategory: "name field",
ID: "LP006",
Brief: "not in LM index",
Description: "The name value is the identifier used to install the library and define dependencies, so it should not be changed.",
MessageTemplate: "Library name {{.}} not found in the Library Manager index. Library names are not allowed to change after being added to the index. See: https://github.com/arduino/Arduino/wiki/Library-Manager-FAQ#how-can-i-change-my-librarys-name",
DisableModes: []checkmode.Type{checkmode.Default},
EnableModes: []checkmode.Type{checkmode.LibraryManagerIndexed},
InfoModes: nil,
WarningModes: nil,
ErrorModes: []checkmode.Type{checkmode.Default},
CheckFunction: checkfunctions.LibraryPropertiesNameFieldNotInIndex,
},
{
ProjectType: projecttype.Library,
Category: "structure",
Subcategory: "general",
ID: "",
Brief: "name-header mismatch",
Description: `The name value determines the installation folder name and the folder match to the filename in the #include directive influences "folder name priority".`,
MessageTemplate: "No header file found matching library name ({{.}}). Best practices are for primary header filename to match library name.",
DisableModes: nil,
EnableModes: []checkmode.Type{checkmode.Default},
InfoModes: []checkmode.Type{checkmode.Permissive},
WarningModes: []checkmode.Type{checkmode.Default},
ErrorModes: nil,
CheckFunction: checkfunctions.LibraryPropertiesNameFieldHeaderMismatch,
},
{
ProjectType: projecttype.Library,
Category: "library.properties",
Subcategory: "version field",
ID: "LP004",
Brief: "missing version field",
Description: "",
MessageTemplate: "missing version field in library.properties",
DisableModes: nil,
EnableModes: []checkmode.Type{checkmode.Default},
InfoModes: nil,
WarningModes: nil,
ErrorModes: []checkmode.Type{checkmode.Default},
CheckFunction: checkfunctions.LibraryPropertiesVersionFieldMissing,
},
{
ProjectType: projecttype.Library,
Category: "library.properties",
Subcategory: "version field",
ID: "",
Brief: "invalid",
Description: `Must be compliant with "relaxed semver".`,
MessageTemplate: "library.properties version value {{.}} is invalid. See https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
DisableModes: nil,
EnableModes: []checkmode.Type{checkmode.Default},
InfoModes: nil,
WarningModes: nil,
ErrorModes: []checkmode.Type{checkmode.Default},
CheckFunction: checkfunctions.LibraryPropertiesVersionFieldNonRelaxedSemver,
},
{
ProjectType: projecttype.Library,
Category: "library.properties",
Subcategory: "version field",
ID: "",
Brief: "non-semver",
Description: "",
MessageTemplate: "library.properties version value {{.}} is not compliant with the semver specification. See https://semver.org/",
DisableModes: nil,
EnableModes: []checkmode.Type{checkmode.Default},
InfoModes: nil,
WarningModes: []checkmode.Type{checkmode.Default},
ErrorModes: []checkmode.Type{checkmode.Strict},
CheckFunction: checkfunctions.LibraryPropertiesVersionFieldNonSemver,
},
{
ProjectType: projecttype.Library,
Category: "library.properties",
Subcategory: "version field",
ID: "",
Brief: "tag mismatch",
Description: "The Library Manager indexer will reject any tag that has a library.properties version equal to a previous tag in the index.",
MessageTemplate: "The latest Git tag appears to be greater than the library.properties version value: {{.}}. You must update the version value before making the tag.",
DisableModes: []checkmode.Type{checkmode.Default},
EnableModes: []checkmode.Type{checkmode.LibraryManagerIndexed},
InfoModes: nil,
WarningModes: []checkmode.Type{checkmode.Default},
ErrorModes: []checkmode.Type{checkmode.Strict},
CheckFunction: checkfunctions.LibraryPropertiesVersionFieldBehindTag,
},
{
ProjectType: projecttype.Library,
Category: "library.properties",
Subcategory: "author field",
ID: "",
Brief: "missing author field",
Description: "",
MessageTemplate: "missing required author field in library.properties. See https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
DisableModes: nil,
EnableModes: []checkmode.Type{checkmode.Default},
InfoModes: nil,
WarningModes: nil,
ErrorModes: []checkmode.Type{checkmode.Default},
CheckFunction: checkfunctions.LibraryPropertiesAuthorFieldMissing,
},
{
ProjectType: projecttype.Library,
Category: "library.properties",
Subcategory: "author field",
ID: "",
Brief: "author < min length",
Description: "",
MessageTemplate: "library.properties author value is less than minimum length.",
DisableModes: nil,
EnableModes: []checkmode.Type{checkmode.Default},
InfoModes: nil,
WarningModes: nil,
ErrorModes: []checkmode.Type{checkmode.Default},
CheckFunction: checkfunctions.LibraryPropertiesAuthorFieldLTMinLength,
},
{
ProjectType: projecttype.Library,
Category: "library.properties",
Subcategory: "maintainer field",
ID: "",
Brief: "missing maintainer field",
Description: "",
MessageTemplate: "missing required maintainer field in library.properties. See https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
DisableModes: nil,
EnableModes: []checkmode.Type{checkmode.Default},
InfoModes: nil,
WarningModes: nil,
ErrorModes: []checkmode.Type{checkmode.Default},
CheckFunction: checkfunctions.LibraryPropertiesMaintainerFieldMissing,
},
{
ProjectType: projecttype.Library,
Category: "library.properties",
Subcategory: "maintainer field",
ID: "",
Brief: "maintainer < min length",
Description: "",
MessageTemplate: "library.properties maintainer value is less than minimum length.",
DisableModes: nil,
EnableModes: []checkmode.Type{checkmode.Default},
InfoModes: nil,
WarningModes: nil,
ErrorModes: []checkmode.Type{checkmode.Default},
CheckFunction: checkfunctions.LibraryPropertiesMaintainerFieldLTMinLength,
},
{
ProjectType: projecttype.Library,
Category: "library.properties",
Subcategory: "maintainer field",
ID: "",
Brief: `starts with "Arduino"`,
Description: "Case insensitive.",
MessageTemplate: `library.properties maintainer value {{.}} starts with "Arduino". 3rd party libraries are not maintained by Arduino.`,
DisableModes: []checkmode.Type{checkmode.Official},
EnableModes: []checkmode.Type{checkmode.Default},
InfoModes: nil,
WarningModes: []checkmode.Type{checkmode.Default},
ErrorModes: []checkmode.Type{checkmode.Strict},
CheckFunction: checkfunctions.LibraryPropertiesMaintainerFieldStartsWithArduino,
},
{
ProjectType: projecttype.Library,
Category: "library.properties",
Subcategory: "email field",
ID: "",
Brief: `"email" field used as alias for "maintainer"`,
Description: "This was in an early draft of the beta 1.5 library specification.",
MessageTemplate: `library.properties "email" field used as alias for "maintainer". This is deprecated.`,
DisableModes: nil,
EnableModes: []checkmode.Type{checkmode.Default},
InfoModes: nil,
WarningModes: []checkmode.Type{checkmode.Permissive},
ErrorModes: []checkmode.Type{checkmode.Default},
CheckFunction: checkfunctions.LibraryPropertiesEmailFieldAsMaintainerAlias,
},
{
ProjectType: projecttype.Library,
Category: "library.properties",
Subcategory: "email field",
ID: "",
Brief: "email < min length",
Description: "",
MessageTemplate: "library.properties email value is less than minimum length.",
DisableModes: nil,
EnableModes: []checkmode.Type{checkmode.Default},
InfoModes: nil,
WarningModes: nil,
ErrorModes: []checkmode.Type{checkmode.Default},
CheckFunction: checkfunctions.LibraryPropertiesEmailFieldLTMinLength,
},
{
ProjectType: projecttype.Library,
Category: "library.properties",
Subcategory: "email field",
ID: "",
Brief: `starts with "Arduino"`,
Description: "Case insensitive.",
MessageTemplate: `library.properties email value {{.}} starts with "Arduino". 3rd party libraries are not maintained by Arduino.`,
DisableModes: []checkmode.Type{checkmode.Official},
EnableModes: []checkmode.Type{checkmode.Default},
InfoModes: nil,
WarningModes: []checkmode.Type{checkmode.Default},
ErrorModes: []checkmode.Type{checkmode.Strict},
CheckFunction: checkfunctions.LibraryPropertiesEmailFieldStartsWithArduino,
},
{
ProjectType: projecttype.Library,
Category: "library.properties",
Subcategory: "sentence field",
ID: "",
Brief: "missing sentence field",
Description: "",
MessageTemplate: "missing required sentence field in library.properties. See https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
DisableModes: nil,
EnableModes: []checkmode.Type{checkmode.Default},
InfoModes: nil,
WarningModes: nil,
ErrorModes: []checkmode.Type{checkmode.Default},
CheckFunction: checkfunctions.LibraryPropertiesSentenceFieldMissing,
},
{
ProjectType: projecttype.Library,
Category: "library.properties",
Subcategory: "sentence field",
ID: "",
Brief: "sentence < min length",
Description: "",
MessageTemplate: "library.properties sentence value is less than minimum length.",
DisableModes: nil,
EnableModes: []checkmode.Type{checkmode.Default},
InfoModes: nil,
WarningModes: nil,
ErrorModes: []checkmode.Type{checkmode.Default},
CheckFunction: checkfunctions.LibraryPropertiesSentenceFieldLTMinLength,
},
{
ProjectType: projecttype.Library,
Category: "library.properties",
Subcategory: "sentence field",
ID: "",
Brief: "sentence spell check",
Description: "",
MessageTemplate: "A commonly misspelled word was found in the library.properties sentence field. Suggested correction: {{.}}",
DisableModes: nil,
EnableModes: []checkmode.Type{checkmode.Default},
InfoModes: nil,
WarningModes: []checkmode.Type{checkmode.Default},
ErrorModes: nil,
CheckFunction: checkfunctions.LibraryPropertiesSentenceFieldSpellCheck,
},
{
ProjectType: projecttype.Library,
Category: "library.properties",
Subcategory: "paragraph field",
ID: "",
Brief: "missing paragraph field",
Description: "",
MessageTemplate: "missing required paragraph field in library.properties. See https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
DisableModes: nil,
EnableModes: []checkmode.Type{checkmode.Default},
InfoModes: nil,
WarningModes: nil,
ErrorModes: []checkmode.Type{checkmode.Default},
CheckFunction: checkfunctions.LibraryPropertiesParagraphFieldMissing,
},
{
ProjectType: projecttype.Library,
Category: "library.properties",
Subcategory: "paragraph field",
ID: "",
Brief: "paragraph spell check",
Description: "",
MessageTemplate: "A commonly misspelled word was found in the library.properties paragraph field. Suggested correction: {{.}}",
DisableModes: nil,
EnableModes: []checkmode.Type{checkmode.Default},
InfoModes: nil,
WarningModes: []checkmode.Type{checkmode.Default},
ErrorModes: nil,
CheckFunction: checkfunctions.LibraryPropertiesParagraphFieldSpellCheck,
},
{
ProjectType: projecttype.Library,
Category: "library.properties",
Subcategory: "paragraph field",
ID: "",
Brief: "paragraph repeats sentence",
Description: "",
MessageTemplate: "The library.properties paragraph field repeats the sentence field. These are displayed together so redundancy is not needed.",
DisableModes: nil,
EnableModes: []checkmode.Type{checkmode.Default},
InfoModes: nil,
WarningModes: []checkmode.Type{checkmode.Default},
ErrorModes: []checkmode.Type{checkmode.Strict},
CheckFunction: checkfunctions.LibraryPropertiesParagraphFieldRepeatsSentence,
},
{
ProjectType: projecttype.Library,
Category: "library.properties",
Subcategory: "category field",
ID: "",
Brief: "missing category field",
Description: `This can cause a warning and results in the default "Uncategorized" category being used.`,
MessageTemplate: "missing category field in library.properties. See https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
DisableModes: nil,
EnableModes: []checkmode.Type{checkmode.Default},
InfoModes: nil,
WarningModes: []checkmode.Type{checkmode.Default},
ErrorModes: []checkmode.Type{checkmode.Strict},
CheckFunction: checkfunctions.LibraryPropertiesCategoryFieldMissing,
},
{
ProjectType: projecttype.Library,
Category: "library.properties",
Subcategory: "category field",
ID: "",
Brief: "invalid category value",
Description: `This can cause a warning and results in the default "Uncategorized" category being used.`,
MessageTemplate: "invalid category field value {{.}} in library.properties. See https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
DisableModes: nil,
EnableModes: []checkmode.Type{checkmode.Default},
InfoModes: nil,
WarningModes: []checkmode.Type{checkmode.Permissive},
ErrorModes: []checkmode.Type{checkmode.Default},
CheckFunction: checkfunctions.LibraryPropertiesCategoryFieldInvalid,
},
{
ProjectType: projecttype.Library,
Category: "library.properties",
Subcategory: "category field",
ID: "",
Brief: `"Uncategorized" category value`,
Description: "There is no good reason for using this non-specification compliant category value.",
MessageTemplate: `Use of "Uncategorized" category value in library.properties. Please use one of the supported categories listed at https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format`,
DisableModes: nil,
EnableModes: []checkmode.Type{checkmode.Default},
InfoModes: nil,
WarningModes: []checkmode.Type{checkmode.Default},
ErrorModes: []checkmode.Type{checkmode.Strict},
CheckFunction: checkfunctions.LibraryPropertiesCategoryFieldUncategorized,
},
{
ProjectType: projecttype.Library,
Category: "library.properties",
Subcategory: "url field",
ID: "",
Brief: "missing url field",
Description: "",
MessageTemplate: "missing required url field in library.properties. See https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
DisableModes: nil,
EnableModes: []checkmode.Type{checkmode.Default},
InfoModes: nil,
WarningModes: nil,
ErrorModes: []checkmode.Type{checkmode.Default},
CheckFunction: checkfunctions.LibraryPropertiesUrlFieldMissing,
},
{
ProjectType: projecttype.Library,
Category: "library.properties",
Subcategory: "url field",
ID: "",
Brief: "invalid url format",
Description: "",
MessageTemplate: "library.properties url field value {{.}} does not have a valid URL format.",
DisableModes: nil,
EnableModes: []checkmode.Type{checkmode.Default},
InfoModes: nil,
WarningModes: []checkmode.Type{checkmode.Permissive},
ErrorModes: []checkmode.Type{checkmode.Default},
CheckFunction: checkfunctions.LibraryPropertiesUrlFieldInvalid,
},
{
ProjectType: projecttype.Library,
Category: "library.properties",
Subcategory: "url field",
ID: "",
Brief: "Dead URL",
Description: "",
MessageTemplate: "Unable to load the library.properties url field: {{.}}",
DisableModes: nil,
EnableModes: []checkmode.Type{checkmode.Default},
InfoModes: nil,
WarningModes: []checkmode.Type{checkmode.Default},
ErrorModes: []checkmode.Type{checkmode.Strict},
CheckFunction: checkfunctions.LibraryPropertiesUrlFieldDeadLink,
},
{
ProjectType: projecttype.Library,
Category: "library.properties",
Subcategory: "architectures field",
ID: "",
Brief: "missing architectures field",
Description: "Defaults to *, but it's better to explicitly define architectures.",
MessageTemplate: "missing architectures field in library.properties. See https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
DisableModes: nil,
EnableModes: []checkmode.Type{checkmode.Default},
InfoModes: nil,
WarningModes: []checkmode.Type{checkmode.Default},
ErrorModes: []checkmode.Type{checkmode.Strict},
CheckFunction: checkfunctions.LibraryPropertiesArchitecturesFieldMissing,
},
{
ProjectType: projecttype.Library,
Category: "library.properties",
Subcategory: "architectures field",
ID: "",
Brief: "architectures blank",
Description: "Causes library to be considered incompatible with all architectures.",
MessageTemplate: "Empty library.properties architectures field. Please define specific architectures or set to * if compatible with all. See https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
DisableModes: nil,
EnableModes: []checkmode.Type{checkmode.Default},
InfoModes: nil,
WarningModes: []checkmode.Type{checkmode.Permissive},
ErrorModes: []checkmode.Type{checkmode.Default},
CheckFunction: checkfunctions.LibraryPropertiesArchitecturesFieldLTMinLength,
},
{
ProjectType: projecttype.Library,
Category: "library.properties",
Subcategory: "depends field",
ID: "",
Brief: "disallowed characters",
Description: "",
MessageTemplate: "disallowed characters in library.properties depends field {{.}}. See: https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
DisableModes: nil,
EnableModes: []checkmode.Type{checkmode.Default},
InfoModes: nil,
WarningModes: nil,
ErrorModes: []checkmode.Type{checkmode.Default},
CheckFunction: checkfunctions.LibraryPropertiesDependsFieldDisallowedCharacters,
},
{
ProjectType: projecttype.Library,
Category: "library.properties",
Subcategory: "depends field",
ID: "LP012",
Brief: "Dependency not in index",
Description: "",
MessageTemplate: "library.properties depends field item(s) {{.}} not found in the Library Manager index.",
DisableModes: nil,
EnableModes: []checkmode.Type{checkmode.Default},
InfoModes: nil,
WarningModes: []checkmode.Type{checkmode.Default},
ErrorModes: nil,
CheckFunction: checkfunctions.LibraryPropertiesDependsFieldNotInIndex,
},
{
ProjectType: projecttype.Library,
Category: "library.properties",
Subcategory: "dot_a_linkage field",
ID: "",
Brief: "invalid value",
Description: "",
MessageTemplate: "invalid dot_a_linkage field value {{.}} in library.properties. See https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
DisableModes: nil,
EnableModes: []checkmode.Type{checkmode.Default},
InfoModes: nil,
WarningModes: []checkmode.Type{checkmode.Permissive},
ErrorModes: []checkmode.Type{checkmode.Default},
CheckFunction: checkfunctions.LibraryPropertiesDotALinkageFieldInvalid,
},
{
ProjectType: projecttype.Library,
Category: "library.properties",
Subcategory: "dot_a_linkage field",
ID: "",
Brief: `"true" with "1.5" library format`,
Description: `dot_a_linkage feature is only supported for the "1.5" or "recursive" library format.`,
MessageTemplate: `library.properties dot_a_linkage field enabled but library is not in "1.5" format. See: https://arduino.github.io/arduino-cli/latest/library-specification/#source-code`,
DisableModes: nil,
EnableModes: []checkmode.Type{checkmode.Default},
InfoModes: nil,
WarningModes: []checkmode.Type{checkmode.Permissive},
ErrorModes: []checkmode.Type{checkmode.Default},
CheckFunction: checkfunctions.LibraryPropertiesDotALinkageFieldTrueWithFlatLayout,
},
{
ProjectType: projecttype.Library,
Category: "library.properties",
Subcategory: "includes field",
ID: "",
Brief: "includes blank",
Description: `Caused the "Sketch > Include library" feature of previous IDE versions to add an empty #include directive to the sketch.`,
MessageTemplate: "Empty library.properties includes field. Please either define includes or remove this optional field. See https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
DisableModes: nil,
EnableModes: []checkmode.Type{checkmode.Default},
InfoModes: nil,
WarningModes: []checkmode.Type{checkmode.Permissive},
ErrorModes: []checkmode.Type{checkmode.Default},
CheckFunction: checkfunctions.LibraryPropertiesIncludesFieldLTMinLength,
},
{
ProjectType: projecttype.Library,
Category: "library.properties",
Subcategory: "includes field",
ID: "",
Brief: "includes file not in library",
Description: `People often think this is the way to define their library's dependencies, which breaks the "Sketch > Include Library" feature for that library.`,
MessageTemplate: "library.properties includes field item(s) {{.}} not found in library.",
DisableModes: nil,
EnableModes: []checkmode.Type{checkmode.Default},
InfoModes: nil,
WarningModes: []checkmode.Type{checkmode.Permissive},
ErrorModes: []checkmode.Type{checkmode.Default},
CheckFunction: checkfunctions.LibraryPropertiesIncludesFieldItemNotFound,
},
{
ProjectType: projecttype.Library,
Category: "library.properties",
Subcategory: "precompiled field",
ID: "",
Brief: "invalid value",
Description: "",
MessageTemplate: "invalid precompiled field value {{.}} in library.properties. See https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
DisableModes: nil,
EnableModes: []checkmode.Type{checkmode.Default},
InfoModes: nil,
WarningModes: []checkmode.Type{checkmode.Permissive},
ErrorModes: []checkmode.Type{checkmode.Default},
CheckFunction: checkfunctions.LibraryPropertiesPrecompiledFieldInvalid,
},
{
ProjectType: projecttype.Library,
Category: "library.properties",
Subcategory: "precompiled field",
ID: "",
Brief: "precompiled with flat layout",
Description: `precompiled feature is only supported for the "1.5" or "recursive" library format.`,
MessageTemplate: `library.properties precompiled field value {{.}}, is not supported with "1.0" format. See: https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format`,
DisableModes: nil,
EnableModes: []checkmode.Type{checkmode.Default},
InfoModes: nil,
WarningModes: []checkmode.Type{checkmode.Permissive},
ErrorModes: []checkmode.Type{checkmode.Default},
CheckFunction: checkfunctions.LibraryPropertiesPrecompiledFieldEnabledWithFlatLayout,
},
{
ProjectType: projecttype.Library,
Category: "library.properties",
Subcategory: "ldflags field",
ID: "",
Brief: "ldflags < min length",
Description: "",
MessageTemplate: "library.properties ldflags value is less than minimum length.",
DisableModes: nil,
EnableModes: []checkmode.Type{checkmode.Default},
InfoModes: nil,
WarningModes: []checkmode.Type{checkmode.Permissive},
ErrorModes: []checkmode.Type{checkmode.Default},
CheckFunction: checkfunctions.LibraryPropertiesLdflagsFieldLTMinLength,
},
{
ProjectType: projecttype.Library,
Category: "library.properties",
Subcategory: "general",
ID: "",
Brief: "misspelled field",
Description: "",
MessageTemplate: "Potentially misspelled library.properties field name detected. See: https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
DisableModes: nil,
EnableModes: []checkmode.Type{checkmode.Default},
InfoModes: nil,
WarningModes: []checkmode.Type{checkmode.Default},
ErrorModes: []checkmode.Type{checkmode.Strict},
CheckFunction: checkfunctions.LibraryPropertiesMisspelledOptionalField,
},
{
ProjectType: projecttype.Library,
Category: "structure",
Subcategory: "",
ID: "",
Brief: "invalid",
Description: "",
MessageTemplate: "Path does not contain a valid Arduino library. See: https://arduino.github.io/arduino-cli/latest/library-specification",
DisableModes: nil,
EnableModes: []checkmode.Type{checkmode.Default},
InfoModes: nil,
WarningModes: nil,
ErrorModes: []checkmode.Type{checkmode.Default},
CheckFunction: checkfunctions.LibraryInvalid,
},
{
ProjectType: projecttype.Library,
Category: "structure",
Subcategory: "",
ID: "",
Brief: "submodule",
Description: "",
MessageTemplate: `Git submodule detected. Library Manager installations and installations from GitHub's "Download ZIP" will only contain an empty folder in place of the submodule.`,
DisableModes: nil,
EnableModes: []checkmode.Type{checkmode.Default},
InfoModes: nil,
WarningModes: []checkmode.Type{checkmode.Default},
ErrorModes: nil,
CheckFunction: checkfunctions.LibraryHasSubmodule,
},
{
ProjectType: projecttype.Library,
Category: "structure",
Subcategory: "general",
ID: "",
Brief: "symlink",
Description: "",
MessageTemplate: "Symlink(s) found at {{.}}. These block acceptance to the Arduino Library Manager index.",
DisableModes: nil,
EnableModes: []checkmode.Type{checkmode.Default},
InfoModes: nil,
WarningModes: []checkmode.Type{checkmode.Default},
ErrorModes: []checkmode.Type{checkmode.LibraryManagerSubmission, checkmode.LibraryManagerIndexed},
CheckFunction: checkfunctions.LibraryContainsSymlinks,
},
{
ProjectType: projecttype.Library,
Category: "structure",
Subcategory: "",
ID: "",
Brief: ".development file",
Description: "",
MessageTemplate: ".development flag file found. Presence of this file blocks addition to the Library Manager index.",
DisableModes: nil,
EnableModes: []checkmode.Type{checkmode.Default},
InfoModes: nil,
WarningModes: []checkmode.Type{checkmode.Default},
ErrorModes: []checkmode.Type{checkmode.LibraryManagerSubmission, checkmode.LibraryManagerIndexed, checkmode.Strict},
CheckFunction: checkfunctions.LibraryHasDotDevelopmentFile,
},
{
ProjectType: projecttype.Library,
Category: "structure",
Subcategory: "",
ID: "",
Brief: ".exe file",
Description: "",
MessageTemplate: ".exe file(s) found: {{.}}. Presence of these files blocks inclusion in Library Manager index.",
DisableModes: nil,
EnableModes: []checkmode.Type{checkmode.Default},
InfoModes: nil,
WarningModes: []checkmode.Type{checkmode.Default},
ErrorModes: []checkmode.Type{checkmode.LibraryManagerSubmission, checkmode.LibraryManagerIndexed, checkmode.Strict},
CheckFunction: checkfunctions.LibraryHasExe,
},
{
ProjectType: projecttype.Library,
Category: "structure",
Subcategory: "",
ID: "",
Brief: "stray sketch",
Description: "",
MessageTemplate: "Sketch(es) found outside examples and extras folders: {{.}}. See: https://arduino.github.io/arduino-cli/latest/library-specification/#library-examples",
DisableModes: nil,
EnableModes: []checkmode.Type{checkmode.Default},
InfoModes: nil,
WarningModes: []checkmode.Type{checkmode.Permissive},
ErrorModes: []checkmode.Type{checkmode.Default},
CheckFunction: checkfunctions.LibraryHasStraySketches,
},
{
ProjectType: projecttype.Library,
Category: "structure",
Subcategory: "",
ID: "",
Brief: "disallowed characters in folder name",
Description: "This will be problematic for people doing manual installation of the library.",
MessageTemplate: "Prohibited characters in folder name: {{.}}. See: https://arduino.github.io/arduino-cli/latest/library-specification/#library-root-folder",
DisableModes: nil,
EnableModes: []checkmode.Type{checkmode.Default},
InfoModes: nil,
WarningModes: []checkmode.Type{checkmode.Permissive},
ErrorModes: []checkmode.Type{checkmode.Default},
CheckFunction: checkfunctions.ProhibitedCharactersInLibraryFolderName,
},
{
ProjectType: projecttype.Library,
Category: "structure",
Subcategory: "",
ID: "",
Brief: "no readme",
Description: "",
MessageTemplate: "No readme found. Please document your library. See: https://docs.github.com/en/free-pro-team@latest/github/creating-cloning-and-archiving-repositories/about-readmes",
DisableModes: nil,
EnableModes: []checkmode.Type{checkmode.Default},
InfoModes: nil,
WarningModes: []checkmode.Type{checkmode.Default},
ErrorModes: []checkmode.Type{checkmode.Strict},
CheckFunction: checkfunctions.MissingReadme,
},
{
ProjectType: projecttype.Library,
Category: "structure",
Subcategory: "",
ID: "",
Brief: "no license file",
Description: "",
MessageTemplate: "No license file found. See: https://docs.github.com/en/free-pro-team@latest/github/creating-cloning-and-archiving-repositories/licensing-a-repository#detecting-a-license",
DisableModes: nil,
EnableModes: []checkmode.Type{checkmode.Default},
InfoModes: nil,
WarningModes: []checkmode.Type{checkmode.Default},