feat: modernize codebase (#5)

* feat: modernize codebase

BREAKING CHANGE: introducing version 2

* fix: istanbul types

Author: farbodsalimi

.github/workflows/go.yml

@@ -25,11 +25,11 @@ jobs:
       - name: Test
         run: go test -v
 
-      - name: Coverage
-        uses: paambaati/codeclimate-action@v3.0.0
-        env:
-          CC_TEST_REPORTER_ID: 7442645f3d316d873958dd124e244c15cef0e7a11b1506f68932a04e472b58b5
-        with:
-          prefix: github.com/farbodsalimi/dokimi
-          coverageCommand: go test -v --race -covermode=atomic -coverprofile=coverage.out ./...
-          coverageLocations: ${{github.workspace}}/coverage.out:gocov
+      # - name: Coverage
+      #   uses: paambaati/codeclimate-action@v3.0.0
+      #   env:
+      #     CC_TEST_REPORTER_ID: 7442645f3d316d873958dd124e244c15cef0e7a11b1506f68932a04e472b58b5
+      #   with:
+      #     prefix: github.com/farbodsalimi/dokimi
+      #     coverageCommand: go test -v --race -covermode=atomic -coverprofile=coverage.out ./...
+      #     coverageLocations: ${{github.workspace}}/coverage.out:gocov

CLAUDE.md

@@ -0,0 +1,49 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## What is Dokimi
+
+Dokimi is a Go CLI tool that provides helper commands for Go test coverage:
+- **`report`** — Converts Go coverage profiles (`coverage.out`) to Istanbul JSON format, optionally opening an HTML report via the `istanbul` npm tool.
+- **`check-coverage`** — Checks total coverage against a threshold, failing (or warning) if below.
+
+## Build & Test Commands
+
+```bash
+go build ./...                        # build all packages
+go build -o ./bin/dokimi .            # build binary
+go test ./...                         # run all tests
+go test -v -coverprofile=coverage.out ./...  # tests with coverage
+go vet ./...                          # static analysis
+```
+
+Makefile targets:
+```bash
+make             # go build ./... (silent)
+make test        # go test -v -coverprofile=coverage.out ./...
+make build       # build binary to ./bin/dokimi
+make build-all   # cross-compile for linux/darwin/windows amd64
+```
+
+## Architecture
+
+```
+main.go                          # entry point, sets Version via ldflags
+cmd/
+  root.go                        # cobra root command, creates ~/.dokimi dirs on init
+  report.go                      # "report" subcommand — delegates to reporter implementations
+  check_coverage.go              # "check-coverage" subcommand — shells out to `go tool cover`
+internal/
+  configs/paths.go               # global path constants (~/.dokimi/istanbul_tmp/*)
+  reporters/istanbul/
+    istanbul.go                   # Istanbul struct, types, functional options constructor
+    write.go                      # WriteReport: parses Go cover profiles → Istanbul JSON
+    show.go                       # ShowReport: writes JSON then runs `istanbul report` + `open`
+```
+
+Key patterns:
+- Reporter uses **functional options** (`New(opts ...func(*Istanbul))`) with an injectable `writeFileFn` for testability.
+- Coverage parsing uses `golang.org/x/tools/cover.ParseProfiles`.
+- `ShowReport` depends on the `istanbul` npm package and macOS `open` command.
+- Version is injected at build time via `-ldflags="-X 'main.Version=vX.Y.Z'"`.

Makefile

@@ -0,0 +1,18 @@
+.DEFAULT_GOAL := all
+
+.PHONY: all test show-cover build build-all
+
+all:
+	@go build ./...
+
+test:
+	go test -v -coverprofile=coverage.out ./...
+
+show-cover:
+	dokimi report --input=coverage.out --output=coverage.json --reporter=istanbul --show
+
+build:
+	go build -o ./bin/dokimi github.com/farbodsalimi/dokimi
+
+build-all:
+	./scripts/build-all.sh github.com/farbodsalimi/dokimi

Taskfile.yaml

@@ -22,14 +22,20 @@ func NewCheckCoverageCmd() *cobra.Command {
 		RunE: func(cmd *cobra.Command, args []string) error {
 			result, err := exec.Command("go", "tool", "cover", "-func", coverProfile).Output()
 			if err != nil {
-				return err
+				return fmt.Errorf("failed to run 'go tool cover' on %s: %w", coverProfile, err)
 			}
 
 			content := string(result)
 			index := strings.Index(content, "total")
+			if index == -1 {
+				return fmt.Errorf("could not find total coverage in %s", coverProfile)
+			}
 			line := content[index:]
 			re := regexp.MustCompile(`([0-9]*\.?[0-9]*)\s*%`)
 			match := re.FindStringSubmatch(line)
+			if match == nil {
+				return fmt.Errorf("could not parse coverage percentage from %s", coverProfile)
+			}
 			totalCoverage, err := strconv.ParseFloat(match[1], 32)
 			if err != nil {
 				return err
@@ -44,7 +50,7 @@ func NewCheckCoverageCmd() *cobra.Command {
 				if doNotFail {
 					log.Warn(msg)
 				} else {
-					log.Fatalf(msg)
+					return fmt.Errorf("%s", msg)
 				}
 			}
 

cmd/check_coverage.go

@@ -2,27 +2,28 @@ package cmd
 
 import (
 	"fmt"
-	"strconv"
 
 	istanbulReporter "github.com/farbodsalimi/dokimi/internal/reporters/istanbul"
 	log "github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
 )
 
 func NewReportCmd() *cobra.Command {
-	var reporter string
-	var rInput string
-	var rOutput string
-	var show bool
+	var (
+		reporter string
+		input    string
+		output   string
+		show     bool
+	)
 
 	reportCmd := &cobra.Command{
 		Use:   "report",
 		Short: "Writes reports for Go coverage profiles",
 		RunE: func(cmd *cobra.Command, args []string) error {
 			log.Infof("Reporter:\t%s", reporter)
-			log.Infof("Input:\t%s", rInput)
-			log.Infof("Output:\t%s", rOutput)
-			log.Infof("Show:\t%s", strconv.FormatBool(show))
+			log.Infof("Input:\t%s", input)
+			log.Infof("Output:\t%s", output)
+			log.Infof("Show:\t%v", show)
 
 			switch reporter {
 			case "istanbul":
@@ -32,26 +33,23 @@ func NewReportCmd() *cobra.Command {
 				}
 
 				if show {
-					istanbul.ShowReport(rInput, rOutput)
-				} else {
-					istanbul.WriteReport(rInput, rOutput)
+					return istanbul.ShowReport(input, output)
 				}
+				return istanbul.WriteReport(input, output)
 
 			default:
 				return fmt.Errorf("unknown reporter: %s", reporter)
 			}
-
-			return nil
 		},
 	}
 
 	reportCmd.Flags().BoolVar(&show, "show", false, "Shows written reports")
 	reportCmd.Flags().
 		StringVarP(&reporter, "reporter", "r", "", "Reporter name e.g. istanbul, lcov, ...")
-	reportCmd.Flags().StringVarP(&rInput, "input", "i", "", "Path to input file")
-	reportCmd.Flags().StringVarP(&rOutput, "output", "o", "", "Path to output file")
+	reportCmd.Flags().StringVarP(&input, "input", "i", "", "Path to input file")
+	reportCmd.Flags().StringVarP(&output, "output", "o", "", "Path to output file")
 	reportCmd.MarkFlagRequired("reporter")
-	reportCmd.MarkFlagRequired("rInput")
+	reportCmd.MarkFlagRequired("input")
 
 	return reportCmd
 }

cmd/report.go

@@ -1,35 +1,19 @@
 module github.com/farbodsalimi/dokimi
 
-go 1.18
+go 1.26
 
 require (
 	github.com/mitchellh/go-homedir v1.1.0
 	github.com/olekukonko/tablewriter v0.0.5
 	github.com/sirupsen/logrus v1.8.1
 	github.com/spf13/cobra v1.4.0
-	github.com/spf13/viper v1.11.0
-	github.com/stretchr/testify v1.8.0
+	golang.org/x/tools v0.43.0
 )
 
 require (
-	github.com/davecgh/go-spew v1.1.1 // indirect
-	github.com/fsnotify/fsnotify v1.5.4 // indirect
-	github.com/hashicorp/hcl v1.0.0 // indirect
 	github.com/inconshreveable/mousetrap v1.0.0 // indirect
-	github.com/magiconair/properties v1.8.6 // indirect
 	github.com/mattn/go-runewidth v0.0.9 // indirect
-	github.com/mitchellh/mapstructure v1.5.0 // indirect
-	github.com/pelletier/go-toml v1.9.5 // indirect
-	github.com/pelletier/go-toml/v2 v2.0.1 // indirect
-	github.com/pmezard/go-difflib v1.0.0 // indirect
-	github.com/spf13/afero v1.8.2 // indirect
-	github.com/spf13/cast v1.5.0 // indirect
-	github.com/spf13/jwalterweatherman v1.1.0 // indirect
 	github.com/spf13/pflag v1.0.5 // indirect
-	github.com/subosito/gotenv v1.2.0 // indirect
-	golang.org/x/sys v0.0.0-20220513210249-45d2b4557a2a // indirect
-	golang.org/x/text v0.3.7 // indirect
-	gopkg.in/ini.v1 v1.66.4 // indirect
-	gopkg.in/yaml.v2 v2.4.0 // indirect
-	gopkg.in/yaml.v3 v3.0.1 // indirect
+	github.com/stretchr/testify v1.8.0 // indirect
+	golang.org/x/sys v0.42.0 // indirect
 )