package
0.0.0-20240813060107-005fe8a3629a
Repository: https://github.com/arduino/arduino-lint.git
Documentation: pkg.go.dev

# Functions

BoardsTxt returns the data from the boards.txt configuration file.
BoardsTxtBoardIds returns the list of board IDs present in the platform's boards.txt.
BoardsTxtLoadError returns the error output from loading the boards.txt configuration file.
BoardsTxtMenuIds returns the list of menu IDs present in the platform's boards.txt.
BoardsTxtSchemaValidationResult returns the result of validating boards.txt against the JSON schema.
BoardsTxtVisibleBoardIds returns the list of IDs for visible boards present in the platform's boards.txt.
Initialize gathers the check data for the specified project.
InitializeForLibrary gathers the library rule data for the specified project.
InitializeForPackageIndex gathers the package index rule data for the specified project.
InitializeForPlatform gathers the platform rule data for the specified project.
InitializeForSketch gathers the check data for the specified sketch project.
LibraryManagerIndex returns the Library Manager index data.
LibraryProperties returns the data from the library.properties metadata file.
LibraryPropertiesLoadError returns the error output from loading the library.properties metadata file.
LibraryPropertiesSchemaValidationResult returns the result of validating library.properties against the JSON schema.
LoadedLibrary returns the library object generated by Arduino CLI.
Metadata returns the metadata object produced by Arduino CLI.
MetadataLoadError returns the error produced during load of the sketch metadata.
MisspelledWordsReplacer returns the misspelled words replacer used for spell check.
PackageIndex returns the package index data.
PackageIndexBoards returns the slice of board data for the package index.
PackageIndexCLILoadError returns the error return of Arduino CLI's packageindex.LoadIndex().
PackageIndexDiscoveryDependencies returns the slice of pluggable discovery tool dependency data for the package index.
PackageIndexLoadError returns the error from loading the package index.
PackageIndexMonitorDependencies returns the slice of pluggable monitor tool dependency data for the package index.
PackageIndexPackages returns the slice of package data for the package index.
PackageIndexPlatforms returns the slice of platform data for the package index.
PackageIndexSchemaValidationResult returns the result of validating the package index against the JSON schema.
PackageIndexSystems returns the slice of system data for the package index.
PackageIndexTools returns the slice of tool data for the package index.
PackageIndexToolsDependencies returns the slice of tool dependency data for the package index.
PlatformTxt returns the data from the platform.txt configuration file.
PlatformTxtExists returns whether the platform contains a platform.txt file.
PlatformTxtLoadError returns the error output from loading the platform.txt configuration file.
PlatformTxtPluggableDiscoveryNames returns the list of pluggable discoveries present in the platform's platform.txt.
PlatformTxtSchemaValidationResult returns the result of validating platform.txt against the JSON schema.
PlatformTxtToolNames returns the list of tools present in the platform's platform.txt.
PlatformTxtUserProvidedFieldNames returns the list of user provided field names present in the platform's platform.txt, mapped by board name.
ProgrammersTxt returns the data from the programmers.txt configuration file.
ProgrammersTxtExists returns whether the platform contains a programmer.txt file.
ProgrammersTxtLoadError returns the error output from loading the programmers.txt configuration file.
ProgrammersTxtProgrammerIds returns the list of board IDs present in the platform's programmers.txt.
ProgrammersTxtSchemaValidationResult returns the result of validating programmers.txt against the JSON schema.
ProjectPath returns the path to the project being checked.
ProjectType returns the type of the project being checked.
Sketch returns the sketch object generated by Arduino CLI.
SketchLoadError returns the error output from Arduino CLI loading the sketch.
SourceHeaders returns the list of library source header filenames discovered by Arduino CLI.
SuperProjectType returns the type of the project being checked.

# Structs

PackageIndexData is the type for package index data.