apply suggestions from code review and move file creation in functions for better readability

Author: umbynos

cmd/compile.go

@@ -7,6 +7,7 @@ package cmd
 import (
 	"bytes"
 	"encoding/json"
+	"fmt"
 	"os"
 	"os/exec"
 	"strings"
@@ -328,7 +329,22 @@ func createLib(sketchName, buildMcu, fqbn string, returnJson *ResultJson, objFil
 
 	// let's create the files
 
-	// create a library.properties file in the root dir of the lib
+	createLibraryPropertiesFile(sketchName, libDir)
+
+	createLibSketchHeaderFile(sketchName, srcDir, returnJson)
+
+	sketchFilePath := createSketchFile(sketchName, sketchDir)
+
+	createReadmeMdFile(sketchFilePath, libDir, workingDir, rootDir, returnJson)
+
+	createArchiveFile(sketchName, objFilePaths, srcDir)
+
+	createResultJsonFile(extraDir, returnJson)
+}
+
+// createLibraryPropertiesFile as the name suggests will create a library.properties file in the libDir,
+// the sketchName is required in order to correctly set the name of the "library"
+func createLibraryPropertiesFile(sketchName string, libDir *paths.Path) {
 	// the library.properties contains the following:
 	libraryProperties := `name=` + sketchName + `
 author=TODO
@@ -342,6 +358,15 @@ precompiled=true`
 	libraryPropertyPath := libDir.Join("library.properties")
 	createFile(libraryPropertyPath, libraryProperties)
 
+}
+
+// createLibSketchHeaderFile as the name suggests will create the libsketch header file,
+// the file will be created in the srcDir
+// This file has predeclarations of _setup() and _loop() functions declared originally in the main.cpp file (which is not included in the .a archive),
+// It is the counterpart of libsketch.a
+// we pass resultJson because from there we can extract infos regarding used libs
+// sketchName is used to name the file
+func createLibSketchHeaderFile(sketchName string, srcDir *paths.Path, returnJson *ResultJson) {
 	// we calculate the #include part to append at the beginning of the header file here with all the libraries used by the original sketch
 	var librariesIncludes []string
 	for _, lib := range returnJson.LibsInfo {
@@ -350,18 +375,19 @@ precompiled=true`
 		}
 	}
 
-	// create the header file in the src/ dir
-	// This file has predeclarations of _setup() and _loop() functions declared originally in the main.cpp file (which is not included in the .a archive),
-	// It is the counterpart of libsketch.a
 	// the libsketch.h contains the following:
 	libsketchHeader := strings.Join(librariesIncludes, "\n") + `
 void _setup();
 void _loop();`
 
 	libsketchFilePath := srcDir.Parent().Join("lib" + sketchName + ".h")
 	createFile(libsketchFilePath, libsketchHeader)
+}
 
-	// create the sketch file in the sketch-dist dir
+// createSketchFile as the name suggest will create the sketch which will be the entrypoint of the compilation with the arduino-cli
+// the sketch file will be created in the sketchDir
+// the sketchName argument is used to correclty include the right .h file
+func createSketchFile(sketchName string, sketchDir *paths.Path) *paths.Path {
 	// This one will include the libsketch.h and basically is the replacement of main.cpp
 	// the sketch.ino contains the following:
 	sketchFile := `#include <` + "lib" + sketchName + `.h>
@@ -373,13 +399,20 @@ void loop() {
 }`
 	sketchFilePath := sketchDir.Join(sketchName + ".ino")
 	createFile(sketchFilePath, sketchFile)
+	return sketchFilePath
+}
 
+// createReadmeMdFile is a helper function that is reposnible for the generation of the README.md file containing informations on how to reproduce the build environment
+// it takes the resultJson and some paths.Paths as input to do the required calculations.. The name of the arguments should be sufficient to understand
+func createReadmeMdFile(sketchFilePath, libDir, workingDir, rootDir *paths.Path, returnJson *ResultJson) {
 	// generate the commands to run to successfully reproduce the build environment, they will be used as content for the README.md
 	var readmeContent []string
 	readmeContent = append(readmeContent, "`arduino-cli core install "+returnJson.CoreInfo.Id+"@"+returnJson.CoreInfo.Version+"`")
-	for _, readmeLib := range returnJson.LibsInfo {
-		readmeContent = append(readmeContent, "`arduino-cli lib install "+readmeLib.Name+"@"+readmeLib.Version+"`")
+	libs := []string{}
+	for _, l := range returnJson.LibsInfo {
+		libs = append(libs, l.Name+"@"+l.Version)
 	}
+	readmeContent = append(readmeContent, fmt.Sprintf("`arduino-cli lib install %s`", strings.Join(libs, " ")))
 	// make the paths relative, absolute paths are too long and are different on the user machine
 	sketchFileRelPath, _ := sketchFilePath.RelFrom(workingDir)
 	libRelDir, _ := libDir.RelFrom(workingDir)
@@ -388,17 +421,19 @@ void loop() {
 	//create the README.md file containig instructions regarding what commands to run in order to have again a working binary
 	// the README.md contains the following:
 	readmeMd := `This package contains firmware code loaded in your product. 
-The firmware contains additional code licensed with LGPL clause; in order to re-compile the entire firmware bundle, please execute the following.
-
-## Install core and libraries
-` + strings.Join(readmeContent, "\n") + "\n" + `
-## Compile
-` + readmeCompile + "\n"
+	The firmware contains additional code licensed with LGPL clause; in order to re-compile the entire firmware bundle, please execute the following.
+	
+	## Install core and libraries
+	` + strings.Join(readmeContent, "\n") + "\n" + `
+	## Compile
+	` + readmeCompile + "\n"
 
 	readmeMdPath := rootDir.Join("README.md")
 	createFile(readmeMdPath, readmeMd)
+}
 
-	// run gcc-ar to create an archive containing all the object files except the main.cpp.o (we don't need it because we have created a substitute of it before ⬆️)
+// createArchiveFile function will run `gcc-ar` to create an archive containing all the object files except the main.cpp.o (we don't need it because we have created a substitute of it before: sketchfile.ino)
+func createArchiveFile(sketchName string, objFilePaths *paths.PathList, srcDir *paths.Path) {
 	// we exclude the main.cpp.o because we are going to link the archive libsketch.a against sketchName.ino
 	objFilePaths.FilterOutPrefix("main.cpp")
 	archivePath := srcDir.Join("lib" + sketchName + ".a")
@@ -413,6 +448,10 @@ The firmware contains additional code licensed with LGPL clause; in order to re-
 	} else {
 		logrus.Infof("created %s", archivePath.String())
 	}
+}
+
+// createResultJsonFile as the name suggests will generate the result.json file and save it in extraDir
+func createResultJsonFile(extraDir *paths.Path, returnJson *ResultJson) {
 	// save the result.json in the library extra dir
 	jsonFilePath := extraDir.Join("result.json")
 	if jsonContents, err := json.MarshalIndent(returnJson, "", " "); err != nil {