Merge pull request #35 from arduino/per1234/spell-check

per1234 · web-flow · commit 2ea2986b3ea4 · 2020-11-24T08:28:14.000-08:00
Add checks for commonly misspelled words in library.properties
diff --git a/Taskfile.yml b/Taskfile.yml
@@ -189,5 +189,5 @@ vars:
 
   WORKFLOW_SCHEMA_PATH: "$(mktemp -t gha-workflow-schema-XXXXXXXXXX.json)"
 
-  CODESPELL_SKIP_OPTION: '--skip "./.git,./go.mod,./go.sum,./arduino-check,./arduino-check.exe"'
+  CODESPELL_SKIP_OPTION: '--skip "./.git,./go.mod,./go.sum,./arduino-check,./arduino-check.exe,./check/checkfunctions/testdata/libraries/MisspelledSentenceParagraphValue/library.properties"'
   CODESPELL_IGNORE_WORDS_OPTION: "--ignore-words ./etc/codespell-ignore-words-list.txt"
diff --git a/check/checkconfigurations/checkconfigurations.go b/check/checkconfigurations/checkconfigurations.go
@@ -206,6 +206,36 @@ var configurations = []Type{
 		ErrorModes:      []checkmode.Type{checkmode.All},
 		CheckFunction:   checkfunctions.LibraryPropertiesAuthorFieldLTMinLength,
 	},
+	{
+		ProjectType:     projecttype.Library,
+		Category:        "library.properties",
+		Subcategory:     "sentence field",
+		ID:              "",
+		Brief:           "sentence spell check",
+		Description:     "",
+		MessageTemplate: "A commonly misspelled word was found in the library.properties sentence field. Suggested correction: {{.}}",
+		DisableModes:    nil,
+		EnableModes:     []checkmode.Type{checkmode.All},
+		InfoModes:       nil,
+		WarningModes:    []checkmode.Type{checkmode.All},
+		ErrorModes:      nil,
+		CheckFunction:   checkfunctions.LibraryPropertiesSentenceFieldSpellCheck,
+	},
+	{
+		ProjectType:     projecttype.Library,
+		Category:        "library.properties",
+		Subcategory:     "paragraph field",
+		ID:              "",
+		Brief:           "paragraph spell check",
+		Description:     "",
+		MessageTemplate: "A commonly misspelled word was found in the library.properties paragraph field. Suggested correction: {{.}}",
+		DisableModes:    nil,
+		EnableModes:     []checkmode.Type{checkmode.All},
+		InfoModes:       nil,
+		WarningModes:    []checkmode.Type{checkmode.All},
+		ErrorModes:      nil,
+		CheckFunction:   checkfunctions.LibraryPropertiesParagraphFieldSpellCheck,
+	},
 	{
 		ProjectType:     projecttype.Library,
 		Category:        "library.properties",
diff --git a/check/checkdata/library.go b/check/checkdata/library.go
@@ -27,6 +27,7 @@ import (
 	"github.com/arduino/arduino-check/result/feedback"
 	"github.com/arduino/go-paths-helper"
 	"github.com/arduino/go-properties-orderedmap"
+	"github.com/client9/misspell"
 	"github.com/ory/jsonschema/v3"
 	"github.com/sirupsen/logrus"
 )
@@ -61,6 +62,11 @@ func InitializeForLibrary(project project.Type, schemasPath *paths.Path) {
 			panic(err)
 		}
 	}
+
+	if misspelledWordsReplacer == nil { // The replacer only needs to be compiled once per run.
+		misspelledWordsReplacer = misspell.New()
+		misspelledWordsReplacer.Compile()
+	}
 }
 
 var libraryPropertiesLoadError error
@@ -90,3 +96,10 @@ var libraryManagerIndex map[string]interface{}
 func LibraryManagerIndex() map[string]interface{} {
 	return libraryManagerIndex
 }
+
+var misspelledWordsReplacer *misspell.Replacer
+
+// MisspelledWordsReplacer returns the misspelled words replacer used for spell check.
+func MisspelledWordsReplacer() *misspell.Replacer {
+	return misspelledWordsReplacer
+}
diff --git a/check/checkfunctions/library.go b/check/checkfunctions/library.go
@@ -175,6 +175,16 @@ func LibraryPropertiesAuthorFieldLTMinLength() (result checkresult.Type, output
 	return checkresult.Pass, ""
 }
 
+// LibraryPropertiesSentenceFieldSpellCheck checks for commonly misspelled words in the library.properties `sentence` field value.
+func LibraryPropertiesSentenceFieldSpellCheck() (result checkresult.Type, output string) {
+	return spellCheckLibraryPropertiesFieldValue("sentence")
+}
+
+// LibraryPropertiesParagraphFieldSpellCheck checks for commonly misspelled words in the library.properties `paragraph` field value.
+func LibraryPropertiesParagraphFieldSpellCheck() (result checkresult.Type, output string) {
+	return spellCheckLibraryPropertiesFieldValue("paragraph")
+}
+
 // LibraryPropertiesDependsFieldNotInIndex checks whether the libraries listed in the library.properties `depends` field are in the Library Manager index.
 func LibraryPropertiesDependsFieldNotInIndex() (result checkresult.Type, output string) {
 	if checkdata.LibraryPropertiesLoadError() != nil {
@@ -205,6 +215,25 @@ func LibraryPropertiesDependsFieldNotInIndex() (result checkresult.Type, output
 	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 {
+		return checkresult.NotRun, ""
+	}
+
+	fieldValue, ok := checkdata.LibraryProperties().GetOk(fieldName)
+	if !ok {
+		return checkresult.NotRun, ""
+	}
+
+	replaced, diff := checkdata.MisspelledWordsReplacer().Replace(fieldValue)
+	if diff != nil {
+		return checkresult.Fail, replaced
+	}
+
+	return checkresult.Pass, ""
+}
+
 // nameInLibraryManagerIndex returns whether there is a library in Library Manager index using the given name.
 func nameInLibraryManagerIndex(name string) bool {
 	libraries := checkdata.LibraryManagerIndex()["libraries"].([]interface{})
diff --git a/check/checkfunctions/library_test.go b/check/checkfunctions/library_test.go
@@ -82,6 +82,28 @@ func TestLibraryPropertiesNameFieldNotInIndex(t *testing.T) {
 	checkCheckFunction(LibraryPropertiesNameFieldNotInIndex, testTables, t)
 }
 
+func TestLibraryPropertiesSentenceFieldSpellCheck(t *testing.T) {
+	testTables := []checkFunctionTestTable{
+		{"Unable to load", "InvalidLibraryProperties", checkresult.NotRun, ""},
+		{"Not defined", "MissingFields", checkresult.NotRun, ""},
+		{"Misspelled word", "MisspelledSentenceParagraphValue", checkresult.Fail, "^grill broccoli now$"},
+		{"Correct spelling", "Recursive", checkresult.Pass, ""},
+	}
+
+	checkCheckFunction(LibraryPropertiesSentenceFieldSpellCheck, testTables, t)
+}
+
+func TestLibraryPropertiesParagraphFieldSpellCheck(t *testing.T) {
+	testTables := []checkFunctionTestTable{
+		{"Unable to load", "InvalidLibraryProperties", checkresult.NotRun, ""},
+		{"Not defined", "MissingFields", checkresult.NotRun, ""},
+		{"Misspelled word", "MisspelledSentenceParagraphValue", checkresult.Fail, "^There is a zebra$"},
+		{"Correct spelling", "Recursive", checkresult.Pass, ""},
+	}
+
+	checkCheckFunction(LibraryPropertiesParagraphFieldSpellCheck, testTables, t)
+}
+
 func TestLibraryPropertiesDependsFieldNotInIndex(t *testing.T) {
 	testTables := []checkFunctionTestTable{
 		{"Unable to load", "InvalidLibraryProperties", checkresult.NotRun, ""},
diff --git a/check/checkfunctions/testdata/libraries/MissingFields/library.properties b/check/checkfunctions/testdata/libraries/MissingFields/library.properties
diff --git a/check/checkfunctions/testdata/libraries/MissingFields/src/MissingFields.h b/check/checkfunctions/testdata/libraries/MissingFields/src/MissingFields.h
diff --git a/check/checkfunctions/testdata/libraries/MisspelledSentenceParagraphValue/library.properties b/check/checkfunctions/testdata/libraries/MisspelledSentenceParagraphValue/library.properties
@@ -0,0 +1,9 @@
+name=MisspelledSentenceParagraphValue
+version=1.0.0
+author=Cristian Maglie <c.maglie@example.com>, Pippo Pluto <pippo@example.com>
+maintainer=Cristian Maglie <c.maglie@example.com>
+sentence=grill brocoli now
+paragraph=There is a zeebra
+category=Communication
+url=http://example.com/
+architectures=avr
diff --git a/check/checkfunctions/testdata/libraries/MisspelledSentenceParagraphValue/src/MisspelledSentenceParagraphValue.h b/check/checkfunctions/testdata/libraries/MisspelledSentenceParagraphValue/src/MisspelledSentenceParagraphValue.h
diff --git a/check/checkfunctions/testdata/libraries/Recursive/library.properties b/check/checkfunctions/testdata/libraries/Recursive/library.properties
@@ -0,0 +1,10 @@
+name=Recursive
+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
+includes=Recursive.h
diff --git a/check/checkfunctions/testdata/libraries/Recursive/src/Recursive.h b/check/checkfunctions/testdata/libraries/Recursive/src/Recursive.h
diff --git a/go.mod b/go.mod
@@ -6,6 +6,7 @@ require (
 	github.com/arduino/arduino-cli v0.0.0-20200922073731-53e3230c4f71
 	github.com/arduino/go-paths-helper v1.3.2
 	github.com/arduino/go-properties-orderedmap v1.4.0
+	github.com/client9/misspell v0.3.4
 	github.com/ory/jsonschema/v3 v3.0.1
 	github.com/sirupsen/logrus v1.6.0
 	github.com/spf13/cobra v1.0.1-0.20200710201246-675ae5f5a98c
diff --git a/go.sum b/go.sum
@@ -47,6 +47,7 @@ github.com/cenkalti/backoff/v3 v3.0.0/go.mod h1:cIeZDE3IrqwwJl6VUwCN6trj1oXrTS4r
 github.com/census-instrumentation/opencensus-proto v0.2.1/go.mod h1:f6KPmirojxKA12rnyqOA5BBL4O983OfeGPqjHWSTneU=
 github.com/cespare/xxhash v1.1.0/go.mod h1:XrSqR1VqqWfGrhpAt58auRo0WTKS1nRRg3ghfAqPWnc=
 github.com/cihub/seelog v0.0.0-20170130134532-f561c5e57575/go.mod h1:9d6lWj8KzO/fd/NrVaLscBKmPigpZpn5YawRPw+e3Yo=
+github.com/client9/misspell v0.3.4 h1:ta993UF76GwbvJcIo3Y68y/M3WxlpEHPWIGDkJYwzJI=
 github.com/client9/misspell v0.3.4/go.mod h1:qj6jICC3Q7zFZvVWo7KLAzC3yx5G7kyvSDkc90ppPyw=
 github.com/cmaglie/go.rice v1.0.3/go.mod h1:AF3bOWkvdOpp8/S3UL8qbQ4N7DiISIbJtj54GWFPAsc=
 github.com/cmaglie/pb v1.0.27/go.mod h1:GilkKZMXYjBA4NxItWFfO+lwkp59PLHQ+IOW/b/kmZI=

Original file line number	Diff line number	Diff line change
`@@ -27,6 +27,7 @@ import (`
`27`	`27`	`"github.com/arduino/arduino-check/result/feedback"`
`28`	`28`	`"github.com/arduino/go-paths-helper"`
`29`	`29`	`"github.com/arduino/go-properties-orderedmap"`
	`30`	`+ "github.com/client9/misspell"`
`30`	`31`	`"github.com/ory/jsonschema/v3"`
`31`	`32`	`"github.com/sirupsen/logrus"`
`32`	`33`	`)`
`@@ -61,6 +62,11 @@ func InitializeForLibrary(project project.Type, schemasPath *paths.Path) {`
`61`	`62`	`panic(err)`
`62`	`63`	`}`
`63`	`64`	`}`
	`65`	`+`
	`66`	`+ if misspelledWordsReplacer == nil { // The replacer only needs to be compiled once per run.`
	`67`	`+ misspelledWordsReplacer = misspell.New()`
	`68`	`+ misspelledWordsReplacer.Compile()`
	`69`	`+ }`
`64`	`70`	`}`
`65`	`71`
`66`	`72`	`var libraryPropertiesLoadError error`
`@@ -90,3 +96,10 @@ var libraryManagerIndex map[string]interface{}`
`90`	`96`	`func LibraryManagerIndex() map[string]interface{} {`
`91`	`97`	`return libraryManagerIndex`
`92`	`98`	`}`
	`99`	`+`
	`100`	`+var misspelledWordsReplacer *misspell.Replacer`
	`101`	`+`
	`102`	`+// MisspelledWordsReplacer returns the misspelled words replacer used for spell check.`
	`103`	`+func MisspelledWordsReplacer() *misspell.Replacer {`
	`104`	`+ return misspelledWordsReplacer`
	`105`	`+}`
-Original file line number
+Diff line change
 	github.com/arduino/arduino-cli v0.0.0-20200922073731-53e3230c4f71
 	github.com/arduino/go-paths-helper v1.3.2
 	github.com/arduino/go-properties-orderedmap v1.4.0
 +	github.com/client9/misspell v0.3.4
 	github.com/ory/jsonschema/v3 v3.0.1
 	github.com/sirupsen/logrus v1.6.0
 	github.com/spf13/cobra v1.0.1-0.20200710201246-675ae5f5a98c