[breaking] refactor: made some golang modules private (part 3) (#2467)

* Internalized 'i18n' module

* Internalized 'docsgen' package

* Internalized 'client_example'

* Updated docs

Author: cmaglie

.github/workflows/check-go-task.yml

@@ -236,7 +236,7 @@ jobs:
       matrix:
         module:
           - path: internal/arduino/discovery/discovery_client
-          - path: client_example
+          - path: rpc/internal/client_example
           - path: commands/daemon/term_example
 
     steps:

.github/workflows/deploy-cobra-mkdocs-versioned-poetry.yml

@@ -21,7 +21,7 @@ on:
       - "go.sum"
       - "Taskfile.ya?ml"
       - "**.go"
-      - "docsgen/**"
+      - "internal/docsgen/**"
       - "rpc/**"
       - "mkdocs.ya?ml"
       - "poetry.lock"

.gitignore

@@ -18,18 +18,18 @@ __debug_bin*
 .vscode
 
 # gRPC client example folder
-/client_example/client_example
-/client_example/**/*.bin
-/client_example/**/*.elf
+/rpc/internal/client_example/client_example
+/rpc/internal/client_example/**/*.bin
+/rpc/internal/client_example/**/*.elf
 
 # Misc.
 .DS_Store
 
 # Mkdocs
 /site/
 /public/
-/docsgen/arduino-cli
-/docsgen/arduino-cli.exe
+/internal/docsgen/arduino-cli
+/internal/docsgen/arduino-cli.exe
 /docs/rpc/*.md
 /docs/commands/*.md
 /docs/configuration.schema.json

Taskfile.yml

@@ -53,12 +53,12 @@ tasks:
   # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/deploy-cobra-mkdocs-versioned-poetry/Taskfile.yml
   go:cli-docs:
     desc: Generate command line interface reference documentation
-    dir: ./docsgen
+    dir: ./internal/docsgen
     cmds:
       # Command examples use os.Args[0] so the docs generation binary must have the same filename as the project
       - go build -o {{.PROJECT_NAME}}{{exeExt}}
       # The binary is invoked like this instead of `./{{.PROJECT_NAME}}` to remove the `./` chars from the examples
-      - PATH=. {{.PROJECT_NAME}} ../docs/commands
+      - PATH=. {{.PROJECT_NAME}} ../../docs/commands
 
   # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-go-task/Taskfile.yml
   go:fix:
@@ -301,24 +301,24 @@ tasks:
   i18n:update:
     desc: Updates i18n files
     cmds:
-      - go run ./i18n/cmd/main.go catalog generate . > ./i18n/data/en.po
+      - go run ./internal/i18n/cmd/main.go catalog generate . > ./internal/i18n/data/en.po
 
   i18n:pull:
     desc: Pull i18n files from transifex
     cmds:
-      - go run ./i18n/cmd/main.go transifex pull ./i18n/data
+      - go run ./internal/i18n/cmd/main.go transifex pull ./internal/i18n/data
 
   i18n:push:
     desc: Push i18n files to transifex
     cmds:
-      - go run ./i18n/cmd/main.go transifex push ./i18n/data
+      - go run ./internal/i18n/cmd/main.go transifex push ./internal/i18n/data
 
   i18n:check:
     desc: Check if the i18n message catalog was updated
     cmds:
       - task: i18n:pull
-      - git add -N ./i18n/data
-      - git diff --exit-code ./i18n/data
+      - git add -N ./internal/i18n/data
+      - git diff --exit-code ./internal/i18n/data
 
   # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-mkdocs-task/Taskfile.yml
   website:check:

commands/board/board.go

@@ -15,6 +15,6 @@
 
 package board
 
-import "github.com/arduino/arduino-cli/i18n"
+import "github.com/arduino/arduino-cli/internal/i18n"
 
 var tr = i18n.Tr

commands/cmderrors/cmderrors.go

@@ -19,7 +19,7 @@ import (
 	"fmt"
 	"strings"
 
-	"github.com/arduino/arduino-cli/i18n"
+	"github.com/arduino/arduino-cli/internal/i18n"
 	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
 	"github.com/arduino/go-paths-helper"
 	"google.golang.org/grpc/codes"

commands/compile/compile.go

@@ -25,14 +25,14 @@ import (
 
 	"github.com/arduino/arduino-cli/commands/cmderrors"
 	"github.com/arduino/arduino-cli/commands/internal/instances"
-	"github.com/arduino/arduino-cli/i18n"
 	"github.com/arduino/arduino-cli/internal/arduino/builder"
 	"github.com/arduino/arduino-cli/internal/arduino/cores"
 	"github.com/arduino/arduino-cli/internal/arduino/libraries/librariesmanager"
 	"github.com/arduino/arduino-cli/internal/arduino/sketch"
 	"github.com/arduino/arduino-cli/internal/arduino/utils"
 	"github.com/arduino/arduino-cli/internal/buildcache"
 	"github.com/arduino/arduino-cli/internal/cli/configuration"
+	"github.com/arduino/arduino-cli/internal/i18n"
 	"github.com/arduino/arduino-cli/internal/inventory"
 	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
 	paths "github.com/arduino/go-paths-helper"

commands/core/download.go

@@ -21,8 +21,8 @@ import (
 	"github.com/arduino/arduino-cli/commands"
 	"github.com/arduino/arduino-cli/commands/cmderrors"
 	"github.com/arduino/arduino-cli/commands/internal/instances"
-	"github.com/arduino/arduino-cli/i18n"
 	"github.com/arduino/arduino-cli/internal/arduino/cores/packagemanager"
+	"github.com/arduino/arduino-cli/internal/i18n"
 	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
 )
 

commands/daemon/daemon.go

@@ -30,7 +30,7 @@ import (
 	"github.com/arduino/arduino-cli/commands/monitor"
 	"github.com/arduino/arduino-cli/commands/sketch"
 	"github.com/arduino/arduino-cli/commands/upload"
-	"github.com/arduino/arduino-cli/i18n"
+	"github.com/arduino/arduino-cli/internal/i18n"
 	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
 	"github.com/sirupsen/logrus"
 	"google.golang.org/grpc/metadata"

commands/debug/debug.go

@@ -26,8 +26,8 @@ import (
 
 	"github.com/arduino/arduino-cli/commands/cmderrors"
 	"github.com/arduino/arduino-cli/commands/internal/instances"
-	"github.com/arduino/arduino-cli/i18n"
 	"github.com/arduino/arduino-cli/internal/arduino/cores/packagemanager"
+	"github.com/arduino/arduino-cli/internal/i18n"
 	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
 	"github.com/arduino/go-paths-helper"
 	"github.com/sirupsen/logrus"