Merge pull request #120 from digitalghost-dev/1.0.3

1.0.3

Author: digitalghost-dev

.github/workflows/ci.yml

@@ -26,7 +26,7 @@ on:
       - main
 
 env:
-  VERSION_NUMBER: 'v1.0.2'
+  VERSION_NUMBER: 'v1.0.3'
   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=v1.0.2
+      - -s -w -X main.version=v1.0.3
 
 archives:
   - format: tar.gz
@@ -36,3 +36,12 @@ changelog:
     exclude:
       - "^docs:"
       - "^test:"
+
+brews:
+  - repository:
+      owner: digitalghost-dev
+      name: homebrew-poke-cli
+      token: "{{.Env.GITHUB_TOKEN}}"
+    homepage: "https://github.com/digitalghost-dev/poke-cli"
+    description: "A CLI tool written in Go that allows you to view data about Pokémon from the terminal."
+    license: "Apache License 2.0"

Dockerfile

@@ -8,7 +8,7 @@ RUN go mod download
 
 COPY . .
 
-RUN go build -ldflags "-X main.version=v1.0.2" -o poke-cli .
+RUN go build -ldflags "-X main.version=v1.0.3" -o poke-cli .
 
 # build 2
 FROM --platform=$BUILDPLATFORM alpine:latest

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/v1.0.2?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/v1.0.3?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">
@@ -56,7 +56,7 @@ _Download a pre-built binary_
   .\poke-cli.exe pokemon charizard --types --abilities
 
   # Unix
-  .\poke-cli pokemon vespiquen -t -a
+  .\poke-cli ability airlock --pokemon
   ```
 
 ### Docker Image
@@ -73,11 +73,11 @@ _Use a Docker Image_
 3. Choose how to interact with the container:
    * Run a single command and exit:
     ```bash
-    docker run --rm -it digitalghostdev/poke-cli:v1.0.2 <command> [subcommand] flag]
+    docker run --rm -it digitalghostdev/poke-cli:v1.0.3 <command> [subcommand] flag]
     ```
    * Enter the container and use its shell:
     ```bash
-    docker run --rm -it --name poke-cli --entrypoint /bin/sh digitalghostdev/poke-cli:v1.0.2 -c "cd /app && exec sh"
+    docker run --rm -it --name poke-cli --entrypoint /bin/sh digitalghostdev/poke-cli:v1.0.3 -c "cd /app && exec sh"
    # placed into the /app directory, run the program with './poke-cli'
    # example: ./poke-cli ability swift-swim
     ```
@@ -142,10 +142,13 @@ Below is a list of the planned/completed commands and flags:
 
 ---
 ## Tested Terminals
-| OS      | Terminal           | Status | Issues                        |
-|---------|--------------------|:------:|-------------------------------|
-| macOS   | Ghostty            |   ✅    | None                          | 
-| macOS   | Alacritty          |   ✅    | None                          |
-| macOS   | macOS Terminal     |   ⚠️   | Images do not render properly |
-| Windows | Windows Terminal   |   ✅    | None                          |
-| Ubuntu  | Standard Terminal  |   ✅    | None                          |
+| OS      | Terminal          | Status | Issues                        |
+|---------|-------------------|:------:|-------------------------------|
+| macOS   | Ghostty           |   ✅    | None                          | 
+| macOS   | Alacritty         |   ✅    | None                          |
+| macOS   | HyperJS           |   ✅    | None                          |
+| macOS   | iTerm2            |   ✅    | None                          |
+| macOS   | macOS Terminal    |   ⚠️   | Images do not render properly |
+| Windows | Windows Terminal  |   ✅    | None                          |
+| Ubuntu  | Standard Terminal |   ✅    | None                          |
+| Ubuntu  | Tabby             |   ✅    | None                          |

cli_test.go

@@ -15,8 +15,8 @@ func TestCurrentVersion(t *testing.T) {
 	}{
 		{
 			name:           "Version set by ldflags",
-			version:        "v1.0.0",
-			expectedOutput: "Version: v1.0.0\n",
+			version:        "v1.0.2",
+			expectedOutput: "Version: v1.0.2\n",
 		},
 		{
 			name:           "Version set to (devel)",
@@ -186,7 +186,7 @@ func TestRunCLI(t *testing.T) {
 		{
 			name:           "Latest Flag",
 			args:           []string{"-l"},
-			expectedOutput: "Latest Docker image version: v1.0.1\nLatest release tag: v1.0.1\n",
+			expectedOutput: "Latest Docker image version: v1.0.2\nLatest release tag: v1.0.2\n",
 			expectedCode:   0,
 		},
 	}

cmd/ability.go

@@ -69,9 +69,34 @@ func AbilityCommand() {
 		}
 	}
 
-	capitalizedEffect := cases.Title(language.English).String(strings.Replace(abilityName, "-", " ", -1))
-	fmt.Println(styling.StyleBold.Render(capitalizedEffect))
-	fmt.Println("Effect:", englishShortEffect)
+	// Extract English flavor_text_entries
+	var englishFlavorEntry string
+	for _, entry := range abilitiesStruct.FlavorEntries {
+		if entry.Language.Name == "en" {
+			englishFlavorEntry = entry.FlavorText
+			break
+		}
+	}
+
+	capitalizedAbility := cases.Title(language.English).String(strings.Replace(abilityName, "-", " ", -1))
+	fmt.Println(styling.StyleBold.Render(capitalizedAbility))
+
+	// API is missing some data for the short_effect for abilities from Generation 9.
+	// If short_effect is empty, fallback to the move's flavor_text_entry.
+	if englishShortEffect == "" {
+		fmt.Println("Effect:", englishFlavorEntry)
+	} else {
+		fmt.Println("Effect:", englishShortEffect)
+	}
+
+	// Print the generation where the move was first introduced.
+	generationParts := strings.Split(abilitiesStruct.Generation.Name, "-")
+	if len(generationParts) > 1 {
+		generationUpper := strings.ToUpper(generationParts[1])
+		fmt.Println("Generation:", generationUpper)
+	} else {
+		fmt.Println("Generation: Unknown")
+	}
 
 	if *pokemonFlag || *shortPokemonFlag {
 		if err := flags.PokemonFlag(endpoint, abilityName); err != nil {

cmd/ability_test.go

@@ -62,9 +62,27 @@ func TestAbilityCommand(t *testing.T) {
 		{
 			name:           "Valid Execution",
 			args:           []string{"ability", "stench"},
-			expectedOutput: styling.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.\nGeneration: III"),
 			expectError:    false,
 		},
+		{
+			name:           "Valid Execution",
+			args:           []string{"ability", "poison-puppeteer", "--pokemon"},
+			expectedOutput: styling.StripANSI("Poison Puppeteer\nEffect: Pokémon poisoned by Pecharunt's moves will also become confused.\nGeneration: IX\n\nPokemon with Poison Puppeteer\n\n 1. Pecharunt"),
+			expectError:    false,
+		},
+		{
+			name: "Valid Execution",
+			args: []string{"ability", "corrosion", "-p"},
+			expectedOutput: styling.StripANSI(fmt.Sprintf(
+				"Corrosion\nEffect: This Pokémon can inflict poison on Poison and Steel Pokémon.\nGeneration: VII\n\nPokemon with Corrosion\n\n"+
+					"%2d. %-30s%2d. %-30s%2d. %-30s\n"+
+					"%2d. %-30s%2d. %-30s",
+				1, "Salandit", 2, "Salazzle", 3, "Glimmet",
+				4, "Glimmora", 5, "Salazzle-Totem",
+			)),
+			expectError: false,
+		},
 	}
 
 	for _, tt := range tests {

cmd/pokemon.go

@@ -3,6 +3,7 @@ package cmd
 import (
 	"flag"
 	"fmt"
+	"github.com/charmbracelet/lipgloss"
 	"github.com/digitalghost-dev/poke-cli/connections"
 	"github.com/digitalghost-dev/poke-cli/flags"
 	"github.com/digitalghost-dev/poke-cli/styling"
@@ -96,9 +97,13 @@ func PokemonCommand() {
 		inches = 0
 	}
 
+	coloredBullet := lipgloss.NewStyle().
+		SetString("•").
+		Foreground(lipgloss.Color("#FFCC00"))
+
 	fmt.Printf(
-		"Your selected Pokémon: %s\nNational Pokédex #: %d\nWeight: %.1fkg (%.1f lbs)\nHeight: %.1fm (%d′%02d″)\n",
-		capitalizedString, pokemonID, weightKilograms, weightPounds, heightFeet, feet, inches,
+		"Your selected Pokémon: %s\n%s National Pokédex #: %d\n%s Weight: %.1fkg (%.1f lbs)\n%s Height: %.1fm (%d′%02d″)\n",
+		capitalizedString, coloredBullet, pokemonID, coloredBullet, weightKilograms, weightPounds, coloredBullet, heightFeet, feet, inches,
 	)
 
 	if *imageFlag != "" || *shortImageFlag != "" {

cmd/pokemon_test.go

@@ -78,5 +78,5 @@ func TestPokemonCommand(t *testing.T) {
 	}
 
 	// Assert output contains expected Pokémon details
-	assert.Equal(t, output.String(), "Your selected Pokémon: Bulbasaur\nNational Pokédex #: 1\nWeight: 6.9kg (15.2 lbs)\nHeight: 2.3m (2′04″)\n")
+	assert.Equal(t, output.String(), "Your selected Pokémon: Bulbasaur\n• National Pokédex #: 1\n• Weight: 6.9kg (15.2 lbs)\n• Height: 2.3m (2′04″)\n")
 }

cmd/validateargs.go

@@ -64,7 +64,7 @@ func ValidatePokemonArgs(args []string) error {
 	if len(args) < 3 {
 		errMessage := styling.ErrorBorder.Render(
 			styling.ErrorColor.Render("Error!"),
-			"\nPlease declare a Pokémon's name after the [pokemon] command",
+			"\nPlease declare a Pokémon's name after the <pokemon> command",
 			"\nRun 'poke-cli pokemon -h' for more details",
 			"\nerror: insufficient arguments",
 		)
@@ -109,21 +109,11 @@ func ValidatePokemonArgs(args []string) error {
 		}
 	}
 
-	// Add a check for invalid Pokémon names (e.g., names starting with `-`)
-	if len(args[2]) > 0 && args[2][0] == '-' {
-		errMessage := styling.ErrorBorder.Render(
-			styling.ErrorColor.Render("Error!"),
-			"\nPokémon not found. Perhaps a typo in the name?",
-		)
-		return fmt.Errorf("%s", errMessage)
-	}
-
 	return nil
 }
 
 // ValidateTypesArgs validates the command line arguments
 func ValidateTypesArgs(args []string) error {
-
 	handleHelpFlag(args)
 
 	if len(args) > 3 {