Skip to content

Commit 62c85e8

Browse files
plastikfanplastikfan
committed
ref(locale): use go-18n.Messge and rename i18n to locale (#216)
ref(locale): rename i18n to locale (#216) ref(locale): use go-i18n.Message directly instead of extendio (#216)
1 parent 218e56a commit 62c85e8

19 files changed

+46
-43
lines changed

‎.vscode/settings.json

+1
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,7 @@
6666
"nakedret",
6767
"natefinch",
6868
"navi",
69+
"nicksnyder",
6970
"nolint",
7071
"nolintlint",
7172
"nosec",

‎go.mod

+1-1
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ require (
6060
github.com/magiconair/properties v1.8.7 // indirect
6161
github.com/mitchellh/mapstructure v1.5.0 // indirect
6262
github.com/natefinch/lumberjack v2.0.0+incompatible
63-
github.com/nicksnyder/go-i18n/v2 v2.4.0 // indirect
63+
github.com/nicksnyder/go-i18n/v2 v2.4.0
6464
github.com/pelletier/go-toml/v2 v2.1.1 // indirect
6565
github.com/snivilised/cobrass v0.4.5
6666
github.com/spf13/afero v1.11.0 // indirect

‎src/app/command/bootstrap.go

+4-4
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ import (
2323
"github.com/snivilised/pixa/src/app/plog"
2424
"github.com/snivilised/pixa/src/app/proxy"
2525
"github.com/snivilised/pixa/src/app/proxy/common"
26-
"github.com/snivilised/pixa/src/i18n"
26+
"github.com/snivilised/pixa/src/locale"
2727
)
2828

2929
type LocaleDetector interface {
@@ -125,8 +125,8 @@ func (b *Bootstrap) Root(options ...ConfigureOptionFn) *cobra.Command {
125125
b.Container = assistant.NewCobraContainer(
126126
&cobra.Command{
127127
Use: "main",
128-
Short: xi18n.Text(i18n.RootCmdShortDescTemplData{}),
129-
Long: xi18n.Text(i18n.RootCmdLongDescTemplData{}),
128+
Short: xi18n.Text(locale.RootCmdShortDescTemplData{}),
129+
Long: xi18n.Text(locale.RootCmdLongDescTemplData{}),
130130
Version: fmt.Sprintf("'%v'", Version),
131131
RunE: func(_ *cobra.Command, args []string) error {
132132
inputs := b.getRootInputs()
@@ -178,7 +178,7 @@ func (b *Bootstrap) Root(options ...ConfigureOptionFn) *cobra.Command {
178178

179179
func (b *Bootstrap) configure() {
180180
if err := b.OptionsInfo.Runner.Run(); err != nil {
181-
msg := xi18n.Text(i18n.UsingConfigFileTemplData{
181+
msg := xi18n.Text(locale.UsingConfigFileTemplData{
182182
ConfigFileName: b.OptionsInfo.Config.Viper.ConfigFileUsed(),
183183
})
184184

‎src/app/command/shrink-cmd.go

+14-14
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ import (
1717

1818
"github.com/snivilised/pixa/src/app/proxy"
1919
"github.com/snivilised/pixa/src/app/proxy/common"
20-
"github.com/snivilised/pixa/src/i18n"
20+
"github.com/snivilised/pixa/src/locale"
2121
)
2222

2323
// We define all the options here, even the ones inherited from the root
@@ -83,11 +83,11 @@ type shrinkParameterSetPtr = *assistant.ParamSet[common.ShrinkParameterSet]
8383
func (b *Bootstrap) buildShrinkCommand(container *assistant.CobraContainer) *cobra.Command {
8484
shrinkCommand := &cobra.Command{
8585
Use: "shrink",
86-
Short: i18n.LeadsWith(
86+
Short: locale.LeadsWith(
8787
"shrink",
88-
xi18n.Text(i18n.ShrinkCmdShortDefinitionTemplData{}),
88+
xi18n.Text(locale.ShrinkCmdShortDefinitionTemplData{}),
8989
),
90-
Long: xi18n.Text(i18n.ShrinkLongDefinitionTemplData{}),
90+
Long: xi18n.Text(locale.ShrinkLongDefinitionTemplData{}),
9191

9292
RunE: func(cmd *cobra.Command, args []string) error {
9393
var appErr error
@@ -168,7 +168,7 @@ func (b *Bootstrap) buildShrinkCommand(container *assistant.CobraContainer) *cob
168168

169169
paramSet.BindValidatedString(
170170
newShrinkFlagInfoWithShort(
171-
xi18n.Text(i18n.ShrinkCmdOutputPathParamUsageTemplData{}),
171+
xi18n.Text(locale.ShrinkCmdOutputPathParamUsageTemplData{}),
172172
defaultOutputPath,
173173
),
174174
&paramSet.Native.OutputPath, func(_ string, _ *pflag.Flag) error {
@@ -190,7 +190,7 @@ func (b *Bootstrap) buildShrinkCommand(container *assistant.CobraContainer) *cob
190190

191191
paramSet.BindValidatedString(
192192
newShrinkFlagInfoWithShort(
193-
xi18n.Text(i18n.ShrinkCmdTrashPathParamUsageTemplData{}),
193+
xi18n.Text(locale.ShrinkCmdTrashPathParamUsageTemplData{}),
194194
defaultTrashPath,
195195
),
196196
&paramSet.Native.TrashPath, func(_ string, _ *pflag.Flag) error {
@@ -212,7 +212,7 @@ func (b *Bootstrap) buildShrinkCommand(container *assistant.CobraContainer) *cob
212212

213213
paramSet.BindBool(
214214
newShrinkFlagInfoWithShort(
215-
xi18n.Text(i18n.ShrinkCmdCuddleParamUsageTemplData{}),
215+
xi18n.Text(locale.ShrinkCmdCuddleParamUsageTemplData{}),
216216
defaultCuddle,
217217
),
218218
&paramSet.Native.Cuddle,
@@ -228,7 +228,7 @@ func (b *Bootstrap) buildShrinkCommand(container *assistant.CobraContainer) *cob
228228

229229
paramSet.BindValidatedFloat32Within(
230230
newShrinkFlagInfoWithShort(
231-
xi18n.Text(i18n.ShrinkCmdGaussianBlurParamUsageTemplData{}),
231+
xi18n.Text(locale.ShrinkCmdGaussianBlurParamUsageTemplData{}),
232232
defaultBlur,
233233
),
234234
&paramSet.Native.ThirdPartySet.GaussianBlur,
@@ -246,15 +246,15 @@ func (b *Bootstrap) buildShrinkCommand(container *assistant.CobraContainer) *cob
246246

247247
paramSet.BindValidatedEnum(
248248
newShrinkFlagInfoWithShort(
249-
xi18n.Text(i18n.ShrinkCmdSamplingFactorParamUsageTemplData{}),
249+
xi18n.Text(locale.ShrinkCmdSamplingFactorParamUsageTemplData{}),
250250
defaultSamplingFactor,
251251
),
252252
&paramSet.Native.ThirdPartySet.SamplingFactorEn.Source,
253253
func(value string, f *pflag.Flag) error {
254254
if f.Changed && !(common.SamplingFactorEnumInfo.IsValid(value)) {
255255
acceptableSet := common.SamplingFactorEnumInfo.AcceptablePrimes()
256256

257-
return i18n.NewInvalidSamplingFactorError(value, acceptableSet)
257+
return locale.NewInvalidSamplingFactorError(value, acceptableSet)
258258
}
259259

260260
return nil
@@ -271,15 +271,15 @@ func (b *Bootstrap) buildShrinkCommand(container *assistant.CobraContainer) *cob
271271

272272
paramSet.BindValidatedEnum(
273273
newShrinkFlagInfoWithShort(
274-
xi18n.Text(i18n.ShrinkCmdInterlaceParamUsageTemplData{}),
274+
xi18n.Text(locale.ShrinkCmdInterlaceParamUsageTemplData{}),
275275
defaultInterlace,
276276
),
277277
&paramSet.Native.ThirdPartySet.InterlaceEn.Source,
278278
func(value string, f *pflag.Flag) error {
279279
if f.Changed && !(common.InterlaceEnumInfo.IsValid(value)) {
280280
acceptableSet := common.InterlaceEnumInfo.AcceptablePrimes()
281281

282-
return i18n.NewInterlaceError(value, acceptableSet)
282+
return locale.NewInterlaceError(value, acceptableSet)
283283
}
284284

285285
return nil
@@ -294,7 +294,7 @@ func (b *Bootstrap) buildShrinkCommand(container *assistant.CobraContainer) *cob
294294

295295
paramSet.BindBool(
296296
newShrinkFlagInfoWithShort(
297-
xi18n.Text(i18n.ShrinkCmdStripParamUsageTemplData{}),
297+
xi18n.Text(locale.ShrinkCmdStripParamUsageTemplData{}),
298298
defaultStrip,
299299
),
300300
&paramSet.Native.ThirdPartySet.Strip,
@@ -310,7 +310,7 @@ func (b *Bootstrap) buildShrinkCommand(container *assistant.CobraContainer) *cob
310310

311311
paramSet.BindValidatedIntWithin(
312312
newShrinkFlagInfoWithShort(
313-
xi18n.Text(i18n.ShrinkCmdQualityParamUsageTemplData{}),
313+
xi18n.Text(locale.ShrinkCmdQualityParamUsageTemplData{}),
314314
defaultQuality,
315315
),
316316
&paramSet.Native.ThirdPartySet.Quality,

‎src/internal/helpers/test-utils.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ import (
1515
"github.com/snivilised/cobrass/src/assistant/configuration"
1616
ci18n "github.com/snivilised/cobrass/src/assistant/i18n"
1717
"github.com/snivilised/pixa/src/app/proxy/common"
18-
"github.com/snivilised/pixa/src/i18n"
1918
"github.com/snivilised/pixa/src/internal/matchers"
19+
"github.com/snivilised/pixa/src/locale"
2020

2121
xi18n "github.com/snivilised/extendio/i18n"
2222
"github.com/snivilised/extendio/xfs/storage"
@@ -122,7 +122,7 @@ func UseI18n(l10nPath string) error {
122122
uo.From = xi18n.LoadFrom{
123123
Path: l10nPath,
124124
Sources: xi18n.TranslationFiles{
125-
i18n.PixaSourceID: xi18n.TranslationSource{
125+
locale.PixaSourceID: xi18n.TranslationSource{
126126
Name: "dummy-cobrass",
127127
},
128128

‎src/i18n/default/pixa.active.en-GB.json renamed to ‎src/locale/default/pixa.active.en-GB.json

File renamed without changes.

‎src/i18n/deploy/pixa.active.en-US.json renamed to ‎src/locale/deploy/pixa.active.en-US.json

File renamed without changes.

‎src/i18n/i18n_suite_test.go renamed to ‎src/locale/locale-suite_test.go

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package i18n_test
1+
package locale_test
22

33
import (
44
"testing"
@@ -7,7 +7,7 @@ import (
77
"github.com/onsi/gomega"
88
)
99

10-
func TestI18n(t *testing.T) {
10+
func TestLocale(t *testing.T) {
1111
gomega.RegisterFailHandler(ginkgo.Fail)
12-
ginkgo.RunSpecs(t, "I18n Suite")
12+
ginkgo.RunSpecs(t, "Locale Suite")
1313
}

‎src/i18n/messages-command-errors.go renamed to ‎src/locale/messages-command-errors.go

+8-7
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
1-
package i18n
1+
package locale
22

33
import (
4+
"github.com/nicksnyder/go-i18n/v2/i18n"
45
xi18n "github.com/snivilised/extendio/i18n"
56
)
67

@@ -12,8 +13,8 @@ type ShrinkCmdSamplingFactorInvalidTemplData struct {
1213
Acceptable string
1314
}
1415

15-
func (td ShrinkCmdSamplingFactorInvalidTemplData) Message() *xi18n.Message {
16-
return &xi18n.Message{
16+
func (td ShrinkCmdSamplingFactorInvalidTemplData) Message() *i18n.Message {
17+
return &i18n.Message{
1718
ID: "shrink-cmd-sampling-factor-invalid.error",
1819
Description: "shrink command sampling factor failed validation",
1920
Other: "invalid sampling factor value: {{.Value}}, acceptable: {{.Acceptable}}",
@@ -49,8 +50,8 @@ type ShrinkCmdInterlaceInvalidTemplData struct {
4950
Acceptable string
5051
}
5152

52-
func (td ShrinkCmdInterlaceInvalidTemplData) Message() *xi18n.Message {
53-
return &xi18n.Message{
53+
func (td ShrinkCmdInterlaceInvalidTemplData) Message() *i18n.Message {
54+
return &i18n.Message{
5455
ID: "shrink-cmd-interlace-invalid.error",
5556
Description: "shrink command interlace failed validation",
5657
Other: "invalid interlace value: {{.Value}}, acceptable: {{.Acceptable}}",
@@ -85,8 +86,8 @@ type ShrinkCmdOutputPathDoesNotExistTemplData struct {
8586
Path string
8687
}
8788

88-
func (td ShrinkCmdOutputPathDoesNotExistTemplData) Message() *xi18n.Message {
89-
return &xi18n.Message{
89+
func (td ShrinkCmdOutputPathDoesNotExistTemplData) Message() *i18n.Message {
90+
return &i18n.Message{
9091
ID: "shrink-cmd-output-path-does-not-exist.error",
9192
Description: "shrink command mirror path does not exist validation",
9293
Other: "output path: {{.Path}}, does not exist",

‎src/i18n/messages-command.go renamed to ‎src/locale/messages-command.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
package i18n
1+
package locale
22

33
import (
4-
"github.com/snivilised/extendio/i18n"
4+
"github.com/nicksnyder/go-i18n/v2/i18n"
55
)
66

77
// ⚠️ for the usage definitions, make sure that the first token inside the "Other"

‎src/i18n/messages-errors.go renamed to ‎src/locale/messages-errors.go

+5-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
1-
package i18n
1+
package locale
22

33
import (
4-
i18n "github.com/snivilised/extendio/i18n"
4+
i18n "github.com/nicksnyder/go-i18n/v2/i18n"
5+
xi18n "github.com/snivilised/extendio/i18n"
56
)
67

78
// ❌ FooBar
@@ -34,7 +35,7 @@ type FooBarErrorBehaviourQuery interface {
3435
}
3536

3637
type FooBarError struct {
37-
i18n.LocalisableError
38+
xi18n.LocalisableError
3839
}
3940

4041
// FooBar enables the client to check if error is FooBarError
@@ -46,7 +47,7 @@ func (e FooBarError) FooBar() bool {
4647
// NewFooBarError creates a FooBarError
4748
func NewFooBarError(path string, reason error) FooBarError {
4849
return FooBarError{
49-
LocalisableError: i18n.LocalisableError{
50+
LocalisableError: xi18n.LocalisableError{
5051
Data: FooBarTemplData{
5152
Path: path,
5253
Reason: reason,

‎src/i18n/messages-general.go renamed to ‎src/locale/messages-general.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
package i18n
1+
package locale
22

33
import (
4-
"github.com/snivilised/extendio/i18n"
4+
"github.com/nicksnyder/go-i18n/v2/i18n"
55
)
66

77
type UsingConfigFileTemplData struct {

‎src/i18n/out/active.en-GB.json renamed to ‎src/locale/out/active.en-GB.json

File renamed without changes.

‎src/i18n/out/active.en-US.json renamed to ‎src/locale/out/active.en-US.json

File renamed without changes.

‎src/i18n/out/en-US/pixa.translate.en-US.json renamed to ‎src/locale/out/en-US/pixa.translate.en-US.json

File renamed without changes.

‎src/i18n/out/translate.en-US.json renamed to ‎src/locale/out/translate.en-US.json

File renamed without changes.

‎src/i18n/test-i18n-messages_test.go renamed to ‎src/locale/test-locale-messages_test.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
package i18n_test
1+
package locale_test
22

33
import (
4-
"github.com/snivilised/extendio/i18n"
4+
"github.com/nicksnyder/go-i18n/v2/i18n"
55
)
66

77
const (

‎src/i18n/translate-defs.go renamed to ‎src/locale/translate-defs.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package i18n
1+
package locale
22

33
// TODO: Should be updated to use url of the implementing project,
44
// so should not be left as arcadia.

‎src/i18n/utils.go renamed to ‎src/locale/utils.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package i18n
1+
package locale
22

33
import (
44
"strings"

0 commit comments

Comments
 (0)