Merge pull request #42 from arduino/per1234/paragraph-repeats-sentence-check

Add check for library.properties paragraph repeating sentence

Author: per1234

Diff for: check/checkconfigurations/checkconfigurations.go

@@ -491,6 +491,21 @@ var configurations = []Type{
 		ErrorModes:      nil,
 		CheckFunction:   checkfunctions.LibraryPropertiesParagraphFieldSpellCheck,
 	},
+	{
+		ProjectType:     projecttype.Library,
+		Category:        "library.properties",
+		Subcategory:     "paragraph field",
+		ID:              "",
+		Brief:           "paragraph repeats sentence",
+		Description:     "",
+		MessageTemplate: "The library.properties paragraph field repeats the sentence field. These are displayed together so redundancy is not needed.",
+		DisableModes:    nil,
+		EnableModes:     []checkmode.Type{checkmode.All},
+		InfoModes:       nil,
+		WarningModes:    []checkmode.Type{checkmode.All},
+		ErrorModes:      nil,
+		CheckFunction:   checkfunctions.LibraryPropertiesParagraphFieldRepeatsSentence,
+	},
 	{
 		ProjectType:     projecttype.Library,
 		Category:        "library.properties",

Diff for: check/checkfunctions/library.go

@@ -471,6 +471,25 @@ func LibraryPropertiesParagraphFieldSpellCheck() (result checkresult.Type, outpu
 	return spellCheckLibraryPropertiesFieldValue("paragraph")
 }
 
+// LibraryPropertiesParagraphFieldRepeatsSentence checks whether the library.properties `paragraph` value repeats the `sentence` value.
+func LibraryPropertiesParagraphFieldRepeatsSentence() (result checkresult.Type, output string) {
+	if checkdata.LibraryPropertiesLoadError() != nil {
+		return checkresult.NotRun, ""
+	}
+
+	sentence, hasSentence := checkdata.LibraryProperties().GetOk("sentence")
+	paragraph, hasParagraph := checkdata.LibraryProperties().GetOk("paragraph")
+
+	if !hasSentence || !hasParagraph {
+		return checkresult.NotRun, ""
+	}
+
+	if strings.HasPrefix(paragraph, sentence) {
+		return checkresult.Fail, ""
+	}
+	return checkresult.Pass, ""
+}
+
 // 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 {

Diff for: check/checkfunctions/library_test.go

@@ -115,6 +115,16 @@ func TestLibraryPropertiesParagraphFieldSpellCheck(t *testing.T) {
 	checkCheckFunction(LibraryPropertiesParagraphFieldSpellCheck, testTables, t)
 }
 
+func TestLibraryPropertiesParagraphFieldRepeatsSentence(t *testing.T) {
+	testTables := []checkFunctionTestTable{
+		{"Unable to load", "InvalidLibraryProperties", checkresult.NotRun, ""},
+		{"Repeat", "ParagraphRepeatsSentence", checkresult.Fail, ""},
+		{"No repeat", "Recursive", checkresult.Pass, ""},
+	}
+
+	checkCheckFunction(LibraryPropertiesParagraphFieldRepeatsSentence, testTables, t)
+}
+
 func TestLibraryPropertiesDependsFieldNotInIndex(t *testing.T) {
 	testTables := []checkFunctionTestTable{
 		{"Unable to load", "InvalidLibraryProperties", checkresult.NotRun, ""},

Diff for: check/checkfunctions/testdata/libraries/ParagraphRepeatsSentence/library.properties

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