i18n

package module

v0.0.0-...-c335968 Latest Latest Go to latest Published: Sep 21, 2022 License: MIT Imports: 4 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Internationalization for Go programs leveraging the type system.

When looking around for Go i18n libraries, I found two popular libraries:

github.com/nicksnyder/go-i18n
- workflow styled after gettext, complete with message extractors and message file updaters (mergers).
- verbose API
- plain (English) language strings in source code
github.com/kataras/i18n
- stringly typed message IDs
- no workflow defined

(when the need arises)

This section is empty.

This section is empty.

This section is empty.

type Catalog interface {
	LoadMessages(languageCode string, textDomain string, messages any) error
}

Catalog is the work horse doing the actual message loading.

func NewFilesystemCatalog(files fs.FS, messagesDirectory string) Catalog

NewFilesystemCatalog.

Message files are located in messages directory.

type FilesystemCatalog struct {
	// contains filtered or unexported fields
}

FilesystemCatalog loads messages from JSON files.

File names must be: <textDomain>.<languageCode>.json. Nested directories are not supported.

func (f *FilesystemCatalog) LoadMessages(
	languageCode string,
	textDomain string,
	messages any,
) error

type Translator func(textDomain string, messages any) error

Translator loads messages into a struct of your choosing.

Text domain groups messages. There should be one text domain per message struct type.

func NewTranslator(languageCode string, catalog Catalog) Translator

NewTranslator creates a translator loading messages from the catalog with the given language code.