Resolve some go lints

- Resolve some go comments lints
- Replace error.New(fmt.Sprintf statements with fmt.Errorf

Author: Eroui

commands/case.go

@@ -3,12 +3,13 @@ package commands
 import (
 	"bufio"
 	"fmt"
-	"github.com/chermehdi/egor/config"
-	"github.com/fatih/color"
-	"github.com/urfave/cli/v2"
 	"os"
 	"path"
 	"strconv"
+
+	"github.com/chermehdi/egor/config"
+	"github.com/fatih/color"
+	"github.com/urfave/cli/v2"
 )
 
 // Read from stdin till ctrl D or Command D
@@ -44,7 +45,7 @@ func writeLinesToFile(filename string, lines []string) error {
 	return nil
 }
 
-// Create and save user specified custom case input, and update the given egor meta data
+// AddNewCaseInput Create and save user specified custom case input, and update the given egor meta data
 func AddNewCaseInput(inputLines []string,
 	caseName string,
 	metaData config.EgorMeta) (config.EgorMeta, error) {
@@ -60,7 +61,7 @@ func AddNewCaseInput(inputLines []string,
 	return metaData, nil
 }
 
-// Create and save user specified custom csae output, and update the given egor meta data
+// AddNewCaseOutput Create and save user specified custom csae output, and update the given egor meta data
 func AddNewCaseOutput(outputLines []string,
 	caseName string,
 	metaData config.EgorMeta) (config.EgorMeta, error) {
@@ -76,7 +77,7 @@ func AddNewCaseOutput(outputLines []string,
 	return metaData, nil
 }
 
-// Create a user custom test case
+// CustomCaseAction Create a user custom test case
 func CustomCaseAction(context *cli.Context) error {
 	color.Green("Creating Custom Test Case...")
 
@@ -132,7 +133,7 @@ func CustomCaseAction(context *cli.Context) error {
 	return nil
 }
 
-// Command to add costum test cases to the current task.
+// CaseCommand Command to add costum test cases to the current task.
 // Running this command will ask the user to provide their input and output, then
 // saves the new test case data into appropriate files and add their meta data into
 // the current task egor meta data.

commands/config.go

@@ -1,7 +1,6 @@
 package commands
 
 import (
-	"errors"
 	"fmt"
 	"strconv"
 	"strings"
@@ -31,20 +30,20 @@ func UpdateConfiguration(config *config.Config, key, value string) error {
 		config.CustomTemplate[lang] = value
 	} else {
 		// Unknow key
-		return errors.New(fmt.Sprintf("Unknown configuration property %s", key))
+		return fmt.Errorf("Unknown configuration property %s", key)
 	}
 	return nil
 }
 
-// Sets the configuration property identified by the first argument
+// SetAction Sets the configuration property identified by the first argument
 // To the value identified by the second argument.
 // Note: The configuration keys are not case sensitive, if a configuration key provided
 // is not recognized, an error is thrown
 func SetAction(context *cli.Context) error {
 	argLen := context.Args().Len()
 	if argLen != 2 {
 		color.Red(fmt.Sprintln("Usage egor config set key value"))
-		return errors.New(fmt.Sprintf("Expected 2 parameters, got %d", argLen))
+		return fmt.Errorf("Expected 2 parameters, got %d", argLen)
 	}
 	key, value := context.Args().Get(0), context.Args().Get(1)
 
@@ -59,13 +58,13 @@ func SetAction(context *cli.Context) error {
 	return config.SaveConfiguration(configuration)
 }
 
-// Gets and prints the current configuration associted to the first argument,
+// GetAction Gets and prints the current configuration associted to the first argument,
 // or Prints all if no argument is specified
 func GetAction(context *cli.Context) error {
 	argLen := context.Args().Len()
 	if argLen > 1 {
 		color.Red(fmt.Sprintln("Usage egor config get <key?>"))
-		return errors.New(fmt.Sprintf("Expected at most 1 parameter, got %d", argLen))
+		return fmt.Errorf("Expected at most 1 parameter, got %d", argLen)
 	}
 	configuration, err := config.LoadDefaultConfiguration()
 	if err != nil {

commands/copy.go

@@ -2,16 +2,17 @@ package commands
 
 import (
 	"fmt"
+	"io/ioutil"
+	"os"
+	"path"
+
 	"github.com/atotto/clipboard"
 	"github.com/chermehdi/egor/config"
 	"github.com/fatih/color"
 	"github.com/urfave/cli/v2"
-	"io/ioutil"
-	"os"
-	"path"
 )
 
-// Load the content of a given file
+// GetFileContent Load the content of a given file
 func GetFileContent(filePath string) (string, error) {
 	filebytes, err := ioutil.ReadFile(filePath)
 	if err != nil {
@@ -65,7 +66,7 @@ func CopyAction(*cli.Context) error {
 	return nil
 }
 
-// Command to copy task source file to clipboard for easy submit.
+// CopyCommand Command to copy task source file to clipboard for easy submit.
 // Running this command will fetch egor meta data, get the content of the task source
 // and then copy the content to the clipboard.
 var CopyCommand = cli.Command{

commands/create.go

@@ -3,12 +3,13 @@ package commands
 import (
 	"bufio"
 	"fmt"
-	"github.com/chermehdi/egor/config"
-	"github.com/fatih/color"
-	"github.com/urfave/cli/v2"
 	"io"
 	"os"
 	"strings"
+
+	"github.com/chermehdi/egor/config"
+	"github.com/fatih/color"
+	"github.com/urfave/cli/v2"
 )
 
 func ReadLine(reader io.Reader) string {
@@ -93,7 +94,7 @@ func fillTaskFromQuestions(task *config.Task, reader io.Reader) error {
 	return nil
 }
 
-// Creates a task directory structure, either in a default manner (a task with a generic name, and default settings).
+// CreateTaskAction Creates a task directory structure, either in a default manner (a task with a generic name, and default settings).
 // Or by specifying the values in an interactive manner, if `-i` flag is specified.
 func CreateTaskAction(context *cli.Context) error {
 	// Default task containing default values.
@@ -133,7 +134,7 @@ func CreateTaskAction(context *cli.Context) error {
 	return nil
 }
 
-// Command will ask the user for a bunch of questions about the task name
+// CreateTaskCommand Command will ask the user for a bunch of questions about the task name
 // Input and outputs and other metadata required to create the task
 var CreateTaskCommand = cli.Command{
 	Name:      "create",

commands/parse.go

@@ -23,10 +23,10 @@ import (
 
 const listenAddr = ":4243"
 
-// TaskExistsError is an rror indicating the task directory exists. Used to be able to skip task creation and move the next one when parsing a contest.
-var TaskExistsError = errors.New("Task already exists, creation skipped!")
+// ErrTaskExists is an rror indicating the task directory exists. Used to be able to skip task creation and move the next one when parsing a contest.
+var ErrTaskExists = errors.New("Task already exists, creation skipped!")
 
-// Serialize task into a JSON string.
+// SerializeTask Serialize task into a JSON string.
 func SerializeTask(meta EgorMeta) (string, error) {
 	var buffer bytes.Buffer
 	encoder := json2.NewEncoder(&buffer)
@@ -40,7 +40,7 @@ func CreateDirectoryStructure(task Task, config Config, rootDir string, context
 	taskDir := path.Join(rootDir, task.Name)
 	if err := os.Mkdir(taskDir, 0777); err != nil {
 		if os.IsExist(err) {
-			return "", TaskExistsError
+			return "", ErrTaskExists
 		}
 		return "", err
 	}
@@ -234,7 +234,7 @@ func ParseAction(context *cli.Context) error {
 
 		taskDir, err := CreateDirectoryStructure(*task, *config, cwd, context)
 		if err != nil {
-			if err == TaskExistsError {
+			if err == ErrTaskExists {
 				color.Magenta("Skipping creating task %s as it already exists", task.Name)
 				continue
 			} else {
@@ -249,7 +249,7 @@ func ParseAction(context *cli.Context) error {
 	return nil
 }
 
-// Command to parse tasks from the `Competitive Companion` Chrome extension.
+// ParseCommand Command to parse tasks from the `Competitive Companion` Chrome extension.
 // Running this command, will start a server on the default port that the extension
 // uses, and will create a directory structure containing input files, expected output files,
 // and an additional `egor-meta.json` file, and finally your task file, which is usually a `main.cpp` or `Main.java`

commands/printcase.go

@@ -4,13 +4,14 @@ import (
 	"bufio"
 	"errors"
 	"fmt"
+	"os"
+	"path"
+	"strconv"
+
 	"github.com/chermehdi/egor/config"
 	"github.com/chermehdi/egor/utils"
 	"github.com/fatih/color"
 	"github.com/urfave/cli/v2"
-	"os"
-	"path"
-	"strconv"
 )
 
 func GetTestCase(egorMeta config.EgorMeta, id int) *TestCaseIO {
@@ -88,7 +89,7 @@ func PrintCaseAction(context *cli.Context) error {
 
 	if err != nil {
 		color.Red(fmt.Sprintf("Cannot parse test id = '%s', a number required!", context.Args().Get(0)))
-		return errors.New(fmt.Sprintf("Failed to parse test id = %s", context.Args().Get(0)))
+		return fmt.Errorf("Failed to parse test id = %s", context.Args().Get(0))
 	}
 
 	cwd, err := os.Getwd()
@@ -113,7 +114,7 @@ func PrintCaseAction(context *cli.Context) error {
 	testCase := GetTestCase(metaData, id)
 	if testCase == nil {
 		color.Red(fmt.Sprintf("Could not find test case with id = %d", id))
-		return errors.New(fmt.Sprintf("Unknown test case with id %d", id))
+		return fmt.Errorf("Unknown test case with id %d", id)
 	}
 
 	if !context.Bool("output-only") {
@@ -127,7 +128,7 @@ func PrintCaseAction(context *cli.Context) error {
 	return nil
 }
 
-// Command to print a test case. this command can be used to print inputs and/or outputs
+// PrintCaseCommand Command to print a test case. this command can be used to print inputs and/or outputs
 // to the consol. The user can choose to print the input only or the output only. The
 // user should provide a valid test id.
 // Running this command will fetch egor meta data, get the test case with the given id,

commands/run.go

@@ -2,7 +2,6 @@ package commands
 
 import (
 	"bytes"
-	"errors"
 	"fmt"
 	"io/ioutil"
 	"os"
@@ -43,7 +42,7 @@ type DiffChecker struct {
 func (c *DiffChecker) Check(got, expected string) error {
 	// Compare the trimmed output from both input and output
 	if strings.TrimRight(got, " \t\n\r") != strings.TrimRight(expected, " \t\n\r") {
-		return errors.New(fmt.Sprintf("Checker failed, expected:\n%s\nfound:\n%s", expected, got))
+		return fmt.Errorf("Checker failed, expected:\n%s\nfound:\n%s", expected, got)
 	}
 	return nil
 }
@@ -58,15 +57,15 @@ func (c *TokenChecker) Check(got, expected string) error {
 	inputTokens := strings.Fields(got)
 	outputTokens := strings.Fields(expected)
 	if len(inputTokens) != len(outputTokens) {
-		return errors.New(fmt.Sprintf("Checker failed, number of tokens different: expected %d, got %d\n\r",
-			len(outputTokens), len(inputTokens)))
+		return fmt.Errorf("Checker failed, number of tokens different: expected %d, got %d\n\r",
+			len(outputTokens), len(inputTokens))
 	}
 	i := 0
 	n := len(inputTokens)
 	for i < n {
 		if inputTokens[i] != outputTokens[i] {
-			return errors.New(fmt.Sprintf("Checker failed, token %d does not match: expected %s, got %s\n\r",
-				i, outputTokens[i], inputTokens[i]))
+			return fmt.Errorf("Checker failed, token %d does not match: expected %s, got %s\n\r",
+				i, outputTokens[i], inputTokens[i])
 		}
 		i = i + 1
 	}
@@ -473,7 +472,7 @@ func NewJudgeFor(meta config.EgorMeta, configuration *config.Config, checker Che
 	case "python":
 		return &PythonJudge{Meta: meta, checker: checker}, nil
 	}
-	return nil, errors.New(fmt.Sprintf("Cannot find judge for the given lang %s", meta.TaskLang))
+	return nil, fmt.Errorf("Cannot find judge for the given lang %s", meta.TaskLang)
 }
 
 // Resolve the checker by name, otherwise fallback to the DiffChecker

commands/showcases.go

@@ -1,12 +1,13 @@
 package commands
 
 import (
+	"os"
+	"path"
+
 	"github.com/chermehdi/egor/config"
 	"github.com/fatih/color"
 	"github.com/jedib0t/go-pretty/table"
 	"github.com/urfave/cli/v2"
-	"os"
-	"path"
 )
 
 type TestCaseIO struct {
@@ -17,7 +18,7 @@ type TestCaseIO struct {
 	Custom     bool
 }
 
-// parse input and output from egor meta to TestCase
+// GetTestCases parse input and output from egor meta to TestCase
 func GetTestCases(egorMeta config.EgorMeta) []*TestCaseIO {
 	testCasesMap := make(map[string]*TestCaseIO)
 	testCases := make([]*TestCaseIO, 0)
@@ -42,7 +43,7 @@ func GetTestCases(egorMeta config.EgorMeta) []*TestCaseIO {
 	return testCases
 }
 
-// print test cases table
+// PrintTestCasesTable print test cases table
 func PrintTestCasesTable(testCases []*TestCaseIO) {
 	t := table.NewWriter()
 	t.SetOutputMirror(os.Stdout)
@@ -60,12 +61,12 @@ func PrintTestCasesTable(testCases []*TestCaseIO) {
 	t.Render()
 }
 
-// print task test cases
+// PrintTestCases print task test cases
 func PrintTestCases(egorMeta config.EgorMeta) {
 	PrintTestCasesTable(GetTestCases(egorMeta))
 }
 
-// list test cases information command action
+// ShowCasesAction list test cases information command action
 // TODO(Eroui): [Refactoring] Duplicate code while loading meta data, consider refactoring...
 func ShowCasesAction(_ *cli.Context) error {
 	cwd, err := os.Getwd()
@@ -95,7 +96,7 @@ func ShowCasesAction(_ *cli.Context) error {
 	return nil
 }
 
-// Command to print the list of test cases input and outputs into the consol.
+// ShowCasesCommand Command to print the list of test cases input and outputs into the consol.
 // Running this command will fetch egor meta data and load all inputs and outputs meta data
 // and prints it as an array into the consol.
 var ShowCasesCommand = cli.Command{