Documentation
¶
Overview ¶
Package sketch provides functions specific to linting Arduino sketches. See: https://arduino.github.io/arduino-cli/latest/sketch-specification/
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ContainsMainSketchFile ¶
func ContainsMainSketchFile(searchPath *paths.Path) bool
ContainsMainSketchFile checks whether the provided path contains a file with valid main sketch file extension.
func HasMainFileValidExtension ¶
func HasMainFileValidExtension(filePath *paths.Path) bool
HasMainFileValidExtension returns whether the file at the given path has a valid sketch main file extension. Sketches may contain source files with other extensions (e.g., .h, .cpp), but they are required to have at least one file with a main extension.
func HasSupportedExtension ¶
func HasSupportedExtension(filePath *paths.Path) bool
HasSupportedExtension returns whether the file at the given path has any of the file extensions supported for source/header files of a sketch.
func MetadataPath ¶
func MetadataPath(sketchPath *paths.Path) *paths.Path
MetadataPath returns the path of the sketch's metadata file.
Types ¶
This section is empty.
Source Files