Documentation
¶
Overview ¶
Package configuration handles the configuration of the Arduino Lint tool.
Index ¶
- Variables
- func BuildCommit() string
- func BuildTimestamp() string
- func BuildVersion() string
- func EnableLogging(enable bool)
- func Initialize(flags *pflag.FlagSet, projectPaths []string) error
- func OutputFormat() outputformat.Type
- func Recursive() bool
- func ReportFilePath() *paths.Path
- func RuleModes(superprojectType projecttype.Type) map[rulemode.Type]bool
- func SuperprojectTypeFilter() projecttype.Type
- func TargetPaths() paths.PathList
- func Verbose() bool
- func VersionMode() bool
Constants ¶
This section is empty.
Variables ¶
var Commit string
Commit is the HEAD commit of the Arduino Lint repository when the application was built.
var Timestamp string
Timestamp is the timestamp of the build.
var Version string
Version is the build version.
Functions ¶
func BuildCommit ¶
func BuildCommit() string
BuildCommit returns the HEAD commit of the Arduino Lint repository when the application was built.
func BuildTimestamp ¶
func BuildTimestamp() string
BuildTimestamp returns the timestamp of the build.
func EnableLogging ¶
func EnableLogging(enable bool)
EnableLogging enables or disables logging debug output.
func Initialize ¶
Initialize sets up the tool configuration according to defaults and user-specified options.
func OutputFormat ¶
func OutputFormat() outputformat.Type
OutputFormat returns the tool output format configuration value.
func Recursive ¶
func Recursive() bool
Recursive returns the recursive project search configuration value.
func ReportFilePath ¶
func ReportFilePath() *paths.Path
ReportFilePath returns the path to save the report file at.
func RuleModes ¶
func RuleModes(superprojectType projecttype.Type) map[rulemode.Type]bool
RuleModes returns the rule modes configuration for the given project type.
func SuperprojectTypeFilter ¶
func SuperprojectTypeFilter() projecttype.Type
SuperprojectTypeFilter returns the superproject type filter configuration.
Types ¶
This section is empty.
Source Files
Directories