lint

Author: publicarray

build.sh

@@ -28,6 +28,7 @@ usage() {
     echo "  package        create spk"
     echo "  dev            runs '_cp', 'compile' and 'package' commands"
     echo "  clean|clear    remove all *spk files"
+    echo "  lint           lint code"
     echo ""
 }
 
@@ -89,6 +90,7 @@ dependencies() {
 }
 
 compileAll() {
+    lint
     dependencies
 
     ## match arches to go build arches:
@@ -136,7 +138,6 @@ compile() {
     _ARCH="${1:-""}"
     _GOARM="${2:-""}"
     if command -v go > /dev/null; then
-        gofmt -s -w -- package/src/synoedit/*.go
         cd package || exit
         export GOPATH=$PWD
         cd src/synoedit || exit
@@ -211,6 +212,20 @@ package() {
         -- *
 }
 
+lint () {
+    gofmt -s -w -- package/src/synoedit/*.go
+    if ! command -v golint > /dev/null || ! command -v revive > /dev/null; then
+        go get -u golang.org/x/lint/golint
+    fi
+
+    if command -v golint > /dev/null; then
+        golint package/src/synoedit/*.go
+    elif command -v revive > /dev/null; then
+        revive package/src/synoedit/*.go
+    fi
+
+}
+
 CMD="${1:-""}"
 BUILD_ARCH="${2:-""}"
 if [ "$CMD" = "compress" ]; then
@@ -234,6 +249,8 @@ elif [ "$CMD" = "dev" ]; then
     package
 elif [ "$CMD" = "clean" ] || [ "$CMD" = "clear" ]; then
     clean
+elif [ "$CMD" = "lint" ]; then
+    lint
 else
     usage
 fi

package/src/synoedit/auth.go

@@ -60,7 +60,7 @@ func token() (string, error) {
 	}
 	token := r.FindSubmatch(cmdOut)
 	if len(token) < 1 {
-		return string(cmdOut), errors.New("Sorry, you need to login first!")
+		return string(cmdOut), errors.New("sorry, you need to login first")
 	}
 	return string(token[1]), nil
 }

package/src/synoedit/config.go

@@ -28,10 +28,12 @@ import (
 	"path/filepath"
 )
 
+// Config holds the configuration for many Applications specified in the toml database
 type Config struct {
 	Applications map[string]ApplicationConfig `toml:"app"`
 }
 
+// ApplicationConfig holds the configuration for a single Application
 type ApplicationConfig struct {
 	Name      string `toml:"name"`
 	Directory string `toml:"directory"`
@@ -42,6 +44,7 @@ type ApplicationConfig struct {
 	Action ActionConfig `toml:"action"`
 }
 
+// ActionConfig holds the configuration for an custom action for an Application
 type ActionConfig struct {
 	Label      string   `toml:"button_label"`
 	Exec       string   `toml:"exec"`
@@ -79,6 +82,8 @@ func verifyFile(filePath string, sha256checksum string) bool {
 }
 
 // borrowed from dnscrypt-proxy
+
+// ConfigLoad loads the configuration file
 func ConfigLoad(configFile *string) error {
 	foundConfigFile, err := findConfigFile(configFile)
 	if err != nil {

package/src/synoedit/http_response.go

@@ -99,7 +99,7 @@ func okHTML(str ...string) {
  * @param  strings message  The message to send
  */
 func jsonMessage(status int, message ...string) {
-	okJsonRes := NewHTTPResponse(200, "OK")
+	okJSONRes := NewHTTPResponse(200, "OK")
 	// RSM 1.2 Doesn't allow 'application/json' Content-Type to pass through!
 	// okJsonRes.ContentType = "application/json;\r\n"
 	jsonObj := &JSONResponse{
@@ -110,6 +110,6 @@ func jsonMessage(status int, message ...string) {
 	if err != nil {
 		panic(err)
 	}
-	okJsonRes.print(string(jsonBytes))
+	okJSONRes.print(string(jsonBytes))
 	os.Exit(0)
 }

package/src/synoedit/main.go

@@ -27,10 +27,13 @@ import (
 )
 
 const (
+	// AppVersion is the Program Version
 	AppVersion = "0.0.2"
-	// DefaultConfigFileName = "synoedit.toml"
-	DefaultDatabaseFileName       = "database.toml"
+	// DefaultDatabaseFileName is the main file name for database
+	DefaultDatabaseFileName = "database.toml"
+	// DefaultDatabaseSHA256Checksum is used to detect manipulation or corruption
 	DefaultDatabaseSHA256Checksum = "da745008c71cda6c993f5b448ada798978d28e0ba00e441190a9bcd17a50ad9c"
+	// DefaultConfigFileName = "synoedit.toml"
 )
 
 // Page contains the data that is passed to the template (layout.html)

package/src/synoedit/utils.go

@@ -37,7 +37,8 @@ func GetFilePath(appName string, fileName string) string {
 	return ""
 }
 
-// Look for command in $PATH or Check that file exits
+// CheckCmdExists returns true when the command (cmd)
+// is found in the $PATH variable or when the file exits
 func CheckCmdExists(cmd string) bool {
 	_, err := exec.LookPath(cmd)
 	if err != nil {
@@ -46,7 +47,7 @@ func CheckCmdExists(cmd string) bool {
 	return true
 }
 
-// Execute custom action given the application string
+// ExecuteAction runs a custom action given the application name
 func ExecuteAction(appName string) string {
 	if app, exists := config.Applications[appName]; exists {