Fixed golangci-lint errors and added new option for spinners

Author: talwat

.vscode/settings.json

@@ -17,6 +17,7 @@
         "Deps",
         "devmasx",
         "dont",
+        "exhaustruct",
         "forbidigo",
         "gmake",
         "GOARCH",

cmds.go

@@ -6,7 +6,7 @@ import (
 	"strings"
 )
 
-// List installed packages
+// List installed packages.
 func listPkgs() {
 	installedPkgs := make([]string, 0)
 	files := dirContents(infoPath, "An error occurred while getting list of installed packages")
@@ -23,7 +23,7 @@ func listPkgs() {
 	rawLog(strings.Join(installedPkgs, "\n") + "\n")
 }
 
-// Gets info for a package
+// Gets info for a package.
 func infoPkg(pkgName string) {
 	pkg := loadPkg(getPkgInfo(pkgName, isValidURL(pkgName)), pkgName)
 
@@ -58,7 +58,7 @@ func infoPkg(pkgName string) {
 	getNotes(pkg)
 }
 
-// Removes data for packages
+// Removes data for packages.
 func rmData(pkgNames []string) {
 	log(3, "Warning: This will remove the data for the selected packages stored in %s", mainPath)
 	log(3, "This will %snot%s run the uninstall commands.", textFx.Bold, RESETCOL)
@@ -82,7 +82,7 @@ func rmData(pkgNames []string) {
 	log(0, "Successfully deleted data.")
 }
 
-// Searches for a package
+// Searches for a package.
 func search(query string) {
 	initDirs(false)
 	loadConfig()
@@ -97,7 +97,7 @@ func search(query string) {
 	}
 }
 
-// Lists all packages in the repos
+// Lists all packages in the repos.
 func listAll() {
 	initDirs(false)
 	loadConfig()
@@ -112,7 +112,7 @@ func listAll() {
 	}
 }
 
-// Fetches and displays system & go info
+// Fetches and displays system & go info.
 func fetch() {
 	configExists := pathExists(configPath+"config.toml", "config file")
 
@@ -185,7 +185,7 @@ func fetch() {
 	}
 }
 
-// Runs help2man for indiepkg
+// Runs help2man for indiepkg.
 func help2man() {
 	log(1, "Compiling IndiePKG...")
 

config.go

@@ -40,6 +40,10 @@ type Progressbar struct {
 	BarEnd        string
 }
 
+type Progress struct {
+	CompileProgressIndicator string `toml:"compile_progress_indicator"`
+}
+
 type Config struct {
 	Paths Paths
 
@@ -48,6 +52,8 @@ type Config struct {
 	Progressbar Progressbar
 
 	Github Github
+
+	Progress Progress
 }
 
 var config Config = Config{
@@ -73,9 +79,13 @@ var config Config = Config{
 		"username",
 		"token",
 	},
+
+	Progress{
+		"spinner",
+	},
 }
 
-// Loads & reads configuration file
+// Loads & reads configuration file.
 func loadConfig() {
 	log(1, "Reading config file...")
 

defText.go

@@ -86,6 +86,12 @@ username = ""
 # Github access token, this should not expire and have no permissions granted for security purposes.
 # Information about getting a token is available here. https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token
 token = ""
+
+# Configures other progress indicators
+[progress]
+
+# Default: spinner. Valid values: spinner, dots
+compile_progress_indicator = "spinner" 
 `
 
 const defaultSources = `# Please only add sources you trust.

downloadURL.go

@@ -5,7 +5,7 @@ import (
 	"runtime"
 )
 
-// Gets the URL to download for a package
+// Gets the URL to download for a package.
 func getDownloadURL(pkg Package) string {
 	debugLog("GOOS: %s. GOARCH: %s", runtime.GOOS, runtime.GOARCH)
 

exec.go

@@ -4,9 +4,11 @@ import (
 	"bufio"
 	"os/exec"
 	"strings"
+
+	"github.com/talwat/indiepkg/spinner"
 )
 
-// Runs a command and prints the output to the terminal in real time
+// Runs a command and prints the output to the terminal in real time.
 func runCommandRealTime(workDir string, cmd string, args ...string) {
 	cmdObj := exec.Command(cmd, args...)
 	cmdObj.Dir = workDir
@@ -38,8 +40,26 @@ func runCommandRealTime(workDir string, cmd string, args ...string) {
 	errorLogNewlineBefore(err, "An error occurred while running command")
 }
 
-// Runs a command and displays dots to indicate progress
-func runCommandDot(workDir string, forceCmd bool, cmd string, args ...string) {
+// Runs a command and displays dots to indicate progress.
+func runCommandDot(commandName string, workDir string, forceCmd bool, cmd string, args ...string) {
+	spinner := spinner.Spinner{ // nolint:exhaustruct
+		Prefix: logType[1] + " Running command " + bolden(commandName) + " ",
+		SpinnerArt: []string{
+			textCol.Violet + "/" + RESETCOL,
+			textCol.Violet + "|" + RESETCOL,
+			textCol.Violet + "\\" + RESETCOL,
+			textCol.Violet + "-" + RESETCOL,
+		},
+	}
+
+	debugLog("Progress indicator: %s", config.Progress.CompileProgressIndicator)
+
+	if config.Progress.CompileProgressIndicator == "dots" {
+		logNoNewline(1, "Running command %s", bolden(commandName))
+	} else {
+		spinner.DisplaySpinner()
+	}
+
 	parsedCmd := strings.TrimPrefix(cmd, "!(FORCE)! ")
 	cmdObj := exec.Command(parsedCmd, args...)
 	cmdObj.Dir = workDir
@@ -65,7 +85,11 @@ func runCommandDot(workDir string, forceCmd bool, cmd string, args ...string) {
 		if debug {
 			rawLogf(logType[5]+(" %s\n"), scanner.Text())
 		} else {
-			rawLog(textCol.Violet + "." + RESETCOL)
+			if config.Progress.CompileProgressIndicator == "dots" {
+				rawLog(textCol.Violet + "." + RESETCOL)
+			} else {
+				spinner.DisplaySpinner()
+			}
 		}
 	}
 
@@ -79,7 +103,7 @@ func runCommandDot(workDir string, forceCmd bool, cmd string, args ...string) {
 	}
 }
 
-// Runs a command
+// Runs a command.
 func runCommand(workDir string, cmd string, args ...string) (string, error) {
 	cmdObj := exec.Command(cmd, args...)
 	cmdObj.Dir = workDir
@@ -92,7 +116,7 @@ func runCommand(workDir string, cmd string, args ...string) (string, error) {
 	return strings.TrimSuffix(string(data), "\n"), nil
 }
 
-// Check if a command exists
+// Check if a command exists.
 func checkIfCommandExists(cmd string) bool {
 	_, err := exec.LookPath(cmd)
 

files.go

@@ -2,7 +2,7 @@ package main
 
 import "strings"
 
-// Copies binaries to their proper location for a specific package
+// Copies binaries to their proper location for a specific package.
 func copyBins(pkg Package, srcPath string) {
 	if pkg.Bin == nil { // Safeguard to prevent nil pointer dereference
 		return
@@ -27,7 +27,7 @@ func copyBins(pkg Package, srcPath string) {
 	}
 }
 
-// Copies manpages to their proper location for a specific package
+// Copies manpages to their proper location for a specific package.
 func copyManpages(pkg Package, srcPath string) {
 	if len(pkg.Manpages) == 0 { // If package doesn't have manpages, return
 		return

funcs.go

@@ -6,7 +6,7 @@ import (
 	"strings"
 )
 
-// Check if a package is installed
+// Check if a package is installed.
 func pkgExists(pkgName string) bool {
 	pkgDispName := bolden(pkgName)
 
@@ -25,7 +25,7 @@ func pkgExists(pkgName string) bool {
 	}
 }
 
-// Runs an array of commands
+// Runs an array of commands.
 func runCmds(cmds []string, pkg Package, path string, cmdsLabel string) {
 	debugLog("Work dir: %s", path)
 
@@ -35,14 +35,13 @@ func runCmds(cmds []string, pkg Package, path string, cmdsLabel string) {
 		for _, cmd := range cmds {
 			parsedCmd := strings.TrimPrefix(cmd, "!(FORCE)! ")
 
-			logNoNewline(1, "Running command %s", bolden(parsedCmd))
-			runCommandDot(path, strings.HasPrefix(cmd, "!(FORCE)! "), strings.Split(parsedCmd, " ")[0], strings.Split(parsedCmd, " ")[1:]...)
+			runCommandDot(parsedCmd, path, strings.HasPrefix(cmd, "!(FORCE)! "), strings.Split(parsedCmd, " ")[0], strings.Split(parsedCmd, " ")[1:]...)
 			rawLog("\n")
 		}
 	}
 }
 
-// Creates required directories and files
+// Creates required directories and files.
 func initDirs(reset bool) {
 	if reset {
 		confirm("y", "Are you sure you want to reset the directories? This will reset your custom configuration & sources file. (y/n)")
@@ -70,7 +69,7 @@ func initDirs(reset bool) {
 	}
 }
 
-// Gets dependencies
+// Gets dependencies.
 func getDeps(deps *Deps) []string {
 	if deps != nil {
 		fullDepsList := deps.All
@@ -100,7 +99,7 @@ func getPkgNameFromURL(url string) string {
 	return strings.TrimSuffix(strings.Split(url, "/")[len(strings.Split(url, "/"))-1], ".json")
 }
 
-// Checks if all dependencies of a package are installed
+// Checks if all dependencies of a package are installed.
 func checkDeps(pkg Package) {
 	if pkgDispName := bolden(pkg.Name); !noDeps {
 		log(1, "Getting dependencies for %s...", pkgDispName)
@@ -131,7 +130,7 @@ func checkDeps(pkg Package) {
 	}
 }
 
-// Checks if all file dependencies of a package are installed
+// Checks if all file dependencies of a package are installed.
 func checkFileDeps(pkg Package) {
 	if pkgDispName := bolden(pkg.Name); !noDeps {
 		log(1, "Getting file dependencies for %s...", pkgDispName)
@@ -162,7 +161,7 @@ func checkFileDeps(pkg Package) {
 	}
 }
 
-// Parse sources file
+// Parse sources file.
 func parseSources() []string {
 	log(1, "Reading sources file...")
 
@@ -189,15 +188,15 @@ func parseSources() []string {
 	return finalList
 }
 
-// Prints notes for a package
+// Prints notes for a package.
 func getNotes(pkg Package) {
 	if len(pkg.Notes) > 0 {
 		log(1, bolden("Important note!"))
 		indent(strings.Join(pkg.Notes, "\n"))
 	}
 }
 
-// Displays a confirmation message when installing, uninstalling, etc... a package
+// Displays a confirmation message when installing, uninstalling, etc... a package.
 func displayPkgs(pkgNames []string, action string) {
 	log(1, "Are you sure you would like to %s the following packages:", bolden(action))
 
@@ -208,7 +207,7 @@ func displayPkgs(pkgNames []string, action string) {
 	confirm("y", "(y/n)")
 }
 
-// Checks if the user is root and suspends program if the user is root
+// Checks if the user is root and suspends program if the user is root.
 func checkRoot() {
 	if isRoot() {
 		if force || ignoreRoot {
@@ -221,13 +220,13 @@ func checkRoot() {
 	}
 }
 
-// Deletes temporary directory
+// Deletes temporary directory.
 func delTmp() {
 	log(1, "Deleting temporary directory...")
 	delPath(true, tmpPath, "An error occurred while deleting the temporary directory")
 }
 
-// Fully initializes all things for IndiePKG to function
+// Fully initializes all things for IndiePKG to function.
 func fullInit() {
 	chapLog("=>", "", "Initializing")
 	checkRoot()

get.go

@@ -6,13 +6,13 @@ import (
 	"strings"
 )
 
-// Writes a packages info to the proper location
+// Writes a packages info to the proper location.
 func writePkg(pkgName string, pkgFile string) {
 	log(1, "Writing package info for %s...", bolden(pkgName))
 	newFile(infoPath+pkgName+".json", pkgFile, "An error occurred while writing package information for %s", pkgName)
 }
 
-// Finds a packages info in the repos
+// Finds a packages info in the repos.
 func findPkg(pkgName string) string {
 	log(1, "Finding package %s...", bolden(pkgName))
 
@@ -110,7 +110,7 @@ func findPkg(pkgName string) string {
 	return ""
 }
 
-// Gets a packages info from the internet
+// Gets a packages info from the internet.
 func getPkgFromNet(pkgName string) (Package, string) {
 	packageFile := findPkg(pkgName)
 
@@ -119,7 +119,7 @@ func getPkgFromNet(pkgName string) (Package, string) {
 	return pkg, packageFile
 }
 
-// Gets a packages info from a URL
+// Gets a packages info from a URL.
 func getPkgFromURL(pkgName string, url string) string {
 	packageFile, statusCode, err := viewFile(url)
 	errorLog(err, "An error occurred while getting package information for %s", bolden(pkgName))
@@ -131,7 +131,7 @@ func getPkgFromURL(pkgName string, url string) string {
 	return packageFile
 }
 
-// Downloads data for a package directly
+// Downloads data for a package directly.
 func doDirectDownload(pkg Package, srcPath string) {
 	pkgDispName := bolden(pkg.Name)
 
@@ -153,7 +153,7 @@ func doDirectDownload(pkg Package, srcPath string) {
 	downloadFileWithProg(nameOfFile, url, "An error occurred while downloading file for %s", pkgDispName)
 }
 
-// Gets info for a package
+// Gets info for a package.
 func getPkgInfo(pkgName string, isURL bool) string {
 	var pkgFile string