README
¶
Arduino Lint
Arduino Lint is a command line tool that checks for common problems in Arduino projects:
- Sketches
- Libraries
- Boards platforms
Documentation
For usage instructions, see the documentation
Continuous Integration
There is a GitHub Actions action that makes it easy to use Arduino Lint` in your CI workflows!
See https://github.com/arduino/arduino-lint-action for more information.
How to contribute
Contributions are welcome!
Please see the How to contribute page for information on building the source code, running tests, and contributing your changes to the project.
Beta testing
Nightly builds are available for beta testing.
Security
If you think you found a vulnerability or other security-related bug in this project, please read our security policy and report the bug to our Security Team 🛡️ Thank you!
e-mail contact: security@arduino.cc
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
docsgen
module
|
|
|
internal
|
|
|
cli
Package cli defines the Arduino Lint command line interface.
|
Package cli defines the Arduino Lint command line interface. |
|
command
Package command implements the arduino-lint commands.
|
Package command implements the arduino-lint commands. |
|
configuration
Package configuration handles the configuration of the Arduino Lint tool.
|
Package configuration handles the configuration of the Arduino Lint tool. |
|
configuration/rulemode
Package rulemode defines the tool configuration options that affect rules.
|
Package rulemode defines the tool configuration options that affect rules. |
|
project
Package project finds and classifies Arduino projects.
|
Package project finds and classifies Arduino projects. |
|
project/general
Package general provides functions that apply to multiple project types.
|
Package general provides functions that apply to multiple project types. |
|
project/library
Package library provides functions specific to linting Arduino libraries.
|
Package library provides functions specific to linting Arduino libraries. |
|
project/library/libraryproperties
Package libraryproperties provides functions for working with the library.properties Arduino library metadata file.
|
Package libraryproperties provides functions for working with the library.properties Arduino library metadata file. |
|
project/packageindex
Package packageindex provides functions specific to linting the package index files of the Arduino Boards Manager.
|
Package packageindex provides functions specific to linting the package index files of the Arduino Boards Manager. |
|
project/platform
Package platform provides functions specific to linting Arduino boards platforms.
|
Package platform provides functions specific to linting Arduino boards platforms. |
|
project/platform/boardstxt
Package boardstxt provides functions specific to linting the boards.txt configuration files of Arduino boards platforms.
|
Package boardstxt provides functions specific to linting the boards.txt configuration files of Arduino boards platforms. |
|
project/platform/platformtxt
Package platformtxt provides functions specific to linting the platform.txt configuration files of Arduino platform platforms.
|
Package platformtxt provides functions specific to linting the platform.txt configuration files of Arduino platform platforms. |
|
project/platform/programmerstxt
Package programmerstxt provides functions specific to linting the programmers.txt configuration files of Arduino programmers platforms.
|
Package programmerstxt provides functions specific to linting the programmers.txt configuration files of Arduino programmers platforms. |
|
project/projectdata
Package projectdata handles the collection of data specific to a project before running the rules on it.
|
Package projectdata handles the collection of data specific to a project before running the rules on it. |
|
project/projecttype
Package projecttype defines the Arduino project types.
|
Package projecttype defines the Arduino project types. |
|
project/sketch
Package sketch provides functions specific to linting Arduino sketches.
|
Package sketch provides functions specific to linting Arduino sketches. |
|
result
Package result records rule results and provides reports and summary text on those results.
|
Package result records rule results and provides reports and summary text on those results. |
|
result/feedback
Package feedback provides feedback to the user.
|
Package feedback provides feedback to the user. |
|
result/outputformat
Package outputformat defines the output formats
|
Package outputformat defines the output formats |
|
rule
Package rule runs rules on a project.
|
Package rule runs rules on a project. |
|
rule/ruleconfiguration
Package ruleconfiguration defines the configuration of each rule: - metadata - output template - under which conditions it's enabled - the level of a failure - which function implements it
|
Package ruleconfiguration defines the configuration of each rule: - metadata - output template - under which conditions it's enabled - the level of a failure - which function implements it |
|
rule/rulefunction
Package rulefunction contains the functions that implement each rule.
|
Package rulefunction contains the functions that implement each rule. |
|
rule/rulelevel
Package rulelevel defines the level assigned to a rule violation.
|
Package rulelevel defines the level assigned to a rule violation. |
|
rule/ruleresult
Package ruleresult defines the possible result values returned by a rule.
|
Package ruleresult defines the possible result values returned by a rule. |
|
rule/schema
Package schema contains code for working with JSON schema.
|
Package schema contains code for working with JSON schema. |
|
rule/schema/compliancelevel
Package compliancelevel defines the levels of specification compliance.
|
Package compliancelevel defines the levels of specification compliance. |
|
rule/schema/schemadata
Code generated for package schemadata by go-bindata DO NOT EDIT.
|
Code generated for package schemadata by go-bindata DO NOT EDIT. |
|
util/test
Package test provides resources for testing arduino-lint.
|
Package test provides resources for testing arduino-lint. |
|
ruledocsgen
module
|
Click to show internal directories.
Click to hide internal directories.