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 1c754bd

Browse files
per1234per1234
authoredDec 27, 2020
Merge pull request #130 from arduino/per1234/improve-rule-messages
Improve formatting and wording of rule messages
2 parents 31c043d + a42cd8c commit 1c754bd

File tree

1 file changed

+80
-80
lines changed

1 file changed

+80
-80
lines changed
 

‎internal/rule/ruleconfiguration/ruleconfiguration.go

Lines changed: 80 additions & 80 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ var configurations = []Type{
6363
Category: "structure",
6464
Subcategory: "general",
6565
ID: "LS001",
66-
Brief: "invalid",
66+
Brief: "invalid library",
6767
Description: "",
6868
MessageTemplate: "Path does not contain a valid Arduino library. See: https://arduino.github.io/arduino-cli/latest/library-specification",
6969
DisableModes: nil,
@@ -95,9 +95,9 @@ var configurations = []Type{
9595
Category: "structure",
9696
Subcategory: "root folder",
9797
ID: "LS003",
98-
Brief: "disallowed characters in folder name",
98+
Brief: "prohibited character in folder name",
9999
Description: "This will be problematic for people doing manual installation of the library.",
100-
MessageTemplate: "Prohibited characters in folder name: {{.}}. See: https://arduino.github.io/arduino-cli/latest/library-specification/#library-root-folder",
100+
MessageTemplate: "Prohibited character(s) in folder name: {{.}}. See: https://arduino.github.io/arduino-cli/latest/library-specification/#library-root-folder",
101101
DisableModes: nil,
102102
EnableModes: []rulemode.Type{rulemode.Default},
103103
InfoModes: nil,
@@ -129,7 +129,7 @@ var configurations = []Type{
129129
ID: "LS005",
130130
Brief: "symlink",
131131
Description: "",
132-
MessageTemplate: "Symlink(s) found at {{.}}. These block acceptance to the Arduino Library Manager index.",
132+
MessageTemplate: "Symlink(s) found at {{.}}. Symlinks cause difficulties for Windows users. These block addition to the Arduino Library Manager index.",
133133
DisableModes: nil,
134134
EnableModes: []rulemode.Type{rulemode.Default},
135135
InfoModes: nil,
@@ -144,8 +144,8 @@ var configurations = []Type{
144144
Subcategory: "miscellaneous",
145145
ID: "LS006",
146146
Brief: ".development file",
147-
Description: "",
148-
MessageTemplate: ".development flag file found. Presence of this file blocks addition to the Library Manager index.",
147+
Description: "See: https://arduino.github.io/arduino-cli/latest/library-specification/#development-flag-file",
148+
MessageTemplate: ".development flag file found. This file allows users to accidentally modify examples. Presence of this file blocks addition to the Library Manager index.",
149149
DisableModes: nil,
150150
EnableModes: []rulemode.Type{rulemode.Default},
151151
InfoModes: nil,
@@ -161,7 +161,7 @@ var configurations = []Type{
161161
ID: "LS007",
162162
Brief: ".exe file",
163163
Description: "",
164-
MessageTemplate: ".exe file(s) found: {{.}}. Presence of these files blocks inclusion in Library Manager index.",
164+
MessageTemplate: ".exe file(s) found: {{.}}. Presence of these files blocks addition to the Library Manager index.",
165165
DisableModes: nil,
166166
EnableModes: []rulemode.Type{rulemode.Default},
167167
InfoModes: nil,
@@ -191,9 +191,9 @@ var configurations = []Type{
191191
Category: "structure",
192192
Subcategory: "source code",
193193
ID: "LS009",
194-
Brief: "incorrect src folder case",
194+
Brief: "src folder case",
195195
Description: "",
196-
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",
196+
MessageTemplate: "Incorrect src folder name case: {{.}}. This will cause the library to not be recognized on case-sensitive file systems. See: https://arduino.github.io/arduino-cli/latest/library-specification/#library-root-folder",
197197
DisableModes: nil,
198198
EnableModes: []rulemode.Type{rulemode.Default},
199199
InfoModes: nil,
@@ -239,7 +239,7 @@ var configurations = []Type{
239239
Category: "structure",
240240
Subcategory: "extras folder",
241241
ID: "LS012",
242-
Brief: "incorrect extras folder name case",
242+
Brief: "extras folder name case",
243243
Description: "",
244244
MessageTemplate: "Incorrect extras folder name case: {{.}}. See: https://arduino.github.io/arduino-cli/latest/library-specification/#extra-documentation",
245245
DisableModes: nil,
@@ -255,8 +255,8 @@ var configurations = []Type{
255255
Category: "library.properties",
256256
Subcategory: "general",
257257
ID: "LP001",
258-
Brief: "missing",
259-
Description: `Although not required for 1.0 format libraries (AKA "legacy") not in Library Manager, metadata is useful, so it is recommended.`,
258+
Brief: "missing library.properties",
259+
Description: `Although not required for 1.0 format libraries (AKA "legacy") not in Library Manager, metadata is useful, hence recommended.`,
260260
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",
261261
DisableModes: nil,
262262
EnableModes: []rulemode.Type{rulemode.Default},
@@ -287,8 +287,8 @@ var configurations = []Type{
287287
Category: "library.properties",
288288
Subcategory: "general",
289289
ID: "LP003",
290-
Brief: "incorrect library.properties file name case",
291-
Description: `This causes "1.5" format (AKA "recursive layout") libraries to not be recognized on filename case-sensitive operating systems.`,
290+
Brief: "library.properties file name case",
291+
Description: `This causes "1.5" format (AKA "recursive layout") libraries to not be recognized on case-sensitive file systems.`,
292292
MessageTemplate: "Incorrect library.properties file name case: {{.}}. See: https://arduino.github.io/arduino-cli/latest/library-specification/#library-metadata",
293293
DisableModes: nil,
294294
EnableModes: []rulemode.Type{rulemode.Default},
@@ -303,7 +303,7 @@ var configurations = []Type{
303303
Category: "library.properties",
304304
Subcategory: "general",
305305
ID: "LP004",
306-
Brief: "redundant",
306+
Brief: "redundant library.properties",
307307
Description: "",
308308
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",
309309
DisableModes: nil,
@@ -319,8 +319,8 @@ var configurations = []Type{
319319
Category: "library.properties",
320320
Subcategory: "general",
321321
ID: "LP005",
322-
Brief: "invalid format",
323-
Description: "",
322+
Brief: "library.properties format",
323+
Description: "See: https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
324324
MessageTemplate: "library.properties has an invalid format: {{.}}",
325325
DisableModes: nil,
326326
EnableModes: []rulemode.Type{rulemode.Default},
@@ -335,7 +335,7 @@ var configurations = []Type{
335335
Category: "library.properties",
336336
Subcategory: "general",
337337
ID: "LP006",
338-
Brief: "misspelled field",
338+
Brief: "misspelled library.properties field",
339339
Description: "",
340340
MessageTemplate: "Potentially misspelled library.properties field name detected. See: https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
341341
DisableModes: nil,
@@ -351,9 +351,9 @@ var configurations = []Type{
351351
Category: "library.properties",
352352
Subcategory: "name field",
353353
ID: "LP007",
354-
Brief: "missing name field",
354+
Brief: "missing name",
355355
Description: "",
356-
MessageTemplate: "missing name field in library.properties",
356+
MessageTemplate: "Missing name field in library.properties. See: https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
357357
DisableModes: nil,
358358
EnableModes: []rulemode.Type{rulemode.Default},
359359
InfoModes: nil,
@@ -401,7 +401,7 @@ var configurations = []Type{
401401
ID: "LP010",
402402
Brief: "name > recommended length",
403403
Description: "",
404-
MessageTemplate: "library.properties name value {{.}} is longer than recommended max length.",
404+
MessageTemplate: "library.properties name value {{.}} is longer than the recommended length of 16 characters.",
405405
DisableModes: nil,
406406
EnableModes: []rulemode.Type{rulemode.Default},
407407
InfoModes: nil,
@@ -415,9 +415,9 @@ var configurations = []Type{
415415
Category: "library.properties",
416416
Subcategory: "name field",
417417
ID: "LP011",
418-
Brief: "disallowed characters",
418+
Brief: "prohibited character in name",
419419
Description: "",
420-
MessageTemplate: "disallowed characters in library.properties name value: {{.}}. See: https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
420+
MessageTemplate: "Prohibited character(s) in library.properties name value: {{.}}. See: https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
421421
DisableModes: nil,
422422
EnableModes: []rulemode.Type{rulemode.Default},
423423
InfoModes: nil,
@@ -431,8 +431,8 @@ var configurations = []Type{
431431
Category: "library.properties",
432432
Subcategory: "name field",
433433
ID: "LP012",
434-
Brief: `starts with "Arduino"`,
435-
Description: `Case insensitive. 3rd party libraries added to Library Manager index prior to the enactment of this rule are "grandfathered".`,
434+
Brief: `name starts with "Arduino"`,
435+
Description: `Case insensitive. Only 3rd party libraries added to the Library Manager index prior to the enactment of this rule are allowed to have this name prefix.`,
436436
MessageTemplate: `Library name {{.}} starts with "Arduino". These names are reserved for official libraries.`,
437437
DisableModes: []rulemode.Type{rulemode.Official},
438438
EnableModes: []rulemode.Type{rulemode.Default},
@@ -447,7 +447,7 @@ var configurations = []Type{
447447
Category: "library.properties",
448448
Subcategory: "name field",
449449
ID: "LP013",
450-
Brief: "missing official prefix",
450+
Brief: "name missing official prefix",
451451
Description: "",
452452
MessageTemplate: `Library name {{.}} is missing the "Arduino_" prefix. All new official library names must use this prefix.`,
453453
DisableModes: []rulemode.Type{rulemode.Default},
@@ -463,7 +463,7 @@ var configurations = []Type{
463463
Category: "library.properties",
464464
Subcategory: "name field",
465465
ID: "LP014",
466-
Brief: `contains "Arduino"`,
466+
Brief: `name contains "Arduino"`,
467467
Description: "Case insensitive",
468468
MessageTemplate: `Library name {{.}} contains "Arduino". This is superfluous.`,
469469
DisableModes: []rulemode.Type{rulemode.Official},
@@ -479,7 +479,7 @@ var configurations = []Type{
479479
Category: "library.properties",
480480
Subcategory: "name field",
481481
ID: "LP015",
482-
Brief: "contains spaces",
482+
Brief: "name contains spaces",
483483
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.",
484484
MessageTemplate: "library.properties name {{.}} contains spaces. Although supported, best practices is to not use spaces.",
485485
DisableModes: nil,
@@ -495,7 +495,7 @@ var configurations = []Type{
495495
Category: "library.properties",
496496
Subcategory: "name field",
497497
ID: "LP016",
498-
Brief: `contains "library"`,
498+
Brief: `name contains "library"`,
499499
Description: "Case insensitive",
500500
MessageTemplate: `Library name {{.}} contains "library". This is superfluous.`,
501501
DisableModes: nil,
@@ -513,7 +513,7 @@ var configurations = []Type{
513513
ID: "LP017",
514514
Brief: "duplicate name",
515515
Description: "This requirement only applies to the library.properties name value. There is no requirement to change the repository or header file names.",
516-
MessageTemplate: "Library name {{.}} is in use by a library in the Library Manager index. Each library must have a unique name value.",
516+
MessageTemplate: "Library name {{.}} is in use by a library in the Library Manager index. Each library must have a unique name value. If your library is already in the index, use the \"--library-manager update\" flag.",
517517
DisableModes: []rulemode.Type{rulemode.LibraryManagerIndexed},
518518
EnableModes: []rulemode.Type{rulemode.Default},
519519
InfoModes: nil,
@@ -545,7 +545,7 @@ var configurations = []Type{
545545
ID: "LP019",
546546
Brief: "missing version field",
547547
Description: "",
548-
MessageTemplate: "missing version field in library.properties",
548+
MessageTemplate: "Missing version field in library.properties",
549549
DisableModes: nil,
550550
EnableModes: []rulemode.Type{rulemode.Default},
551551
InfoModes: nil,
@@ -559,7 +559,7 @@ var configurations = []Type{
559559
Category: "library.properties",
560560
Subcategory: "version field",
561561
ID: "LP020",
562-
Brief: "invalid",
562+
Brief: "invalid version",
563563
Description: `Must be compliant with "relaxed semver".`,
564564
MessageTemplate: "library.properties version value {{.}} is invalid. See https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
565565
DisableModes: nil,
@@ -575,7 +575,7 @@ var configurations = []Type{
575575
Category: "library.properties",
576576
Subcategory: "version field",
577577
ID: "LP021",
578-
Brief: "non-semver",
578+
Brief: "non-semver version",
579579
Description: "",
580580
MessageTemplate: "library.properties version value {{.}} is not compliant with the semver specification. See https://semver.org/",
581581
DisableModes: nil,
@@ -609,7 +609,7 @@ var configurations = []Type{
609609
ID: "LP023",
610610
Brief: "missing author field",
611611
Description: "",
612-
MessageTemplate: "missing required author field in library.properties. See https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
612+
MessageTemplate: "Missing author field in library.properties. See https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
613613
DisableModes: nil,
614614
EnableModes: []rulemode.Type{rulemode.Default},
615615
InfoModes: nil,
@@ -641,7 +641,7 @@ var configurations = []Type{
641641
ID: "LP025",
642642
Brief: "missing maintainer field",
643643
Description: "",
644-
MessageTemplate: "missing required maintainer field in library.properties. See https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
644+
MessageTemplate: "Missing maintainer field in library.properties. See https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
645645
DisableModes: nil,
646646
EnableModes: []rulemode.Type{rulemode.Default},
647647
InfoModes: nil,
@@ -671,7 +671,7 @@ var configurations = []Type{
671671
Category: "library.properties",
672672
Subcategory: "maintainer field",
673673
ID: "LP027",
674-
Brief: `starts with "Arduino"`,
674+
Brief: `maintainer starts with "Arduino"`,
675675
Description: "Case insensitive.",
676676
MessageTemplate: `library.properties maintainer value {{.}} starts with "Arduino". 3rd party libraries are not maintained by Arduino.`,
677677
DisableModes: []rulemode.Type{rulemode.Official},
@@ -687,8 +687,8 @@ var configurations = []Type{
687687
Category: "library.properties",
688688
Subcategory: "email field",
689689
ID: "LP028",
690-
Brief: `"email" field used as alias for "maintainer"`,
691-
Description: "This was in an early draft of the beta 1.5 library specification.",
690+
Brief: `"email" used as alias for "maintainer"`,
691+
Description: "This was only in an early draft of the beta 1.5 library specification.",
692692
MessageTemplate: `library.properties "email" field used as alias for "maintainer". This is deprecated.`,
693693
DisableModes: nil,
694694
EnableModes: []rulemode.Type{rulemode.Default},
@@ -719,7 +719,7 @@ var configurations = []Type{
719719
Category: "library.properties",
720720
Subcategory: "email field",
721721
ID: "LP030",
722-
Brief: `starts with "Arduino"`,
722+
Brief: `email starts with "Arduino"`,
723723
Description: "Case insensitive.",
724724
MessageTemplate: `library.properties email value {{.}} starts with "Arduino". 3rd party libraries are not maintained by Arduino.`,
725725
DisableModes: []rulemode.Type{rulemode.Official},
@@ -737,7 +737,7 @@ var configurations = []Type{
737737
ID: "LP031",
738738
Brief: "missing sentence field",
739739
Description: "",
740-
MessageTemplate: "missing required sentence field in library.properties. See https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
740+
MessageTemplate: "Missing sentence field in library.properties. See https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
741741
DisableModes: nil,
742742
EnableModes: []rulemode.Type{rulemode.Default},
743743
InfoModes: nil,
@@ -785,7 +785,7 @@ var configurations = []Type{
785785
ID: "LP034",
786786
Brief: "missing paragraph field",
787787
Description: "",
788-
MessageTemplate: "missing required paragraph field in library.properties. See https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
788+
MessageTemplate: "Missing paragraph field in library.properties. See https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
789789
DisableModes: nil,
790790
EnableModes: []rulemode.Type{rulemode.Default},
791791
InfoModes: nil,
@@ -833,7 +833,7 @@ var configurations = []Type{
833833
ID: "LP037",
834834
Brief: "missing category field",
835835
Description: `This can cause a warning and results in the default "Uncategorized" category being used.`,
836-
MessageTemplate: "missing category field in library.properties. See https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
836+
MessageTemplate: "Missing category field in library.properties. See https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
837837
DisableModes: nil,
838838
EnableModes: []rulemode.Type{rulemode.Default},
839839
InfoModes: nil,
@@ -849,7 +849,7 @@ var configurations = []Type{
849849
ID: "LP038",
850850
Brief: "invalid category value",
851851
Description: `This can cause a warning and results in the default "Uncategorized" category being used.`,
852-
MessageTemplate: "invalid category field value {{.}} in library.properties. See https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
852+
MessageTemplate: "Invalid category field value {{.}} in library.properties. See https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
853853
DisableModes: nil,
854854
EnableModes: []rulemode.Type{rulemode.Default},
855855
InfoModes: nil,
@@ -865,7 +865,7 @@ var configurations = []Type{
865865
ID: "LP039",
866866
Brief: `"Uncategorized" category value`,
867867
Description: "There is no good reason for using this non-specification compliant category value.",
868-
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`,
868+
MessageTemplate: `Use of "Uncategorized" category value in library.properties. Please use one of the allowed categories: https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format`,
869869
DisableModes: nil,
870870
EnableModes: []rulemode.Type{rulemode.Default},
871871
InfoModes: nil,
@@ -881,7 +881,7 @@ var configurations = []Type{
881881
ID: "LP040",
882882
Brief: "missing url field",
883883
Description: "",
884-
MessageTemplate: "missing required url field in library.properties. See https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
884+
MessageTemplate: "Missing url field in library.properties. See https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
885885
DisableModes: nil,
886886
EnableModes: []rulemode.Type{rulemode.Default},
887887
InfoModes: nil,
@@ -911,7 +911,7 @@ var configurations = []Type{
911911
Category: "library.properties",
912912
Subcategory: "url field",
913913
ID: "LP042",
914-
Brief: "Dead URL",
914+
Brief: "dead URL",
915915
Description: "",
916916
MessageTemplate: "Unable to load the library.properties url field: {{.}}",
917917
DisableModes: nil,
@@ -929,7 +929,7 @@ var configurations = []Type{
929929
ID: "LP043",
930930
Brief: "missing architectures field",
931931
Description: "Defaults to *, but it's better to explicitly define architectures.",
932-
MessageTemplate: "missing architectures field in library.properties. See https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
932+
MessageTemplate: "Missing architectures field in library.properties. See https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
933933
DisableModes: nil,
934934
EnableModes: []rulemode.Type{rulemode.Default},
935935
InfoModes: nil,
@@ -975,7 +975,7 @@ var configurations = []Type{
975975
Category: "library.properties",
976976
Subcategory: "architectures field",
977977
ID: "LP046",
978-
Brief: "miscased architecture",
978+
Brief: "architecture case",
979979
Description: "",
980980
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",
981981
DisableModes: nil,
@@ -991,9 +991,9 @@ var configurations = []Type{
991991
Category: "library.properties",
992992
Subcategory: "depends field",
993993
ID: "LP047",
994-
Brief: "disallowed characters",
994+
Brief: "prohibited character in depends",
995995
Description: "",
996-
MessageTemplate: "disallowed characters in library.properties depends field {{.}}. See: https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
996+
MessageTemplate: "Prohibited character(s) in library.properties depends field {{.}}. See: https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
997997
DisableModes: nil,
998998
EnableModes: []rulemode.Type{rulemode.Default},
999999
InfoModes: nil,
@@ -1007,8 +1007,8 @@ var configurations = []Type{
10071007
Category: "library.properties",
10081008
Subcategory: "depends field",
10091009
ID: "LP048",
1010-
Brief: "Dependency not in index",
1011-
Description: "",
1010+
Brief: "depends not in index",
1011+
Description: "This field should be used to define the dependencies available from Library Manager. Library names are case-sensitive.",
10121012
MessageTemplate: "library.properties depends field item(s) {{.}} not found in the Library Manager index.",
10131013
DisableModes: nil,
10141014
EnableModes: []rulemode.Type{rulemode.Default},
@@ -1023,9 +1023,9 @@ var configurations = []Type{
10231023
Category: "library.properties",
10241024
Subcategory: "dot_a_linkage field",
10251025
ID: "LP049",
1026-
Brief: "invalid value",
1026+
Brief: "invalid dot_a_linkage value",
10271027
Description: "",
1028-
MessageTemplate: "invalid dot_a_linkage field value {{.}} in library.properties. See https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
1028+
MessageTemplate: "Invalid dot_a_linkage field value {{.}} in library.properties. See https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
10291029
DisableModes: nil,
10301030
EnableModes: []rulemode.Type{rulemode.Default},
10311031
InfoModes: nil,
@@ -1039,7 +1039,7 @@ var configurations = []Type{
10391039
Category: "library.properties",
10401040
Subcategory: "dot_a_linkage field",
10411041
ID: "LP050",
1042-
Brief: `"true" with "1.5" library format`,
1042+
Brief: `dot_a_linkage=true with "1.0" library format`,
10431043
Description: `dot_a_linkage feature is only supported for the "1.5" or "recursive" library format.`,
10441044
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`,
10451045
DisableModes: nil,
@@ -1071,7 +1071,7 @@ var configurations = []Type{
10711071
Category: "library.properties",
10721072
Subcategory: "includes field",
10731073
ID: "LP052",
1074-
Brief: "includes file not in library",
1074+
Brief: "includes not in library",
10751075
Description: `People often think this is the way to define their library's dependencies, which breaks the "Sketch > Include Library" feature for that library.`,
10761076
MessageTemplate: "library.properties includes field item(s) {{.}} not found in library.",
10771077
DisableModes: nil,
@@ -1087,9 +1087,9 @@ var configurations = []Type{
10871087
Category: "library.properties",
10881088
Subcategory: "precompiled field",
10891089
ID: "LP053",
1090-
Brief: "invalid value",
1090+
Brief: "invalid precompiled value",
10911091
Description: "",
1092-
MessageTemplate: "invalid precompiled field value {{.}} in library.properties. See https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
1092+
MessageTemplate: "Invalid precompiled field value {{.}} in library.properties. See https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
10931093
DisableModes: nil,
10941094
EnableModes: []rulemode.Type{rulemode.Default},
10951095
InfoModes: nil,
@@ -1103,7 +1103,7 @@ var configurations = []Type{
11031103
Category: "library.properties",
11041104
Subcategory: "precompiled field",
11051105
ID: "LP054",
1106-
Brief: "precompiled with flat layout",
1106+
Brief: "precompiled with \"1.0\" format",
11071107
Description: `precompiled feature is only supported for the "1.5" or "recursive" library format.`,
11081108
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`,
11091109
DisableModes: nil,
@@ -1135,9 +1135,9 @@ var configurations = []Type{
11351135
Category: "code",
11361136
Subcategory: "miscellaneous",
11371137
ID: "LC001",
1138-
Brief: "incorrect Arduino.h case",
1139-
Description: "This causes compilation failure on filename case-sensitive OS (e.g., Linux).",
1140-
MessageTemplate: "Incorrect of Arduino.h filename case detected in #include directive: {{.}}",
1138+
Brief: "Arduino.h case",
1139+
Description: "This causes compilation failure on case-sensitive file systems.",
1140+
MessageTemplate: "Incorrect Arduino.h filename case in #include directive: {{.}}",
11411141
DisableModes: nil,
11421142
EnableModes: []rulemode.Type{rulemode.Default},
11431143
InfoModes: nil,
@@ -1231,7 +1231,7 @@ var configurations = []Type{
12311231
Category: "documentation",
12321232
Subcategory: "examples",
12331233
ID: "LD006",
1234-
Brief: "incorrect examples folder name case",
1234+
Brief: "examples folder name case",
12351235
Description: "",
12361236
MessageTemplate: "Incorrect examples folder name case: {{.}}. See: https://arduino.github.io/arduino-cli/latest/library-specification/#library-examples",
12371237
DisableModes: nil,
@@ -1263,9 +1263,9 @@ var configurations = []Type{
12631263
Category: "structure",
12641264
Subcategory: "file name",
12651265
ID: "SS002",
1266-
Brief: "disallowed characters in file name",
1266+
Brief: "prohibited character in filename",
12671267
Description: "",
1268-
MessageTemplate: "Prohibited characters in file name(s): {{.}}. See: https://arduino.github.io/arduino-cli/latest/sketch-specification/#sketch-root-folder",
1268+
MessageTemplate: "Prohibited character(s) in file name(s): {{.}}. See: https://arduino.github.io/arduino-cli/latest/sketch-specification/#sketch-root-folder",
12691269
DisableModes: nil,
12701270
EnableModes: []rulemode.Type{rulemode.Default},
12711271
InfoModes: nil,
@@ -1311,9 +1311,9 @@ var configurations = []Type{
13111311
Category: "structure",
13121312
Subcategory: "miscellaneous",
13131313
ID: "SS005",
1314-
Brief: "incorrect src folder case",
1314+
Brief: "src folder case",
13151315
Description: "",
1316-
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",
1316+
MessageTemplate: "Incorrect src folder case: {{.}}. This will cause the source files under it to not be compiled on case-sensitive file systems. See: https://arduino.github.io/arduino-cli/latest/sketch-specification/#src-subfolder",
13171317
DisableModes: nil,
13181318
EnableModes: []rulemode.Type{rulemode.Default},
13191319
InfoModes: nil,
@@ -1327,9 +1327,9 @@ var configurations = []Type{
13271327
Category: "code",
13281328
Subcategory: "miscellaneous",
13291329
ID: "SC001",
1330-
Brief: "incorrect Arduino.h case",
1331-
Description: "This causes compilation failure on filename case-sensitive OS (e.g., Linux).",
1332-
MessageTemplate: "Incorrect of Arduino.h filename case detected in #include directive: {{.}}",
1330+
Brief: "Arduino.h case",
1331+
Description: "This causes compilation failure on filename case-sensitive file systems.",
1332+
MessageTemplate: "Incorrect Arduino.h filename case in #include directive: {{.}}",
13331333
DisableModes: nil,
13341334
EnableModes: []rulemode.Type{rulemode.Default},
13351335
InfoModes: nil,
@@ -1375,7 +1375,7 @@ var configurations = []Type{
13751375
Category: "sketch.json",
13761376
Subcategory: "general",
13771377
ID: "SM001",
1378-
Brief: "invalid sketch.json JSON format",
1378+
Brief: "sketch.json JSON format",
13791379
Description: "",
13801380
MessageTemplate: "sketch.json is not a valid JSON document. See: https://arduino.github.io/arduino-cli/latest/sketch-specification/#metadata",
13811381
DisableModes: nil,
@@ -1391,7 +1391,7 @@ var configurations = []Type{
13911391
Category: "sketch.json",
13921392
Subcategory: "general",
13931393
ID: "SM002",
1394-
Brief: "invalid sketch.json data format",
1394+
Brief: "sketch.json data format",
13951395
Description: "",
13961396
MessageTemplate: "sketch.json has an invalid data format: {{.}}. See: https://arduino.github.io/arduino-cli/latest/sketch-specification/#metadata",
13971397
DisableModes: nil,
@@ -1409,7 +1409,7 @@ var configurations = []Type{
14091409
ID: "PD001",
14101410
Brief: "no readme",
14111411
Description: "",
1412-
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",
1412+
MessageTemplate: "No readme found. Please document your boards platform. See: https://docs.github.com/en/free-pro-team@latest/github/creating-cloning-and-archiving-repositories/about-readmes",
14131413
DisableModes: nil,
14141414
EnableModes: []rulemode.Type{rulemode.Default},
14151415
InfoModes: nil,
@@ -1439,7 +1439,7 @@ var configurations = []Type{
14391439
Category: "configuration files",
14401440
Subcategory: "boards.txt",
14411441
ID: "PF001",
1442-
Brief: "missing",
1442+
Brief: "boards.txt missing",
14431443
Description: "",
14441444
MessageTemplate: "Required boards.txt is missing. Expected at: {{.}}",
14451445
DisableModes: nil,
@@ -1455,7 +1455,7 @@ var configurations = []Type{
14551455
Category: "configuration files",
14561456
Subcategory: "boards.txt",
14571457
ID: "PF002",
1458-
Brief: "Invalid boards.txt",
1458+
Brief: "invalid boards.txt",
14591459
Description: "",
14601460
MessageTemplate: "boards.txt has an invalid format: {{.}}",
14611461
DisableModes: nil,
@@ -1471,9 +1471,9 @@ var configurations = []Type{
14711471
Category: "code",
14721472
Subcategory: "miscellaneous",
14731473
ID: "PC001",
1474-
Brief: "incorrect Arduino.h case",
1475-
Description: "This causes compilation failure on filename case-sensitive OS (e.g., Linux).",
1476-
MessageTemplate: "Incorrect of Arduino.h filename case detected in #include directive: {{.}}",
1474+
Brief: "Arduino.h case",
1475+
Description: "This causes compilation failure on filename case-sensitive file systems.",
1476+
MessageTemplate: "Incorrect Arduino.h filename case in #include directive: {{.}}",
14771477
DisableModes: nil,
14781478
EnableModes: []rulemode.Type{rulemode.Default},
14791479
InfoModes: nil,
@@ -1487,7 +1487,7 @@ var configurations = []Type{
14871487
Category: "data",
14881488
Subcategory: "general",
14891489
ID: "ID001",
1490-
Brief: "Invalid JSON format",
1490+
Brief: "JSON format",
14911491
Description: "",
14921492
MessageTemplate: "Invalid JSON format.",
14931493
DisableModes: nil,
@@ -1503,7 +1503,7 @@ var configurations = []Type{
15031503
Category: "data",
15041504
Subcategory: "general",
15051505
ID: "ID002",
1506-
Brief: "Invalid format",
1506+
Brief: "data format",
15071507
Description: "",
15081508
MessageTemplate: "Invalid package index format: {{.}}",
15091509
DisableModes: nil,

0 commit comments

Comments
 (0)
Please sign in to comment.