Add Linting Changes

Author: frenchie0x4ff

README.md

@@ -65,7 +65,7 @@ go build
 
 [xterm-256](https://github.com/gilliek/go-xterm256) - Color Printing To Terminal
 
-[neofetch](https://github.com/dylanaraps/neofetch) - Inspiration and Ascii Art
+[neofetch](https://github.com/dylanaraps/neofetch) - Inspiration and ASCII Art
 
 
 ## Contribution

config.go

@@ -6,23 +6,25 @@ import (
 	"os/user"
 )
 
+// Config Struct for Configuration File
 type Config struct {
-	Format           []string    `json:"format"`
-	ShowAscii        bool        `json:"showAscii"`
-	UseDefaultColors bool        `json:"useDefaultColors"`
-	UseSmallAscii    bool        `json:"useSmallAscii"`
-	AsciiColor       string      `json:"asciiColor"`
-	UseCustomAscii   bool        `json:"useCustomAscii"`
-	CustomAsciiPath  string      `json:"customAsciiPath"`
-	UserColor        string      `json:"userColor"`
-	SepColor         string      `json:"sepColor"`
-	TitleColor       string      `json:"titleColor"`
-	InfoColor        string      `json:"infoColor"`
-	Titles           TitleValues `json:"titles"`
-	AutoUpdate       bool        `json:"autoupdate"`
-	Version          int64       `json:"configVersion"`
+	Format           []string    `json:"format"`           // Format Array for Modules
+	ShowASCII        bool        `json:"showASCII"`        // True/False to Display ASCII
+	UseDefaultColors bool        `json:"useDefaultColors"` // Use Default Colors
+	UseSmallASCII    bool        `json:"useSmallASCII"`    // Use Small ASCII Art
+	ASCIIColor       string      `json:"ASCIIColor"`       // Change ASCII Color
+	UseCustomASCII   bool        `json:"useCustomASCII"`   // Use Custom ASCII TRUE/FALSE
+	CustomASCIIPath  string      `json:"customASCIIPath"`  // Absolute Path to Custom ASCII
+	UserColor        string      `json:"userColor"`        // Color for Username
+	SepColor         string      `json:"sepColor"`         // Color for Separator
+	TitleColor       string      `json:"titleColor"`       // Color for Title
+	InfoColor        string      `json:"infoColor"`        // Color for Information
+	Titles           TitleValues `json:"titles"`           // Title Struct
+	AutoUpdate       bool        `json:"autoupdate"`       // Should Auto Update?
+	Version          int64       `json:"configVersion"`    // Configuration Version
 }
 
+// TitleValues Struct for Title Strings
 type TitleValues struct {
 	Memory         string `json:"memory"`
 	CPU            string `json:"cpu"`
@@ -50,12 +52,12 @@ func updateConfig(config Config) {
 func newConfig() Config {
 	config := Config{}
 	config.Format = []string{"user", "sep", "uptime", "mem", "cpu", "procs", "cpuCores", "cpuThreads", "disk", "wversion", "gpus", "bios", "baseboard"}
-	config.ShowAscii = true
-	config.UseSmallAscii = false
-	config.UseCustomAscii = false
-	config.CustomAsciiPath = ""
+	config.ShowASCII = true
+	config.UseSmallASCII = false
+	config.UseCustomASCII = false
+	config.CustomASCIIPath = ""
 	config.UseDefaultColors = true
-	config.AsciiColor = "Blue"
+	config.ASCIIColor = "Blue"
 	config.UserColor = "Red"
 	config.SepColor = "Red"
 	config.TitleColor = "Green"

helpers.go

@@ -10,7 +10,7 @@ import (
 
 	hst "github.com/shirou/gopsutil/host"
 	ps "github.com/shirou/gopsutil/process"
-	// cp "github.com/shirou/gopsutil/cpu"
+
 	"github.com/gilliek/go-xterm256/xterm256"
 	"github.com/jaypipes/ghw"
 	"golang.org/x/sys/windows/registry"
@@ -25,6 +25,7 @@ func indexOf(element string, data []string) int {
 	return -1 //not found.
 }
 
+// Find - Find String inside String
 func Find(slice []string, val string) (int, bool) {
 	for i, item := range slice {
 		if item == val {
@@ -34,6 +35,7 @@ func Find(slice []string, val string) (int, bool) {
 	return -1, false
 }
 
+// RoundUp - Round Float Up To New Value
 func RoundUp(input float64, places int) (newVal float64) {
 	var round float64
 	pow := math.Pow(10, float64(places))
@@ -43,6 +45,7 @@ func RoundUp(input float64, places int) (newVal float64) {
 	return
 }
 
+// ByteFormat - Format Bytes to Human Readable
 func ByteFormat(inputNum float64, precision int) string {
 
 	if precision <= 0 {

main.go

@@ -4,14 +4,15 @@ import (
 	"bufio"
 	"encoding/json"
 	"fmt"
-	"github.com/gilliek/go-xterm256/xterm256"
 	"io/ioutil"
 	"log"
 	"net/http"
 	"os"
 	"os/user"
 	"strings"
 	"unicode/utf8"
+
+	"github.com/gilliek/go-xterm256/xterm256"
 )
 
 func getCustomColor(color string) xterm256.Color {
@@ -156,42 +157,42 @@ func main() {
 		}
 	}
 	var winArtResult []string
-	if config.UseSmallAscii {
+	if config.UseSmallASCII {
 		winArtResult = strings.Split(winArtSmall, "\n")
 	} else {
 		winArtResult = strings.Split(winArt, "\n")
 	}
-	if config.UseCustomAscii {
-		content, err := ioutil.ReadFile(config.CustomAsciiPath)
+	if config.UseCustomASCII {
+		content, err := ioutil.ReadFile(config.CustomASCIIPath)
 		if err != nil {
 			log.Fatal(err)
 		}
 		winArtResult = strings.Split(string(content), "\n")
 	}
 
 	title := xterm256.Green
-	ascii := xterm256.Blue
+	ASCII := xterm256.Blue
 	sep := xterm256.Red
 	userc := xterm256.Red
 	info := xterm256.White
 
 	if !config.UseDefaultColors {
 		title = getCustomColor(config.TitleColor)
-		ascii = getCustomColor(config.AsciiColor)
+		ASCII = getCustomColor(config.ASCIIColor)
 		sep = getCustomColor(config.SepColor)
 		userc = getCustomColor(config.UserColor)
 		info = getCustomColor(config.InfoColor)
 	}
 	s = generateInfo(config, title, info, userc, sep)
-	if config.ShowAscii {
+	if config.ShowASCII {
 		scanner := bufio.NewScanner(strings.NewReader(""))
-		if config.UseSmallAscii {
+		if config.UseSmallASCII {
 			scanner = bufio.NewScanner(strings.NewReader(winArtSmall))
 		} else {
 			scanner = bufio.NewScanner(strings.NewReader(winArt))
 		}
-		if config.UseCustomAscii {
-			content, err := ioutil.ReadFile(config.CustomAsciiPath)
+		if config.UseCustomASCII {
+			content, err := ioutil.ReadFile(config.CustomASCIIPath)
 			if err != nil {
 				log.Fatal(err)
 			}
@@ -203,12 +204,12 @@ func main() {
 			if len(winArtResult)-1 < i {
 				fmt.Println(strings.Repeat(" ", utf8.RuneCountInString(winArtResult[0])) + "    " + str)
 			} else {
-				fmt.Println(xterm256.Sprint(ascii, winArtResult[i]) + "    " + str)
+				fmt.Println(xterm256.Sprint(ASCII, winArtResult[i]) + "    " + str)
 			}
 		}
 		for scanner.Scan() {
 			if index >= len(s) {
-				fmt.Println(xterm256.Sprint(ascii, scanner.Text()))
+				fmt.Println(xterm256.Sprint(ASCII, scanner.Text()))
 			}
 			index++
 		}