boardstxt

Documentation

Overview

Package boardstxt provides functions specific to linting the boards.txt configuration files of Arduino boards platforms. See: https://arduino.github.io/arduino-cli/latest/platform-specification/#boardstxt

Index

• func BoardIDs(boardsTxt *properties.Map) []string
• func MenuIDs(boardsTxt *properties.Map) []string
• func Properties(platformPath *paths.Path) (*properties.Map, error)
• func Validate(boardsTxt *properties.Map) map[compliancelevel.Type]schema.ValidationResult
• func VisibleBoardIDs(boardsTxt *properties.Map) []string

Functions

func BoardIDs

func BoardIDs(boardsTxt *properties.Map) []string

BoardIDs returns the list of board IDs from the given boards.txt properties.

func MenuIDs

func MenuIDs(boardsTxt *properties.Map) []string

MenuIDs returns the list of menu IDs from the given boards.txt properties.

func Properties

func Properties(platformPath *paths.Path) (*properties.Map, error)

Properties parses the boards.txt from the given path and returns the data.

func Validate

func Validate(boardsTxt *properties.Map) 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.

func VisibleBoardIDs

func VisibleBoardIDs(boardsTxt *properties.Map) []string

VisibleBoardIDs returns the list of IDs for non-hidden boards from the given boards.txt properties.