Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit 45062fb

Browse filesBrowse files
cmagliecmaglie
committed
Isolate locale-handling functions from i18n interface
This changes allows to make a clean i18n package (without dependency on a specific implementation of the translation package) that, in turn, allows to export packages that internally use i18n with the minimal dependency load.
1 parent a3c9f72 commit 45062fb
Copy full SHA for 45062fb

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
Dismiss banner

53 files changed

+85
-50
lines changed

‎commands/instances.go

Copy file name to clipboardExpand all lines: commands/instances.go
+2-1Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ import (
3838
"github.com/arduino/arduino-cli/internal/arduino/sketch"
3939
"github.com/arduino/arduino-cli/internal/arduino/utils"
4040
"github.com/arduino/arduino-cli/internal/i18n"
41+
"github.com/arduino/arduino-cli/internal/locales"
4142
rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
4243
paths "github.com/arduino/go-paths-helper"
4344
"github.com/sirupsen/logrus"
@@ -420,7 +421,7 @@ func (s *arduinoCoreServerImpl) Init(req *rpc.InitRequest, stream rpc.ArduinoCor
420421
// language of the CLI if the locale is different
421422
// after started.
422423
if locale, ok, _ := s.settings.GetStringOk("locale"); ok {
423-
i18n.Init(locale)
424+
locales.Init(locale)
424425
}
425426

426427
return nil

‎internal/i18n/i18n.go

Copy file name to clipboardExpand all lines: internal/i18n/i18n.go
+19-22Lines changed: 19 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -15,31 +15,28 @@
1515

1616
package i18n
1717

18-
// Init initializes the i18n module, setting the locale according to this order of preference:
19-
// 1. Locale specified via the function call
20-
// 2. OS Locale
21-
// 3. en (default)
22-
func Init(configLocale string) {
23-
locales := supportedLocales()
24-
if configLocale != "" {
25-
if locale := findMatchingLocale(configLocale, locales); locale != "" {
26-
setLocale(locale)
27-
return
28-
}
29-
}
30-
31-
if osLocale := getLocaleIdentifierFromOS(); osLocale != "" {
32-
if locale := findMatchingLocale(osLocale, locales); locale != "" {
33-
setLocale(locale)
34-
return
35-
}
36-
}
37-
38-
setLocale("en")
18+
import "fmt"
19+
20+
type Locale interface {
21+
Get(msg string, args ...interface{}) string
22+
}
23+
24+
type nullLocale struct{}
25+
26+
func (n nullLocale) Parse([]byte) {}
27+
28+
func (n nullLocale) Get(msg string, args ...interface{}) string {
29+
return fmt.Sprintf(msg, args...)
30+
}
31+
32+
var locale Locale = &nullLocale{}
33+
34+
func SetLocale(l Locale) {
35+
locale = l
3936
}
4037

4138
// Tr returns msg translated to the selected locale
4239
// the msg argument must be a literal string
4340
func Tr(msg string, args ...interface{}) string {
44-
return po.Get(msg, args...)
41+
return locale.Get(msg, args...)
4542
}

‎internal/i18n/i18n_test.go

Copy file name to clipboardExpand all lines: internal/i18n/i18n_test.go
+4-3Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,9 @@ import (
2525
)
2626

2727
func setPo(poFile string) {
28-
po = gotext.NewPo()
29-
po.Parse([]byte(poFile))
28+
dict := gotext.NewPo()
29+
dict.Parse([]byte(poFile))
30+
SetLocale(dict)
3031
}
3132

3233
func TestPoTranslation(t *testing.T) {
@@ -39,7 +40,7 @@ func TestPoTranslation(t *testing.T) {
3940
}
4041

4142
func TestNoLocaleSet(t *testing.T) {
42-
po = gotext.NewPo()
43+
locale = gotext.NewPo()
4344
require.Equal(t, "test-key", Tr("test-key"))
4445
}
4546

‎internal/i18n/README.md renamed to ‎internal/locales/README.md

Copy file name to clipboard

‎internal/i18n/cmd/ast/parser.go renamed to ‎internal/locales/cmd/ast/parser.go

Copy file name to clipboardExpand all lines: internal/locales/cmd/ast/parser.go
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ import (
2424
"path/filepath"
2525
"strconv"
2626

27-
"github.com/arduino/arduino-cli/internal/i18n/cmd/po"
27+
"github.com/arduino/arduino-cli/internal/locales/cmd/po"
2828
)
2929

3030
// GenerateCatalog generates the i18n message catalog for the go source files

‎internal/i18n/cmd/commands/catalog/catalog.go renamed to ‎internal/locales/cmd/commands/catalog/catalog.go

Copy file name to clipboard
File renamed without changes.

‎internal/i18n/cmd/commands/catalog/generate_catalog.go renamed to ‎internal/locales/cmd/commands/catalog/generate_catalog.go

Copy file name to clipboardExpand all lines: internal/locales/cmd/commands/catalog/generate_catalog.go
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ import (
1919
"os"
2020
"path/filepath"
2121

22-
"github.com/arduino/arduino-cli/internal/i18n/cmd/ast"
22+
"github.com/arduino/arduino-cli/internal/locales/cmd/ast"
2323
"github.com/spf13/cobra"
2424
)
2525

‎internal/i18n/cmd/commands/root.go renamed to ‎internal/locales/cmd/commands/root.go

Copy file name to clipboardExpand all lines: internal/locales/cmd/commands/root.go
+2-2Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@
1616
package commands
1717

1818
import (
19-
"github.com/arduino/arduino-cli/internal/i18n/cmd/commands/catalog"
20-
"github.com/arduino/arduino-cli/internal/i18n/cmd/commands/transifex"
19+
"github.com/arduino/arduino-cli/internal/locales/cmd/commands/catalog"
20+
"github.com/arduino/arduino-cli/internal/locales/cmd/commands/transifex"
2121
"github.com/spf13/cobra"
2222
)
2323

‎internal/i18n/cmd/commands/transifex/pull_transifex.go renamed to ‎internal/locales/cmd/commands/transifex/pull_transifex.go

Copy file name to clipboard
File renamed without changes.

‎internal/i18n/cmd/commands/transifex/push_transifex.go renamed to ‎internal/locales/cmd/commands/transifex/push_transifex.go

Copy file name to clipboard
File renamed without changes.

‎internal/i18n/cmd/commands/transifex/transifex.go renamed to ‎internal/locales/cmd/commands/transifex/transifex.go

Copy file name to clipboard
File renamed without changes.

‎internal/i18n/cmd/main.go renamed to ‎internal/locales/cmd/main.go

Copy file name to clipboardExpand all lines: internal/locales/cmd/main.go
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ import (
1919
"fmt"
2020
"os"
2121

22-
"github.com/arduino/arduino-cli/internal/i18n/cmd/commands"
22+
"github.com/arduino/arduino-cli/internal/locales/cmd/commands"
2323
)
2424

2525
func main() {

‎internal/i18n/cmd/po/catalog.go renamed to ‎internal/locales/cmd/po/catalog.go

Copy file name to clipboard
File renamed without changes.

‎internal/i18n/cmd/po/catalog_test.go renamed to ‎internal/locales/cmd/po/catalog_test.go

Copy file name to clipboard
File renamed without changes.

‎internal/i18n/cmd/po/merge.go renamed to ‎internal/locales/cmd/po/merge.go

Copy file name to clipboard
File renamed without changes.

‎internal/i18n/cmd/po/merge_test.go renamed to ‎internal/locales/cmd/po/merge_test.go

Copy file name to clipboard
File renamed without changes.

‎internal/i18n/cmd/po/parser.go renamed to ‎internal/locales/cmd/po/parser.go

Copy file name to clipboard
File renamed without changes.

‎internal/i18n/cmd/po/parser_test.go renamed to ‎internal/locales/cmd/po/parser_test.go

Copy file name to clipboard
File renamed without changes.

‎internal/i18n/convert.go renamed to ‎internal/locales/convert.go

Copy file name to clipboardExpand all lines: internal/locales/convert.go
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
// Arduino software without disclosing the source code of your own applications.
1414
// To purchase a commercial license, send an email to license@arduino.cc.
1515

16-
package i18n
16+
package locales
1717

1818
import (
1919
"regexp"

‎internal/i18n/convert_test.go renamed to ‎internal/locales/convert_test.go

Copy file name to clipboardExpand all lines: internal/locales/convert_test.go
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
// Arduino software without disclosing the source code of your own applications.
1414
// To purchase a commercial license, send an email to license@arduino.cc.
1515

16-
package i18n
16+
package locales
1717

1818
import (
1919
"fmt"

‎internal/i18n/data/.gitkeep renamed to ‎internal/locales/data/.gitkeep

Copy file name to clipboard
File renamed without changes.

‎internal/i18n/data/README.md renamed to ‎internal/locales/data/README.md

Copy file name to clipboard

‎internal/i18n/data/ar.po renamed to ‎internal/locales/data/ar.po

Copy file name to clipboard
File renamed without changes.

‎internal/i18n/data/be.po renamed to ‎internal/locales/data/be.po

Copy file name to clipboard
File renamed without changes.

‎internal/i18n/data/de.po renamed to ‎internal/locales/data/de.po

Copy file name to clipboard
File renamed without changes.

‎internal/i18n/data/en.po renamed to ‎internal/locales/data/en.po

Copy file name to clipboard
File renamed without changes.

‎internal/i18n/data/es.po renamed to ‎internal/locales/data/es.po

Copy file name to clipboard
File renamed without changes.

‎internal/i18n/data/fr.po renamed to ‎internal/locales/data/fr.po

Copy file name to clipboard
File renamed without changes.

‎internal/i18n/data/he.po renamed to ‎internal/locales/data/he.po

Copy file name to clipboard
File renamed without changes.

‎internal/i18n/data/it_IT.po renamed to ‎internal/locales/data/it_IT.po

Copy file name to clipboard
File renamed without changes.

‎internal/i18n/data/ja.po renamed to ‎internal/locales/data/ja.po

Copy file name to clipboard
File renamed without changes.

‎internal/i18n/data/kk.po renamed to ‎internal/locales/data/kk.po

Copy file name to clipboard
File renamed without changes.

‎internal/i18n/data/ko.po renamed to ‎internal/locales/data/ko.po

Copy file name to clipboard
File renamed without changes.

‎internal/i18n/data/lb.po renamed to ‎internal/locales/data/lb.po

Copy file name to clipboard
File renamed without changes.

‎internal/i18n/data/mn.po renamed to ‎internal/locales/data/mn.po

Copy file name to clipboard
File renamed without changes.

‎internal/i18n/data/my_MM.po renamed to ‎internal/locales/data/my_MM.po

Copy file name to clipboard
File renamed without changes.

‎internal/i18n/data/ne.po renamed to ‎internal/locales/data/ne.po

Copy file name to clipboard
File renamed without changes.

‎internal/i18n/data/pl.po renamed to ‎internal/locales/data/pl.po

Copy file name to clipboard
File renamed without changes.

‎internal/i18n/data/pt.po renamed to ‎internal/locales/data/pt.po

Copy file name to clipboard
File renamed without changes.

‎internal/i18n/data/pt_BR.po renamed to ‎internal/locales/data/pt_BR.po

Copy file name to clipboard
File renamed without changes.

‎internal/i18n/data/ru.po renamed to ‎internal/locales/data/ru.po

Copy file name to clipboard
File renamed without changes.

‎internal/i18n/data/zh.po renamed to ‎internal/locales/data/zh.po

Copy file name to clipboard
File renamed without changes.

‎internal/i18n/data/zh_TW.po renamed to ‎internal/locales/data/zh_TW.po

Copy file name to clipboard
File renamed without changes.

‎internal/i18n/detect.go renamed to ‎internal/locales/detect.go

Copy file name to clipboardExpand all lines: internal/locales/detect.go
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
// Arduino software without disclosing the source code of your own applications.
1414
// To purchase a commercial license, send an email to license@arduino.cc.
1515

16-
package i18n
16+
package locales
1717

1818
import (
1919
"os"

‎internal/i18n/detect_cgo_darwin.go renamed to ‎internal/locales/detect_cgo_darwin.go

Copy file name to clipboardExpand all lines: internal/locales/detect_cgo_darwin.go
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515

1616
//go:build darwin && cgo
1717

18-
package i18n
18+
package locales
1919

2020
/*
2121
#cgo CFLAGS: -x objective-c

‎internal/i18n/detect_freebsd.go renamed to ‎internal/locales/detect_freebsd.go

Copy file name to clipboardExpand all lines: internal/locales/detect_freebsd.go
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
// Arduino software without disclosing the source code of your own applications.
1414
// To purchase a commercial license, send an email to license@arduino.cc.
1515

16-
package i18n
16+
package locales
1717

1818
func getLocaleIdentifier() string {
1919
return getLocaleIdentifierFromEnv()

‎internal/i18n/detect_linux.go renamed to ‎internal/locales/detect_linux.go

Copy file name to clipboardExpand all lines: internal/locales/detect_linux.go
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
// Arduino software without disclosing the source code of your own applications.
1414
// To purchase a commercial license, send an email to license@arduino.cc.
1515

16-
package i18n
16+
package locales
1717

1818
func getLocaleIdentifier() string {
1919
return getLocaleIdentifierFromEnv()

‎internal/i18n/detect_nocgo_darwin.go renamed to ‎internal/locales/detect_nocgo_darwin.go

Copy file name to clipboardExpand all lines: internal/locales/detect_nocgo_darwin.go
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515

1616
//go:build darwin && !cgo
1717

18-
package i18n
18+
package locales
1919

2020
func getLocaleIdentifier() string {
2121
return getLocaleIdentifierFromEnv()

‎internal/i18n/detect_windows.go renamed to ‎internal/locales/detect_windows.go

Copy file name to clipboardExpand all lines: internal/locales/detect_windows.go
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
// Arduino software without disclosing the source code of your own applications.
1414
// To purchase a commercial license, send an email to license@arduino.cc.
1515

16-
package i18n
16+
package locales
1717

1818
import (
1919
"strings"

‎internal/locales/i18n.go

Copy file name to clipboard
+39Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
// This file is part of arduino-cli.
2+
//
3+
// Copyright 2020 ARDUINO SA (http://www.arduino.cc/)
4+
//
5+
// This software is released under the GNU General Public License version 3,
6+
// which covers the main part of arduino-cli.
7+
// The terms of this license can be found at:
8+
// https://www.gnu.org/licenses/gpl-3.0.en.html
9+
//
10+
// You can be released from the requirements of the above licenses by purchasing
11+
// a commercial license. Buying such a license is mandatory if you want to
12+
// modify or otherwise use the software for commercial activities involving the
13+
// Arduino software without disclosing the source code of your own applications.
14+
// To purchase a commercial license, send an email to license@arduino.cc.
15+
16+
package locales
17+
18+
// Init initializes the i18n module, setting the locale according to this order of preference:
19+
// 1. Locale specified via the function call
20+
// 2. OS Locale
21+
// 3. en (default)
22+
func Init(configLocale string) {
23+
locales := supportedLocales()
24+
if configLocale != "" {
25+
if locale := findMatchingLocale(configLocale, locales); locale != "" {
26+
setLocale(locale)
27+
return
28+
}
29+
}
30+
31+
if osLocale := getLocaleIdentifierFromOS(); osLocale != "" {
32+
if locale := findMatchingLocale(osLocale, locales); locale != "" {
33+
setLocale(locale)
34+
return
35+
}
36+
}
37+
38+
setLocale("en")
39+
}

‎internal/i18n/locale.go renamed to ‎internal/locales/locale.go

Copy file name to clipboardExpand all lines: internal/locales/locale.go
+5-9Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -13,24 +13,19 @@
1313
// Arduino software without disclosing the source code of your own applications.
1414
// To purchase a commercial license, send an email to license@arduino.cc.
1515

16-
package i18n
16+
package locales
1717

1818
import (
1919
"embed"
2020
"strings"
2121

22+
"github.com/arduino/arduino-cli/internal/i18n"
2223
"github.com/leonelquinteros/gotext"
2324
)
2425

25-
var po *gotext.Po
26-
2726
//go:embed data/*.po
2827
var contents embed.FS
2928

30-
func init() {
31-
po = gotext.NewPo()
32-
}
33-
3429
func supportedLocales() []string {
3530
var locales []string
3631
files, err := contents.ReadDir("data")
@@ -75,6 +70,7 @@ func setLocale(locale string) {
7570
if err != nil {
7671
panic("Error reading embedded i18n data: " + err.Error())
7772
}
78-
po = gotext.NewPo()
79-
po.Parse(poFile)
73+
dict := gotext.NewPo()
74+
dict.Parse(poFile)
75+
i18n.SetLocale(dict)
8076
}

‎internal/i18n/locale_test.go renamed to ‎internal/locales/locale_test.go

Copy file name to clipboardExpand all lines: internal/locales/locale_test.go
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
// Arduino software without disclosing the source code of your own applications.
1414
// To purchase a commercial license, send an email to license@arduino.cc.
1515

16-
package i18n
16+
package locales
1717

1818
import (
1919
"testing"

‎main.go

Copy file name to clipboardExpand all lines: main.go
+2-1Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ import (
2727
"github.com/arduino/arduino-cli/internal/cli/configuration"
2828
"github.com/arduino/arduino-cli/internal/cli/feedback"
2929
"github.com/arduino/arduino-cli/internal/i18n"
30+
"github.com/arduino/arduino-cli/internal/locales"
3031
rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
3132
"github.com/arduino/go-paths-helper"
3233
"github.com/sirupsen/logrus"
@@ -67,7 +68,7 @@ func main() {
6768
config := resp.GetConfiguration()
6869

6970
// Setup i18n
70-
i18n.Init(config.GetLocale())
71+
locales.Init(config.GetLocale())
7172

7273
// Setup command line parser with the server and settings
7374
arduinoCmd := cli.NewCommand(srv)

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.