i18n

i18n

i18n is a minimal, flexible, simple to use and simple to embed (in your packages) localizations package.
It support yaml, json or toml localization files.

i18n is ready to be used in sprbox.

Install

$ go get github.com/oblq/i18n

Quickstart

Get a new instance:

package main

import (
	"github.com/oblq/i18n"
	"golang.org/x/text/language"
)

func init() {
	// Optionally pass the config file path and nil config.
	// The config file can be in yaml, json or toml format.
	localizer := i18n.New(
        "",
        &i18n.Config{
            Locales: []string{
                language.English.String(), // "en"
                language.Italian.String(), // "it"
            },
            Path: "./example/localizations",
        },
    )	
}

Optionally override the GetLocale func to automatically determine the locale to be used from http requests (using i18n.AutoT func), if an empty string is returned the default method will be used anyway:

localizer.GetLocaleOverride = func(r *http.Request) string {
    user := AuthLib.UserFromRequest(r)
    return user.Locale
}

Automatically localize a key based on the http request, i18n will first look for the locale by the GetLocaleOverride func, then in cookies (language and/or lang keys), then in Accept-Language header:

func(w http.ResponseWriter, r *http.Request) {
	response := localizer.AutoT(r, "MY_KEY")
	w.WriteHeader(http.StatusOK)
	w.Write([]byte(response))
}

Localize a key:

localizer.T("en", "MY_KEY")

Optionally pass parameters to be parsed with fmt package, given the en.yaml localization file:

"SAY_HELLO": 
    one: "Hello, %s!"
    other: "Hello, %s and %s!"

...localize a key using plural and multiple parameters:

localizer.TP("en", true, "SAY_HELLO", "Marco", "Valentina") // -> "Hello, Marco and Valentina!"

Localized file server:

localizer.SetFileServer(
    map[string]http.Handler{
        language.English.String(): http.FileServer(http.Dir("./landing_en")),
        language.Italian.String(): http.FileServer(http.Dir("./landing_ita")),
    }, 
)

mux.Handle("/", localizer)

Embed i18n in your package:

Use hardcoded localizations, they can be a json, yaml or toml string:

package main

import (
	"github.com/oblq/i18n"
	"golang.org/x/text/language"
)

// keys
const (
	GEM = "GEM" // generic_error_message
)

var hardcodedLocs = map[string]map[string]i18n.Localization{
	language.English.String(): {
		GEM: {
			One:   "Something went wrong, please try again later %s",
			Other: "Some things went wrong, please try again later %s",
		},
	},
	language.Italian.String(): {
		GEM: {
			One:   "Qualcosa è andato storto, riprova più tardi %s",
			Other: "Alcune cose sono andate storte, riprova più tardi %s",
		},
	},
}

var localizer *i18n.I18n

func init() {
	localizer := i18n.New("", &i18n.Config{
		Locales: []string{
			language.English.String(), // "en"
			language.Italian.String(), // "it"
		},
		Locs: hardcodedLocs,
	})
}

Vendored packages

• golang.org/x/text/language
• gopkg.in/yaml.v2
• github.com/BurntSushi/toml

Author

• Marco Muratori

License

i18n is available under the MIT license. See the LICENSE file for more information.