Fix go-lint warnings

Author: cmuench

inotify-proxy.go

@@ -10,6 +10,7 @@ import (
 	"strings"
 )
 
+// Version defines the version of the application. This variable will be overridden by build system
 var Version = "dev"
 
 func main() {

internal/config/config.go

@@ -6,22 +6,26 @@ import (
 	"io/ioutil"
 )
 
+// Config is the root struct for the application configuration
 type Config struct {
 	Entries []WatchEntry `yaml:"watch"`
 
 	OldGlobalProfile *string `yaml:"profile"`
 }
 
+// WatchEntry is the configuration of one watch entry (directory) which is handled in a separate go-routine
 type WatchEntry struct {
 	Directory  string   `yaml:"directory"`
 	Extensions []string `yaml:"extensions"`
 	Profile    *string  `yaml:"profile"`
 }
 
+// AddEntry allows to add a new directory watch
 func (c *Config) AddEntry(e WatchEntry) {
 	c.Entries = append(c.Entries, e)
 }
 
+// GetEntryByDirectory returns the watch configuration of a given directory
 func (c *Config) GetEntryByDirectory(dir string) WatchEntry {
 	for _, e := range c.Entries {
 		if e.Directory == dir {
@@ -32,6 +36,7 @@ func (c *Config) GetEntryByDirectory(dir string) WatchEntry {
 	return WatchEntry{}
 }
 
+// Read a configuration from a file or other resource
 func Read(f io.Reader) (Config, error) {
 	var (
 		c        Config
@@ -49,6 +54,7 @@ func Read(f io.Reader) (Config, error) {
 	return c, err
 }
 
+// Parse the config data and return a Config object
 func Parse(yamlData []byte) (Config, error) {
 	var c Config
 	err := yaml.Unmarshal(yamlData, &c)

internal/profile/types.go

@@ -1,33 +1,41 @@
 package profile
 
+// Profile is the base type of any profile
 type Profile struct {
 	Extensions []string
 }
 
+// Default is the default profile which allows all extensions
 var Default = Profile{
 	Extensions: []string{"*"},
 }
 
+// LESS allows only .less extension
 var LESS = Profile{
 	Extensions: []string{".less"},
 }
 
+// Magento2Theme allows only extensions of a Magento 2 Theme
 var Magento2Theme = Profile{
 	Extensions: []string{".css", ".js", ".less", ".sass", ".ts"},
 }
 
+// Magento2Theme allows only extensions required for development of a Magento 2 Module / Extension
 var Magento2 = Profile{
 	Extensions: []string{".css", ".html", ".less", ".sass", ".js", ".php", ".phtml", ".ts", ".xml"},
 }
 
+// SASS allow only extensions related to the SASS tool
 var SASS = Profile{
 	Extensions: []string{".sass", ".scss"},
 }
 
+// VueStorefront allow only extensions related to vue-storefront projects
 var VueStorefront = Profile{
 	Extensions: []string{".css", ".js", ".sass", ".ts"},
 }
 
+// VueStorefront allow only .js (Javascript) and .ts (Typescript) extension
 var Javascript = Profile{
 	Extensions: []string{".js", ".ts"},
 }

internal/profile/validator/path.go

@@ -7,14 +7,15 @@ import (
 	"strings"
 )
 
+// IsPathValid checks if a path matches criteria to be included in watch process
 func IsPathValid(path string, entryConfig config.WatchEntry) bool {
 
 	if !isAllowedDirectory(path) {
 		return false
 	}
 
 	if len(entryConfig.Extensions) > 0 && !isAllowedFileExtension(path, entryConfig.Extensions) {
-		 return false
+		return false
 	}
 
 	if entryConfig.Profile == nil {

internal/util/file.go

@@ -2,6 +2,7 @@ package util
 
 import "os"
 
+// FileExists checks if a file or directory exists in the filesystem
 func FileExists(path string) bool {
 	info, err := os.Stat(path)
 

internal/watcher/types.go

@@ -1,9 +1,8 @@
 package watcher
 
+// NodeInfo contains the required information for a file to watch
 type NodeInfo struct {
 	modificationUnixTime int64
 }
 
 var fileMap = make(map[string]NodeInfo)
-
-var selectedProfile = ""

internal/watcher/watcher.go

@@ -14,6 +14,7 @@ import (
 var mu sync.Mutex
 var wg sync.WaitGroup
 
+// Watch starts the watch process of a defined directories of the given configuration
 func Watch(c config.Config, watchFrequenceSeconds int) {
 	i := 0
 
@@ -112,7 +113,7 @@ func isFileChanged(path string) bool {
 func garbageCollection() {
 	mu.Lock()
 	defer mu.Unlock()
-	for path, _ := range fileMap {
+	for path := range fileMap {
 		if !util.FileExists(path) {
 			delete(fileMap, path)
 			color.Style{color.FgGray}.Printf("Deleted: %s\n", path)