ref: replace extendio.i18n with li18ngo (#226)

.github/workflows/ci-workflow.yml

@@ -1,4 +1,5 @@
 name: Pixa Continuous Integration
+
 on:
   push:
 
@@ -7,43 +8,68 @@ jobs:
     name: lint
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/setup-go@v3
+      - uses: actions/setup-go@v4
         with:
-          go-version: 1.22
+          go-version: 1.23
       - uses: actions/checkout@v3
       - name: golangci-lint
-        uses: golangci/golangci-lint-action@v4
+        uses: golangci/golangci-lint-action@v3
         with:
-          version: v1.56.2
+          version: v1.60.3
           args: --verbose
 
   test:
     strategy:
       matrix:
-        go-version: [1.22]
+        go-version: [1.23]
         platform: [ubuntu-latest, macos-latest]
 
     runs-on: ${{ matrix.platform }}
 
+    env:
+      COVER_DIR: ${{ github.workspace }}/coverage
+      COVER_FILE: coverage.out
+      COVER_OUT_PATH: ${{ github.workspace }}/coverage/coverage.out
+      COVER_HTML_PATH: ${{ github.workspace }}/coverage/coverage.html
+      GINKGO_REPORT: ginkgo.report
+
     steps:
       - name: Install Go
-        uses: actions/setup-go@v3
+        uses: actions/setup-go@v5
         with:
           go-version: ${{ matrix.go-version }}
 
       - name: Install goveralls
         run: go install github.com/mattn/goveralls@latest
 
+      - name: Install ginkgo
+        run: go install github.com/onsi/ginkgo/v2/[email protected]
+
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
-      - run: go test -v -coverprofile=coverage.out ./...
+      - name: Ensure coverage directory exists
+        run: |
+          mkdir -p ${{ github.workspace }}/coverage
+      
+      - name: Run tests and generate coverage profile with Ginkgo
+        run: |
+          ginkgo run -r -json-report {{env.GINKGO_REPORT}} -coverpkg=./... -coverprofile=coverage.out
 
-      - uses: shogo82148/actions-goveralls@v1
+      - name: Apply coverage exclusions
+        run: |
+          ${{ github.workspace }}/scripts/apply-coverage-exclusions.sh
+      
+      - name: Check coverage directory contents
+        run: |
+          echo "Contents of ${{ github.workspace }}/coverage:"
+          ls -la ${{ github.workspace }}/coverage
+
+      - name: Generate HTML coverage report
+        run: |
+          go tool cover -html=coverage.out -o ${{ github.workspace }}/coverage/coverage.html
+
+      - name: Upload coverage to Coveralls
+        uses: shogo82148/actions-goveralls@v1
         with:
           path-to-profile: coverage.out
-
-      - name: Send coverage
-        env:
-          COVERALLS_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: goveralls -coverprofile=coverage.out -service=github

.golangci.yml

@@ -12,14 +12,13 @@ linters-settings:
       - performance
       - style
   govet:
-    check-shadowing: true
+    shadow: true
     disable:
       - fieldalignment # too strict
 
   nolintlint:
-    require-explanation: true
+    require-explanation: false
     require-specific: true
-
 linters:
   disable-all: true
   enable:
@@ -29,22 +28,22 @@ linters:
     # it can be re-enabled.
     # https://github.com/OpenPeeDeeP/depguard#example-configs
     # - depguard
+    - copyloopvar
     - dogsled
     # - dupl
     - errcheck
-    - exportloopref
     - exhaustive
     - goconst
     - gocritic
     - gofmt
     - goimports
-    - gomnd
     - gocyclo
     - gosec
     - gosimple
     - govet
     - ineffassign
     - misspell
+    - mnd
     - nolintlint
     - nakedret
     - prealloc
@@ -70,4 +69,4 @@ issues:
 
 run:
   issues-exit-code: 1
-  timeout: 5m
+  timeout: "5m"

.vscode/settings.json

@@ -18,6 +18,9 @@
     "cmocks",
     "cobrass",
     "configurator",
+    "copyloopvar",
+    "coverpkg",
+    "coverprofile",
     "cubiest",
     "deadcode",
     "deepcopy",

Taskfile.yml

@@ -225,10 +225,38 @@ tasks:
 
   # === coverage =============================================
 
-  cover:
+  cover-clean:
+    cmds:
+      - rm -rf ./coverage
+
+  cover-publish:
     cmds:
       - goveralls -repotoken {{.COVERALLS_TOKEN}}
 
+  cover-setup:
+    cmds:
+      - mkdir -p ./coverage
+
+  cover-ginkgo:
+    cmds:
+      - ginkgo run -r -json-report {{.GINKGO_REPORT}} -coverpkg=./... -coverprofile={{.COVER_FILE}} --output-dir {{.COVER_DIR}}
+
+  cover-show:
+    cmds:
+      - open {{.COVER_HTML_PATH}}
+
+  cover-exclude:
+    cmds:
+      - ./scripts/apply-coverage-exclusions.sh
+
+  cover:
+    cmds:
+      - task: cover-setup
+      - task: cover-ginkgo
+      - task: cover-exclude
+      - go tool cover -html=./coverage.out -o {{.COVER_HTML_PATH}}
+      - open {{.COVER_HTML_PATH}}
+
   # === i18n =================================================
 
   clear:

go.mod

@@ -1,6 +1,6 @@
 module github.com/snivilised/pixa
 
-go 1.22
+go 1.23.0
 
 require (
 	github.com/charmbracelet/bubbletea v1.1.1
@@ -11,6 +11,7 @@ require (
 	github.com/pkg/errors v0.9.1
 	github.com/samber/lo v1.47.0
 	github.com/snivilised/extendio v0.7.0
+	github.com/snivilised/li18ngo v0.1.4
 	github.com/snivilised/lorax v0.5.2
 	github.com/spf13/cobra v1.8.1
 	github.com/spf13/viper v1.18.2

go.sum

@@ -125,6 +125,8 @@ github.com/snivilised/cobrass v0.4.5 h1:NeU/NwuOuJzotqa4JwnqGqbV1fs1SjB6GF53sXFO
 github.com/snivilised/cobrass v0.4.5/go.mod h1:hGVu/zjWVG3tRKo3P0tjelm5S44vMTa/w29ygnvi+lY=
 github.com/snivilised/extendio v0.7.0 h1:MY6w9qCK5wVEvP2WpMT5ywJwpDJe97WHDGuwrsTLpek=
 github.com/snivilised/extendio v0.7.0/go.mod h1:l8MwJOy9ojMQYJrSKRbQS3WfDylevnRtBp/zwAmFEKc=
+github.com/snivilised/li18ngo v0.1.4 h1:y6EECoVFpmkud2yDEeBnMnebPmSvdrEZ/LAq1PoPctE=
+github.com/snivilised/li18ngo v0.1.4/go.mod h1:Or3qUhpR6AM1X51i82RtyCvORWy2/hrxY9lg1i1gFTE=
 github.com/snivilised/lorax v0.5.2 h1:iReIJl63tydiPSSD0YzsNQFX1CctmvMkYx0aSxoZJKo=
 github.com/snivilised/lorax v0.5.2/go.mod h1:7H1JPgSn4h4p8NSqfl64raacYefdm/FiFkfcZ51PVHY=
 github.com/sourcegraph/conc v0.3.0 h1:OQTbbt6P72L20UqAkXXuLOj79LfEanQ+YQFNpLA9ySo=

scripts/apply-coverage-exclusions.sh

@@ -0,0 +1,34 @@
+#!/bin/bash
+
+# Define paths relative to the root directory
+ROOT_DIR="$(git rev-parse --show-toplevel)"
+COVERAGE_FILE="$ROOT_DIR/coverage.out"
+EXCLUSIONS_FILE="$ROOT_DIR/scripts/coverage-exclusion-list.txt"
+
+# Check if required files exist
+if [ ! -f "$COVERAGE_FILE" ]; then
+    echo "Error: Coverage file not found at $COVERAGE_FILE"
+    exit 1
+fi
+
+if [ ! -f "$EXCLUSIONS_FILE" ]; then
+    echo "Error: Exclusions file not found at $EXCLUSIONS_FILE"
+    exit 1
+fi
+
+# Create a temporary file
+TEMP_FILE=$(mktemp)
+
+# Process the exclusions
+while IFS= read -r line || [[ -n "$line" ]]; do
+    # Escape special characters in the line for use in sed
+    escaped_line=$(echo "$line" | sed 's/[\/&]/\\&/g')
+
+    # Remove matching lines from the coverage file
+    sed "/${escaped_line}/d" "$COVERAGE_FILE" > "$TEMP_FILE"
+
+    # Replace the original file with the modified content
+    mv "$TEMP_FILE" "$COVERAGE_FILE"
+done < "$EXCLUSIONS_FILE"
+
+echo "Coverage exclusions have been applied successfully."

scripts/coverage-exclusion-list.txt

@@ -0,0 +1 @@
+github.com/snivilised/pixa/src/internal/matchers

src/app/cfg/config-runner.go

@@ -11,8 +11,8 @@ import (
 	"github.com/snivilised/cobrass/src/assistant/configuration"
 	ci18n "github.com/snivilised/cobrass/src/assistant/i18n"
 	"github.com/snivilised/extendio/collections"
-	xi18n "github.com/snivilised/extendio/i18n"
 	"github.com/snivilised/extendio/xfs/storage"
+	"github.com/snivilised/li18ngo"
 	"github.com/snivilised/pixa/src/app/proxy/common"
 	"github.com/spf13/viper"
 	"golang.org/x/text/language"
@@ -216,18 +216,18 @@ func (c *configRunner) handleLangSetting(config configuration.ViperConfig) {
 			return parsedTag
 		},
 		func() language.Tag {
-			return xi18n.DefaultLanguage.Get()
+			return li18ngo.DefaultLanguage
 		},
 	)
 
-	err := xi18n.Use(func(uo *xi18n.UseOptions) {
+	err := li18ngo.Use(func(uo *li18ngo.UseOptions) {
 		uo.Tag = tag
-		uo.From = xi18n.LoadFrom{
-			Sources: xi18n.TranslationFiles{
-				c.sourceID: xi18n.TranslationSource{
+		uo.From = li18ngo.LoadFrom{
+			Sources: li18ngo.TranslationFiles{
+				c.sourceID: li18ngo.TranslationSource{
 					Name: c.applicationName,
 				},
-				ci18n.CobrassSourceID: xi18n.TranslationSource{
+				ci18n.CobrassSourceID: li18ngo.TranslationSource{
 					Name: "cobrass",
 				},
 			},

src/app/cfg/config-runner_test.go

@@ -12,6 +12,7 @@ import (
 
 	"github.com/snivilised/cobrass/src/assistant/mocks"
 	"github.com/snivilised/extendio/xfs/storage"
+	"github.com/snivilised/li18ngo"
 	"github.com/snivilised/pixa/src/app/cfg"
 	"github.com/snivilised/pixa/src/app/proxy/common"
 	"github.com/snivilised/pixa/src/internal/helpers"
@@ -58,7 +59,7 @@ type runnerTE struct {
 	assert  func(entry *runnerTE, runner common.ConfigRunner, err error)
 }
 
-var _ = Describe("ConfigRunner", func() {
+var _ = Describe("ConfigRunner", Ordered, func() {
 	var (
 		repo       string
 		configPath string
@@ -67,6 +68,10 @@ var _ = Describe("ConfigRunner", func() {
 		mock       *mocks.MockViperConfig
 	)
 
+	BeforeAll(func() {
+		Expect(li18ngo.Use()).To(Succeed())
+	})
+
 	BeforeEach(func() {
 		viper.Reset()
 		vfs = storage.UseMemFS()

src/app/command/bootstrap.go

@@ -16,9 +16,9 @@ import (
 	"github.com/snivilised/cobrass/src/assistant"
 	"github.com/snivilised/cobrass/src/assistant/configuration"
 	ci18n "github.com/snivilised/cobrass/src/assistant/i18n"
-	xi18n "github.com/snivilised/extendio/i18n"
 	"github.com/snivilised/extendio/xfs/storage"
 	"github.com/snivilised/extendio/xfs/utils"
+	"github.com/snivilised/li18ngo"
 	"github.com/snivilised/pixa/src/app/cfg"
 	"github.com/snivilised/pixa/src/app/plog"
 	"github.com/snivilised/pixa/src/app/proxy"
@@ -51,7 +51,7 @@ func validatePositionalArgs(cmd *cobra.Command, args []string) error {
 	directory := utils.ResolvePath(args[0])
 
 	if !utils.Exists(directory) {
-		return xi18n.NewPathNotFoundError("shrink directory", directory)
+		return li18ngo.NewPathNotFoundError("shrink directory", directory)
 	}
 
 	return nil
@@ -125,8 +125,8 @@ func (b *Bootstrap) Root(options ...ConfigureOptionFn) *cobra.Command {
 	b.Container = assistant.NewCobraContainer(
 		&cobra.Command{
 			Use:     "main",
-			Short:   xi18n.Text(locale.RootCmdShortDescTemplData{}),
-			Long:    xi18n.Text(locale.RootCmdLongDescTemplData{}),
+			Short:   li18ngo.Text(locale.RootCmdShortDescTemplData{}),
+			Long:    li18ngo.Text(locale.RootCmdLongDescTemplData{}),
 			Version: fmt.Sprintf("'%v'", Version),
 			RunE: func(_ *cobra.Command, args []string) error {
 				inputs := b.getRootInputs()
@@ -178,7 +178,7 @@ func (b *Bootstrap) Root(options ...ConfigureOptionFn) *cobra.Command {
 
 func (b *Bootstrap) configure() {
 	if err := b.OptionsInfo.Runner.Run(); err != nil {
-		msg := xi18n.Text(locale.UsingConfigFileTemplData{
+		msg := li18ngo.Text(locale.UsingConfigFileTemplData{
 			ConfigFileName: b.OptionsInfo.Config.Viper.ConfigFileUsed(),
 		})
 
@@ -202,18 +202,18 @@ func handleLangSetting(config configuration.ViperConfig) {
 			return parsedTag
 		},
 		func() language.Tag {
-			return xi18n.DefaultLanguage.Get()
+			return li18ngo.DefaultLanguage
 		},
 	)
 
-	err := xi18n.Use(func(uo *xi18n.UseOptions) {
+	err := li18ngo.Use(func(uo *li18ngo.UseOptions) {
 		uo.Tag = tag
-		uo.From = xi18n.LoadFrom{
-			Sources: xi18n.TranslationFiles{
-				common.Definitions.Pixa.SourceID: xi18n.TranslationSource{
+		uo.From = li18ngo.LoadFrom{
+			Sources: li18ngo.TranslationFiles{
+				common.Definitions.Pixa.SourceID: li18ngo.TranslationSource{
 					Name: common.Definitions.Pixa.AppName,
 				},
-				ci18n.CobrassSourceID: xi18n.TranslationSource{
+				ci18n.CobrassSourceID: li18ngo.TranslationSource{
 					Name: "cobrass",
 				},
 			},

src/app/command/magick-cmd_test.go

@@ -5,8 +5,8 @@ import (
 	. "github.com/onsi/gomega"    //nolint:revive // foo
 
 	"github.com/snivilised/cobrass/src/assistant/configuration"
-	xi18n "github.com/snivilised/extendio/i18n"
 	"github.com/snivilised/extendio/xfs/storage"
+	"github.com/snivilised/li18ngo"
 	"github.com/snivilised/pixa/src/app/command"
 	"github.com/snivilised/pixa/src/app/proxy/common"
 	"github.com/snivilised/pixa/src/internal/helpers"
@@ -28,7 +28,7 @@ var _ = Describe("MagickCmd", Ordered, func() {
 	})
 
 	BeforeEach(func() {
-		xi18n.ResetTx()
+		Expect(li18ngo.Use()).To(Succeed())
 		vfs, _ = helpers.SetupTest(
 			"nasa-scientist-index.xml", configPath, l10nPath, helpers.Silent,
 		)