Documentation
¶
Overview ¶
Package packageindex provides functions specific to linting the package index files of the Arduino Boards Manager. See: https://arduino.github.io/arduino-cli/latest/package_index_json-specification
Index ¶
- func Find(folderPath *paths.Path) (*paths.Path, error)
- func HasValidExtension(filePath *paths.Path) bool
- func HasValidFilename(filePath *paths.Path, officialRuleMode bool) bool
- func Properties(packageIndexPath *paths.Path) (map[string]interface{}, error)
- func Validate(packageIndex map[string]interface{}) map[compliancelevel.Type]schema.ValidationResult
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Find ¶
func Find(folderPath *paths.Path) (*paths.Path, error)
Find searches the provided path for a file that has a name resembling a package index and returns the path to that file.
func HasValidExtension ¶
func HasValidExtension(filePath *paths.Path) bool
HasValidExtension returns whether the file at the given path has a valid package index extension.
func HasValidFilename ¶
HasValidFilename returns whether the file at the given path has a valid package index filename.
func Properties ¶
Properties parses the package index from the given path and returns the data.
func Validate ¶
func Validate(packageIndex map[string]interface{}) map[compliancelevel.Type]schema.ValidationResult
Validate validates boards.txt data against the JSON schema and returns a map of the result for each compliance level.
Types ¶
This section is empty.
Source Files