diff --git a/internal/rule/ruleconfiguration/ruleconfiguration.go b/internal/rule/ruleconfiguration/ruleconfiguration.go index 05a654533..73c67c0c5 100644 --- a/internal/rule/ruleconfiguration/ruleconfiguration.go +++ b/internal/rule/ruleconfiguration/ruleconfiguration.go @@ -63,7 +63,7 @@ var configurations = []Type{ Category: "structure", Subcategory: "general", ID: "LS001", - Brief: "invalid", + Brief: "invalid library", Description: "", MessageTemplate: "Path does not contain a valid Arduino library. See: https://arduino.github.io/arduino-cli/latest/library-specification", DisableModes: nil, @@ -95,9 +95,9 @@ var configurations = []Type{ Category: "structure", Subcategory: "root folder", ID: "LS003", - Brief: "disallowed characters in folder name", + Brief: "prohibited character 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", + MessageTemplate: "Prohibited character(s) in folder name: {{.}}. See: https://arduino.github.io/arduino-cli/latest/library-specification/#library-root-folder", DisableModes: nil, EnableModes: []rulemode.Type{rulemode.Default}, InfoModes: nil, @@ -129,7 +129,7 @@ var configurations = []Type{ ID: "LS005", Brief: "symlink", Description: "", - MessageTemplate: "Symlink(s) found at {{.}}. These block acceptance to the Arduino Library Manager index.", + MessageTemplate: "Symlink(s) found at {{.}}. Symlinks cause difficulties for Windows users. These block addition to the Arduino Library Manager index.", DisableModes: nil, EnableModes: []rulemode.Type{rulemode.Default}, InfoModes: nil, @@ -144,8 +144,8 @@ var configurations = []Type{ Subcategory: "miscellaneous", ID: "LS006", Brief: ".development file", - Description: "", - MessageTemplate: ".development flag file found. Presence of this file blocks addition to the Library Manager index.", + Description: "See: https://arduino.github.io/arduino-cli/latest/library-specification/#development-flag-file", + MessageTemplate: ".development flag file found. This file allows users to accidentally modify examples. Presence of this file blocks addition to the Library Manager index.", DisableModes: nil, EnableModes: []rulemode.Type{rulemode.Default}, InfoModes: nil, @@ -161,7 +161,7 @@ var configurations = []Type{ ID: "LS007", Brief: ".exe file", Description: "", - MessageTemplate: ".exe file(s) found: {{.}}. Presence of these files blocks inclusion in Library Manager index.", + MessageTemplate: ".exe file(s) found: {{.}}. Presence of these files blocks addition to the Library Manager index.", DisableModes: nil, EnableModes: []rulemode.Type{rulemode.Default}, InfoModes: nil, @@ -191,9 +191,9 @@ var configurations = []Type{ Category: "structure", Subcategory: "source code", ID: "LS009", - Brief: "incorrect src folder case", + Brief: "src folder case", Description: "", - 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", + 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", DisableModes: nil, EnableModes: []rulemode.Type{rulemode.Default}, InfoModes: nil, @@ -239,7 +239,7 @@ var configurations = []Type{ Category: "structure", Subcategory: "extras folder", ID: "LS012", - Brief: "incorrect extras folder name case", + Brief: "extras folder name case", Description: "", MessageTemplate: "Incorrect extras folder name case: {{.}}. See: https://arduino.github.io/arduino-cli/latest/library-specification/#extra-documentation", DisableModes: nil, @@ -255,8 +255,8 @@ var configurations = []Type{ 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.`, + Brief: "missing library.properties", + Description: `Although not required for 1.0 format libraries (AKA "legacy") not in Library Manager, metadata is useful, hence 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: []rulemode.Type{rulemode.Default}, @@ -287,8 +287,8 @@ var configurations = []Type{ Category: "library.properties", Subcategory: "general", ID: "LP003", - 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.`, + Brief: "library.properties file name case", + Description: `This causes "1.5" format (AKA "recursive layout") libraries to not be recognized on case-sensitive file systems.`, MessageTemplate: "Incorrect library.properties file name case: {{.}}. See: https://arduino.github.io/arduino-cli/latest/library-specification/#library-metadata", DisableModes: nil, EnableModes: []rulemode.Type{rulemode.Default}, @@ -303,7 +303,7 @@ var configurations = []Type{ Category: "library.properties", Subcategory: "general", ID: "LP004", - Brief: "redundant", + Brief: "redundant library.properties", 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, @@ -319,8 +319,8 @@ var configurations = []Type{ Category: "library.properties", Subcategory: "general", ID: "LP005", - Brief: "invalid format", - Description: "", + Brief: "library.properties format", + Description: "See: https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format", MessageTemplate: "library.properties has an invalid format: {{.}}", DisableModes: nil, EnableModes: []rulemode.Type{rulemode.Default}, @@ -335,7 +335,7 @@ var configurations = []Type{ Category: "library.properties", Subcategory: "general", ID: "LP006", - Brief: "misspelled field", + Brief: "misspelled library.properties 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, @@ -351,9 +351,9 @@ var configurations = []Type{ Category: "library.properties", Subcategory: "name field", ID: "LP007", - Brief: "missing name field", + Brief: "missing name", Description: "", - MessageTemplate: "missing name field in library.properties", + MessageTemplate: "Missing name field in library.properties. See: https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format", DisableModes: nil, EnableModes: []rulemode.Type{rulemode.Default}, InfoModes: nil, @@ -401,7 +401,7 @@ var configurations = []Type{ ID: "LP010", Brief: "name > recommended length", Description: "", - MessageTemplate: "library.properties name value {{.}} is longer than recommended max length.", + MessageTemplate: "library.properties name value {{.}} is longer than the recommended length of 16 characters.", DisableModes: nil, EnableModes: []rulemode.Type{rulemode.Default}, InfoModes: nil, @@ -415,9 +415,9 @@ var configurations = []Type{ Category: "library.properties", Subcategory: "name field", ID: "LP011", - Brief: "disallowed characters", + Brief: "prohibited character in name", Description: "", - MessageTemplate: "disallowed characters in library.properties name value: {{.}}. See: https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format", + MessageTemplate: "Prohibited character(s) in library.properties name value: {{.}}. See: https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format", DisableModes: nil, EnableModes: []rulemode.Type{rulemode.Default}, InfoModes: nil, @@ -431,8 +431,8 @@ var configurations = []Type{ Category: "library.properties", Subcategory: "name field", ID: "LP012", - Brief: `starts with "Arduino"`, - Description: `Case insensitive. 3rd party libraries added to Library Manager index prior to the enactment of this rule are "grandfathered".`, + Brief: `name starts with "Arduino"`, + 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.`, MessageTemplate: `Library name {{.}} starts with "Arduino". These names are reserved for official libraries.`, DisableModes: []rulemode.Type{rulemode.Official}, EnableModes: []rulemode.Type{rulemode.Default}, @@ -447,7 +447,7 @@ var configurations = []Type{ Category: "library.properties", Subcategory: "name field", ID: "LP013", - Brief: "missing official prefix", + Brief: "name missing official prefix", Description: "", MessageTemplate: `Library name {{.}} is missing the "Arduino_" prefix. All new official library names must use this prefix.`, DisableModes: []rulemode.Type{rulemode.Default}, @@ -463,7 +463,7 @@ var configurations = []Type{ Category: "library.properties", Subcategory: "name field", ID: "LP014", - Brief: `contains "Arduino"`, + Brief: `name contains "Arduino"`, Description: "Case insensitive", MessageTemplate: `Library name {{.}} contains "Arduino". This is superfluous.`, DisableModes: []rulemode.Type{rulemode.Official}, @@ -479,7 +479,7 @@ var configurations = []Type{ Category: "library.properties", Subcategory: "name field", ID: "LP015", - Brief: "contains spaces", + Brief: "name 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, @@ -495,7 +495,7 @@ var configurations = []Type{ Category: "library.properties", Subcategory: "name field", ID: "LP016", - Brief: `contains "library"`, + Brief: `name contains "library"`, Description: "Case insensitive", MessageTemplate: `Library name {{.}} contains "library". This is superfluous.`, DisableModes: nil, @@ -513,7 +513,7 @@ var configurations = []Type{ ID: "LP017", 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.", + 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.", DisableModes: []rulemode.Type{rulemode.LibraryManagerIndexed}, EnableModes: []rulemode.Type{rulemode.Default}, InfoModes: nil, @@ -545,7 +545,7 @@ var configurations = []Type{ ID: "LP019", Brief: "missing version field", Description: "", - MessageTemplate: "missing version field in library.properties", + MessageTemplate: "Missing version field in library.properties", DisableModes: nil, EnableModes: []rulemode.Type{rulemode.Default}, InfoModes: nil, @@ -559,7 +559,7 @@ var configurations = []Type{ Category: "library.properties", Subcategory: "version field", ID: "LP020", - Brief: "invalid", + Brief: "invalid version", 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, @@ -575,7 +575,7 @@ var configurations = []Type{ Category: "library.properties", Subcategory: "version field", ID: "LP021", - Brief: "non-semver", + Brief: "non-semver version", Description: "", MessageTemplate: "library.properties version value {{.}} is not compliant with the semver specification. See https://semver.org/", DisableModes: nil, @@ -609,7 +609,7 @@ var configurations = []Type{ ID: "LP023", 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", + MessageTemplate: "Missing author field in library.properties. See https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format", DisableModes: nil, EnableModes: []rulemode.Type{rulemode.Default}, InfoModes: nil, @@ -641,7 +641,7 @@ var configurations = []Type{ ID: "LP025", 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", + MessageTemplate: "Missing maintainer field in library.properties. See https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format", DisableModes: nil, EnableModes: []rulemode.Type{rulemode.Default}, InfoModes: nil, @@ -671,7 +671,7 @@ var configurations = []Type{ Category: "library.properties", Subcategory: "maintainer field", ID: "LP027", - Brief: `starts with "Arduino"`, + Brief: `maintainer starts with "Arduino"`, Description: "Case insensitive.", MessageTemplate: `library.properties maintainer value {{.}} starts with "Arduino". 3rd party libraries are not maintained by Arduino.`, DisableModes: []rulemode.Type{rulemode.Official}, @@ -687,8 +687,8 @@ var configurations = []Type{ Category: "library.properties", Subcategory: "email field", ID: "LP028", - Brief: `"email" field used as alias for "maintainer"`, - Description: "This was in an early draft of the beta 1.5 library specification.", + Brief: `"email" used as alias for "maintainer"`, + Description: "This was only 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: []rulemode.Type{rulemode.Default}, @@ -719,7 +719,7 @@ var configurations = []Type{ Category: "library.properties", Subcategory: "email field", ID: "LP030", - Brief: `starts with "Arduino"`, + Brief: `email starts with "Arduino"`, Description: "Case insensitive.", MessageTemplate: `library.properties email value {{.}} starts with "Arduino". 3rd party libraries are not maintained by Arduino.`, DisableModes: []rulemode.Type{rulemode.Official}, @@ -737,7 +737,7 @@ var configurations = []Type{ ID: "LP031", 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", + MessageTemplate: "Missing sentence field in library.properties. See https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format", DisableModes: nil, EnableModes: []rulemode.Type{rulemode.Default}, InfoModes: nil, @@ -785,7 +785,7 @@ var configurations = []Type{ ID: "LP034", 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", + MessageTemplate: "Missing paragraph field in library.properties. See https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format", DisableModes: nil, EnableModes: []rulemode.Type{rulemode.Default}, InfoModes: nil, @@ -833,7 +833,7 @@ var configurations = []Type{ ID: "LP037", 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", + MessageTemplate: "Missing category field in library.properties. See https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format", DisableModes: nil, EnableModes: []rulemode.Type{rulemode.Default}, InfoModes: nil, @@ -849,7 +849,7 @@ var configurations = []Type{ ID: "LP038", 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", + MessageTemplate: "Invalid category field value {{.}} in library.properties. See https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format", DisableModes: nil, EnableModes: []rulemode.Type{rulemode.Default}, InfoModes: nil, @@ -865,7 +865,7 @@ var configurations = []Type{ ID: "LP039", 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`, + 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`, DisableModes: nil, EnableModes: []rulemode.Type{rulemode.Default}, InfoModes: nil, @@ -881,7 +881,7 @@ var configurations = []Type{ ID: "LP040", 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", + MessageTemplate: "Missing url field in library.properties. See https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format", DisableModes: nil, EnableModes: []rulemode.Type{rulemode.Default}, InfoModes: nil, @@ -911,7 +911,7 @@ var configurations = []Type{ Category: "library.properties", Subcategory: "url field", ID: "LP042", - Brief: "Dead URL", + Brief: "dead URL", Description: "", MessageTemplate: "Unable to load the library.properties url field: {{.}}", DisableModes: nil, @@ -929,7 +929,7 @@ var configurations = []Type{ ID: "LP043", 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", + MessageTemplate: "Missing architectures field in library.properties. See https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format", DisableModes: nil, EnableModes: []rulemode.Type{rulemode.Default}, InfoModes: nil, @@ -975,7 +975,7 @@ var configurations = []Type{ Category: "library.properties", Subcategory: "architectures field", ID: "LP046", - Brief: "miscased architecture", + Brief: "architecture case", Description: "", 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", DisableModes: nil, @@ -991,9 +991,9 @@ var configurations = []Type{ Category: "library.properties", Subcategory: "depends field", ID: "LP047", - Brief: "disallowed characters", + Brief: "prohibited character in depends", Description: "", - MessageTemplate: "disallowed characters in library.properties depends field {{.}}. See: https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format", + MessageTemplate: "Prohibited character(s) in library.properties depends field {{.}}. See: https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format", DisableModes: nil, EnableModes: []rulemode.Type{rulemode.Default}, InfoModes: nil, @@ -1007,8 +1007,8 @@ var configurations = []Type{ Category: "library.properties", Subcategory: "depends field", ID: "LP048", - Brief: "Dependency not in index", - Description: "", + Brief: "depends not in index", + Description: "This field should be used to define the dependencies available from Library Manager. Library names are case-sensitive.", MessageTemplate: "library.properties depends field item(s) {{.}} not found in the Library Manager index.", DisableModes: nil, EnableModes: []rulemode.Type{rulemode.Default}, @@ -1023,9 +1023,9 @@ var configurations = []Type{ Category: "library.properties", Subcategory: "dot_a_linkage field", ID: "LP049", - Brief: "invalid value", + Brief: "invalid dot_a_linkage 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", + 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: []rulemode.Type{rulemode.Default}, InfoModes: nil, @@ -1039,7 +1039,7 @@ var configurations = []Type{ Category: "library.properties", Subcategory: "dot_a_linkage field", ID: "LP050", - Brief: `"true" with "1.5" library format`, + Brief: `dot_a_linkage=true with "1.0" 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, @@ -1071,7 +1071,7 @@ var configurations = []Type{ Category: "library.properties", Subcategory: "includes field", ID: "LP052", - Brief: "includes file not in library", + Brief: "includes 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, @@ -1087,9 +1087,9 @@ var configurations = []Type{ Category: "library.properties", Subcategory: "precompiled field", ID: "LP053", - Brief: "invalid value", + Brief: "invalid precompiled value", Description: "", - MessageTemplate: "invalid precompiled field value {{.}} in library.properties. See https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format", + MessageTemplate: "Invalid precompiled field value {{.}} in library.properties. See https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format", DisableModes: nil, EnableModes: []rulemode.Type{rulemode.Default}, InfoModes: nil, @@ -1103,7 +1103,7 @@ var configurations = []Type{ Category: "library.properties", Subcategory: "precompiled field", ID: "LP054", - Brief: "precompiled with flat layout", + Brief: "precompiled with \"1.0\" format", 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, @@ -1135,9 +1135,9 @@ var configurations = []Type{ Category: "code", Subcategory: "miscellaneous", ID: "LC001", - Brief: "incorrect Arduino.h case", - Description: "This causes compilation failure on filename case-sensitive OS (e.g., Linux).", - MessageTemplate: "Incorrect of Arduino.h filename case detected in #include directive: {{.}}", + Brief: "Arduino.h case", + Description: "This causes compilation failure on case-sensitive file systems.", + MessageTemplate: "Incorrect Arduino.h filename case in #include directive: {{.}}", DisableModes: nil, EnableModes: []rulemode.Type{rulemode.Default}, InfoModes: nil, @@ -1231,7 +1231,7 @@ var configurations = []Type{ Category: "documentation", Subcategory: "examples", ID: "LD006", - Brief: "incorrect examples folder name case", + Brief: "examples folder name case", Description: "", MessageTemplate: "Incorrect examples folder name case: {{.}}. See: https://arduino.github.io/arduino-cli/latest/library-specification/#library-examples", DisableModes: nil, @@ -1263,9 +1263,9 @@ var configurations = []Type{ Category: "structure", Subcategory: "file name", ID: "SS002", - Brief: "disallowed characters in file name", + Brief: "prohibited character in filename", Description: "", - MessageTemplate: "Prohibited characters in file name(s): {{.}}. See: https://arduino.github.io/arduino-cli/latest/sketch-specification/#sketch-root-folder", + MessageTemplate: "Prohibited character(s) in file name(s): {{.}}. See: https://arduino.github.io/arduino-cli/latest/sketch-specification/#sketch-root-folder", DisableModes: nil, EnableModes: []rulemode.Type{rulemode.Default}, InfoModes: nil, @@ -1311,9 +1311,9 @@ var configurations = []Type{ Category: "structure", Subcategory: "miscellaneous", ID: "SS005", - Brief: "incorrect src folder case", + Brief: "src folder case", Description: "", - 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", + 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", DisableModes: nil, EnableModes: []rulemode.Type{rulemode.Default}, InfoModes: nil, @@ -1327,9 +1327,9 @@ var configurations = []Type{ Category: "code", Subcategory: "miscellaneous", ID: "SC001", - Brief: "incorrect Arduino.h case", - Description: "This causes compilation failure on filename case-sensitive OS (e.g., Linux).", - MessageTemplate: "Incorrect of Arduino.h filename case detected in #include directive: {{.}}", + Brief: "Arduino.h case", + Description: "This causes compilation failure on filename case-sensitive file systems.", + MessageTemplate: "Incorrect Arduino.h filename case in #include directive: {{.}}", DisableModes: nil, EnableModes: []rulemode.Type{rulemode.Default}, InfoModes: nil, @@ -1375,7 +1375,7 @@ var configurations = []Type{ Category: "sketch.json", Subcategory: "general", ID: "SM001", - Brief: "invalid sketch.json JSON format", + Brief: "sketch.json JSON format", Description: "", MessageTemplate: "sketch.json is not a valid JSON document. See: https://arduino.github.io/arduino-cli/latest/sketch-specification/#metadata", DisableModes: nil, @@ -1391,7 +1391,7 @@ var configurations = []Type{ Category: "sketch.json", Subcategory: "general", ID: "SM002", - Brief: "invalid sketch.json data format", + Brief: "sketch.json data format", Description: "", MessageTemplate: "sketch.json has an invalid data format: {{.}}. See: https://arduino.github.io/arduino-cli/latest/sketch-specification/#metadata", DisableModes: nil, @@ -1409,7 +1409,7 @@ var configurations = []Type{ ID: "PD001", 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", + 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", DisableModes: nil, EnableModes: []rulemode.Type{rulemode.Default}, InfoModes: nil, @@ -1439,7 +1439,7 @@ var configurations = []Type{ Category: "configuration files", Subcategory: "boards.txt", ID: "PF001", - Brief: "missing", + Brief: "boards.txt missing", Description: "", MessageTemplate: "Required boards.txt is missing. Expected at: {{.}}", DisableModes: nil, @@ -1455,7 +1455,7 @@ var configurations = []Type{ Category: "configuration files", Subcategory: "boards.txt", ID: "PF002", - Brief: "Invalid boards.txt", + Brief: "invalid boards.txt", Description: "", MessageTemplate: "boards.txt has an invalid format: {{.}}", DisableModes: nil, @@ -1471,9 +1471,9 @@ var configurations = []Type{ Category: "code", Subcategory: "miscellaneous", ID: "PC001", - Brief: "incorrect Arduino.h case", - Description: "This causes compilation failure on filename case-sensitive OS (e.g., Linux).", - MessageTemplate: "Incorrect of Arduino.h filename case detected in #include directive: {{.}}", + Brief: "Arduino.h case", + Description: "This causes compilation failure on filename case-sensitive file systems.", + MessageTemplate: "Incorrect Arduino.h filename case in #include directive: {{.}}", DisableModes: nil, EnableModes: []rulemode.Type{rulemode.Default}, InfoModes: nil, @@ -1487,7 +1487,7 @@ var configurations = []Type{ Category: "data", Subcategory: "general", ID: "ID001", - Brief: "Invalid JSON format", + Brief: "JSON format", Description: "", MessageTemplate: "Invalid JSON format.", DisableModes: nil, @@ -1503,7 +1503,7 @@ var configurations = []Type{ Category: "data", Subcategory: "general", ID: "ID002", - Brief: "Invalid format", + Brief: "data format", Description: "", MessageTemplate: "Invalid package index format: {{.}}", DisableModes: nil,