Add check for library folder exceeding maximum length

Author: per1234

check/checkconfigurations/checkconfigurations.go

@@ -881,6 +881,21 @@ var configurations = []Type{
 		ErrorModes:      []checkmode.Type{checkmode.Default},
 		CheckFunction:   checkfunctions.ProhibitedCharactersInSketchFileName,
 	},
+	{
+		ProjectType:     projecttype.Library,
+		Category:        "structure",
+		Subcategory:     "",
+		ID:              "",
+		Brief:           "folder name too long",
+		Description:     "This will be problematic for people doing manual installation of the library.",
+		MessageTemplate: "Folder name {{.}} exceeds maximum length. See: https://arduino.github.io/arduino-cli/latest/library-specification/#library-root-folder",
+		DisableModes:    nil,
+		EnableModes:     []checkmode.Type{checkmode.All},
+		InfoModes:       nil,
+		WarningModes:    []checkmode.Type{checkmode.Permissive},
+		ErrorModes:      []checkmode.Type{checkmode.Default},
+		CheckFunction:   checkfunctions.LibraryFolderNameGTMaxLength,
+	},
 	{
 		ProjectType:     projecttype.Sketch,
 		Category:        "structure",

check/checkfunctions/library.go

@@ -938,6 +938,15 @@ func ProhibitedCharactersInLibraryFolderName() (result checkresult.Type, output
 	return checkresult.Pass, ""
 }
 
+// LibraryFolderNameGTMaxLength checks if the library folder name exceeds the maximum length.
+func LibraryFolderNameGTMaxLength() (result checkresult.Type, output string) {
+	if len(checkdata.ProjectPath().Base()) > 63 {
+		return checkresult.Fail, checkdata.ProjectPath().Base()
+	}
+
+	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

@@ -251,3 +251,12 @@ func TestProhibitedCharactersInLibraryFolderName(t *testing.T) {
 
 	checkLibraryCheckFunction(ProhibitedCharactersInLibraryFolderName, testTables, t)
 }
+
+func TestLibraryFolderNameGTMaxLength(t *testing.T) {
+	testTables := []libraryCheckFunctionTestTable{
+		{"Has folder name > max length", "FolderNameTooLong12345678901234567890123456789012345678901234567890", checkresult.Fail, "^FolderNameTooLong12345678901234567890123456789012345678901234567890$"},
+		{"Folder name <= max length", "Recursive", checkresult.Pass, ""},
+	}
+
+	checkLibraryCheckFunction(LibraryFolderNameGTMaxLength, testTables, t)
+}

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

@@ -0,0 +1,9 @@
+name=FolderNameTooLong
+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=Supports HTTP1.1 and you can do GET and POST.
+category=Communication
+url=http://example.com/
+architectures=avr