projectdata

Documentation

Overview

Package projectdata handles the collection of data specific to a project before running the rules on it. This is for data required by multiple rules.

Index

• func BoardsTxt() *properties.Map
• func BoardsTxtBoardIds() []string
• func BoardsTxtLoadError() error
• func BoardsTxtMenuIds() []string
• func BoardsTxtSchemaValidationResult() map[compliancelevel.Type]schema.ValidationResult
• func BoardsTxtVisibleBoardIds() []string
• func Initialize(project project.Type)
• func InitializeForLibrary(project project.Type)
• func InitializeForPackageIndex()
• func InitializeForPlatform(project project.Type)
• func InitializeForSketch(project project.Type)
• func LibraryManagerIndex() *librariesmanager.LibrariesManager
• func LibraryProperties() *properties.Map
• func LibraryPropertiesLoadError() error
• func LibraryPropertiesSchemaValidationResult() map[compliancelevel.Type]schema.ValidationResult
• func LoadedLibrary() *libraries.Library
• func MisspelledWordsReplacer() *misspell.Replacer
• func PackageIndex() map[string]interface{}
• func PackageIndexCLILoadError() error
• func PackageIndexLoadError() error
• func PackageIndexSchemaValidationResult() map[compliancelevel.Type]schema.ValidationResult
• func PlatformTxt() *properties.Map
• func PlatformTxtExists() bool
• func PlatformTxtLoadError() error
• func PlatformTxtPluggableDiscoveryNames() []string
• func PlatformTxtSchemaValidationResult() map[compliancelevel.Type]schema.ValidationResult
• func PlatformTxtToolNames() []string
• func PlatformTxtUserProvidedFieldNames() map[string][]string
• func ProgrammersTxt() *properties.Map
• func ProgrammersTxtExists() bool
• func ProgrammersTxtLoadError() error
• func ProgrammersTxtProgrammerIds() []string
• func ProgrammersTxtSchemaValidationResult() map[compliancelevel.Type]schema.ValidationResult
• func ProjectPath() *paths.Path
• func ProjectType() projecttype.Type
• func Sketch() *sketch.Sketch
• func SketchLoadError() error
• func SourceHeaders() []string
• func SuperProjectType() projecttype.Type
• type PackageIndexData
  • func PackageIndexBoards() []PackageIndexData
  • func PackageIndexDiscoveryDependencies() []PackageIndexData
  • func PackageIndexMonitorDependencies() []PackageIndexData
  • func PackageIndexPackages() []PackageIndexData
  • func PackageIndexPlatforms() []PackageIndexData
  • func PackageIndexSystems() []PackageIndexData
  • func PackageIndexTools() []PackageIndexData
  • func PackageIndexToolsDependencies() []PackageIndexData

Functions

func BoardsTxt

func BoardsTxt() *properties.Map

BoardsTxt returns the data from the boards.txt configuration file.

func BoardsTxtBoardIds

func BoardsTxtBoardIds() []string

BoardsTxtBoardIds returns the list of board IDs present in the platform's boards.txt.

func BoardsTxtLoadError

func BoardsTxtLoadError() error

BoardsTxtLoadError returns the error output from loading the boards.txt configuration file.

func BoardsTxtMenuIds

func BoardsTxtMenuIds() []string

BoardsTxtMenuIds returns the list of menu IDs present in the platform's boards.txt.

func BoardsTxtSchemaValidationResult

func BoardsTxtSchemaValidationResult() map[compliancelevel.Type]schema.ValidationResult

BoardsTxtSchemaValidationResult returns the result of validating boards.txt against the JSON schema.

func BoardsTxtVisibleBoardIds

func BoardsTxtVisibleBoardIds() []string

BoardsTxtVisibleBoardIds returns the list of IDs for visible boards present in the platform's boards.txt.

func Initialize

func Initialize(project project.Type)

Initialize gathers the check data for the specified project.

func InitializeForLibrary

func InitializeForLibrary(project project.Type)

InitializeForLibrary gathers the library rule data for the specified project.

func InitializeForPackageIndex

func InitializeForPackageIndex()

InitializeForPackageIndex gathers the package index rule data for the specified project.

func InitializeForPlatform

func InitializeForPlatform(project project.Type)

InitializeForPlatform gathers the platform rule data for the specified project.

func InitializeForSketch

func InitializeForSketch(project project.Type)

InitializeForSketch gathers the check data for the specified sketch project.

func LibraryManagerIndex

func LibraryManagerIndex() *librariesmanager.LibrariesManager

LibraryManagerIndex returns the Library Manager index data.

func LibraryProperties

func LibraryProperties() *properties.Map

LibraryProperties returns the data from the library.properties metadata file.

func LibraryPropertiesLoadError

func LibraryPropertiesLoadError() error

LibraryPropertiesLoadError returns the error output from loading the library.properties metadata file.

func LibraryPropertiesSchemaValidationResult

func LibraryPropertiesSchemaValidationResult() map[compliancelevel.Type]schema.ValidationResult

LibraryPropertiesSchemaValidationResult returns the result of validating library.properties against the JSON schema.

func LoadedLibrary

func LoadedLibrary() *libraries.Library

LoadedLibrary returns the library object generated by Arduino CLI.

func MisspelledWordsReplacer

func MisspelledWordsReplacer() *misspell.Replacer

MisspelledWordsReplacer returns the misspelled words replacer used for spell check.

func PackageIndex

func PackageIndex() map[string]interface{}

PackageIndex returns the package index data.

func PackageIndexCLILoadError

func PackageIndexCLILoadError() error

PackageIndexCLILoadError returns the error return of Arduino CLI's packageindex.LoadIndex().

func PackageIndexLoadError

func PackageIndexLoadError() error

PackageIndexLoadError returns the error from loading the package index.

func PackageIndexSchemaValidationResult

func PackageIndexSchemaValidationResult() map[compliancelevel.Type]schema.ValidationResult

PackageIndexSchemaValidationResult returns the result of validating the package index against the JSON schema.

func PlatformTxt

func PlatformTxt() *properties.Map

PlatformTxt returns the data from the platform.txt configuration file.

func PlatformTxtExists

func PlatformTxtExists() bool

PlatformTxtExists returns whether the platform contains a platform.txt file.

func PlatformTxtLoadError

func PlatformTxtLoadError() error

PlatformTxtLoadError returns the error output from loading the platform.txt configuration file.

func PlatformTxtPluggableDiscoveryNames

func PlatformTxtPluggableDiscoveryNames() []string

PlatformTxtPluggableDiscoveryNames returns the list of pluggable discoveries present in the platform's platform.txt.

func PlatformTxtSchemaValidationResult

func PlatformTxtSchemaValidationResult() map[compliancelevel.Type]schema.ValidationResult

PlatformTxtSchemaValidationResult returns the result of validating platform.txt against the JSON schema.

func PlatformTxtToolNames

func PlatformTxtToolNames() []string

PlatformTxtToolNames returns the list of tools present in the platform's platform.txt.

func PlatformTxtUserProvidedFieldNames

func PlatformTxtUserProvidedFieldNames() map[string][]string

PlatformTxtUserProvidedFieldNames returns the list of user provided field names present in the platform's platform.txt, mapped by board name.

func ProgrammersTxt

func ProgrammersTxt() *properties.Map

ProgrammersTxt returns the data from the programmers.txt configuration file.

func ProgrammersTxtExists

func ProgrammersTxtExists() bool

ProgrammersTxtExists returns whether the platform contains a programmer.txt file.

func ProgrammersTxtLoadError

func ProgrammersTxtLoadError() error

ProgrammersTxtLoadError returns the error output from loading the programmers.txt configuration file.

func ProgrammersTxtProgrammerIds

func ProgrammersTxtProgrammerIds() []string

ProgrammersTxtProgrammerIds returns the list of board IDs present in the platform's programmers.txt.

func ProgrammersTxtSchemaValidationResult

func ProgrammersTxtSchemaValidationResult() map[compliancelevel.Type]schema.ValidationResult

ProgrammersTxtSchemaValidationResult returns the result of validating programmers.txt against the JSON schema.

func ProjectPath

func ProjectPath() *paths.Path

ProjectPath returns the path to the project being checked.

func ProjectType

func ProjectType() projecttype.Type

ProjectType returns the type of the project being checked.

func Sketch

func Sketch() *sketch.Sketch

Sketch returns the sketch object generated by Arduino CLI.

func SketchLoadError

func SketchLoadError() error

SketchLoadError returns the error output from Arduino CLI loading the sketch.

func SourceHeaders

func SourceHeaders() []string

SourceHeaders returns the list of library source header filenames discovered by Arduino CLI.

func SuperProjectType

func SuperProjectType() projecttype.Type

SuperProjectType returns the type of the project being checked.

Types

type PackageIndexData

type PackageIndexData struct {
	ID          string                 // Identifier for display to humans
	JSONPointer string                 // Path to the data in the JSON document
	Object      map[string]interface{} // The data of the object
}

PackageIndexData is the type for package index data.

func PackageIndexBoards

func PackageIndexBoards() []PackageIndexData

PackageIndexBoards returns the slice of board data for the package index.

func PackageIndexDiscoveryDependencies

func PackageIndexDiscoveryDependencies() []PackageIndexData

PackageIndexDiscoveryDependencies returns the slice of pluggable discovery tool dependency data for the package index.

func PackageIndexMonitorDependencies

func PackageIndexMonitorDependencies() []PackageIndexData

PackageIndexMonitorDependencies returns the slice of pluggable monitor tool dependency data for the package index.

func PackageIndexPackages

func PackageIndexPackages() []PackageIndexData

PackageIndexPackages returns the slice of package data for the package index.

func PackageIndexPlatforms

func PackageIndexPlatforms() []PackageIndexData

PackageIndexPlatforms returns the slice of platform data for the package index.

func PackageIndexSystems

func PackageIndexSystems() []PackageIndexData

PackageIndexSystems returns the slice of system data for the package index.

func PackageIndexTools

func PackageIndexTools() []PackageIndexData

PackageIndexTools returns the slice of tool data for the package index.

func PackageIndexToolsDependencies

func PackageIndexToolsDependencies() []PackageIndexData

PackageIndexToolsDependencies returns the slice of tool dependency data for the package index.