Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 14b046d

Browse files
per1234per1234
committedDec 15, 2020
Define unique IDs for all check configurations
During initial development, it was an unnecessary amount of work to assign unique IDs to each check configuration as it was added. Now that the bulk of the checks have been added, it's the time to do this.
1 parent b27cc87 commit 14b046d

File tree

1 file changed

+90
-90
lines changed

1 file changed

+90
-90
lines changed
 

‎check/checkconfigurations/checkconfigurations.go

Lines changed: 90 additions & 90 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ var configurations = []Type{
6060
ProjectType: projecttype.Library,
6161
Category: "structure",
6262
Subcategory: "general",
63-
ID: "",
63+
ID: "LS001",
6464
Brief: "invalid",
6565
Description: "",
6666
MessageTemplate: "Path does not contain a valid Arduino library. See: https://arduino.github.io/arduino-cli/latest/library-specification",
@@ -75,7 +75,7 @@ var configurations = []Type{
7575
ProjectType: projecttype.Library,
7676
Category: "structure",
7777
Subcategory: "root folder",
78-
ID: "",
78+
ID: "LS002",
7979
Brief: "folder name too long",
8080
Description: "This will be problematic for people doing manual installation of the library.",
8181
MessageTemplate: "Folder name {{.}} exceeds maximum length. See: https://arduino.github.io/arduino-cli/latest/library-specification/#library-root-folder",
@@ -90,7 +90,7 @@ var configurations = []Type{
9090
ProjectType: projecttype.Library,
9191
Category: "structure",
9292
Subcategory: "root folder",
93-
ID: "",
93+
ID: "LS003",
9494
Brief: "disallowed characters in folder name",
9595
Description: "This will be problematic for people doing manual installation of the library.",
9696
MessageTemplate: "Prohibited characters in folder name: {{.}}. See: https://arduino.github.io/arduino-cli/latest/library-specification/#library-root-folder",
@@ -105,7 +105,7 @@ var configurations = []Type{
105105
ProjectType: projecttype.Library,
106106
Category: "structure",
107107
Subcategory: "miscellaneous",
108-
ID: "",
108+
ID: "LS004",
109109
Brief: "submodule",
110110
Description: "",
111111
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.`,
@@ -120,7 +120,7 @@ var configurations = []Type{
120120
ProjectType: projecttype.Library,
121121
Category: "structure",
122122
Subcategory: "miscellaneous",
123-
ID: "",
123+
ID: "LS005",
124124
Brief: "symlink",
125125
Description: "",
126126
MessageTemplate: "Symlink(s) found at {{.}}. These block acceptance to the Arduino Library Manager index.",
@@ -135,7 +135,7 @@ var configurations = []Type{
135135
ProjectType: projecttype.Library,
136136
Category: "structure",
137137
Subcategory: "miscellaneous",
138-
ID: "",
138+
ID: "LS006",
139139
Brief: ".development file",
140140
Description: "",
141141
MessageTemplate: ".development flag file found. Presence of this file blocks addition to the Library Manager index.",
@@ -150,7 +150,7 @@ var configurations = []Type{
150150
ProjectType: projecttype.Library,
151151
Category: "structure",
152152
Subcategory: "miscellaneous",
153-
ID: "",
153+
ID: "LS007",
154154
Brief: ".exe file",
155155
Description: "",
156156
MessageTemplate: ".exe file(s) found: {{.}}. Presence of these files blocks inclusion in Library Manager index.",
@@ -165,7 +165,7 @@ var configurations = []Type{
165165
ProjectType: projecttype.Library,
166166
Category: "structure",
167167
Subcategory: "source code",
168-
ID: "",
168+
ID: "LS008",
169169
Brief: "name-header mismatch",
170170
Description: `The name value determines the installation folder name and the folder match to the filename in the #include directive influences "folder name priority".`,
171171
MessageTemplate: "No header file found matching library name ({{.}}). Best practices are for primary header filename to match library name.",
@@ -180,7 +180,7 @@ var configurations = []Type{
180180
ProjectType: projecttype.Library,
181181
Category: "structure",
182182
Subcategory: "source code",
183-
ID: "",
183+
ID: "LS009",
184184
Brief: "incorrect src folder case",
185185
Description: "",
186186
MessageTemplate: "Incorrect src folder case: {{.}}. This will cause the library to not be recognized on case-sensitive operating systems. See: https://arduino.github.io/arduino-cli/latest/library-specification/#library-root-folder",
@@ -195,7 +195,7 @@ var configurations = []Type{
195195
ProjectType: projecttype.Library,
196196
Category: "structure",
197197
Subcategory: "source code",
198-
ID: "",
198+
ID: "LS010",
199199
Brief: "recursive with utility folder",
200200
Description: "",
201201
MessageTemplate: `Utility folder found in "1.5" format library. Compilation of this folder is only supported on "1.0" format libraries. See: https://arduino.github.io/arduino-cli/latest/library-specification/#source-code`,
@@ -210,7 +210,7 @@ var configurations = []Type{
210210
ProjectType: projecttype.Library,
211211
Category: "structure",
212212
Subcategory: "extras folder",
213-
ID: "",
213+
ID: "LS011",
214214
Brief: "incorrect extras folder name",
215215
Description: "",
216216
MessageTemplate: "Potentially misspelled extras folder name found: {{.}}. See: https://arduino.github.io/arduino-cli/latest/library-specification/#extra-documentation",
@@ -225,7 +225,7 @@ var configurations = []Type{
225225
ProjectType: projecttype.Library,
226226
Category: "structure",
227227
Subcategory: "extras folder",
228-
ID: "",
228+
ID: "LS012",
229229
Brief: "incorrect extras folder name case",
230230
Description: "",
231231
MessageTemplate: "Incorrect extras folder name case: {{.}}. See: https://arduino.github.io/arduino-cli/latest/library-specification/#extra-documentation",
@@ -255,7 +255,7 @@ var configurations = []Type{
255255
ProjectType: projecttype.Library,
256256
Category: "library.properties",
257257
Subcategory: "general",
258-
ID: "",
258+
ID: "LP002",
259259
Brief: "incorrect library.properties file name",
260260
Description: "",
261261
MessageTemplate: "Incorrectly spelled library.properties file name found: {{.}}. See: https://arduino.github.io/arduino-cli/latest/library-specification/#library-metadata",
@@ -270,7 +270,7 @@ var configurations = []Type{
270270
ProjectType: projecttype.Library,
271271
Category: "library.properties",
272272
Subcategory: "general",
273-
ID: "",
273+
ID: "LP003",
274274
Brief: "incorrect library.properties file name case",
275275
Description: `This causes "1.5" format (AKA "recursive layout") libraries to not be recognized on filename case-sensitive operating systems.`,
276276
MessageTemplate: "Incorrect library.properties file name case: {{.}}. See: https://arduino.github.io/arduino-cli/latest/library-specification/#library-metadata",
@@ -285,7 +285,7 @@ var configurations = []Type{
285285
ProjectType: projecttype.Library,
286286
Category: "library.properties",
287287
Subcategory: "general",
288-
ID: "",
288+
ID: "LP004",
289289
Brief: "redundant",
290290
Description: "",
291291
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",
@@ -300,7 +300,7 @@ var configurations = []Type{
300300
ProjectType: projecttype.Library,
301301
Category: "library.properties",
302302
Subcategory: "general",
303-
ID: "LP001",
303+
ID: "LP005",
304304
Brief: "invalid format",
305305
Description: "",
306306
MessageTemplate: "library.properties has an invalid format: {{.}}",
@@ -315,7 +315,7 @@ var configurations = []Type{
315315
ProjectType: projecttype.Library,
316316
Category: "library.properties",
317317
Subcategory: "general",
318-
ID: "",
318+
ID: "LP006",
319319
Brief: "misspelled field",
320320
Description: "",
321321
MessageTemplate: "Potentially misspelled library.properties field name detected. See: https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
@@ -330,7 +330,7 @@ var configurations = []Type{
330330
ProjectType: projecttype.Library,
331331
Category: "library.properties",
332332
Subcategory: "name field",
333-
ID: "LP002",
333+
ID: "LP007",
334334
Brief: "missing name field",
335335
Description: "",
336336
MessageTemplate: "missing name field in library.properties",
@@ -345,7 +345,7 @@ var configurations = []Type{
345345
ProjectType: projecttype.Library,
346346
Category: "library.properties",
347347
Subcategory: "name field",
348-
ID: "",
348+
ID: "LP008",
349349
Brief: "name < min length",
350350
Description: "",
351351
MessageTemplate: "library.properties name value is less than minimum length.",
@@ -360,7 +360,7 @@ var configurations = []Type{
360360
ProjectType: projecttype.Library,
361361
Category: "library.properties",
362362
Subcategory: "name field",
363-
ID: "",
363+
ID: "LP009",
364364
Brief: "name > max length",
365365
Description: "",
366366
MessageTemplate: "library.properties name value {{.}} is longer than maximum length.",
@@ -375,7 +375,7 @@ var configurations = []Type{
375375
ProjectType: projecttype.Library,
376376
Category: "library.properties",
377377
Subcategory: "name field",
378-
ID: "",
378+
ID: "LP010",
379379
Brief: "name > recommended length",
380380
Description: "",
381381
MessageTemplate: "library.properties name value {{.}} is longer than recommended max length.",
@@ -390,7 +390,7 @@ var configurations = []Type{
390390
ProjectType: projecttype.Library,
391391
Category: "library.properties",
392392
Subcategory: "name field",
393-
ID: "LP003",
393+
ID: "LP011",
394394
Brief: "disallowed characters",
395395
Description: "",
396396
MessageTemplate: "disallowed characters in library.properties name value: {{.}}. See: https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
@@ -405,7 +405,7 @@ var configurations = []Type{
405405
ProjectType: projecttype.Library,
406406
Category: "library.properties",
407407
Subcategory: "name field",
408-
ID: "",
408+
ID: "LP012",
409409
Brief: `starts with "Arduino"`,
410410
Description: `Case insensitive. 3rd party libraries added to Library Manager index prior to the enactment of this rule are "grandfathered".`,
411411
MessageTemplate: `Library name {{.}} starts with "Arduino". These names are reserved for official libraries.`,
@@ -420,7 +420,7 @@ var configurations = []Type{
420420
ProjectType: projecttype.Library,
421421
Category: "library.properties",
422422
Subcategory: "name field",
423-
ID: "",
423+
ID: "LP013",
424424
Brief: "missing official prefix",
425425
Description: "",
426426
MessageTemplate: `Library name {{.}} is missing the "Arduino_" prefix. All new official library names must use this prefix.`,
@@ -435,7 +435,7 @@ var configurations = []Type{
435435
ProjectType: projecttype.Library,
436436
Category: "library.properties",
437437
Subcategory: "name field",
438-
ID: "",
438+
ID: "LP014",
439439
Brief: `contains "Arduino"`,
440440
Description: "Case insensitive",
441441
MessageTemplate: `Library name {{.}} contains "Arduino". This is superfluous.`,
@@ -450,7 +450,7 @@ var configurations = []Type{
450450
ProjectType: projecttype.Library,
451451
Category: "library.properties",
452452
Subcategory: "name field",
453-
ID: "",
453+
ID: "LP015",
454454
Brief: "contains spaces",
455455
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.",
456456
MessageTemplate: "library.properties name {{.}} contains spaces. Although supported, best practices is to not use spaces.",
@@ -465,7 +465,7 @@ var configurations = []Type{
465465
ProjectType: projecttype.Library,
466466
Category: "library.properties",
467467
Subcategory: "name field",
468-
ID: "",
468+
ID: "LP016",
469469
Brief: `contains "library"`,
470470
Description: "Case insensitive",
471471
MessageTemplate: `Library name {{.}} contains "library". This is superfluous.`,
@@ -480,7 +480,7 @@ var configurations = []Type{
480480
ProjectType: projecttype.Library,
481481
Category: "library.properties",
482482
Subcategory: "name field",
483-
ID: "LP005",
483+
ID: "LP017",
484484
Brief: "duplicate name",
485485
Description: "This requirement only applies to the library.properties name value. There is no requirement to change the repository or header file names.",
486486
MessageTemplate: "Library name {{.}} is in use by a library in the Library Manager index. Each library must have a unique name value.",
@@ -495,7 +495,7 @@ var configurations = []Type{
495495
ProjectType: projecttype.Library,
496496
Category: "library.properties",
497497
Subcategory: "name field",
498-
ID: "LP006",
498+
ID: "LP018",
499499
Brief: "not in LM index",
500500
Description: "The name value is the identifier used to install the library and define dependencies, so it should not be changed.",
501501
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",
@@ -510,7 +510,7 @@ var configurations = []Type{
510510
ProjectType: projecttype.Library,
511511
Category: "library.properties",
512512
Subcategory: "version field",
513-
ID: "LP004",
513+
ID: "LP019",
514514
Brief: "missing version field",
515515
Description: "",
516516
MessageTemplate: "missing version field in library.properties",
@@ -525,7 +525,7 @@ var configurations = []Type{
525525
ProjectType: projecttype.Library,
526526
Category: "library.properties",
527527
Subcategory: "version field",
528-
ID: "",
528+
ID: "LP020",
529529
Brief: "invalid",
530530
Description: `Must be compliant with "relaxed semver".`,
531531
MessageTemplate: "library.properties version value {{.}} is invalid. See https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
@@ -540,7 +540,7 @@ var configurations = []Type{
540540
ProjectType: projecttype.Library,
541541
Category: "library.properties",
542542
Subcategory: "version field",
543-
ID: "",
543+
ID: "LP021",
544544
Brief: "non-semver",
545545
Description: "",
546546
MessageTemplate: "library.properties version value {{.}} is not compliant with the semver specification. See https://semver.org/",
@@ -555,7 +555,7 @@ var configurations = []Type{
555555
ProjectType: projecttype.Library,
556556
Category: "library.properties",
557557
Subcategory: "version field",
558-
ID: "",
558+
ID: "LP022",
559559
Brief: "tag mismatch",
560560
Description: "The Library Manager indexer will reject any tag that has a library.properties version equal to a previous tag in the index.",
561561
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.",
@@ -570,7 +570,7 @@ var configurations = []Type{
570570
ProjectType: projecttype.Library,
571571
Category: "library.properties",
572572
Subcategory: "author field",
573-
ID: "",
573+
ID: "LP023",
574574
Brief: "missing author field",
575575
Description: "",
576576
MessageTemplate: "missing required author field in library.properties. See https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
@@ -585,7 +585,7 @@ var configurations = []Type{
585585
ProjectType: projecttype.Library,
586586
Category: "library.properties",
587587
Subcategory: "author field",
588-
ID: "",
588+
ID: "LP024",
589589
Brief: "author < min length",
590590
Description: "",
591591
MessageTemplate: "library.properties author value is less than minimum length.",
@@ -600,7 +600,7 @@ var configurations = []Type{
600600
ProjectType: projecttype.Library,
601601
Category: "library.properties",
602602
Subcategory: "maintainer field",
603-
ID: "",
603+
ID: "LP025",
604604
Brief: "missing maintainer field",
605605
Description: "",
606606
MessageTemplate: "missing required maintainer field in library.properties. See https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
@@ -615,7 +615,7 @@ var configurations = []Type{
615615
ProjectType: projecttype.Library,
616616
Category: "library.properties",
617617
Subcategory: "maintainer field",
618-
ID: "",
618+
ID: "LP026",
619619
Brief: "maintainer < min length",
620620
Description: "",
621621
MessageTemplate: "library.properties maintainer value is less than minimum length.",
@@ -630,7 +630,7 @@ var configurations = []Type{
630630
ProjectType: projecttype.Library,
631631
Category: "library.properties",
632632
Subcategory: "maintainer field",
633-
ID: "",
633+
ID: "LP027",
634634
Brief: `starts with "Arduino"`,
635635
Description: "Case insensitive.",
636636
MessageTemplate: `library.properties maintainer value {{.}} starts with "Arduino". 3rd party libraries are not maintained by Arduino.`,
@@ -645,7 +645,7 @@ var configurations = []Type{
645645
ProjectType: projecttype.Library,
646646
Category: "library.properties",
647647
Subcategory: "email field",
648-
ID: "",
648+
ID: "LP028",
649649
Brief: `"email" field used as alias for "maintainer"`,
650650
Description: "This was in an early draft of the beta 1.5 library specification.",
651651
MessageTemplate: `library.properties "email" field used as alias for "maintainer". This is deprecated.`,
@@ -660,7 +660,7 @@ var configurations = []Type{
660660
ProjectType: projecttype.Library,
661661
Category: "library.properties",
662662
Subcategory: "email field",
663-
ID: "",
663+
ID: "LP029",
664664
Brief: "email < min length",
665665
Description: "",
666666
MessageTemplate: "library.properties email value is less than minimum length.",
@@ -675,7 +675,7 @@ var configurations = []Type{
675675
ProjectType: projecttype.Library,
676676
Category: "library.properties",
677677
Subcategory: "email field",
678-
ID: "",
678+
ID: "LP030",
679679
Brief: `starts with "Arduino"`,
680680
Description: "Case insensitive.",
681681
MessageTemplate: `library.properties email value {{.}} starts with "Arduino". 3rd party libraries are not maintained by Arduino.`,
@@ -690,7 +690,7 @@ var configurations = []Type{
690690
ProjectType: projecttype.Library,
691691
Category: "library.properties",
692692
Subcategory: "sentence field",
693-
ID: "",
693+
ID: "LP031",
694694
Brief: "missing sentence field",
695695
Description: "",
696696
MessageTemplate: "missing required sentence field in library.properties. See https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
@@ -705,7 +705,7 @@ var configurations = []Type{
705705
ProjectType: projecttype.Library,
706706
Category: "library.properties",
707707
Subcategory: "sentence field",
708-
ID: "",
708+
ID: "LP032",
709709
Brief: "sentence < min length",
710710
Description: "",
711711
MessageTemplate: "library.properties sentence value is less than minimum length.",
@@ -720,7 +720,7 @@ var configurations = []Type{
720720
ProjectType: projecttype.Library,
721721
Category: "library.properties",
722722
Subcategory: "sentence field",
723-
ID: "",
723+
ID: "LP033",
724724
Brief: "sentence spell check",
725725
Description: "",
726726
MessageTemplate: "A commonly misspelled word was found in the library.properties sentence field. Suggested correction: {{.}}",
@@ -735,7 +735,7 @@ var configurations = []Type{
735735
ProjectType: projecttype.Library,
736736
Category: "library.properties",
737737
Subcategory: "paragraph field",
738-
ID: "",
738+
ID: "LP034",
739739
Brief: "missing paragraph field",
740740
Description: "",
741741
MessageTemplate: "missing required paragraph field in library.properties. See https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
@@ -750,7 +750,7 @@ var configurations = []Type{
750750
ProjectType: projecttype.Library,
751751
Category: "library.properties",
752752
Subcategory: "paragraph field",
753-
ID: "",
753+
ID: "LP035",
754754
Brief: "paragraph spell check",
755755
Description: "",
756756
MessageTemplate: "A commonly misspelled word was found in the library.properties paragraph field. Suggested correction: {{.}}",
@@ -765,7 +765,7 @@ var configurations = []Type{
765765
ProjectType: projecttype.Library,
766766
Category: "library.properties",
767767
Subcategory: "paragraph field",
768-
ID: "",
768+
ID: "LP036",
769769
Brief: "paragraph repeats sentence",
770770
Description: "",
771771
MessageTemplate: "The library.properties paragraph field repeats the sentence field. These are displayed together so redundancy is not needed.",
@@ -780,7 +780,7 @@ var configurations = []Type{
780780
ProjectType: projecttype.Library,
781781
Category: "library.properties",
782782
Subcategory: "category field",
783-
ID: "",
783+
ID: "LP037",
784784
Brief: "missing category field",
785785
Description: `This can cause a warning and results in the default "Uncategorized" category being used.`,
786786
MessageTemplate: "missing category field in library.properties. See https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
@@ -795,7 +795,7 @@ var configurations = []Type{
795795
ProjectType: projecttype.Library,
796796
Category: "library.properties",
797797
Subcategory: "category field",
798-
ID: "",
798+
ID: "LP038",
799799
Brief: "invalid category value",
800800
Description: `This can cause a warning and results in the default "Uncategorized" category being used.`,
801801
MessageTemplate: "invalid category field value {{.}} in library.properties. See https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
@@ -810,7 +810,7 @@ var configurations = []Type{
810810
ProjectType: projecttype.Library,
811811
Category: "library.properties",
812812
Subcategory: "category field",
813-
ID: "",
813+
ID: "LP039",
814814
Brief: `"Uncategorized" category value`,
815815
Description: "There is no good reason for using this non-specification compliant category value.",
816816
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`,
@@ -825,7 +825,7 @@ var configurations = []Type{
825825
ProjectType: projecttype.Library,
826826
Category: "library.properties",
827827
Subcategory: "url field",
828-
ID: "",
828+
ID: "LP040",
829829
Brief: "missing url field",
830830
Description: "",
831831
MessageTemplate: "missing required url field in library.properties. See https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
@@ -840,7 +840,7 @@ var configurations = []Type{
840840
ProjectType: projecttype.Library,
841841
Category: "library.properties",
842842
Subcategory: "url field",
843-
ID: "",
843+
ID: "LP041",
844844
Brief: "invalid url format",
845845
Description: "",
846846
MessageTemplate: "library.properties url field value {{.}} does not have a valid URL format.",
@@ -855,7 +855,7 @@ var configurations = []Type{
855855
ProjectType: projecttype.Library,
856856
Category: "library.properties",
857857
Subcategory: "url field",
858-
ID: "",
858+
ID: "LP042",
859859
Brief: "Dead URL",
860860
Description: "",
861861
MessageTemplate: "Unable to load the library.properties url field: {{.}}",
@@ -870,7 +870,7 @@ var configurations = []Type{
870870
ProjectType: projecttype.Library,
871871
Category: "library.properties",
872872
Subcategory: "architectures field",
873-
ID: "",
873+
ID: "LP043",
874874
Brief: "missing architectures field",
875875
Description: "Defaults to *, but it's better to explicitly define architectures.",
876876
MessageTemplate: "missing architectures field in library.properties. See https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
@@ -885,7 +885,7 @@ var configurations = []Type{
885885
ProjectType: projecttype.Library,
886886
Category: "library.properties",
887887
Subcategory: "architectures field",
888-
ID: "",
888+
ID: "LP044",
889889
Brief: "architectures blank",
890890
Description: "Causes library to be considered incompatible with all architectures.",
891891
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",
@@ -900,7 +900,7 @@ var configurations = []Type{
900900
ProjectType: projecttype.Library,
901901
Category: "library.properties",
902902
Subcategory: "architectures field",
903-
ID: "",
903+
ID: "LP045",
904904
Brief: "architecture alias",
905905
Description: "Alternative development frameworks diverged on architecture naming.",
906906
MessageTemplate: "Architecture alias(es) in library.properties architectures field: {{.}}. Please also specify the true Arduino architectures compatibilities of the library. See https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
@@ -915,7 +915,7 @@ var configurations = []Type{
915915
ProjectType: projecttype.Library,
916916
Category: "library.properties",
917917
Subcategory: "architectures field",
918-
ID: "",
918+
ID: "LP046",
919919
Brief: "miscased architecture",
920920
Description: "",
921921
MessageTemplate: "Incorrect case of library.properties architectures field item(s): {{.}}. Architectures are case sensitive. See https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
@@ -930,7 +930,7 @@ var configurations = []Type{
930930
ProjectType: projecttype.Library,
931931
Category: "library.properties",
932932
Subcategory: "depends field",
933-
ID: "",
933+
ID: "LP047",
934934
Brief: "disallowed characters",
935935
Description: "",
936936
MessageTemplate: "disallowed characters in library.properties depends field {{.}}. See: https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
@@ -945,7 +945,7 @@ var configurations = []Type{
945945
ProjectType: projecttype.Library,
946946
Category: "library.properties",
947947
Subcategory: "depends field",
948-
ID: "LP012",
948+
ID: "LP048",
949949
Brief: "Dependency not in index",
950950
Description: "",
951951
MessageTemplate: "library.properties depends field item(s) {{.}} not found in the Library Manager index.",
@@ -960,7 +960,7 @@ var configurations = []Type{
960960
ProjectType: projecttype.Library,
961961
Category: "library.properties",
962962
Subcategory: "dot_a_linkage field",
963-
ID: "",
963+
ID: "LP049",
964964
Brief: "invalid value",
965965
Description: "",
966966
MessageTemplate: "invalid dot_a_linkage field value {{.}} in library.properties. See https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
@@ -975,7 +975,7 @@ var configurations = []Type{
975975
ProjectType: projecttype.Library,
976976
Category: "library.properties",
977977
Subcategory: "dot_a_linkage field",
978-
ID: "",
978+
ID: "LP050",
979979
Brief: `"true" with "1.5" library format`,
980980
Description: `dot_a_linkage feature is only supported for the "1.5" or "recursive" library format.`,
981981
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`,
@@ -990,7 +990,7 @@ var configurations = []Type{
990990
ProjectType: projecttype.Library,
991991
Category: "library.properties",
992992
Subcategory: "includes field",
993-
ID: "",
993+
ID: "LP051",
994994
Brief: "includes blank",
995995
Description: `Caused the "Sketch > Include library" feature of previous IDE versions to add an empty #include directive to the sketch.`,
996996
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",
@@ -1005,7 +1005,7 @@ var configurations = []Type{
10051005
ProjectType: projecttype.Library,
10061006
Category: "library.properties",
10071007
Subcategory: "includes field",
1008-
ID: "",
1008+
ID: "LP052",
10091009
Brief: "includes file not in library",
10101010
Description: `People often think this is the way to define their library's dependencies, which breaks the "Sketch > Include Library" feature for that library.`,
10111011
MessageTemplate: "library.properties includes field item(s) {{.}} not found in library.",
@@ -1020,7 +1020,7 @@ var configurations = []Type{
10201020
ProjectType: projecttype.Library,
10211021
Category: "library.properties",
10221022
Subcategory: "precompiled field",
1023-
ID: "",
1023+
ID: "LP053",
10241024
Brief: "invalid value",
10251025
Description: "",
10261026
MessageTemplate: "invalid precompiled field value {{.}} in library.properties. See https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
@@ -1035,7 +1035,7 @@ var configurations = []Type{
10351035
ProjectType: projecttype.Library,
10361036
Category: "library.properties",
10371037
Subcategory: "precompiled field",
1038-
ID: "",
1038+
ID: "LP054",
10391039
Brief: "precompiled with flat layout",
10401040
Description: `precompiled feature is only supported for the "1.5" or "recursive" library format.`,
10411041
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`,
@@ -1050,7 +1050,7 @@ var configurations = []Type{
10501050
ProjectType: projecttype.Library,
10511051
Category: "library.properties",
10521052
Subcategory: "ldflags field",
1053-
ID: "",
1053+
ID: "LP055",
10541054
Brief: "ldflags < min length",
10551055
Description: "",
10561056
MessageTemplate: "library.properties ldflags value is less than minimum length.",
@@ -1065,7 +1065,7 @@ var configurations = []Type{
10651065
ProjectType: projecttype.Library,
10661066
Category: "code",
10671067
Subcategory: "miscellaneous",
1068-
ID: "",
1068+
ID: "LC001",
10691069
Brief: "incorrect Arduino.h case",
10701070
Description: "This causes compilation failure on filename case-sensitive OS (e.g., Linux).",
10711071
MessageTemplate: "Incorrect of Arduino.h filename case detected in #include directive: {{.}}",
@@ -1080,7 +1080,7 @@ var configurations = []Type{
10801080
ProjectType: projecttype.Library,
10811081
Category: "documentation",
10821082
Subcategory: "miscellaneous",
1083-
ID: "",
1083+
ID: "LD001",
10841084
Brief: "no readme",
10851085
Description: "",
10861086
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",
@@ -1095,7 +1095,7 @@ var configurations = []Type{
10951095
ProjectType: projecttype.Library,
10961096
Category: "documentation",
10971097
Subcategory: "miscellaneous",
1098-
ID: "",
1098+
ID: "LD002",
10991099
Brief: "no license file",
11001100
Description: "",
11011101
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",
@@ -1110,7 +1110,7 @@ var configurations = []Type{
11101110
ProjectType: projecttype.Library,
11111111
Category: "documentation",
11121112
Subcategory: "examples",
1113-
ID: "",
1113+
ID: "LD003",
11141114
Brief: "stray sketch",
11151115
Description: "",
11161116
MessageTemplate: "Sketch(es) found outside examples and extras folders: {{.}}. See: https://arduino.github.io/arduino-cli/latest/library-specification/#library-examples",
@@ -1125,7 +1125,7 @@ var configurations = []Type{
11251125
ProjectType: projecttype.Library,
11261126
Category: "documentation",
11271127
Subcategory: "examples",
1128-
ID: "",
1128+
ID: "LD004",
11291129
Brief: "no examples",
11301130
Description: "",
11311131
MessageTemplate: "No example sketches found. Please provide examples. See: https://arduino.github.io/arduino-cli/latest/library-specification/#library-examples",
@@ -1140,7 +1140,7 @@ var configurations = []Type{
11401140
ProjectType: projecttype.Library,
11411141
Category: "documentation",
11421142
Subcategory: "examples",
1143-
ID: "",
1143+
ID: "LD005",
11441144
Brief: "incorrect examples folder name",
11451145
Description: "",
11461146
MessageTemplate: "Potentially misspelled examples folder name found: {{.}}. See: https://arduino.github.io/arduino-cli/latest/library-specification/#library-examples",
@@ -1155,7 +1155,7 @@ var configurations = []Type{
11551155
ProjectType: projecttype.Library,
11561156
Category: "documentation",
11571157
Subcategory: "examples",
1158-
ID: "",
1158+
ID: "LD006",
11591159
Brief: "incorrect examples folder name case",
11601160
Description: "",
11611161
MessageTemplate: "Incorrect examples folder name case: {{.}}. See: https://arduino.github.io/arduino-cli/latest/library-specification/#library-examples",
@@ -1170,7 +1170,7 @@ var configurations = []Type{
11701170
ProjectType: projecttype.Sketch,
11711171
Category: "structure",
11721172
Subcategory: "root folder",
1173-
ID: "",
1173+
ID: "SS001",
11741174
Brief: "name mismatch",
11751175
Description: "",
11761176
MessageTemplate: "Sketch file/folder name mismatch. The primary sketch file name must match the folder: {{.}}. See: https://arduino.github.io/arduino-cli/latest/sketch-specification/#primary-sketch-file",
@@ -1185,7 +1185,7 @@ var configurations = []Type{
11851185
ProjectType: projecttype.Sketch,
11861186
Category: "structure",
11871187
Subcategory: "file name",
1188-
ID: "",
1188+
ID: "SS002",
11891189
Brief: "disallowed characters in file name",
11901190
Description: "",
11911191
MessageTemplate: "Prohibited characters in file name(s): {{.}}. See: https://arduino.github.io/arduino-cli/latest/sketch-specification/#sketch-root-folder",
@@ -1200,7 +1200,7 @@ var configurations = []Type{
12001200
ProjectType: projecttype.Sketch,
12011201
Category: "structure",
12021202
Subcategory: "file name",
1203-
ID: "",
1203+
ID: "SS003",
12041204
Brief: "file name too long",
12051205
Description: "",
12061206
MessageTemplate: "File name(s): {{.}} exceed maximum length. See: https://arduino.github.io/arduino-cli/latest/sketch-specification/#sketch-root-folder",
@@ -1215,7 +1215,7 @@ var configurations = []Type{
12151215
ProjectType: projecttype.Sketch,
12161216
Category: "structure",
12171217
Subcategory: "file name",
1218-
ID: "SS001",
1218+
ID: "SS004",
12191219
Brief: ".pde extension",
12201220
Description: "The .pde extension is used by both Processing sketches and Arduino sketches. Processing sketches should either be in the \"data\" subfolder of the sketch or in the \"extras\" folder of the library. Arduino sketches should use the modern .ino extension.",
12211221
MessageTemplate: "{{.}} uses deprecated .pde file extension. Use .ino for Arduino sketches.",
@@ -1230,7 +1230,7 @@ var configurations = []Type{
12301230
ProjectType: projecttype.Sketch,
12311231
Category: "structure",
12321232
Subcategory: "miscellaneous",
1233-
ID: "",
1233+
ID: "SS005",
12341234
Brief: "incorrect src folder case",
12351235
Description: "",
12361236
MessageTemplate: "Incorrect src folder case: {{.}}. This will cause the source files under it to not be compiled on case-sensitive operating systems. See: https://arduino.github.io/arduino-cli/latest/sketch-specification/#src-subfolder",
@@ -1245,7 +1245,7 @@ var configurations = []Type{
12451245
ProjectType: projecttype.Sketch,
12461246
Category: "code",
12471247
Subcategory: "miscellaneous",
1248-
ID: "",
1248+
ID: "SC001",
12491249
Brief: "incorrect Arduino.h case",
12501250
Description: "This causes compilation failure on filename case-sensitive OS (e.g., Linux).",
12511251
MessageTemplate: "Incorrect of Arduino.h filename case detected in #include directive: {{.}}",
@@ -1260,7 +1260,7 @@ var configurations = []Type{
12601260
ProjectType: projecttype.Sketch,
12611261
Category: "documentation",
12621262
Subcategory: "miscellaneous",
1263-
ID: "",
1263+
ID: "SD001",
12641264
Brief: "no readme",
12651265
Description: "",
12661266
MessageTemplate: "No readme found. Please document your sketch. See: https://docs.github.com/en/free-pro-team@latest/github/creating-cloning-and-archiving-repositories/about-readmes",
@@ -1275,7 +1275,7 @@ var configurations = []Type{
12751275
ProjectType: projecttype.Sketch,
12761276
Category: "documentation",
12771277
Subcategory: "miscellaneous",
1278-
ID: "",
1278+
ID: "SD002",
12791279
Brief: "no license file",
12801280
Description: "",
12811281
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",
@@ -1290,7 +1290,7 @@ var configurations = []Type{
12901290
ProjectType: projecttype.Sketch,
12911291
Category: "sketch.json",
12921292
Subcategory: "general",
1293-
ID: "",
1293+
ID: "SM001",
12941294
Brief: "invalid sketch.json JSON format",
12951295
Description: "",
12961296
MessageTemplate: "sketch.json is not a valid JSON document. See: https://arduino.github.io/arduino-cli/latest/sketch-specification/#metadata",
@@ -1305,7 +1305,7 @@ var configurations = []Type{
13051305
ProjectType: projecttype.Sketch,
13061306
Category: "sketch.json",
13071307
Subcategory: "general",
1308-
ID: "",
1308+
ID: "SM002",
13091309
Brief: "invalid sketch.json data format",
13101310
Description: "",
13111311
MessageTemplate: "sketch.json has an invalid data format: {{.}}. See: https://arduino.github.io/arduino-cli/latest/sketch-specification/#metadata",
@@ -1320,7 +1320,7 @@ var configurations = []Type{
13201320
ProjectType: projecttype.Platform,
13211321
Category: "documentation",
13221322
Subcategory: "miscellaneous",
1323-
ID: "",
1323+
ID: "PD001",
13241324
Brief: "no readme",
13251325
Description: "",
13261326
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",
@@ -1335,7 +1335,7 @@ var configurations = []Type{
13351335
ProjectType: projecttype.Platform,
13361336
Category: "documentation",
13371337
Subcategory: "miscellaneous",
1338-
ID: "",
1338+
ID: "PD002",
13391339
Brief: "no license file",
13401340
Description: "",
13411341
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",
@@ -1350,7 +1350,7 @@ var configurations = []Type{
13501350
ProjectType: projecttype.Platform,
13511351
Category: "configuration files",
13521352
Subcategory: "boards.txt",
1353-
ID: "",
1353+
ID: "PF001",
13541354
Brief: "missing",
13551355
Description: "",
13561356
MessageTemplate: "Required boards.txt is missing. Expected at: {{.}}",
@@ -1365,7 +1365,7 @@ var configurations = []Type{
13651365
ProjectType: projecttype.Platform,
13661366
Category: "configuration files",
13671367
Subcategory: "boards.txt",
1368-
ID: "",
1368+
ID: "PF002",
13691369
Brief: "Invalid boards.txt",
13701370
Description: "",
13711371
MessageTemplate: "boards.txt has an invalid format: {{.}}",
@@ -1380,7 +1380,7 @@ var configurations = []Type{
13801380
ProjectType: projecttype.Platform,
13811381
Category: "code",
13821382
Subcategory: "miscellaneous",
1383-
ID: "",
1383+
ID: "PC001",
13841384
Brief: "incorrect Arduino.h case",
13851385
Description: "This causes compilation failure on filename case-sensitive OS (e.g., Linux).",
13861386
MessageTemplate: "Incorrect of Arduino.h filename case detected in #include directive: {{.}}",
@@ -1395,7 +1395,7 @@ var configurations = []Type{
13951395
ProjectType: projecttype.PackageIndex,
13961396
Category: "data",
13971397
Subcategory: "general",
1398-
ID: "",
1398+
ID: "ID001",
13991399
Brief: "Invalid JSON format",
14001400
Description: "",
14011401
MessageTemplate: "Invalid JSON format.",
@@ -1410,7 +1410,7 @@ var configurations = []Type{
14101410
ProjectType: projecttype.PackageIndex,
14111411
Category: "data",
14121412
Subcategory: "general",
1413-
ID: "",
1413+
ID: "ID002",
14141414
Brief: "Invalid format",
14151415
Description: "",
14161416
MessageTemplate: "Invalid package index format: {{.}}",

0 commit comments

Comments
 (0)
Please sign in to comment.