package
0.0.0-20240813060107-005fe8a3629a
Repository: https://github.com/arduino/arduino-lint.git
Documentation: pkg.go.dev
# Functions
BoardsTxtBoardIDBuildBoardLTMinLength checks if any of the board build.board values are less than the minimum length.
BoardsTxtBoardIDBuildBoardMissing checks if any of the boards are missing build.board properties.
BoardsTxtBoardIDBuildCoreLTMinLength checks if any of the board build.core values are less than the minimum length.
BoardsTxtBoardIDBuildCoreMissing checks if any of the boards are missing build.core properties.
BoardsTxtBoardIDHideInvalid checks if any of the board hide values have invalid format.
BoardsTxtBoardIDNameLTMinLength checks if any of the board names are less than the minimum length.
BoardsTxtBoardIDNameMissing checks if any of the boards are missing name properties.
BoardsTxtBoardIDPidNInvalid checks if any of the board pid.n values have an invalid format.
BoardsTxtBoardIDSerialDisableDTRInvalid checks if any of the board serial.disableDTR values are invalid.
BoardsTxtBoardIDSerialDisableRTSInvalid checks if any of the board serial.disableRTS values are invalid.
BoardsTxtBoardIDUploadMaximumDataSizeInvalid checks if any of the board upload.maximum_data_size values have an invalid format.
BoardsTxtBoardIDUploadMaximumDataSizeMissing checks if any of the boards are missing upload.maximum_data_size properties.
BoardsTxtBoardIDUploadMaximumSizeInvalid checks if any of the board upload.maximum_size values have an invalid format.
BoardsTxtBoardIDUploadMaximumSizeMissing checks if any of the boards are missing upload.maximum_size properties.
BoardsTxtBoardIDUploadToolLTMinLength checks if any of the board upload.tool values are less than the minimum length.
BoardsTxtBoardIDUploadToolMissing checks if any of the boards are missing upload.tool properties.
BoardsTxtBoardIDUploadUse1200bpsTouchInvalid checks if any of the board upload.use_1200bps_touch values are invalid.
BoardsTxtBoardIDUploadWaitForUploadPortInvalid checks if any of the board upload.wait_for_upload_port values are invalid.
BoardsTxtBoardIDVidNInvalid checks if any of the board vid.n values have an invalid format.
BoardsTxtFormat checks for invalid boards.txt format.
BoardsTxtMenuMenuIDLTMinLength checks if any of the menu titles are less than the minimum length.
BoardsTxtMissing checks whether the platform contains a boards.txt.
BoardsTxtUserExtraFlagsUsage checks if the user's compiler.<pattern type>.extra_flags properties are used in boards.txt.
IncorrectArduinoDotHFileNameCase checks for incorrect file name case of Arduino.h in #include directives.
IncorrectExamplesFolderNameCase checks for incorrect `examples` folder name case.
IncorrectExtrasFolderNameCase checks for incorrect `extras` folder name case.
IncorrectLibraryPropertiesFileNameCase checks for incorrect library.properties file name case.
IncorrectLibrarySrcFolderNameCase checks for incorrect case of src subfolder name in recursive format libraries.
IncorrectSketchSrcFolderNameCase checks for incorrect case of src subfolder name in recursive format libraries.
LibraryContainsSymlinks checks if the library folder contains symbolic links.
LibraryFolderNameGTMaxLength checks if the library folder name exceeds the maximum length.
LibraryHasDotDevelopmentFile checks whether the library contains a .development flag file.
LibraryHasExe checks whether the library contains files with .exe extension.
LibraryHasStraySketches checks for sketches outside the `examples` and `extras` folders.
LibraryHasSubmodule checks whether the library contains a Git submodule.
LibraryInvalid checks whether the provided path is a valid library.
LibraryPropertiesArchitecturesFieldLTMinLength checks if the library.properties "architectures" value is less than the minimum length.
LibraryPropertiesArchitecturesFieldMissing checks for missing library.properties "architectures" field.
LibraryPropertiesArchitecturesFieldSoloAlias checks whether an alias architecture name is present, but not its true Arduino architecture name.
LibraryPropertiesArchitecturesFieldValueCase checks for incorrect case of common architectures.
LibraryPropertiesAuthorFieldLTMinLength checks if the library.properties "author" value is less than the minimum length.
LibraryPropertiesAuthorFieldMissing checks for missing library.properties "author" field.
LibraryPropertiesCategoryFieldInvalid checks for invalid category in the library.properties "category" field.
LibraryPropertiesCategoryFieldMissing checks for missing library.properties "category" field.
LibraryPropertiesCategoryFieldUncategorized checks whether the library.properties "category" value is "Uncategorized".
LibraryPropertiesDependsFieldConstraintInvalid checks whether the syntax of the version constraints in the library.properties `depends` field is valid.
LibraryPropertiesDependsFieldInvalidFormat checks for the library.properties "depends" field having an invalid format.
LibraryPropertiesDependsFieldNotInIndex checks whether the libraries listed in the library.properties `depends` field are in the Library Manager index.
LibraryPropertiesDotALinkageFieldInvalid checks for invalid value in the library.properties "dot_a_linkage" field.
LibraryPropertiesDotALinkageFieldTrueWithFlatLayout checks whether a library using the "dot_a_linkage" feature has the required recursive layout type.
LibraryPropertiesEmailFieldAsMaintainerAlias checks whether the library.properties "email" field is being used as an alias for the "maintainer" field.
LibraryPropertiesEmailFieldLTMinLength checks if the library.properties "email" value is less than the minimum length.
LibraryPropertiesEmailFieldStartsWithArduino checks if the library.properties "email" value starts with "Arduino".
LibraryPropertiesFormat checks for invalid library.properties format.
LibraryPropertiesIncludesFieldItemNotFound checks whether the header files specified in the library.properties `includes` field are in the library.
LibraryPropertiesIncludesFieldLTMinLength checks if the library.properties "includes" value is less than the minimum length.
LibraryPropertiesLdflagsFieldLTMinLength checks if the library.properties "ldflags" value is less than the minimum length.
LibraryPropertiesMaintainerFieldContainsArduino checks if the library.properties "maintainer" value contains "Arduino".
LibraryPropertiesMaintainerFieldLTMinLength checks if the library.properties "maintainer" value is less than the minimum length.
LibraryPropertiesMaintainerFieldMissing checks for missing library.properties "maintainer" field.
LibraryPropertiesMaintainerFieldStartsWithArduino checks if the library.properties "maintainer" value starts with "Arduino".
LibraryPropertiesMissing checks for presence of library.properties.
LibraryPropertiesMisspelledOptionalField checks if library.properties contains common misspellings of optional fields.
LibraryPropertiesNameFieldContainsArduino checks if the library.properties "name" value contains "Arduino".
LibraryPropertiesNameFieldContainsLibrary checks if the library.properties "name" value contains "library".
LibraryPropertiesNameFieldDisallowedCharacters checks for disallowed characters in the library.properties "name" field.
LibraryPropertiesNameFieldDuplicate checks whether there is an existing entry in the Library Manager index using the library.properties `name` value.
LibraryPropertiesNameFieldGTMaxLength checks if the library.properties "name" value is greater than the maximum length.
LibraryPropertiesNameFieldGTRecommendedLength checks if the library.properties "name" value is greater than the recommended length.
LibraryPropertiesNameFieldHasSpaces checks if the library.properties "name" value contains spaces.
LibraryPropertiesNameFieldHeaderMismatch checks whether the filename of one of the library's header files matches the Library Manager installation folder name.
LibraryPropertiesNameFieldLTMinLength checks if the library.properties "name" value is less than the minimum length.
LibraryPropertiesNameFieldMissing checks for missing library.properties "name" field.
LibraryPropertiesNameFieldMissingOfficialPrefix checks whether the library.properties `name` value uses the prefix required of all new official Arduino libraries.
LibraryPropertiesNameFieldNotInIndex checks whether there is no existing entry in the Library Manager index using the library.properties `name` value.
LibraryPropertiesNameFieldStartsWithArduino checks if the library.properties "name" value starts with "Arduino".
LibraryPropertiesParagraphFieldMissing checks for missing library.properties "paragraph" field.
LibraryPropertiesParagraphFieldRepeatsSentence checks whether the library.properties `paragraph` value repeats the `sentence` value.
LibraryPropertiesParagraphFieldSpellCheck checks for commonly misspelled words in the library.properties `paragraph` field value.
LibraryPropertiesPrecompiledFieldEnabledWithFlatLayout checks whether a precompiled library has the required recursive layout type.
LibraryPropertiesPrecompiledFieldInvalid checks for invalid value in the library.properties "precompiled" field.
LibraryPropertiesSentenceFieldLTMinLength checks if the library.properties "sentence" value is less than the minimum length.
LibraryPropertiesSentenceFieldMissing checks for missing library.properties "sentence" field.
LibraryPropertiesSentenceFieldSpellCheck checks for commonly misspelled words in the library.properties `sentence` field value.
LibraryPropertiesURLFieldDeadLink checks whether the URL in the library.properties `url` field can be loaded.
LibraryPropertiesURLFieldInvalid checks whether the library.properties "url" value has a valid URL format.
LibraryPropertiesURLFieldLTMinLength checks if the library.properties "url" value is less than the minimum length.
LibraryPropertiesURLFieldMissing checks for missing library.properties "url" field.
LibraryPropertiesVersionFieldBehindTag checks whether a release tag was made without first bumping the library.properties version value.
LibraryPropertiesVersionFieldMissing checks for missing library.properties "version" field.
LibraryPropertiesVersionFieldNonRelaxedSemver checks whether the library.properties "version" value is "relaxed semver" compliant.
LibraryPropertiesVersionFieldNonSemver checks whether the library.properties "version" value is semver compliant.
MissingExamples checks whether the library is missing examples.
MissingLicenseFile checks if the project has a license file that will be recognized by GitHub.
MissingReadme checks if the project has a readme that will be recognized by GitHub.
MisspelledExamplesFolderName checks for incorrectly spelled `examples` folder name.
MisspelledExtrasFolderName checks for incorrectly spelled `extras` folder name.
MisspelledLibraryPropertiesFileName checks for incorrectly spelled library.properties file name.
PackageIndexAdditionalProperties checks for additional properties in the package index root.
PackageIndexFilenameInvalid checks whether the package index's filename is valid for 3rd party projects.
PackageIndexFormat checks for invalid package index data format.
PackageIndexJSONFormat checks whether the package index file is a valid JSON document.
PackageIndexMissing checks whether a file resembling a package index was found in the specified project folder.
PackageIndexOfficialFilenameInvalid checks whether the package index's filename is valid for official projects.
PackageIndexPackagesAdditionalProperties checks for additional properties in packages[].
PackageIndexPackagesEmailIncorrectType checks for incorrect type of the packages[].email property.
PackageIndexPackagesEmailMissing checks for missing packages[].email property.
PackageIndexPackagesHelpAdditionalProperties checks for additional properties in packages[].help.
PackageIndexPackagesHelpIncorrectType checks for incorrect type of the packages[].help property.
PackageIndexPackagesHelpOnlineDeadLink checks for dead links in packages[].help.online.
PackageIndexPackagesHelpOnlineIncorrectType checks for incorrect type of the packages[].help.online property.
PackageIndexPackagesHelpOnlineInvalidFormat checks for incorrect format of the packages[].help.online property.
PackageIndexPackagesHelpOnlineMissing checks for missing packages[].help.online property.
PackageIndexPackagesIncorrectType checks for incorrect type of packages[].
PackageIndexPackagesMaintainerIncorrectType checks for incorrect type of the packages[].maintainer property.
PackageIndexPackagesMaintainerLTMinLength checks for packages[].maintainer property less than the minimum length.
PackageIndexPackagesMaintainerMissing checks for missing packages[].maintainer property.
PackageIndexPackagesMaintainerStartsWithArduino checks for packages[].maintainer starting with "arduino".
PackageIndexPackagesMissing checks for missing packages property.
PackageIndexPackagesNameIncorrectType checks for incorrect type of the packages[].name property.
PackageIndexPackagesNameIsArduino checks for packages[].name being "arduino".
PackageIndexPackagesNameLTMinLength checks for packages[].name property less than the minimum length.
PackageIndexPackagesNameMissing checks for missing packages[].name property.
PackageIndexPackagesPlatformsAdditionalProperties checks for additional properties in packages[].platforms[].
PackageIndexPackagesPlatformsArchitectureIncorrectType checks for incorrect type of the packages[].platforms[].architecture property.
PackageIndexPackagesPlatformsArchitectureLTMinLength checks for packages[].platforms[].architecture property less than the minimum length.
PackageIndexPackagesPlatformsArchitectureMissing checks for missing packages[].platforms[].architecture property.
PackageIndexPackagesPlatformsArchiveFileNameIncorrectType checks for incorrect type of the packages[].platforms[].archiveFileName property.
PackageIndexPackagesPlatformsArchiveFileNameInvalid checks for invalid format of packages[].platforms[].archiveFileName property.
PackageIndexPackagesPlatformsArchiveFileNameLTMinLength checks for packages[].platforms[].archiveFileName property less than the minimum length.
PackageIndexPackagesPlatformsArchiveFileNameMissing checks for missing packages[].platforms[].archiveFileName property.
PackageIndexPackagesPlatformsBoardsAdditionalProperties checks for additional properties in packages[].platforms[].boards[].
PackageIndexPackagesPlatformsBoardsIncorrectType checks for incorrect type of the packages[].platforms[].boards property.
PackageIndexPackagesPlatformsBoardsMissing checks for missing packages[].platforms[].boards[] property.
PackageIndexPackagesPlatformsBoardsNameIncorrectType checks for incorrect type of the packages[].platforms[].boards[].name property.
PackageIndexPackagesPlatformsBoardsNameLTMinLength checks for packages[].platforms[].board[].name property less than the minimum length.
PackageIndexPackagesPlatformsBoardsNameMissing checks for missing packages[].platforms[].boards[].name property.
PackageIndexPackagesPlatformsCategoryIncorrectType checks for incorrect type of the packages[].platforms[].category property.
PackageIndexPackagesPlatformsCategoryMissing checks for missing packages[].platforms[].category property.
PackageIndexPackagesPlatformsCategoryThirdPartyInvalid checks for invalid value of the packages[].platforms[].category property for 3rd party platforms.
PackageIndexPackagesPlatformsChecksumDiscouragedAlgorithm checks for use of discouraged hash algorithm in packages[].platforms[].checksum property.
PackageIndexPackagesPlatformsChecksumIncorrectType checks for incorrect type of the packages[].platforms[].checksum property.
PackageIndexPackagesPlatformsChecksumInvalid checks for invalid format of packages[].platforms[].checksum property.
PackageIndexPackagesPlatformsChecksumMissing checks for missing packages[].platforms[].checksum property.
PackageIndexPackagesPlatformsDeprecatedIncorrectType checks for incorrect type of the packages[].platforms[].deprecated property.
PackageIndexPackagesPlatformsDiscoveryDependenciesAdditionalProperties checks for additional properties in packages[].platforms[].discoveryDependencies[].
PackageIndexPackagesPlatformsDiscoveryDependenciesIncorrectType checks for incorrect type of the packages[].platforms[].discoveryDependencies property.
PackageIndexPackagesPlatformsDiscoveryDependenciesNameIncorrectType checks for incorrect type of the packages[].platforms[].discoveryDependencies[].name property.
PackageIndexPackagesPlatformsDiscoveryDependenciesNameLTMinLength checks for packages[].platforms[].discoveryDependencies[].name property less than the minimum length.
PackageIndexPackagesPlatformsDiscoveryDependenciesNameMissing checks for missing packages[].platforms[].discoveryDependencies[].name property.
PackageIndexPackagesPlatformsDiscoveryDependenciesPackagerIncorrectType checks for incorrect type of the packages[].platforms[].discoveryDependencies[].packager property.
PackageIndexPackagesPlatformsDiscoveryDependenciesPackagerLTMinLength checks for packages[].platforms[].discoveryDependencies[].packager property less than the minimum length.
PackageIndexPackagesPlatformsDiscoveryDependenciesPackagerMissing checks for missing packages[].platforms[].discoveryDependencies[].packager property.
PackageIndexPackagesPlatformsHelpAdditionalProperties checks for additional properties in packages[].help.
PackageIndexPackagesPlatformsHelpIncorrectType checks for incorrect type of the packages[].platforms[].help property.
PackageIndexPackagesPlatformsHelpMissing checks for missing packages[].platforms[].help property.
PackageIndexPackagesPlatformsHelpOnlineDeadLink checks for dead links in packages[].platforms[].help.online.
PackageIndexPackagesPlatformsHelpOnlineIncorrectType checks for incorrect type of the packages[].platforms[].help.online property.
PackageIndexPackagesPlatformsHelpOnlineInvalidFormat checks for incorrect format of the packages[].platforms[].help.online property.
PackageIndexPackagesPlatformsHelpOnlineMissing checks for missing packages[].platforms[].help.online property.
PackageIndexPackagesPlatformsIncorrectType checks for incorrect type of packages[].platforms.
PackageIndexPackagesPlatformsMissing checks for missing packages[].platforms[] property.
PackageIndexPackagesPlatformsMonitorDependenciesAdditionalProperties checks for additional properties in packages[].platforms[].monitorDependencies[].
PackageIndexPackagesPlatformsMonitorDependenciesIncorrectType checks for incorrect type of the packages[].platforms[].monitorDependencies property.
PackageIndexPackagesPlatformsMonitorDependenciesNameIncorrectType checks for incorrect type of the packages[].platforms[].monitorDependencies[].name property.
PackageIndexPackagesPlatformsMonitorDependenciesNameLTMinLength checks for packages[].platforms[].monitorDependencies[].name property less than the minimum length.
PackageIndexPackagesPlatformsMonitorDependenciesNameMissing checks for missing packages[].platforms[].monitorDependencies[].name property.
PackageIndexPackagesPlatformsMonitorDependenciesPackagerIncorrectType checks for incorrect type of the packages[].platforms[].monitorDependencies[].packager property.
PackageIndexPackagesPlatformsMonitorDependenciesPackagerLTMinLength checks for packages[].platforms[].monitorDependencies[].packager property less than the minimum length.
PackageIndexPackagesPlatformsMonitorDependenciesPackagerMissing checks for missing packages[].platforms[].monitorDependencies[].packager property.
PackageIndexPackagesPlatformsNameIncorrectType checks for incorrect type of the packages[].platforms[].name property.
PackageIndexPackagesPlatformsNameLTMinLength checks for packages[].platforms[].name property less than the minimum length.
PackageIndexPackagesPlatformsNameMissing checks for missing packages[].platforms[].name property.
PackageIndexPackagesPlatformsSizeIncorrectType checks for incorrect type of the packages[].platforms[].size property.
PackageIndexPackagesPlatformsSizeInvalid checks for invalid format of packages[].platforms[].size property.
PackageIndexPackagesPlatformsSizeMissing checks for missing packages[].platforms[].size property.
PackageIndexPackagesPlatformsToolsDependenciesAdditionalProperties checks for additional properties in packages[].platforms[].toolsDependencies[].
PackageIndexPackagesPlatformsToolsDependenciesIncorrectType checks for incorrect type of the packages[].platforms[].toolsDependencies property.
PackageIndexPackagesPlatformsToolsDependenciesMissing checks for missing packages[].platforms[].toolsDependencies[] property.
PackageIndexPackagesPlatformsToolsDependenciesNameIncorrectType checks for incorrect type of the packages[].platforms[].toolsDependencies[].name property.
PackageIndexPackagesPlatformsToolsDependenciesNameLTMinLength checks for packages[].platforms[].toolsDependencies[].name property less than the minimum length.
PackageIndexPackagesPlatformsToolsDependenciesNameMissing checks for missing packages[].platforms[].toolsDependencies[].name property.
PackageIndexPackagesPlatformsToolsDependenciesPackagerIncorrectType checks for incorrect type of the packages[].platforms[].toolsDependencies[].packager property.
PackageIndexPackagesPlatformsToolsDependenciesPackagerLTMinLength checks for packages[].platforms[].toolsDependencies[].packager property less than the minimum length.
PackageIndexPackagesPlatformsToolsDependenciesPackagerMissing checks for missing packages[].platforms[].toolsDependencies[].packager property.
PackageIndexPackagesPlatformsToolsDependenciesVersionIncorrectType checks for incorrect type of the packages[].platforms[].toolsDependencies[].packager property.
PackageIndexPackagesPlatformsToolsDependenciesVersionMissing checks for missing packages[].platforms[].toolsDependencies[].version property.
PackageIndexPackagesPlatformsToolsDependenciesVersionNonRelaxedSemver checks whether the packages[].platforms[].toolsDependencies[].version property is "relaxed semver" compliant.
PackageIndexPackagesPlatformsToolsDependenciesVersionNonSemver checks whether the packages[].platforms[].toolsDependencies[].version property is semver compliant.
PackageIndexPackagesPlatformsURLDeadLink checks for dead links in packages[].platforms[].url.
PackageIndexPackagesPlatformsURLIncorrectType checks for incorrect type of the packages[].platforms[].url property.
PackageIndexPackagesPlatformsURLInvalidFormat checks for incorrect format of the packages[].platforms[].url property.
PackageIndexPackagesPlatformsURLMissing checks for missing packages[].platforms[].url property.
PackageIndexPackagesPlatformsVersionIncorrectType checks for incorrect type of the packages[].platforms[].version property.
PackageIndexPackagesPlatformsVersionMissing checks for missing packages[].platforms[].version property.
PackageIndexPackagesPlatformsVersionNonRelaxedSemver checks whether the packages[].platforms[].version property is "relaxed semver" compliant.
PackageIndexPackagesPlatformsVersionNonSemver checks whether the packages[].platforms[].version property is semver compliant.
PackageIndexPackagesToolsAdditionalProperties checks for additional properties in packages[].tools[].
PackageIndexPackagesToolsIncorrectType checks for incorrect type of packages[].tools.
PackageIndexPackagesToolsMissing checks for missing packages[].tools property.
PackageIndexPackagesToolsNameIncorrectType checks for incorrect type of the packages[].tools[].name property.
PackageIndexPackagesToolsNameLTMinLength checks for packages[].tools[].name property less than the minimum length.
PackageIndexPackagesToolsNameMissing checks for missing packages[].tools[].name property.
PackageIndexPackagesToolsSystemsAdditionalProperties checks for additional properties in packages[].tools[].systems[].
PackageIndexPackagesToolsSystemsArchiveFileNameIncorrectType checks for incorrect type of the packages[].tools[].systems[].archiveFileName property.
PackageIndexPackagesToolsSystemsArchiveFileNameInvalid checks for invalid format of packages[].tools[].systems[].archiveFileName property.
PackageIndexPackagesToolsSystemsArchiveFileNameLTMinLength checks for packages[].tools[].systems[].archiveFileName property less than the minimum length.
PackageIndexPackagesToolsSystemsArchiveFileNameMissing checks for missing packages[].tools[].systems[].archiveFileName property.
PackageIndexPackagesToolsSystemsChecksumDiscouragedAlgorithm checks for use of discouraged hash algorithm in packages[].tools[].systems[].checksum property.
PackageIndexPackagesToolsSystemsChecksumIncorrectType checks for incorrect type of the packages[].tools[].systems[].checksum property.
PackageIndexPackagesToolsSystemsChecksumInvalid checks for invalid format of packages[].tools[].systems[].checksum property.
PackageIndexPackagesToolsSystemsChecksumMissing checks for missing packages[].tools[].systems[].checksum property.
PackageIndexPackagesToolsSystemsHostIncorrectType checks for incorrect type of the packages[].tools[].systems[].host property.
PackageIndexPackagesToolsSystemsHostInvalid checks for invalid format of whether the packages[].tools[].systems[].host property.
PackageIndexPackagesToolsSystemsHostMissing checks for missing packages[].tools[].systems[].host property.
PackageIndexPackagesToolsSystemsIncorrectType checks for incorrect type of the packages[].tools[].systems property.
PackageIndexPackagesToolsSystemsMissing checks for missing packages[].tools[].systems[] property.
PackageIndexPackagesToolsSystemsSizeIncorrectType checks for incorrect type of the packages[].tools[].systems[].size property.
PackageIndexPackagesToolsSystemsSizeInvalid checks for invalid format of packages[].tools[].systems[].size property.
PackageIndexPackagesToolsSystemsSizeMissing checks for missing packages[].tools[].systems[].size property.
PackageIndexPackagesToolsSystemsURLDeadLink checks for dead links in packages[].tools[].systems[].url.
PackageIndexPackagesToolsSystemsURLIncorrectType checks for incorrect type of the packages[].tools[].systems[].url property.
PackageIndexPackagesToolsSystemsURLInvalidFormat checks for incorrect format of the packages[].tools[].systems[].url property.
PackageIndexPackagesToolsSystemsURLMissing checks for missing packages[].tools[].systems[].url property.
PackageIndexPackagesToolsVersionIncorrectType checks for incorrect type of the packages[].tools[].version property.
PackageIndexPackagesToolsVersionMissing checks for missing packages[].tools[].version property.
PackageIndexPackagesToolsVersionNonRelaxedSemver checks whether the packages[].tools[].version property is "relaxed semver" compliant.
PackageIndexPackagesToolsVersionNonSemver checks whether the packages[].tools[].version property is semver compliant.
PackageIndexPackagesWebsiteURLDeadLink checks for dead links in packages[].websiteURL.
PackageIndexPackagesWebsiteURLIncorrectType checks for incorrect type of the packages[].websiteURL property.
PackageIndexPackagesWebsiteURLInvalidFormat checks for incorrect format of the packages[].websiteURL property.
PackageIndexPackagesWebsiteURLMissing checks for missing packages[].websiteURL property.
PdeSketchExtension checks for use of deprecated .pde sketch file extensions.
PlatformTxtBootloaderParamsQuietMissing checks if any of the tools are missing bootloader.params.quiet properties.
PlatformTxtBootloaderParamsVerboseMissing checks if any of the tools are missing bootloader.params.verbose properties.
PlatformTxtBootloaderPatternMissing checks if any of the tools are missing bootloader.pattern properties.
PlatformTxtCompilerArExtraFlagsMissing checks for missing compiler.ar.extra_flags property in platform.txt.
PlatformTxtCompilerArExtraFlagsNotEmpty checks for non-empty compiler.ar.extra_flags property in platform.txt.
PlatformTxtCompilerCElfExtraFlagsMissing checks for missing compiler.c.elf.extra_flags property in platform.txt.
PlatformTxtCompilerCElfExtraFlagsNotEmpty checks for non-empty compiler.c.elf.extra_flags property in platform.txt.
PlatformTxtCompilerCExtraFlagsMissing checks for missing compiler.c.extra_flags property in platform.txt.
PlatformTxtCompilerCExtraFlagsNotEmpty checks for non-empty compiler.c.extra_flags property in platform.txt.
PlatformTxtCompilerCppExtraFlagsMissing checks for missing compiler.cpp.extra_flags property in platform.txt.
PlatformTxtCompilerCppExtraFlagsNotEmpty checks for non-empty compiler.cpp.extra_flags property in platform.txt.
PlatformTxtCompilerOptimizationFlagsDebugMissing checks for missing compiler.optimization_flags.debug property in platform.txt.
PlatformTxtCompilerOptimizationFlagsReleaseMissing checks for missing compiler.optimization_flags.release property in platform.txt.
PlatformTxtCompilerSExtraFlagsMissing checks for missing compiler.S.extra_flags property in platform.txt.
PlatformTxtCompilerSExtraFlagsNotEmpty checks for non-empty compiler.S.extra_flags property in platform.txt.
PlatformTxtCompilerWarningFlagsAllMissing checks for missing compiler.warning_flags.all property in platform.txt.
PlatformTxtCompilerWarningFlagsDefaultMissing checks for missing compiler.warning_flags.default property in platform.txt.
PlatformTxtCompilerWarningFlagsMoreMissing checks for missing compiler.warning_flags.more property in platform.txt.
PlatformTxtCompilerWarningFlagsNoneMissing checks for missing compiler.warning_flags.none property in platform.txt.
PlatformTxtEraseParamsQuietMissing checks if any of the tools are missing erase.params.quiet properties.
PlatformTxtEraseParamsVerboseMissing checks if any of the tools are missing erase.params.verbose properties.
PlatformTxtErasePatternMissing checks if any of the tools are missing erase.pattern properties.
PlatformTxtFormat checks for invalid platform.txt format.
PlatformTxtNameLTMinLength checks if the platform.txt name property value is less than the minimum length.
PlatformTxtNameMissing checks for missing name property in platform.txt.
PlatformTxtPluggableDiscoveryDiscoveryIDPatternMissing checks if any of the manual installation pluggable discoveries are missing pattern properties.
PlatformTxtPluggableDiscoveryRequiredInvalid checks if any of the pluggable discovery tool references have invalid format.
PlatformTxtPluggableMonitorPatternProtocolIDLTMinLength checks if the platform.txt pluggable_monitor.pattern.PROTOCOL_ID property value is less than the minimum length.
PlatformTxtPluggableMonitorRequiredProtocolIDInvalid checks if any of the pluggable monitor tool references have invalid format.
PlatformTxtProgramParamsQuietMissing checks if any of the tools are missing program.params.quiet properties.
PlatformTxtProgramParamsVerboseMissing checks if any of the tools are missing program.params.verbose properties.
PlatformTxtProgramPatternMissing checks if any of the tools are missing program.pattern properties.
PlatformTxtRecipeArPatternExtraFlagsSupport checks if platform.txt recipe.ar.pattern provides support for user extra flags.
PlatformTxtRecipeArPatternLTMinLength checks if the platform.txt recipe.ar.pattern property value is less than the minimum length.
PlatformTxtRecipeArPatternMissing checks for missing recipe.ar.pattern property in platform.txt.
PlatformTxtRecipeCCombinePatternExtraFlagsSupport checks if platform.txt recipe.c.combine.pattern provides support for user extra flags.
PlatformTxtRecipeCCombinePatternLTMinLength checks if the platform.txt recipe.c.combine.pattern property value is less than the minimum length.
PlatformTxtRecipeCCombinePatternMissing checks for missing recipe.c.combine.pattern property in platform.txt.
PlatformTxtRecipeCOPatternExtraFlagsSupport checks if platform.txt recipe.c.o.pattern provides support for user extra flags.
PlatformTxtRecipeCOPatternLTMinLength checks if the platform.txt recipe.c.o.pattern property value is less than the minimum length.
PlatformTxtRecipeCOPatternMissing checks for missing recipe.c.o.pattern property in platform.txt.
PlatformTxtRecipeCppOPatternExtraFlagsSupport checks if platform.txt recipe.cpp.o.pattern provides support for user extra flags.
PlatformTxtRecipeCppOPatternLTMinLength checks if the platform.txt recipe.cpp.o.pattern property value is less than the minimum length.
PlatformTxtRecipeCppOPatternMissing checks for missing recipe.cpp.o.pattern property in platform.txt.
PlatformTxtRecipeOutputSaveFileLTMinLength checks if the platform.txt recipe.output.save_file property value is less than the minimum length.
PlatformTxtRecipeOutputSaveFileMissing checks for missing recipe.output.save_file property in platform.txt.
PlatformTxtRecipeOutputTmpFileLTMinLength checks if the platform.txt recipe.output.tmp_file property value is less than the minimum length.
PlatformTxtRecipeOutputTmpFileMissing checks for missing recipe.output.tmp_file property in platform.txt.
PlatformTxtRecipePreprocMacrosExtraFlagsSupport checks if platform.txt recipe.preproc.macros provides support for user extra flags.
PlatformTxtRecipePreprocMacrosLTMinLength checks if the platform.txt recipe.preproc.macros property value is less than the minimum length.
PlatformTxtRecipeSizePatternLTMinLength checks if the platform.txt recipe.size.pattern property value is less than the minimum length.
PlatformTxtRecipeSizePatternMissing checks for missing recipe.size.pattern property in platform.txt.
PlatformTxtRecipeSizeRegexDataMissing checks for missing recipe.size.regex.data property in platform.txt.
PlatformTxtRecipeSizeRegexMissing checks for missing recipe.size.regex property in platform.txt.
PlatformTxtRecipeSOPatternExtraFlagsSupport checks if platform.txt recipe.S.o.pattern provides support for user extra flags.
PlatformTxtRecipeSOPatternLTMinLength checks if the platform.txt recipe.S.o.pattern property value is less than the minimum length.
PlatformTxtRecipeSOPatternMissing checks for missing recipe.S.o.pattern property in platform.txt.
PlatformTxtUploadFieldFieldNameGTMaxLength checks if any platform.txt tools.UPLOAD_RECIPE_ID.upload.field.FIELD_NAME property value is greater than the maximum length.
PlatformTxtUploadFieldFieldNameSecretInvalid checks if any of the platform.txt tools.UPLOAD_RECIPE_ID.upload.field.FIELD_NAME.secret property values have invalid format.
PlatformTxtUploadParamsQuietMissing checks if any of the tools are missing upload.params.quiet properties.
PlatformTxtUploadParamsVerboseMissing checks if any of the tools are missing upload.params.verbose properties.
PlatformTxtUploadPatternMissing checks if any of the tools are missing upload.pattern properties.
PlatformTxtVersionMissing checks for missing version property in platform.txt.
PlatformTxtVersionNonRelaxedSemver checks whether the platform.txt version property is "relaxed semver" compliant.
PlatformTxtVersionNonSemver checks whether the platform.txt version property is semver compliant.
ProgrammersTxtFormat checks for invalid programmers.txt format.
ProgrammersTxtProgrammerIDNameLTMinLength checks if any of the programmer names are less than the minimum length.
ProgrammersTxtProgrammerIDNameMissing checks if any of the programmers are missing name properties.
ProgrammersTxtProgrammerIDProgramToolLTMinLength checks if any of the programmer program.tool properties are less than the minimum length.
ProgrammersTxtProgrammerIDProgramToolMissing checks if any of the programmers are missing program.tool properties.
ProhibitedCharactersInLibraryFolderName checks for prohibited characters in the library folder name.
ProhibitedCharactersInSketchFileName checks for prohibited characters in the sketch file names.
RecursiveLibraryWithUtilityFolder checks for presence of a `utility` subfolder in a recursive layout library.
RedundantLibraryProperties checks for redundant copies of the library.properties file.
SketchDotJSONFormat checks whether the sketch.json metadata file has the required data format.
SketchDotJSONJSONFormat checks whether the sketch.json metadata file is a valid JSON document.
SketchFileNameGTMaxLength checks if the sketch file names exceed the maximum length.
SketchNameMismatch checks for mismatch between sketch folder name and primary file name.
# Type aliases
Type is the function signature for the rule functions.