Documentation
      ¶
    
    
  
    
  
    Overview ¶
Package project finds and classifies Arduino projects.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Type ¶
type Type struct {
	Path             *paths.Path
	ProjectType      projecttype.Type
	SuperprojectType projecttype.Type
}
    Type is the type for project definitions.
func FindProjects ¶
FindProjects searches the target path configured by the user for projects of the type configured by the user as well as the subprojects of those project. It returns a slice containing the definitions of each found project.
      
      Directories
      ¶
    
    | Path | Synopsis | 
|---|---|
| 
       Package general provides functions that apply to multiple project types. 
         | 
      Package general provides functions that apply to multiple project types. | 
| 
       Package library provides functions specific to linting Arduino libraries. 
         | 
      Package library provides functions specific to linting Arduino libraries. | 
| 
         
          
            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. | 
| 
       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. | 
| 
       Package platform provides functions specific to linting Arduino boards platforms. 
         | 
      Package platform provides functions specific to linting Arduino boards platforms. | 
| 
         
          
            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. | 
| 
         
          
            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. | 
| 
         
          
            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. | 
| 
       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. | 
| 
       Package projecttype defines the Arduino project types. 
         | 
      Package projecttype defines the Arduino project types. | 
| 
       Package sketch provides functions specific to linting Arduino sketches. 
         | 
      Package sketch provides functions specific to linting Arduino sketches. | 
 Click to show internal directories. 
   Click to hide internal directories.