Documentation
¶
Overview ¶
Package platformtxt provides functions specific to linting the platform.txt configuration files of Arduino platform platforms. See: https://arduino.github.io/arduino-cli/latest/platform-specification/#platformtxt
Index ¶
- func PluggableDiscoveryNames(platformTxt *properties.Map) []string
- func Properties(platformPath *paths.Path) (*properties.Map, error)
- func ToolNames(platformTxt *properties.Map) []string
- func UserProvidedFieldNames(platformTxt *properties.Map) map[string][]string
- func Validate(platformTxt *properties.Map) map[compliancelevel.Type]schema.ValidationResult
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func PluggableDiscoveryNames ¶
func PluggableDiscoveryNames(platformTxt *properties.Map) []string
PluggableDiscoveryNames returns the list of pluggable discovery names from the given platform.txt properties.
func Properties ¶
func Properties(platformPath *paths.Path) (*properties.Map, error)
Properties parses the platform.txt from the given path and returns the data.
func ToolNames ¶
func ToolNames(platformTxt *properties.Map) []string
ToolNames returns the list of tool names from the given platform.txt properties.
func UserProvidedFieldNames ¶
UserProvidedFieldNames returns the list of user provided field names platform.txt properties, mapped by tool name.
func Validate ¶
func Validate(platformTxt *properties.Map) map[compliancelevel.Type]schema.ValidationResult
Validate validates platform.txt data against the JSON schema and returns a map of the result for each compliance level.
Types ¶
This section is empty.