Merge pull request #124 from digitalghost-dev/1.1.0

1.1.0

Author: digitalghost-dev

.github/workflows/ci.yml

@@ -26,7 +26,7 @@ on:
       - main
 
 env:
-  VERSION_NUMBER: 'v1.0.3'
+  VERSION_NUMBER: 'v1.1.0'
   DOCKERHUB_REGISTRY_NAME: 'digitalghostdev/poke-cli'
   AWS_REGION: 'us-west-2'
 
@@ -185,7 +185,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        platform: [linux/amd64, linux/arm64]
+        platform: [linux/amd64, linux/arm64, windows/amd64, windows/arm64]
 
     steps:
       - name: Checkout

.github/workflows/go_lint.yml

@@ -21,7 +21,7 @@ jobs:
           go-version: 1.23
 
       - name: Lint
-        uses: golangci/golangci-lint-action@v6
+        uses: golangci/golangci-lint-action@v7
         with:
-          version: v1.61
+          version: v2.0.1
           skip-cache: true

.golangci.yml

@@ -0,0 +1,31 @@
+version: "2"
+linters:
+  default: none
+  enable:
+    - bodyclose
+    - errcheck
+    - govet
+    - ineffassign
+    - perfsprint
+    - staticcheck
+    - testifylint
+    - unused
+    - whitespace
+  exclusions:
+    generated: lax
+    presets:
+      - comments
+      - common-false-positives
+      - legacy
+      - std-error-handling
+    paths:
+      - third_party$
+      - builtin$
+      - examples$
+formatters:
+  exclusions:
+    generated: lax
+    paths:
+      - third_party$
+      - builtin$
+      - examples$

.goreleaser.yaml

@@ -14,7 +14,7 @@ builds:
       - windows
       - darwin
     ldflags:
-      - -s -w -X main.version=v1.0.3
+      - -s -w -X main.version=v1.1.0
 
 archives:
   - format: tar.gz

Dockerfile

@@ -8,7 +8,7 @@ RUN go mod download
 
 COPY . .
 
-RUN go build -ldflags "-X main.version=v1.0.3" -o poke-cli .
+RUN go build -ldflags "-X main.version=v1.1.0" -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.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.1.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">
@@ -28,8 +28,12 @@ View future plans in the [Roadmap](#roadmap) section.
 ---
 ## Installation
 
+* [Binary](#binary)
+* [Docker Image](#docker-image)
+* [Homebrew](#homebrew)
+* [Source](#source)
+
 ### Binary
-_Download a pre-built binary_
 
 1. Head to the [releases](https://github.com/digitalghost-dev/poke-cli/releases) page of the project.
 2. Choose a version to download. The latest is best.
@@ -60,7 +64,6 @@ _Download a pre-built binary_
   ```
 
 ### Docker Image
-_Use a Docker Image_
 
 1. Install [Docker Desktop](https://www.docker.com/products/docker-desktop/).
 2. Once installed, use the command below to pull the image and run the container!
@@ -73,23 +76,32 @@ _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.3 <command> [subcommand] flag]
+    docker run --rm -it digitalghostdev/poke-cli:v1.1.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.0.3 -c "cd /app && exec sh"
+    docker run --rm -it --name poke-cli --entrypoint /bin/sh digitalghostdev/poke-cli:v1.1.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 tap digitalghost-dev/poke-cli
+brew install poke-cli
 
-### Go Install
-_If you have Go already, install the executable yourself._
+# verify
+poke-cli -v
+```
+
+### Source
 
 1. Run the following command:
    ```bash
    go install github.com/digitalghost-dev/poke-cli@latest
    ```
 2. The tool is ready to use!
+
 ---
 ## Usage
 By running `poke-cli [-h | --help]`, it'll display information on how to use the tool. 
@@ -111,6 +123,7 @@ By running `poke-cli [-h | --help]`, it'll display information on how to use the
 │    ability         Get details about an ability          │
 │    natures         Get details about all natures         │
 │    pokemon         Get details about a Pokémon           │
+│    search          Search for a resource                 │
 │    types           Get details about a typing            │
 │                                                          │
 │ hint: when calling a resource with a space, use a hyphen │
@@ -127,6 +140,7 @@ Below is a list of the planned/completed commands and flags:
 - [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.
+- [ ] `item`: get data about a specific item.
 - [ ] `move`: get data about a specific move.
     - [ ] `-p | --pokemon`: display Pokémon that learn this move.
 - [x] `natures`: get data about natures.
@@ -136,7 +150,7 @@ Below is a list of the planned/completed commands and flags:
     - [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`)
+- [x] `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

@@ -4,6 +4,7 @@ import (
 	"flag"
 	"fmt"
 	"github.com/digitalghost-dev/poke-cli/cmd"
+	"github.com/digitalghost-dev/poke-cli/cmd/search"
 	"github.com/digitalghost-dev/poke-cli/flags"
 	"github.com/digitalghost-dev/poke-cli/styling"
 	"os"
@@ -59,6 +60,7 @@ func runCLI(args []string) int {
 			fmt.Sprintf("\n\t%-15s %s", "ability", "Get details about an ability"),
 			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", "search", "Search for a resource"),
 			fmt.Sprintf("\n\t%-15s %s", "types", "Get details about a typing"),
 			"\n\n", styling.StyleItalic.Render("hint: when calling a resource with a space, use a hyphen"),
 			"\n", styling.StyleItalic.Render("example: poke-cli ability strong-jaw"),
@@ -88,6 +90,7 @@ func runCLI(args []string) int {
 		"natures": cmd.NaturesCommand,
 		"pokemon": cmd.PokemonCommand,
 		"types":   cmd.TypesCommand,
+		"search":  search.SearchCommand,
 	}
 
 	if len(os.Args) < 2 {
@@ -111,6 +114,7 @@ func runCLI(args []string) int {
 			fmt.Sprintf("\n\t%-15s %s", "ability", "Get details about an ability"),
 			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", "search", "Search for a resource"),
 			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")),
 		)

cli_test.go

@@ -112,6 +112,7 @@ func TestRunCLI(t *testing.T) {
 				"│    ability         Get details about an ability          │\n" +
 				"│    natures         Get details about all natures         │\n" +
 				"│    pokemon         Get details about a Pokémon           │\n" +
+				"│    search          Search for a resource                 │\n" +
 				"│    types           Get details about a typing            │\n" +
 				"│                                                          │\n" +
 				"│ hint: when calling a resource with a space, use a hyphen │\n" +
@@ -140,6 +141,7 @@ func TestRunCLI(t *testing.T) {
 				"│    ability         Get details about an ability          │\n" +
 				"│    natures         Get details about all natures         │\n" +
 				"│    pokemon         Get details about a Pokémon           │\n" +
+				"│    search          Search for a resource                 │\n" +
 				"│    types           Get details about a typing            │\n" +
 				"│                                                          │\n" +
 				"│ hint: when calling a resource with a space, use a hyphen │\n" +
@@ -168,6 +170,7 @@ func TestRunCLI(t *testing.T) {
 				"│    ability         Get details about an ability          │\n" +
 				"│    natures         Get details about all natures         │\n" +
 				"│    pokemon         Get details about a Pokémon           │\n" +
+				"│    search          Search for a resource                 │\n" +
 				"│    types           Get details about a typing            │\n" +
 				"│                                                          │\n" +
 				"│ hint: when calling a resource with a space, use a hyphen │\n" +
@@ -183,12 +186,6 @@ func TestRunCLI(t *testing.T) {
 			expectedOutput: "Error!",
 			expectedCode:   1,
 		},
-		{
-			name:           "Latest Flag",
-			args:           []string{"-l"},
-			expectedOutput: "Latest Docker image version: v1.0.2\nLatest release tag: v1.0.2\n",
-			expectedCode:   0,
-		},
 	}
 
 	for _, tt := range tests {

cmd/ability.go

@@ -13,7 +13,6 @@ import (
 )
 
 func AbilityCommand() {
-
 	flag.Usage = func() {
 		helpMessage := styling.HelpBorder.Render(
 			"Get details about a specific ability.\n\n",
@@ -52,7 +51,7 @@ func AbilityCommand() {
 		}
 	}
 
-	abilitiesStruct, abilityName, err := connections.AbilityApiCall(endpoint, abilityName, "https://pokeapi.co/api/v2/")
+	abilitiesStruct, abilityName, err := connections.AbilityApiCall(endpoint, abilityName, connections.APIURL)
 	if err != nil {
 		fmt.Println(err)
 		if os.Getenv("GO_TESTING") != "1" {
@@ -78,7 +77,7 @@ func AbilityCommand() {
 		}
 	}
 
-	capitalizedAbility := cases.Title(language.English).String(strings.Replace(abilityName, "-", " ", -1))
+	capitalizedAbility := cases.Title(language.English).String(strings.ReplaceAll(abilityName, "-", " "))
 	fmt.Println(styling.StyleBold.Render(capitalizedAbility))
 
 	// API is missing some data for the short_effect for abilities from Generation 9.

cmd/ability_test.go

@@ -103,7 +103,9 @@ func TestAbilityCommand(t *testing.T) {
 				AbilityCommand()
 			})
 
-			if !strings.Contains(output, tt.expectedOutput) {
+			cleanOutput := styling.StripANSI(output)
+
+			if !strings.Contains(cleanOutput, tt.expectedOutput) {
 				t.Errorf("Output mismatch. Expected to contain:\n%s\nGot:\n%s", tt.expectedOutput, output)
 			}
 		})