digitalghost-dev / pl-cli Goto Github PK

Currently, the flag.NewFlagSet for the standings subcommand is in the main() function. By moving the new flag setup to it's own function, it'll help organize new flag sets in the future.

When using the -h or --help flag, it currently only works with the root command (pl-cli). Edit the usage with creating a new flag.NewFlagSet() for the standings subcommand.

Update the usage message to inform the user of data update frequency.

Remove the globally declared ctx context in standings.go.

Create a update_test.go file

Create a new file under cmd/ that deletes the standings.csv file.
Set flag options to -d and --delete

When considering the scalability of our project, it would be beneficial to manage the flags for each subcommand in separate configuration files.

Create a short and long flag for displaying standings:

• -s
• --standings

• Update help message by using tabs (\t) for spacing.
• Change usage message to pl-cli [subcommand]

In cmd/delete.go, edit return.Errorf("...") to lowercase and no newline. (ST1005)

Add better error handling and a print statement when the csv file doesn't exist in standings.go.

Separate the functions responsible for the commands into different files. For -s and --standings, this function is moved into standings.go.

Create a new function in standings.go that is responsible for fetching and parsing the CSV file. This will help in not having to repeat the same code for the new -c and --champions flag.

Goland IDE has flagged lines 54-56 in standings.go has redundant type conversions.

Change cli.go to accept new function name and argument from standings.go and delete.go.

Fix the module name in the go.mod file to github.com/digitalghost-dev/premier-league-cli

Instead of downloading the standings.csv file in order to read the data into a dataframe, read directly from the cloud bucket.

This will replace all current flags (-d, -s, -u) with a single sub-command: pl-cli standings in cli.go

Add a -c and --champions flag to the standings subcommand to print a table with the top four teams currently eligible for promotion to the Champions League.

Use the lipgloss library to render the table with color and other features instead of dataframe-go.

Replaced Printf with Errorf to return the error instead of retuning nil in delete.go.

Create an "update" flag to download a new standings.csv file.

When running the -h or --help flag, edit the standard output to better display usage.

Example:

Options:
    -s                    Prints current standings
    --standings           Prints current standings

Add missing update flag hints when using the -h or --help flag.

Update the usage message when using the -h or --help flag to reflect changes with the new subcommand: standings

The current checks to validate the provided arguments by the user aren't verbose enough to capture every potential case.

Enhancing the small section in the main() function to run through these checks before parsing the commands should help with this:

func main() {

       ...

	// Check the length of provided arguments
	if len(os.Args) < 2 {
            flag.Usage()
	    os.Exit(1)
	} else if len(os.Args) > 3 {
	    standings.Usage()
	    fmt.Println(errorColor.Render("Too many arguments\n"))
	    os.Exit(1)
	}

	// Check whether the provided command is valid
	if os.Args[1] != "standings" {
	    flag.Usage()
            fmt.Println(errorColor.Render("Not a valid command\n"))
	    os.Exit(1)
	}

        ...
}

If there are too many arguments, if len(os.Args) > 2, show the help message, print an error message and exit the program.

Create a test for delete.go

Add a welcome/description message when using the -h flag.

Apply formatting when using the -h or --help flag to make the content more legible. Also allow the usage of the -h and --help flag when only running the pl-cli command.

When the user types too many arguments, an incorrect flag, too few arguments, etc., display an error message with a red color font and describe the exact error.

Re-add a fmt.Println statement when checking if the file exists.

To improve the scalability of our project, especially with the addition of future subcommands, we should consider creating separate files for each subcommand's logic.