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

* Internalized 'i18n' module

* Internalized 'docsgen' package

* Internalized 'client_example'

* Updated docs

Author: cmaglie

Diff for: .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:

Diff for: .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"

Diff for: .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

Diff for: 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:

Diff for: 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

Diff for: 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"

Diff for: 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"

Diff for: 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"
 )
 

Diff for: 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"

Diff for: 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"

Diff for: commands/instances.go

@@ -24,7 +24,6 @@ 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"
 	"github.com/arduino/arduino-cli/internal/arduino/cores/packageindex"
 	"github.com/arduino/arduino-cli/internal/arduino/cores/packagemanager"
@@ -36,6 +35,7 @@ import (
 	"github.com/arduino/arduino-cli/internal/arduino/sketch"
 	"github.com/arduino/arduino-cli/internal/arduino/utils"
 	"github.com/arduino/arduino-cli/internal/cli/configuration"
+	"github.com/arduino/arduino-cli/internal/i18n"
 	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
 	paths "github.com/arduino/go-paths-helper"
 	"github.com/sirupsen/logrus"

Diff for: commands/lib/download.go

@@ -20,10 +20,10 @@ 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/httpclient"
 	"github.com/arduino/arduino-cli/internal/arduino/libraries/librariesindex"
 	"github.com/arduino/arduino-cli/internal/arduino/libraries/librariesmanager"
+	"github.com/arduino/arduino-cli/internal/i18n"
 	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
 	"github.com/sirupsen/logrus"
 )

Diff for: commands/monitor/monitor.go

@@ -22,10 +22,10 @@ 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"
 	"github.com/arduino/arduino-cli/internal/arduino/cores/packagemanager"
 	pluggableMonitor "github.com/arduino/arduino-cli/internal/arduino/monitor"
+	"github.com/arduino/arduino-cli/internal/i18n"
 	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
 	"github.com/arduino/go-properties-orderedmap"
 	"github.com/sirupsen/logrus"

Diff for: commands/sketch/archive.go

@@ -23,8 +23,8 @@ import (
 	"strings"
 
 	"github.com/arduino/arduino-cli/commands/cmderrors"
-	"github.com/arduino/arduino-cli/i18n"
 	"github.com/arduino/arduino-cli/internal/arduino/sketch"
+	"github.com/arduino/arduino-cli/internal/i18n"
 	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
 	paths "github.com/arduino/go-paths-helper"
 )

Diff for: commands/upload/upload.go

@@ -26,14 +26,14 @@ import (
 
 	"github.com/arduino/arduino-cli/commands/cmderrors"
 	"github.com/arduino/arduino-cli/commands/internal/instances"
-	"github.com/arduino/arduino-cli/i18n"
 	f "github.com/arduino/arduino-cli/internal/algorithms"
 	"github.com/arduino/arduino-cli/internal/arduino/cores"
 	"github.com/arduino/arduino-cli/internal/arduino/cores/packagemanager"
 	"github.com/arduino/arduino-cli/internal/arduino/discovery"
 	"github.com/arduino/arduino-cli/internal/arduino/globals"
 	"github.com/arduino/arduino-cli/internal/arduino/serialutils"
 	"github.com/arduino/arduino-cli/internal/arduino/sketch"
+	"github.com/arduino/arduino-cli/internal/i18n"
 	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
 	paths "github.com/arduino/go-paths-helper"
 	properties "github.com/arduino/go-properties-orderedmap"

Diff for: docs/UPGRADING.md

@@ -10,8 +10,11 @@ The following golang modules are no longer available as public API:
 
 - `github.com/arduino/arduino-cli/arduino`
 - `github.com/arduino/arduino-cli/buildcache`
+- `github.com/arduino/arduino-cli/client_example`
 - `github.com/arduino/arduino-cli/configuration`
+- `github.com/arduino/arduino-cli/docsgen`
 - `github.com/arduino/arduino-cli/executils`
+- `github.com/arduino/arduino-cli/i18n`
 - `github.com/arduino/arduino-cli/table`
 
 Most of the `executils` library has been integrated inside the `go-paths` library `github.com/arduino/go-paths-helper`.

Diff for: docs/getting-started.md

@@ -349,6 +349,6 @@ metrics:
 ```
 
 [configuration documentation]: configuration.md
-[client_example]: https://github.com/arduino/arduino-cli/blob/master/client_example
+[client_example]: https://github.com/arduino/arduino-cli/blob/master/rpc/internal/client_example
 [grpc reference]: rpc/commands.md
 [prometheus]: https://prometheus.io/

Diff for: docs/index.md

@@ -19,5 +19,5 @@ services and messages are detailed in the [gRPC reference] pages.
 
 [installation]: installation.md
 [getting started guide]: getting-started.md
-[client_example]: https://github.com/arduino/arduino-cli/blob/master/client_example
+[client_example]: https://github.com/arduino/arduino-cli/blob/master/rpc/internal/client_example
 [grpc reference]: rpc/commands.md

Diff for: docs/integration-options.md

@@ -102,7 +102,7 @@ tracker] if you’ve got a use case that doesn’t fit one of the three pillars.
 [grpc interface reference]: rpc/commands.md
 [grpc supported languages]: https://grpc.io/docs/languages/
 [arduino cli repository]: https://github.com/arduino/arduino-cli
-[grpc client example]: https://github.com/arduino/arduino-cli/blob/master/client_example
+[grpc client example]: https://github.com/arduino/arduino-cli/blob/master/rpc/internal/client_example
 [commands package]: https://github.com/arduino/arduino-cli/tree/master/commands
 [issue tracker]: https://github.com/arduino/arduino-cli/issues
 [contextual help screenshot]: img/CLI_contextual_help_screenshot.png

Diff for: internal/arduino/builder/internal/compilation/database.go

@@ -20,7 +20,7 @@ import (
 	"fmt"
 	"os"
 
-	"github.com/arduino/arduino-cli/i18n"
+	"github.com/arduino/arduino-cli/internal/i18n"
 	"github.com/arduino/go-paths-helper"
 )
 

Diff for: internal/arduino/builder/internal/detector/detector.go

@@ -26,7 +26,6 @@ import (
 	"strings"
 	"time"
 
-	"github.com/arduino/arduino-cli/i18n"
 	"github.com/arduino/arduino-cli/internal/arduino/builder/internal/logger"
 	"github.com/arduino/arduino-cli/internal/arduino/builder/internal/preprocessor"
 	"github.com/arduino/arduino-cli/internal/arduino/builder/internal/utils"
@@ -36,6 +35,7 @@ import (
 	"github.com/arduino/arduino-cli/internal/arduino/libraries/librariesmanager"
 	"github.com/arduino/arduino-cli/internal/arduino/libraries/librariesresolver"
 	"github.com/arduino/arduino-cli/internal/arduino/sketch"
+	"github.com/arduino/arduino-cli/internal/i18n"
 	"github.com/arduino/go-paths-helper"
 	"github.com/arduino/go-properties-orderedmap"
 )

Diff for: internal/arduino/builder/internal/preprocessor/ctags.go

@@ -25,10 +25,10 @@ import (
 	"strconv"
 	"strings"
 
-	"github.com/arduino/arduino-cli/i18n"
 	"github.com/arduino/arduino-cli/internal/arduino/builder/cpp"
 	"github.com/arduino/arduino-cli/internal/arduino/builder/internal/preprocessor/internal/ctags"
 	"github.com/arduino/arduino-cli/internal/arduino/sketch"
+	"github.com/arduino/arduino-cli/internal/i18n"
 	"github.com/arduino/go-paths-helper"
 	"github.com/arduino/go-properties-orderedmap"
 )

Diff for: internal/arduino/builder/sketch.go

@@ -24,9 +24,9 @@ import (
 	"strconv"
 	"strings"
 
-	"github.com/arduino/arduino-cli/i18n"
 	f "github.com/arduino/arduino-cli/internal/algorithms"
 	"github.com/arduino/arduino-cli/internal/arduino/builder/cpp"
+	"github.com/arduino/arduino-cli/internal/i18n"
 	"github.com/arduino/go-paths-helper"
 	"github.com/marcinbor85/gohex"
 )

Diff for: internal/arduino/cores/cores.go

@@ -25,10 +25,10 @@ import (
 	"sort"
 	"strings"
 
-	"github.com/arduino/arduino-cli/i18n"
 	"github.com/arduino/arduino-cli/internal/arduino/globals"
 	"github.com/arduino/arduino-cli/internal/arduino/resources"
 	"github.com/arduino/arduino-cli/internal/arduino/utils"
+	"github.com/arduino/arduino-cli/internal/i18n"
 	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
 	paths "github.com/arduino/go-paths-helper"
 	properties "github.com/arduino/go-properties-orderedmap"

Diff for: internal/arduino/cores/packageindex/index.go

@@ -19,10 +19,10 @@ import (
 	"encoding/json"
 	"fmt"
 
-	"github.com/arduino/arduino-cli/i18n"
 	"github.com/arduino/arduino-cli/internal/arduino/cores"
 	"github.com/arduino/arduino-cli/internal/arduino/resources"
 	"github.com/arduino/arduino-cli/internal/arduino/security"
+	"github.com/arduino/arduino-cli/internal/i18n"
 	"github.com/arduino/go-paths-helper"
 	easyjson "github.com/mailru/easyjson"
 	"github.com/sirupsen/logrus"

Diff for: internal/arduino/cores/packagemanager/package_manager.go

@@ -28,11 +28,11 @@ import (
 	"time"
 
 	"github.com/arduino/arduino-cli/commands/cmderrors"
-	"github.com/arduino/arduino-cli/i18n"
 	"github.com/arduino/arduino-cli/internal/arduino/cores"
 	"github.com/arduino/arduino-cli/internal/arduino/cores/packageindex"
 	"github.com/arduino/arduino-cli/internal/arduino/discovery/discoverymanager"
 	"github.com/arduino/arduino-cli/internal/arduino/sketch"
+	"github.com/arduino/arduino-cli/internal/i18n"
 	paths "github.com/arduino/go-paths-helper"
 	properties "github.com/arduino/go-properties-orderedmap"
 	"github.com/arduino/go-timeutils"

Diff for: internal/arduino/discovery/discovery.go

@@ -24,7 +24,7 @@ import (
 	"sync"
 	"time"
 
-	"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/arduino-cli/version"
 	"github.com/arduino/go-paths-helper"

Diff for: internal/arduino/discovery/discoverymanager/discoverymanager.go

@@ -21,8 +21,8 @@ import (
 	"sync"
 	"time"
 
-	"github.com/arduino/arduino-cli/i18n"
 	"github.com/arduino/arduino-cli/internal/arduino/discovery"
+	"github.com/arduino/arduino-cli/internal/i18n"
 	"github.com/sirupsen/logrus"
 )
 

Diff for: internal/arduino/httpclient/httpclient.go

@@ -21,8 +21,8 @@ import (
 	"time"
 
 	"github.com/arduino/arduino-cli/commands/cmderrors"
-	"github.com/arduino/arduino-cli/i18n"
 	"github.com/arduino/arduino-cli/internal/cli/configuration"
+	"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"

Diff for: internal/arduino/libraries/libraries.go

@@ -18,9 +18,9 @@ package libraries
 import (
 	"fmt"
 
-	"github.com/arduino/arduino-cli/i18n"
 	"github.com/arduino/arduino-cli/internal/arduino/cores"
 	"github.com/arduino/arduino-cli/internal/arduino/globals"
+	"github.com/arduino/arduino-cli/internal/i18n"
 	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
 	paths "github.com/arduino/go-paths-helper"
 	properties "github.com/arduino/go-properties-orderedmap"

Diff for: internal/arduino/libraries/librariesindex/json.go

@@ -18,8 +18,8 @@ package librariesindex
 import (
 	"fmt"
 
-	"github.com/arduino/arduino-cli/i18n"
 	"github.com/arduino/arduino-cli/internal/arduino/resources"
+	"github.com/arduino/arduino-cli/internal/i18n"
 	"github.com/arduino/go-paths-helper"
 	easyjson "github.com/mailru/easyjson"
 	semver "go.bug.st/relaxed-semver"

Diff for: internal/arduino/libraries/librariesmanager/librariesmanager.go

@@ -22,10 +22,10 @@ import (
 	"slices"
 	"strings"
 
-	"github.com/arduino/arduino-cli/i18n"
 	"github.com/arduino/arduino-cli/internal/arduino/cores"
 	"github.com/arduino/arduino-cli/internal/arduino/libraries"
 	"github.com/arduino/arduino-cli/internal/arduino/libraries/librariesindex"
+	"github.com/arduino/arduino-cli/internal/i18n"
 	paths "github.com/arduino/go-paths-helper"
 	"github.com/sirupsen/logrus"
 	"google.golang.org/grpc/codes"