Merge pull request #107 from digitalghost-dev/0.12.2

0.12.2

Author: digitalghost-dev

.github/workflows/ci.yml

@@ -26,7 +26,7 @@ on:
       - main
 
 env:
-  VERSION_NUMBER: 'v0.12.1'
+  VERSION_NUMBER: 'v0.12.2'
   DOCKERHUB_REGISTRY_NAME: 'digitalghostdev/poke-cli'
   AWS_REGION: 'us-west-2'
 

.goreleaser.yaml

@@ -14,7 +14,7 @@ builds:
       - windows
       - darwin
     ldflags:
-      - -s -w -X main.version=v0.12.1
+      - -s -w -X main.version=v0.12.2
 
 archives:
   - format: tar.gz

Dockerfile

@@ -8,7 +8,7 @@ RUN go mod download
 
 COPY . .
 
-RUN go build -ldflags "-X main.version=v0.12.1" -o poke-cli .
+RUN go build -ldflags "-X main.version=v0.12.2" -o poke-cli .
 
 # build 2
 FROM gcr.io/distroless/static-debian12:nonroot

README.md

@@ -2,7 +2,7 @@
     <img height="250" width="350" src="pokemon.svg" alt="pokemon-logo"/>
     <h1>Pokémon CLI</h1>
     <img src="https://img.shields.io/github/v/release/digitalghost-dev/poke-cli?style=flat-square&logo=git&logoColor=FFCC00&label=Release%20Version&labelColor=EEE&color=FFCC00" alt="version-label">
-    <img src="https://img.shields.io/docker/image-size/digitalghostdev/poke-cli/v0.12.1?arch=arm64&style=flat-square&logo=docker&logoColor=FFCC00&labelColor=EEE&color=FFCC00" alt="docker-image-size">
+    <img src="https://img.shields.io/docker/image-size/digitalghostdev/poke-cli/v0.12.2?arch=arm64&style=flat-square&logo=docker&logoColor=FFCC00&labelColor=EEE&color=FFCC00" alt="docker-image-size">
     <img src="https://img.shields.io/github/actions/workflow/status/digitalghost-dev/poke-cli/ci.yml?branch=main&style=flat-square&logo=github&logoColor=FFCC00&label=CI&labelColor=EEE&color=FFCC00" alt="ci-status-badge">
 </div>
 <div align="center">
@@ -12,10 +12,10 @@
 </div>
 
 ## Overview
-A CLI tool for viewing data about Pokémon from your terminal! I am new to writing Go and taking my time in building this 
+`poke-cli` is a hybrid of a classic CLI and modern TUI tool for viewing data about Pokémon! I am new to writing Go and taking my time in building this 
 project. 
 
-My aim is to have five commands finished for `v1.0.0`. Read more in the [Roadmap](#roadmap) section.
+My aim is to have eight commands finished for `v1.0.0`. Read more in the [Roadmap](#roadmap) section.
 
 ---
 ## Demo
@@ -68,7 +68,7 @@ _Use a Docker Image_
      * Necessary.
 
 ```bash
-docker run --rm -i -t digitalghostdev/poke-cli:v0.12.1 <command> [subcommand] flag]
+docker run --rm -i -t digitalghostdev/poke-cli:v0.12.2 <command> [subcommand] flag]
 ```
 
 ### Go Install
@@ -115,15 +115,20 @@ The architecture behind how the tool works is straight forward.
 
 _Not 100% up-to-date, may add or remove some of these choices_
 
+Below are the commands and flags that are planned for `v1.0.0`
+
 - [x] `ability`: get data about a specific ability.
     - [x] `-p | --pokemon`: display Pokémon that learn this ability.
+- [ ] `berry`: get data about a specific berry.
 - [ ] `move`: get data about a specific move.
     - [ ] `-p | --pokemon`: display Pokémon that learn this move.
 - [x] `natures`: get data about natures.
 - [ ] `pokemon`: get data about a specific Pokémon.
-   - [x] `-a | --abilities`: display the Pokémon's abilities.
-   - [x] `-i | --image`: display a pixel image of the Pokémon.
-   - [x] `-s | --stats`: display the Pokémon's base stats.
-   - [x] `-t | --types`: display the Pokémon's typing.
-   - [ ] `-m | --moves`: display learnable moves.
+    - [x] `-a | --abilities`: display the Pokémon's abilities.
+    - [x] `-i | --image`: display a pixel image of the Pokémon.
+    - [x] `-s | --stats`: display the Pokémon's base stats.
+    - [x] `-t | --types`: display the Pokémon's typing.
+    - [ ] `-m | --moves`: display learnable moves.
+- [ ] `search`: search for a resource (`ability`, `berry`, `pokemon`, `move`)
+- [ ] `speed`: compare speed stats between two Pokémon.
 - [x] `types`: get data about a specific typing.

cli.go

@@ -3,24 +3,13 @@ package main
 import (
 	"flag"
 	"fmt"
-	"github.com/charmbracelet/lipgloss"
 	"github.com/digitalghost-dev/poke-cli/cmd"
 	"github.com/digitalghost-dev/poke-cli/flags"
+	"github.com/digitalghost-dev/poke-cli/styling"
 	"os"
 	"runtime/debug"
 )
 
-var (
-	styleBold  = lipgloss.NewStyle().Bold(true)
-	helpBorder = lipgloss.NewStyle().
-			BorderStyle(lipgloss.RoundedBorder()).
-			BorderForeground(lipgloss.Color("#FFCC00"))
-	errorColor  = lipgloss.NewStyle().Foreground(lipgloss.Color("#F2055C"))
-	errorBorder = lipgloss.NewStyle().
-			BorderStyle(lipgloss.RoundedBorder()).
-			BorderForeground(lipgloss.Color("#F2055C"))
-)
-
 var version = "(devel)"
 
 func currentVersion() {
@@ -56,21 +45,21 @@ func runCLI(args []string) int {
 	shortCurrentVersionFlag := mainFlagSet.Bool("v", false, "Prints the current version")
 
 	mainFlagSet.Usage = func() {
-		helpMessage := helpBorder.Render(
+		helpMessage := styling.HelpBorder.Render(
 			"Welcome! This tool displays data related to Pokémon!",
-			"\n\n", styleBold.Render("USAGE:"),
+			"\n\n", styling.StyleBold.Render("USAGE:"),
 			fmt.Sprintf("\n\t%-15s %s", "poke-cli [flag]", ""),
 			fmt.Sprintf("\n\t%-15s %s", "poke-cli <command> [flag]", ""),
 			fmt.Sprintf("\n\t%-15s %s", "poke-cli <command> <subcommand> [flag]", ""),
-			"\n\n", styleBold.Render("FLAGS:"),
+			"\n\n", styling.StyleBold.Render("FLAGS:"),
 			fmt.Sprintf("\n\t%-15s %s", "-h, --help", "Shows the help menu"),
 			fmt.Sprintf("\n\t%-15s %s", "-l, --latest", "Prints the latest version available"),
 			fmt.Sprintf("\n\t%-15s %s", "-v, --version", "Prints the current version"),
-			"\n\n", styleBold.Render("COMMANDS:"),
+			"\n\n", styling.StyleBold.Render("COMMANDS:"),
 			fmt.Sprintf("\n\t%-15s %s", "ability", "Get details about an ability"),
-			fmt.Sprintf("\n\t%-15s %s", "natures", "Get details about Pokémon natures"),
-			fmt.Sprintf("\n\t%-15s %s", "pokemon", "Get details about a specific Pokémon"),
-			fmt.Sprintf("\n\t%-15s %s", "types", "Get details about a specific typing"),
+			fmt.Sprintf("\n\t%-15s %s", "natures", "Get details about all natures"),
+			fmt.Sprintf("\n\t%-15s %s", "pokemon", "Get details about a Pokémon"),
+			fmt.Sprintf("\n\t%-15s %s", "types", "Get details about a typing"),
 		)
 		fmt.Println(helpMessage)
 	}
@@ -112,15 +101,15 @@ func runCLI(args []string) int {
 		return 0
 	} else {
 		command := os.Args[1]
-		errMessage := errorBorder.Render(
-			errorColor.Render("Error!"),
+		errMessage := styling.ErrorBorder.Render(
+			styling.ErrorColor.Render("Error!"),
 			fmt.Sprintf("\n\t%-15s", fmt.Sprintf("'%s' is not a valid command.\n", command)),
-			styleBold.Render("\nCommands:"),
+			styling.StyleBold.Render("\nCommands:"),
 			fmt.Sprintf("\n\t%-15s %s", "ability", "Get details about an ability"),
-			fmt.Sprintf("\n\t%-15s %s", "natures", "Get details about Pokémon natures"),
-			fmt.Sprintf("\n\t%-15s %s", "pokemon", "Get details about a specific Pokémon"),
-			fmt.Sprintf("\n\t%-15s %s", "types", "Get details about a specific typing"),
-			fmt.Sprintf("\n\nAlso run %s for more info!", styleBold.Render("poke-cli -h")),
+			fmt.Sprintf("\n\t%-15s %s", "natures", "Get details about all natures"),
+			fmt.Sprintf("\n\t%-15s %s", "pokemon", "Get details about a Pokémon"),
+			fmt.Sprintf("\n\t%-15s %s", "types", "Get details about a typing"),
+			fmt.Sprintf("\n\nAlso run %s for more info!", styling.StyleBold.Render("poke-cli -h")),
 		)
 		fmt.Printf("%s\n", errMessage)
 		return 1

cli_test.go

@@ -173,7 +173,7 @@ func TestRunCLI(t *testing.T) {
 		{
 			name:           "Latest Flag",
 			args:           []string{"-l"},
-			expectedOutput: "Latest Docker image version: v0.12.0\nLatest release tag: v0.12.0\n",
+			expectedOutput: "Latest Docker image version: v0.12.1\nLatest release tag: v0.12.1\n",
 			expectedCode:   0,
 		},
 	}

cmd/ability.go

@@ -5,6 +5,7 @@ import (
 	"fmt"
 	"github.com/digitalghost-dev/poke-cli/connections"
 	"github.com/digitalghost-dev/poke-cli/flags"
+	"github.com/digitalghost-dev/poke-cli/styling"
 	"golang.org/x/text/cases"
 	"golang.org/x/text/language"
 	"os"
@@ -14,13 +15,13 @@ import (
 func AbilityCommand() {
 
 	flag.Usage = func() {
-		helpMessage := helpBorder.Render(
+		helpMessage := styling.HelpBorder.Render(
 			"Get details about a specific ability.\n\n",
-			styleBold.Render("USAGE:"),
-			fmt.Sprintf("\n\t%s %s %s %s", "poke-cli", styleBold.Render("ability"), "<ability-name>", "[flag]"),
-			fmt.Sprintf("\n\t%-30s", styleItalic.Render("Use a hyphen when typing a name with a space.")),
+			styling.StyleBold.Render("USAGE:"),
+			fmt.Sprintf("\n\t%s %s %s %s", "poke-cli", styling.StyleBold.Render("ability"), "<ability-name>", "[flag]"),
+			fmt.Sprintf("\n\t%-30s", styling.StyleItalic.Render("Use a hyphen when typing a name with a space.")),
 			"\n\n",
-			styleBold.Render("FLAGS:"),
+			styling.StyleBold.Render("FLAGS:"),
 			fmt.Sprintf("\n\t%-30s %s", "-p, --pokemon", "Prints Pokémon that learn this ability."),
 			fmt.Sprintf("\n\t%-30s %s", "-h, --help", "Prints the help menu."),
 		)
@@ -69,7 +70,7 @@ func AbilityCommand() {
 	}
 
 	capitalizedEffect := cases.Title(language.English).String(strings.Replace(abilityName, "-", " ", -1))
-	fmt.Println(styleBold.Render(capitalizedEffect))
+	fmt.Println(styling.StyleBold.Render(capitalizedEffect))
 	fmt.Println("Effect:", englishShortEffect)
 
 	if *pokemonFlag || *shortPokemonFlag {

cmd/ability_test.go

@@ -3,6 +3,7 @@ package cmd
 import (
 	"bytes"
 	"fmt"
+	"github.com/digitalghost-dev/poke-cli/styling"
 	"log"
 	"os"
 	"strings"
@@ -61,7 +62,7 @@ func TestAbilityCommand(t *testing.T) {
 		{
 			name:           "Valid Execution",
 			args:           []string{"ability", "stench"},
-			expectedOutput: stripANSI("Stench\nEffect: Has a 10% chance of making target Pokémon flinch with each hit."),
+			expectedOutput: styling.StripANSI("Stench\nEffect: Has a 10% chance of making target Pokémon flinch with each hit."),
 			expectError:    false,
 		},
 	}

cmd/natures.go

@@ -5,19 +5,17 @@ import (
 	"fmt"
 	"github.com/charmbracelet/lipgloss"
 	"github.com/charmbracelet/lipgloss/table"
+	"github.com/digitalghost-dev/poke-cli/styling"
 	"os"
 )
 
 func NaturesCommand() {
 
 	flag.Usage = func() {
-		helpMessage := helpBorder.Render(
-			"Get details about Pokémon natures.\n\n",
-			styleBold.Render("USAGE:"),
-			fmt.Sprintf("\n\t%s %s %s", "poke-cli", styleBold.Render("natures"), "[flag]"),
-			"\n\n",
-			styleBold.Render("FLAGS:"),
-			fmt.Sprintf("\n\t%-30s %s", "-h, --help", "Prints out the help menu."),
+		helpMessage := styling.HelpBorder.Render(
+			"Get details about all natures.\n\n",
+			styling.StyleBold.Render("USAGE:"),
+			fmt.Sprintf("\n\t%s %s", "poke-cli", styling.StyleBold.Render("natures")),
 		)
 		fmt.Println(helpMessage)
 	}
@@ -32,20 +30,20 @@ func NaturesCommand() {
 	fmt.Println("Natures affect the growth of a Pokémon.\n" +
 		"Each nature increases one of its stats by 10% and decreases one by 10%.\n" +
 		"Five natures increase and decrease the same stat and therefore have no effect.\n\n" +
-		styleBold.Render("Nature Chart:"))
+		styling.StyleBold.Render("Nature Chart:"))
 
 	chart := [][]string{
-		{" ", red.Render("-Attack"), red.Render("-Defense"), red.Render("-Sp. Atk"), red.Render("-Sp. Def"), red.Render("Speed")},
-		{green.Render("+Attack"), "Hardy", "Lonely", "Adamant", "Naughty", "Brave"},
-		{green.Render("+Defense"), "Bold", "Docile", "Impish", "Lax", "Relaxed"},
-		{green.Render("+Sp. Atk"), "Modest", "Mild", "Bashful", "Rash", "Quiet"},
-		{green.Render("+Sp. Def"), "Calm", "Gentle", "Careful", "Quirky", "Sassy"},
-		{green.Render("Speed"), "Timid", "Hasty", "Jolly", "Naive", "Serious"},
+		{" ", styling.Red.Render("-Attack"), styling.Red.Render("-Defense"), styling.Red.Render("-Sp. Atk"), styling.Red.Render("-Sp. Def"), styling.Red.Render("Speed")},
+		{styling.Green.Render("+Attack"), "Hardy", "Lonely", "Adamant", "Naughty", "Brave"},
+		{styling.Green.Render("+Defense"), "Bold", "Docile", "Impish", "Lax", "Relaxed"},
+		{styling.Green.Render("+Sp. Atk"), "Modest", "Mild", "Bashful", "Rash", "Quiet"},
+		{styling.Green.Render("+Sp. Def"), "Calm", "Gentle", "Careful", "Quirky", "Sassy"},
+		{styling.Green.Render("Speed"), "Timid", "Hasty", "Jolly", "Naive", "Serious"},
 	}
 
 	t := table.New().
 		Border(lipgloss.NormalBorder()).
-		BorderStyle(lipgloss.NewStyle().Foreground(gray)).
+		BorderStyle(lipgloss.NewStyle().Foreground(styling.Gray)).
 		BorderRow(true).
 		BorderColumn(true).
 		Rows(chart...).

cmd/pokemon.go

@@ -5,6 +5,7 @@ import (
 	"fmt"
 	"github.com/digitalghost-dev/poke-cli/connections"
 	"github.com/digitalghost-dev/poke-cli/flags"
+	"github.com/digitalghost-dev/poke-cli/styling"
 	"golang.org/x/text/cases"
 	"golang.org/x/text/language"
 	"math"
@@ -15,16 +16,16 @@ import (
 // PokemonCommand processes the Pokémon command
 func PokemonCommand() {
 
-	hintMessage := styleItalic.Render("options: [sm, md, lg]")
+	hintMessage := styling.StyleItalic.Render("options: [sm, md, lg]")
 
 	flag.Usage = func() {
-		helpMessage := helpBorder.Render(
+		helpMessage := styling.HelpBorder.Render(
 			"Get details about a specific Pokémon.\n\n",
-			styleBold.Render("USAGE:"),
-			fmt.Sprintf("\n\t%s %s %s %s", "poke-cli", styleBold.Render("pokemon"), "<pokemon-name>", "[flag]"),
-			fmt.Sprintf("\n\t%-30s", styleItalic.Render("Use a hyphen when typing a name with a space.")),
+			styling.StyleBold.Render("USAGE:"),
+			fmt.Sprintf("\n\t%s %s %s %s", "poke-cli", styling.StyleBold.Render("pokemon"), "<pokemon-name>", "[flag]"),
+			fmt.Sprintf("\n\t%-30s", styling.StyleItalic.Render("Use a hyphen when typing a name with a space.")),
 			"\n\n",
-			styleBold.Render("FLAGS:"),
+			styling.StyleBold.Render("FLAGS:"),
 			fmt.Sprintf("\n\t%-30s %s", "-a, --abilities", "Prints the Pokémon's abilities."),
 			fmt.Sprintf("\n\t%-30s %s", "-i=xx, --image=xx", "Prints out the Pokémon's default sprite."),
 			fmt.Sprintf("\n\t%5s%-15s", "", hintMessage),
@@ -42,15 +43,15 @@ func PokemonCommand() {
 	// Pre-parse validation for empty image flag values
 	for _, arg := range args {
 		if strings.HasPrefix(arg, "-i=") && len(arg) == 3 {
-			fmt.Println(errorBorder.Render(errorColor.Render("Error!"), "\nThe image flag (-i or --image) requires a non-empty value.\nValid sizes are: lg, md, sm."))
+			fmt.Println(styling.ErrorBorder.Render(styling.ErrorColor.Render("Error!"), "\nThe image flag (-i or --image) requires a non-empty value.\nValid sizes are: lg, md, sm."))
 			os.Exit(1)
 		}
 		if strings.HasPrefix(arg, "--image=") && len(arg) == 8 {
-			fmt.Println(errorBorder.Render(errorColor.Render("Error!"), "\nThe image flag (-i or --image) requires a non-empty value.\nValid sizes are: lg, md, sm."))
+			fmt.Println(styling.ErrorBorder.Render(styling.ErrorColor.Render("Error!"), "\nThe image flag (-i or --image) requires a non-empty value.\nValid sizes are: lg, md, sm."))
 			os.Exit(1)
 		}
 		if strings.HasPrefix(arg, "-image=") && len(arg) == 7 {
-			fmt.Println(errorBorder.Render(errorColor.Render("Error!"), "\nThe image flag (-i or --image) requires a non-empty value.\nValid sizes are: lg, md, sm."))
+			fmt.Println(styling.ErrorBorder.Render(styling.ErrorColor.Render("Error!"), "\nThe image flag (-i or --image) requires a non-empty value.\nValid sizes are: lg, md, sm."))
 			os.Exit(1)
 		}
 	}