1.4.0

.github/workflows/ci.yml

@@ -28,7 +28,7 @@ on:
       - main
 
 env:
-  VERSION_NUMBER: 'v1.3.3'
+  VERSION_NUMBER: 'v1.4.0'
   DOCKERHUB_REGISTRY_NAME: 'digitalghostdev/poke-cli'
   AWS_REGION: 'us-west-2'
 

.goreleaser.yaml → .goreleaser.yml

@@ -14,7 +14,7 @@ builds:
       - windows
       - darwin
     ldflags:
-      - -s -w -X main.version=v1.3.3
+      - -s -w -X main.version=v1.4.0
 
 archives:
   - formats: [ 'zip' ]
@@ -28,7 +28,7 @@ archives:
     # use zip for windows archives
     format_overrides:
       - goos: windows
-      - formats: [ 'zip' ]
+        formats: [ 'zip' ]
 
 changelog:
   sort: asc
@@ -51,6 +51,6 @@ homebrew_casks:
     hooks:
       post:
         install: |
-          if system_command("/usr/bin/xattr", args: ["-h"]).exit_status == 0
+          if OS.mac? && system_command("/usr/bin/xattr", args: ["-h"]).exit_status == 0
             system_command "/usr/bin/xattr", args: ["-dr", "com.apple.quarantine", "#{staged_path}/poke-cli"]
           end

Dockerfile

@@ -1,5 +1,5 @@
 # build 1
-FROM golang:1.24.4-alpine3.21 AS build
+FROM golang:1.24.4-alpine3.22 AS build
 
 WORKDIR /app
 
@@ -8,13 +8,14 @@ RUN go mod download
 
 COPY . .
 
-RUN go build -ldflags "-X main.version=v1.3.3" -o poke-cli .
+RUN go build -ldflags "-X main.version=v1.4.0" -o poke-cli .
 
 # build 2
-FROM --platform=$BUILDPLATFORM alpine:latest
+FROM --platform=$BUILDPLATFORM alpine:3.22
 
 # Install only necessary packages and remove them after use
-RUN apk add --no-cache shadow && \
+RUN apk upgrade && \
+    apk add --no-cache shadow && \
     addgroup -S poke_group && adduser -S poke_user -G poke_group && \
     sed -i 's/^root:.*/root:!*:0:0:root:\/root:\/sbin\/nologin/' /etc/passwd && \
     apk del shadow

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.3.3?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.4.0?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">
@@ -77,22 +77,24 @@ View future plans in the [Roadmap](#roadmap) section.
 3. Choose how to interact with the container:
    * Run a single command and exit:
     ```bash
-    docker run --rm -it digitalghostdev/poke-cli:v1.3.3 <command> [subcommand] flag]
+    docker run --rm -it digitalghostdev/poke-cli:v1.4.0 <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.3.3 -c "cd /app && exec sh"
+    docker run --rm -it --name poke-cli --entrypoint /bin/sh digitalghostdev/poke-cli:v1.4.0 -c "cd /app && exec sh"
    # placed into the /app directory, run the program with './poke-cli'
    # example: ./poke-cli ability swift-swim
     ```
 
 ### Homebrew
-```bash
-brew install --cask digitalghost-dev/tap/poke-cli
-
-# verify
-poke-cli -v
-```
+1. Install the Cask:
+    ```bash
+    brew install --cask digitalghost-dev/tap/poke-cli
+    ````
+2. Verify install!
+    ```bash
+    poke-cli -v
+    ```
 
 ### Source
 
@@ -121,6 +123,7 @@ By running `poke-cli [-h | --help]`, it'll display information on how to use the
 │                                                          │
 │ COMMANDS:                                                │
 │    ability         Get details about an ability          │
+│    item            Get details about an item             │
 │    move            Get details about a move              │
 │    natures         Get details about all natures         │
 │    pokemon         Get details about a Pokémon           │
@@ -130,6 +133,9 @@ By running `poke-cli [-h | --help]`, it'll display information on how to use the
 │ hint: when calling a resource with a space, use a hyphen │
 │ example: poke-cli ability strong-jaw                     │
 │ example: poke-cli pokemon flutter-mane                   │
+│                                                          │
+│ ↓ ctrl/cmd + click for docs/guides                       │
+│ docs.poke-cli.com                                        │
 ╰──────────────────────────────────────────────────────────╯
 ```
 
@@ -138,20 +144,25 @@ By running `poke-cli [-h | --help]`, it'll display information on how to use the
 ## Roadmap
 Below is a list of the planned/completed commands and flags:
 
-- [x] `ability`: get data about a specific ability.
+- [x] `ability`: get data about an ability.
     - [x] `-p | --pokemon`: display Pokémon that learn this ability.
-- [ ] `berry`: get data about a specific berry.
-- [ ] `item`: get data about a specific item.
-- [x] `move`: get data about a specific move.
+- [ ] `berry`: get data about a berry.
+- [x] `item`: get data about an item.
+- [x] `move`: get data about a move.
     - [ ] `-p | --pokemon`: display Pokémon that learn this move.
 - [x] `natures`: get data about natures.
-- [x] `pokemon`: get data about a specific Pokémon.
+- [x] `pokemon`: get data about a 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.
     - [x] `-m | --moves`: display learnable moves.
-- [x] `search`: search for a resource (`ability`, `berry`, `pokemon`, `move`)
+- [ ] `search`: search for a resource 
+    - [x] `ability`
+    - [ ] `berry`
+    - [ ] `item`
+    - [x] `move`
+    - [x] `pokemon`
 - [ ] `speed`: compare speed stats between two Pokémon.
 - [x] `types`: get data about a specific typing.
 

cli.go

@@ -4,6 +4,7 @@
 	"flag"
 	"fmt"
 	"github.com/digitalghost-dev/poke-cli/cmd/ability"
+	"github.com/digitalghost-dev/poke-cli/cmd/item"
 	"github.com/digitalghost-dev/poke-cli/cmd/move"
 	"github.com/digitalghost-dev/poke-cli/cmd/natures"
 	"github.com/digitalghost-dev/poke-cli/cmd/pokemon"
@@ -66,6 +67,7 @@
 			fmt.Sprintf("\n\t%-15s %s", "-v, --version", "Prints the current version"),
 			"\n\n", styling.StyleBold.Render("COMMANDS:"),
 			fmt.Sprintf("\n\t%-15s %s", "ability", "Get details about an ability"),
+			fmt.Sprintf("\n\t%-15s %s", "item", "Get details about an item"),
 			fmt.Sprintf("\n\t%-15s %s", "move", "Get details about a move"),
 			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"),
@@ -99,6 +101,7 @@
 
 	commands := map[string]func() int{
 		"ability": utils.HandleCommandOutput(ability.AbilityCommand),
+		"item":    utils.HandleCommandOutput(item.ItemCommand),
 		"move":    utils.HandleCommandOutput(move.MoveCommand),
 		"natures": utils.HandleCommandOutput(natures.NaturesCommand),
 		"pokemon": utils.HandleCommandOutput(pokemon.PokemonCommand),
@@ -133,6 +136,7 @@
 			fmt.Sprintf("\n\t%-15s", fmt.Sprintf("'%s' is not a valid command.\n", cmdArg)),
 			styling.StyleBold.Render("\nCommands:"),
 			fmt.Sprintf("\n\t%-15s %s", "ability", "Get details about an ability"),
+			fmt.Sprintf("\n\t%-15s %s", "item", "Get details about an item"),
 			fmt.Sprintf("\n\t%-15s %s", "move", "Get details about a move"),
 			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"),

cmd/item/item.go

@@ -0,0 +1,96 @@
+package item
+
+import (
+	"flag"
+	"fmt"
+	"github.com/charmbracelet/lipgloss"
+	"github.com/digitalghost-dev/poke-cli/cmd/utils"
+	"github.com/digitalghost-dev/poke-cli/connections"
+	"github.com/digitalghost-dev/poke-cli/structs"
+	"github.com/digitalghost-dev/poke-cli/styling"
+	"golang.org/x/text/cases"
+	"golang.org/x/text/language"
+	"os"
+	"strings"
+)
+
+func ItemCommand() (string, error) {
+	var output strings.Builder
+
+	flag.Usage = func() {
+		helpMessage := styling.HelpBorder.Render(
+			"Get details about a specific item.\n\n",
+			styling.StyleBold.Render("USAGE:"),
+			fmt.Sprintf("\n\t%s %s %s %s", "poke-cli", styling.StyleBold.Render("item"), "<item-name>", "[flag]"),
+			fmt.Sprintf("\n\t%-30s", styling.StyleItalic.Render("Use a hyphen when typing a name with a space.")),
+			"\n\n",
+			styling.StyleBold.Render("FLAGS:"),
+			fmt.Sprintf("\n\t%-30s %s", "-h, --help", "Prints the help menu."),
+		)
+		output.WriteString(helpMessage)
+	}
+
+	args := os.Args
+
+	flag.Parse()
+
+	if len(os.Args) == 3 && (os.Args[2] == "-h" || os.Args[2] == "--help") {
+		flag.Usage()
+		return output.String(), nil
+	}
+
+	if err := utils.ValidateItemArgs(os.Args); err != nil {
+		output.WriteString(err.Error())
+		return output.String(), err
+	}
+
+	endpoint := strings.ToLower(args[1])
+	itemName := strings.ToLower(args[2])
+
+	itemStruct, itemName, err := connections.ItemApiCall(endpoint, itemName, connections.APIURL)
+	if err != nil {
+		if os.Getenv("GO_TESTING") != "1" {
+			fmt.Fprintln(os.Stderr, err)
+			os.Exit(1)
+		}
+		return err.Error(), nil
+	}
+
+	itemInfoContainer(&output, itemStruct, itemName)
+
+	return output.String(), nil
+}
+
+func itemInfoContainer(output *strings.Builder, itemStruct structs.ItemJSONStruct, itemName string) {
+	capitalizedItem := styling.StyleBold.Render(cases.Title(language.English).String(strings.ReplaceAll(itemName, "-", " ")))
+	itemCost := fmt.Sprintf("Cost: %d", itemStruct.Cost)
+	itemCategory := "Category: " + cases.Title(language.English).String(strings.ReplaceAll(itemStruct.Category.Name, "-", " "))
+
+	docStyle := lipgloss.NewStyle().
+		Padding(1, 2).
+		BorderStyle(lipgloss.ThickBorder()).
+		BorderForeground(lipgloss.AdaptiveColor{Light: "#444", Dark: "#EEE"}).
+		Width(32)
+
+	var flavorTextEntry string
+	var missingData string
+	var fullDoc string
+
+	if len(itemStruct.FlavorTextEntries) == 0 {
+		missingData = styling.StyleItalic.Render("Missing data from API")
+		fullDoc = lipgloss.JoinVertical(lipgloss.Top, capitalizedItem, itemCost, itemCategory, "---", "Description:", missingData)
+	} else {
+		for _, entry := range itemStruct.FlavorTextEntries {
+			if entry.Language.Name == "en" && entry.VersionGroup.Name == "sword-shield" {
+				if entry.Text != "" {
+					flavorTextEntry = entry.Text
+					fullDoc = lipgloss.JoinVertical(lipgloss.Top, capitalizedItem, itemCost, itemCategory, "---", "Description:", flavorTextEntry)
+					break
+				}
+			}
+		}
+	}
+
+	output.WriteString(docStyle.Render(fullDoc))
+	output.WriteString("\n")
+}

cmd/item/item_test.go

@@ -0,0 +1,70 @@
+package item
+
+import (
+	"github.com/digitalghost-dev/poke-cli/cmd/utils"
+	"github.com/digitalghost-dev/poke-cli/styling"
+	"github.com/stretchr/testify/assert"
+	"os"
+	"testing"
+)
+
+func TestItemCommand(t *testing.T) {
+	err := os.Setenv("GO_TESTING", "1")
+	if err != nil {
+		t.Fatalf("Failed to set GO_TESTING env var: %v", err)
+	}
+
+	defer func() {
+		err := os.Unsetenv("GO_TESTING")
+		if err != nil {
+			t.Logf("Warning: failed to unset GO_TESTING: %v", err)
+		}
+	}()
+
+	tests := []struct {
+		name           string
+		args           []string
+		expectedOutput string
+		expectedError  bool
+	}{
+		{
+			name:           "Item help flag",
+			args:           []string{"item", "--help"},
+			expectedOutput: utils.LoadGolden(t, "item_help.golden"),
+		},
+		{
+			name:           "Item help flag",
+			args:           []string{"item", "-h"},
+			expectedOutput: utils.LoadGolden(t, "item_help.golden"),
+		},
+		{
+			name:           "Select 'choice-band' as item",
+			args:           []string{"item", "choice-band"},
+			expectedOutput: utils.LoadGolden(t, "item.golden"),
+		},
+		{
+			name:           "Select 'clear-amulet' as item with missing data",
+			args:           []string{"item", "clear-amulet"},
+			expectedOutput: utils.LoadGolden(t, "item_missing_data.golden"),
+		},
+		{
+			name:           "Too many arguments",
+			args:           []string{"item", "dubious-disc", "--help"},
+			expectedOutput: utils.LoadGolden(t, "item_too_many_args.golden"),
+			expectedError:  true,
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			originalArgs := os.Args
+			os.Args = append([]string{"poke-cli"}, tt.args...)
+			defer func() { os.Args = originalArgs }()
+
+			output, _ := ItemCommand()
+			cleanOutput := styling.StripANSI(output)
+
+			assert.Equal(t, tt.expectedOutput, cleanOutput, "Output should match expected")
+		})
+	}
+}

cmd/move/move_test.go

@@ -38,7 +38,7 @@ func TestMoveCommand(t *testing.T) {
 			expectedOutput: utils.LoadGolden(t, "move_help.golden"),
 		},
 		{
-			name:           "Select 'Shadow-Ball' as move",
+			name:           "Select 'shadow-ball' as move",
 			args:           []string{"move", "shadow-ball"},
 			expectedOutput: utils.LoadGolden(t, "move.golden"),
 		},

cmd/natures/natures.go

@@ -14,7 +14,6 @@ import (
 func NaturesCommand() (string, error) {
 	var output strings.Builder
 
-	// Define the usage function
 	flag.Usage = func() {
 		helpMessage := styling.HelpBorder.Render(
 			"Get details about all natures.\n\n",

cmd/pokemon/pokemon.go

@@ -104,8 +104,8 @@ func PokemonCommand() (string, error) {
 
 		// Call the ImageFlag function with the specified size
 		if err := flags.ImageFlag(&output, endpoint, pokemonName, size); err != nil {
-			output.WriteString(fmt.Sprintf("error parsing flags: %v\n", err))
-			return "", fmt.Errorf("error parsing flags: %w", err)
+			output.WriteString(fmt.Sprintf("%v\n", err))
+			return output.String(), fmt.Errorf("%w", err)
 		}
 	}