Skip to content

Commit

Permalink
feat(i18n): only embed locale files when using the build tag 'locales'
Browse files Browse the repository at this point in the history
  • Loading branch information
Goutte committed Jan 10, 2024
1 parent ab14efa commit c922911
Show file tree
Hide file tree
Showing 4 changed files with 87 additions and 8 deletions.
22 changes: 14 additions & 8 deletions localizer.go
Original file line number Diff line number Diff line change
@@ -1,7 +1,20 @@
// Copyright 2013-2024 The Cobra Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package cobra

import (
"embed"
"fmt"
"os"

Expand All @@ -27,13 +40,6 @@ var availableLocalizationDomains = []string{
"default",
}

// localeFS points to an embedded filesystem of binary gettext translation files.
// For performance and smaller builds, only the binary MO files are included.
// Their sibling PO files should still be considered their authoritative source.
//
//go:embed locales/*/*.mo
var localeFS embed.FS

// i18nCommandGlossary wraps the translated strings passed to the command usage template.
// This is used in CommandUsageTemplateData.
type i18nCommandGlossary struct {
Expand Down
29 changes: 29 additions & 0 deletions localizer_locales.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
// Copyright 2013-2024 The Cobra Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

//go:build locales
// +build locales

package cobra

import (
"embed"
)

// localeFS points to an embedded filesystem of binary gettext translation files.
// For performance and smaller builds, only the binary MO files are included.
// Their sibling PO files should still be considered their authoritative source.
//
//go:embed locales/*/*.mo
var localeFS embed.FS
30 changes: 30 additions & 0 deletions localizer_notlocales.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
// Copyright 2013-2024 The Cobra Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

//go:build !locales
// +build !locales

package cobra

import (
"embed"
)

// localeFS points to an embedded filesystem of binary gettext translation files,
// but only for the default (english) language, as the locales build tag was not set.
// For performance and smaller builds, only the binary MO files are included.
// Their sibling PO files should still be considered their authoritative source.
//
//go:embed locales/*/en.mo
var localeFS embed.FS
14 changes: 14 additions & 0 deletions localizer_test.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,17 @@
// Copyright 2013-2024 The Cobra Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package cobra

import (
Expand Down

0 comments on commit c922911

Please sign in to comment.