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