Merge pull request #67 from arduino/per1234/misspelled-path-checks

Add checks for common misspellings of path base names

Author: per1234

check/checkconfigurations/checkconfigurations.go

@@ -71,6 +71,21 @@ var configurations = []Type{
 		ErrorModes:      []checkmode.Type{checkmode.All},
 		CheckFunction:   checkfunctions.LibraryPropertiesFormat,
 	},
+	{
+		ProjectType:     projecttype.Library,
+		Category:        "library.properties",
+		Subcategory:     "general",
+		ID:              "",
+		Brief:           "incorrect library.properties file name",
+		Description:     "",
+		MessageTemplate: "Incorrectly spelled library.properties file name found: {{.}}. See: https://arduino.github.io/arduino-cli/latest/library-specification/#library-metadata",
+		DisableModes:    nil,
+		EnableModes:     []checkmode.Type{checkmode.All},
+		InfoModes:       nil,
+		WarningModes:    []checkmode.Type{checkmode.Permissive},
+		ErrorModes:      []checkmode.Type{checkmode.Default},
+		CheckFunction:   checkfunctions.MisspelledLibraryPropertiesFileName,
+	},
 	{
 		ProjectType:     projecttype.Library,
 		Category:        "library.properties",
@@ -911,6 +926,36 @@ var configurations = []Type{
 		ErrorModes:      []checkmode.Type{checkmode.Default},
 		CheckFunction:   checkfunctions.LibraryFolderNameGTMaxLength,
 	},
+	{
+		ProjectType:     projecttype.Library,
+		Category:        "structure",
+		Subcategory:     "",
+		ID:              "",
+		Brief:           "incorrect examples folder name",
+		Description:     "",
+		MessageTemplate: "Potentially misspelled examples folder name found: {{.}}. See: https://arduino.github.io/arduino-cli/latest/library-specification/#library-examples",
+		DisableModes:    nil,
+		EnableModes:     []checkmode.Type{checkmode.All},
+		InfoModes:       nil,
+		WarningModes:    []checkmode.Type{checkmode.Permissive},
+		ErrorModes:      []checkmode.Type{checkmode.Default},
+		CheckFunction:   checkfunctions.MisspelledExamplesFolderName,
+	},
+	{
+		ProjectType:     projecttype.Library,
+		Category:        "structure",
+		Subcategory:     "",
+		ID:              "",
+		Brief:           "incorrect extras folder name",
+		Description:     "",
+		MessageTemplate: "Potentially misspelled extras folder name found: {{.}}. See: https://arduino.github.io/arduino-cli/latest/library-specification/#extra-documentation",
+		DisableModes:    nil,
+		EnableModes:     []checkmode.Type{checkmode.All},
+		InfoModes:       nil,
+		WarningModes:    []checkmode.Type{checkmode.All},
+		ErrorModes:      nil,
+		CheckFunction:   checkfunctions.MisspelledExtrasFolderName,
+	},
 	{
 		ProjectType:     projecttype.Sketch,
 		Category:        "structure",

check/checkfunctions/checkfunctions.go

@@ -20,6 +20,7 @@ import (
 	"regexp"
 
 	"github.com/arduino/arduino-check/check/checkresult"
+	"github.com/arduino/go-paths-helper"
 )
 
 // Type is the function signature for the check functions.
@@ -31,3 +32,18 @@ func validProjectPathBaseName(name string) bool {
 	baseNameRegexp := regexp.MustCompile("^[a-zA-Z0-9][a-zA-Z0-9_.-]*$")
 	return baseNameRegexp.MatchString(name)
 }
+
+func containsMisspelledPathBaseName(pathList paths.PathList, correctBaseName string, misspellingQuery string) (*paths.Path, bool) {
+	misspellingRegexp := regexp.MustCompile(misspellingQuery)
+	for _, path := range pathList {
+		if path.Base() == correctBaseName {
+			return nil, false
+		}
+
+		if misspellingRegexp.MatchString(path.Base()) {
+			return path, true
+		}
+	}
+
+	return nil, false
+}

check/checkfunctions/library.go

@@ -43,6 +43,22 @@ func LibraryPropertiesFormat() (result checkresult.Type, output string) {
 	return checkresult.Pass, ""
 }
 
+// MisspelledLibraryPropertiesFileName checks for incorrectly spelled library.properties file name.
+func MisspelledLibraryPropertiesFileName() (result checkresult.Type, output string) {
+	directoryListing, err := checkdata.ProjectPath().ReadDir()
+	if err != nil {
+		panic(err)
+	}
+	directoryListing.FilterOutDirs()
+
+	path, found := containsMisspelledPathBaseName(directoryListing, "library.properties", "(?i)^librar(y)|(ie)s?[.-_]?propert(y)|(ie)s?$")
+	if found {
+		return checkresult.Fail, path.String()
+	}
+
+	return checkresult.Pass, ""
+}
+
 // LibraryPropertiesNameFieldMissing checks for missing library.properties "name" field.
 func LibraryPropertiesNameFieldMissing() (result checkresult.Type, output string) {
 	if checkdata.LibraryPropertiesLoadError() != nil {
@@ -965,6 +981,38 @@ func LibraryFolderNameGTMaxLength() (result checkresult.Type, output string) {
 	return checkresult.Pass, ""
 }
 
+// MisspelledExamplesFolderName checks for incorrectly spelled `examples` folder name.
+func MisspelledExamplesFolderName() (result checkresult.Type, output string) {
+	directoryListing, err := checkdata.ProjectPath().ReadDir()
+	if err != nil {
+		panic(err)
+	}
+	directoryListing.FilterDirs()
+
+	path, found := containsMisspelledPathBaseName(directoryListing, "examples", "(?i)^e((x)|(xs)|(s))((am)|(ma))p((le)|(el))s?$")
+	if found {
+		return checkresult.Fail, path.String()
+	}
+
+	return checkresult.Pass, ""
+}
+
+// MisspelledExtrasFolderName checks for incorrectly spelled `extras` folder name.
+func MisspelledExtrasFolderName() (result checkresult.Type, output string) {
+	directoryListing, err := checkdata.ProjectPath().ReadDir()
+	if err != nil {
+		panic(err)
+	}
+	directoryListing.FilterDirs()
+
+	path, found := containsMisspelledPathBaseName(directoryListing, "extras", "(?i)^extra$")
+	if found {
+		return checkresult.Fail, path.String()
+	}
+
+	return checkresult.Pass, ""
+}
+
 // spellCheckLibraryPropertiesFieldValue returns the value of the provided library.properties field with commonly misspelled words corrected.
 func spellCheckLibraryPropertiesFieldValue(fieldName string) (result checkresult.Type, output string) {
 	if checkdata.LibraryPropertiesLoadError() != nil {

check/checkfunctions/library_test.go

@@ -64,6 +64,15 @@ func checkLibraryCheckFunction(checkFunction Type, testTables []libraryCheckFunc
 	}
 }
 
+func TestMisspelledLibraryPropertiesFileName(t *testing.T) {
+	testTables := []libraryCheckFunctionTestTable{
+		{"Incorrect", "MisspelledLibraryProperties", checkresult.Fail, ""},
+		{"Correct", "Recursive", checkresult.Pass, ""},
+	}
+
+	checkLibraryCheckFunction(MisspelledLibraryPropertiesFileName, testTables, t)
+}
+
 func TestLibraryPropertiesNameFieldMissingOfficialPrefix(t *testing.T) {
 	testTables := []libraryCheckFunctionTestTable{
 		{"Unable to load", "InvalidLibraryProperties", checkresult.NotRun, ""},
@@ -272,3 +281,23 @@ func TestLibraryFolderNameGTMaxLength(t *testing.T) {
 
 	checkLibraryCheckFunction(LibraryFolderNameGTMaxLength, testTables, t)
 }
+
+func TestMisspelledExamplesFolderName(t *testing.T) {
+	testTables := []libraryCheckFunctionTestTable{
+		{"Correctly spelled", "ExamplesFolder", checkresult.Pass, ""},
+		{"Misspelled", "MisspelledExamplesFolder", checkresult.Fail, ""},
+		{"No examples folder", "Recursive", checkresult.Pass, ""},
+	}
+
+	checkLibraryCheckFunction(MisspelledExamplesFolderName, testTables, t)
+}
+
+func TestMisspelledExtrasFolderName(t *testing.T) {
+	testTables := []libraryCheckFunctionTestTable{
+		{"Correctly spelled", "ExtrasFolder", checkresult.Pass, ""},
+		{"Misspelled", "MisspelledExtrasFolder", checkresult.Fail, ""},
+		{"No extras folder", "Recursive", checkresult.Pass, ""},
+	}
+
+	checkLibraryCheckFunction(MisspelledExtrasFolderName, testTables, t)
+}

check/checkfunctions/testdata/libraries/ExamplesFolder/examples/Example/Example.ino

@@ -0,0 +1,2 @@
+void setup() {}
+void loop() {}

check/checkfunctions/testdata/libraries/ExamplesFolder/library.properties

@@ -0,0 +1,9 @@
+name=ExamplesFolder
+version=1.0.0
+author=Cristian Maglie <c.maglie@example.com>, Pippo Pluto <pippo@example.com>
+maintainer=Cristian Maglie <c.maglie@example.com>
+sentence=A library that makes coding a web server a breeze.
+paragraph=Supports HTTP1.1 and you can do GET and POST.
+category=Communication
+url=http://example.com/
+architectures=avr

check/checkfunctions/testdata/libraries/ExamplesFolder/src/ExamplesFolder.h

@@ -0,0 +1,9 @@
+name=ExtrasFolder
+version=1.0.0
+author=Cristian Maglie <c.maglie@example.com>, Pippo Pluto <pippo@example.com>
+maintainer=Cristian Maglie <c.maglie@example.com>
+sentence=A library that makes coding a web server a breeze.
+paragraph=Supports HTTP1.1 and you can do GET and POST.
+category=Communication
+url=http://example.com/
+architectures=avr

check/checkfunctions/testdata/libraries/ExtrasFolder/extras/.gitkeep

@@ -0,0 +1,2 @@
+void setup() {}
+void loop() {}

check/checkfunctions/testdata/libraries/ExtrasFolder/library.properties

@@ -0,0 +1,9 @@
+name=MisspelledExamplesFolder
+version=1.0.0
+author=Cristian Maglie <c.maglie@example.com>, Pippo Pluto <pippo@example.com>
+maintainer=Cristian Maglie <c.maglie@example.com>
+sentence=A library that makes coding a web server a breeze.
+paragraph=Supports HTTP1.1 and you can do GET and POST.
+category=Communication
+url=http://example.com/
+architectures=avr

check/checkfunctions/testdata/libraries/ExtrasFolder/src/ExtrasFolder.h

@@ -0,0 +1,9 @@
+name=MisspelledExtrasFolder
+version=1.0.0
+author=Cristian Maglie <c.maglie@example.com>, Pippo Pluto <pippo@example.com>
+maintainer=Cristian Maglie <c.maglie@example.com>
+sentence=A library that makes coding a web server a breeze.
+paragraph=Supports HTTP1.1 and you can do GET and POST.
+category=Communication
+url=http://example.com/
+architectures=avr

check/checkfunctions/testdata/libraries/MisspelledExamplesFolder/example/Example/Example.ino

@@ -0,0 +1,9 @@
+name=MisspelledLibraryProperties
+version=1.0.0
+author=Cristian Maglie <c.maglie@example.com>, Pippo Pluto <pippo@example.com>
+maintainer=Cristian Maglie <c.maglie@example.com>
+sentence=A library that makes coding a web server a breeze.
+paragraph=Supports HTTP1.1 and you can do GET and POST.
+category=Communication
+url=http://example.com/
+architectures=avr

check/checkfunctions/testdata/libraries/MisspelledExamplesFolder/library.properties

@@ -1 +1,2 @@
 ot
+propert