gotext

package module
v1.3.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 14, 2018 License: MIT Imports: 10 Imported by: 0

README

GitHub release MIT license GoDoc Build Status codecov Go Report Card

Gotext

GNU gettext utilities for Go.

Features

  • Implements GNU gettext support in native Go.
  • Complete support for PO files including:
  • Thread-safe: This package is safe for concurrent use across multiple goroutines.
  • It works with UTF-8 encoding as it's the default for Go language.
  • Unit tests available.
  • Language codes are automatically simplified from the form en_UK to en if the first isn't available.
  • Ready to use inside Go templates.

License

MIT license

Documentation

Refer to the Godoc package documentation at (https://godoc.org/github.com/leonelquinteros/gotext)

Installation

go get github.com/leonelquinteros/gotext
  • There are no requirements or dependencies to use this package.
  • No need to install GNU gettext utilities (unless specific needs of CLI tools).
  • No need for environment variables. Some naming conventions are applied but not needed.
Version vendoring

Stable releases use semantic versioning tagging on this repository.

You can rely on this to use your preferred vendoring tool or to manually retrieve the corresponding release tag from the GitHub repository.

Vendoring with gopkg.in

http://gopkg.in/leonelquinteros/gotext.v1

To get the latest v1 package stable release, execute:

go get gopkg.in/leonelquinteros/gotext.v1

To import this package, add the following line to your code:

import "gopkg.in/leonelquinteros/gotext.v1"

Refer to it as gotext.

Locales directories structure

The package will assume a directories structure starting with a base path that will be provided to the package configuration or to object constructors depending on the use, but either will use the same convention to lookup inside the base path.

Inside the base directory where will be the language directories named using the language and country 2-letter codes (en_US, es_AR, ...). All package functions can lookup after the simplified version for each language in case the full code isn't present but the more general language code exists. So if the language set is en_UK, but there is no directory named after that code and there is a directory named en, all package functions will be able to resolve this generalization and provide translations for the more general library.

The language codes are assumed to be ISO 639-1 codes (2-letter codes). That said, most functions will work with any coding standard as long the directory name matches the language code set on the configuration.

Then, there can be a LC_MESSAGES containing all PO files or the PO files themselves.
A library directory structure can look like:

/path/to/locales
/path/to/locales/en_US
/path/to/locales/en_US/LC_MESSAGES
/path/to/locales/en_US/LC_MESSAGES/default.po
/path/to/locales/en_US/LC_MESSAGES/extras.po
/path/to/locales/en_UK
/path/to/locales/en_UK/LC_MESSAGES
/path/to/locales/en_UK/LC_MESSAGES/default.po
/path/to/locales/en_UK/LC_MESSAGES/extras.po
/path/to/locales/en_AU
/path/to/locales/en_AU/LC_MESSAGES
/path/to/locales/en_AU/LC_MESSAGES/default.po
/path/to/locales/en_AU/LC_MESSAGES/extras.po
/path/to/locales/es
/path/to/locales/es/default.po
/path/to/locales/es/extras.po
/path/to/locales/es_ES
/path/to/locales/es_ES/default.po
/path/to/locales/es_ES/extras.po
/path/to/locales/fr
/path/to/locales/fr/default.po
/path/to/locales/fr/extras.po

And so on...

Usage examples

Using package for single language/domain settings

For quick/simple translations you can use the package level functions directly.

import (
    "fmt"
    "github.com/leonelquinteros/gotext"
)

func main() {
    // Configure package
    gotext.Configure("/path/to/locales/root/dir", "en_UK", "domain-name")
    
    // Translate text from default domain
    fmt.Println(gotext.Get("My text on 'domain-name' domain"))
    
    // Translate text from a different domain without reconfigure
    fmt.Println(gotext.GetD("domain2", "Another text on a different domain"))
}

Using dynamic variables on translations

All translation strings support dynamic variables to be inserted without translate. Use the fmt.Printf syntax (from Go's "fmt" package) to specify how to print the non-translated variable inside the translation string.

import (
    "fmt"
    "github.com/leonelquinteros/gotext"
)

func main() {
    // Configure package
    gotext.Configure("/path/to/locales/root/dir", "en_UK", "domain-name")
    
    // Set variables
    name := "John"
    
    // Translate text with variables
    fmt.Println(gotext.Get("Hi, my name is %s", name))
}

Using Locale object

When having multiple languages/domains/libraries at the same time, you can create Locale objects for each variation so you can handle each settings on their own.

import (
    "fmt"
    "github.com/leonelquinteros/gotext"
)

func main() {
    // Create Locale with library path and language code
    l := gotext.NewLocale("/path/to/locales/root/dir", "es_UY")
    
    // Load domain '/path/to/locales/root/dir/es_UY/default.po'
    l.AddDomain("default")
    
    // Translate text from default domain
    fmt.Println(l.Get("Translate this"))
    
    // Load different domain
    l.AddDomain("translations")
    
    // Translate text from domain
    fmt.Println(l.GetD("translations", "Translate this"))
}

This is also helpful for using inside templates (from the "text/template" package), where you can pass the Locale object to the template. If you set the Locale object as "Loc" in the template, then the template code would look like:

{{ .Loc.Get "Translate this" }}

Using the Po object to handle .po files and PO-formatted strings

For when you need to work with PO files and strings, you can directly use the Po object to parse it and access the translations in there in the same way.

import (
    "fmt"
    "github.com/leonelquinteros/gotext"
)

func main() {
    // Set PO content
    str := `
msgid "Translate this"
msgstr "Translated text"

msgid "Another string"
msgstr ""

msgid "One with var: %s"
msgstr "This one sets the var: %s"
`
    
    // Create Po object
    po := new(gotext.Po)
    po.Parse(str)
    
    fmt.Println(po.Get("Translate this"))
}

Use plural forms of translations

PO format supports defining one or more plural forms for the same translation. Relying on the PO file headers, a Plural-Forms formula can be set on the translation file as defined in (https://www.gnu.org/savannah-checkouts/gnu/gettext/manual/html_node/Plural-forms.html)

Plural formulas are parsed and evaluated using Kinako

import (
    "fmt"
    "github.com/leonelquinteros/gotext"
)

func main() {
    // Set PO content
    str := `
msgid ""
msgstr ""

# Header below
"Plural-Forms: nplurals=2; plural=(n != 1);\n"

msgid "Translate this"
msgstr "Translated text"

msgid "Another string"
msgstr ""

msgid "One with var: %s"
msgid_plural "Several with vars: %s"
msgstr[0] "This one is the singular: %s"
msgstr[1] "This one is the plural: %s"
`
    
    // Create Po object
    po := new(gotext.Po)
    po.Parse(str)
    
    fmt.Println(po.GetN("One with var: %s", "Several with vars: %s", 54, v))
    // "This one is the plural: Variable"
}

Contribute

  • Please, contribute.
  • Use the package on your projects.
  • Report issues on Github.
  • Send pull requests for bugfixes and improvements.
  • Send proposals on Github issues.

Documentation

Overview

Package gotext implements GNU gettext utilities.

For quick/simple translations you can use the package level functions directly. 

    import (
	    "fmt"
	    "github.com/leonelquinteros/gotext"
    )

    func main() {
        // Configure package
        gotext.Configure("/path/to/locales/root/dir", "en_UK", "domain-name")

        // Translate text from default domain
        fmt.Println(gotext.Get("My text on 'domain-name' domain"))

        // Translate text from a different domain without reconfigure
        fmt.Println(gotext.GetD("domain2", "Another text on a different domain"))
    }

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Configure 

func Configure(lib, lang, dom string)

Configure sets all configuration variables to be used at package level and reloads the corresponding translation file. It receives the library path, language code and domain name. This function is recommended to be used when changing more than one setting, as using each setter will introduce a I/O overhead because the translation file will be loaded after each set.

func Get 

func Get(str string, vars ...interface{}) string

Get uses the default domain globally set to return the corresponding translation of a given string. Supports optional parameters (vars... interface{}) to be inserted on the formatted string using the fmt.Printf syntax.

func GetC added in v1.0.0 

func GetC(str, ctx string, vars ...interface{}) string

GetC uses the default domain globally set to return the corresponding translation of the given string in the given context. Supports optional parameters (vars... interface{}) to be inserted on the formatted string using the fmt.Printf syntax.

func GetD 

func GetD(dom, str string, vars ...interface{}) string

GetD returns the corresponding translation in the given domain for a given string. Supports optional parameters (vars... interface{}) to be inserted on the formatted string using the fmt.Printf syntax.

func GetDC added in v1.0.0 

func GetDC(dom, str, ctx string, vars ...interface{}) string

GetDC returns the corresponding translation in the given domain for the given string in the given context. Supports optional parameters (vars... interface{}) to be inserted on the formatted string using the fmt.Printf syntax.

func GetDomain 

func GetDomain() string

GetDomain is the domain getter for the package configuration

func GetLanguage 

func GetLanguage() string

GetLanguage is the language getter for the package configuration

func GetLibrary 

func GetLibrary() string

GetLibrary is the library getter for the package configuration

func GetN 

func GetN(str, plural string, n int, vars ...interface{}) string

GetN retrieves the (N)th plural form of translation for the given string in the default domain. Supports optional parameters (vars... interface{}) to be inserted on the formatted string using the fmt.Printf syntax.

func GetNC added in v1.0.0 

func GetNC(str, plural string, n int, ctx string, vars ...interface{}) string

GetNC retrieves the (N)th plural form of translation for the given string in the given context in the default domain. Supports optional parameters (vars... interface{}) to be inserted on the formatted string using the fmt.Printf syntax.

func GetND 

func GetND(dom, str, plural string, n int, vars ...interface{}) string

GetND retrieves the (N)th plural form of translation in the given domain for a given string. Supports optional parameters (vars... interface{}) to be inserted on the formatted string using the fmt.Printf syntax.

func GetNDC added in v1.0.0 

func GetNDC(dom, str, plural string, n int, ctx string, vars ...interface{}) string

GetNDC retrieves the (N)th plural form of translation in the given domain for a given string. Supports optional parameters (vars... interface{}) to be inserted on the formatted string using the fmt.Printf syntax.

func SetDomain 

func SetDomain(dom string)

SetDomain sets the name for the domain to be used at package level. It reloads the corresponding translation file.

func SetLanguage 

func SetLanguage(lang string)

SetLanguage sets the language code to be used at package level. It reloads the corresponding translation file.

func SetLibrary 

func SetLibrary(lib string)

SetLibrary sets the root path for the loale directories and files to be used at package level. It reloads the corresponding translation file.

Types

type Locale 

type Locale struct {

	// Sync Mutex
	sync.RWMutex
	// contains filtered or unexported fields
}

Locale wraps the entire i18n collection for a single language (locale) It's used by the package functions, but it can also be used independently to handle multiple languages at the same time by working with this object.

Example: 

    import (
	    "fmt"
	    "github.com/leonelquinteros/gotext"
    )

    func main() {
        // Create Locale with library path and language code
        l := gotext.NewLocale("/path/to/i18n/dir", "en_US")

        // Load domain '/path/to/i18n/dir/en_US/LC_MESSAGES/default.po'
        l.AddDomain("default")

        // Translate text from default domain
        fmt.Println(l.Get("Translate this"))

        // Load different domain ('/path/to/i18n/dir/en_US/LC_MESSAGES/extras.po')
        l.AddDomain("extras")

        // Translate text from domain
        fmt.Println(l.GetD("extras", "Translate this"))
    }

func NewLocale 

func NewLocale(p, l string) *Locale

NewLocale creates and initializes a new Locale object for a given language. It receives a path for the i18n files directory (p) and a language code to use (l).

func (*Locale) AddDomain 

func (l *Locale) AddDomain(dom string)

AddDomain creates a new domain for a given locale object and initializes the Po object. If the domain exists, it gets reloaded.

func (*Locale) Get 

func (l *Locale) Get(str string, vars ...interface{}) string

Get uses a domain "default" to return the corresponding translation of a given string. Supports optional parameters (vars... interface{}) to be inserted on the formatted string using the fmt.Printf syntax.

func (*Locale) GetC added in v1.0.0 

func (l *Locale) GetC(str, ctx string, vars ...interface{}) string

GetC uses a domain "default" to return the corresponding translation of the given string in the given context. Supports optional parameters (vars... interface{}) to be inserted on the formatted string using the fmt.Printf syntax.

func (*Locale) GetD 

func (l *Locale) GetD(dom, str string, vars ...interface{}) string

GetD returns the corresponding translation in the given domain for the given string. Supports optional parameters (vars... interface{}) to be inserted on the formatted string using the fmt.Printf syntax.

func (*Locale) GetDC added in v1.0.0 

func (l *Locale) GetDC(dom, str, ctx string, vars ...interface{}) string

GetDC returns the corresponding translation in the given domain for the given string in the given context. Supports optional parameters (vars... interface{}) to be inserted on the formatted string using the fmt.Printf syntax.

func (*Locale) GetN 

func (l *Locale) GetN(str, plural string, n int, vars ...interface{}) string

GetN retrieves the (N)th plural form of translation for the given string in the "default" domain. Supports optional parameters (vars... interface{}) to be inserted on the formatted string using the fmt.Printf syntax.

func (*Locale) GetNC added in v1.0.0 

func (l *Locale) GetNC(str, plural string, n int, ctx string, vars ...interface{}) string

GetNC retrieves the (N)th plural form of translation for the given string in the given context in the "default" domain. Supports optional parameters (vars... interface{}) to be inserted on the formatted string using the fmt.Printf syntax.

func (*Locale) GetND 

func (l *Locale) GetND(dom, str, plural string, n int, vars ...interface{}) string

GetND retrieves the (N)th plural form of translation in the given domain for the given string. Supports optional parameters (vars... interface{}) to be inserted on the formatted string using the fmt.Printf syntax.

func (*Locale) GetNDC added in v1.0.0 

func (l *Locale) GetNDC(dom, str, plural string, n int, ctx string, vars ...interface{}) string

GetNDC retrieves the (N)th plural form of translation in the given domain for the given string in the given context. Supports optional parameters (vars... interface{}) to be inserted on the formatted string using the fmt.Printf syntax.

type Po 

type Po struct {
	// Headers storage
	Headers textproto.MIMEHeader

	// Language header
	Language string

	// Plural-Forms header
	PluralForms string

	// Sync Mutex
	sync.RWMutex
	// contains filtered or unexported fields
}

Po parses the content of any PO file and provides all the translation functions needed. It's the base object used by all package methods. And it's safe for concurrent use by multiple goroutines by using the sync package for locking.

Example: 

import (
	"fmt"
	"github.com/leonelquinteros/gotext"
)

func main() {
	// Create po object
	po := new(gotext.Po)

	// Parse .po file
	po.ParseFile("/path/to/po/file/translations.po")

	// Get translation
	fmt.Println(po.Get("Translate this"))
}

func (*Po) Get 

func (po *Po) Get(str string, vars ...interface{}) string

Get retrieves the corresponding translation for the given string. Supports optional parameters (vars... interface{}) to be inserted on the formatted string using the fmt.Printf syntax.

func (*Po) GetC added in v1.0.0 

func (po *Po) GetC(str, ctx string, vars ...interface{}) string

GetC retrieves the corresponding translation for a given string in the given context. Supports optional parameters (vars... interface{}) to be inserted on the formatted string using the fmt.Printf syntax.

func (*Po) GetN 

func (po *Po) GetN(str, plural string, n int, vars ...interface{}) string

GetN retrieves the (N)th plural form of translation for the given string. Supports optional parameters (vars... interface{}) to be inserted on the formatted string using the fmt.Printf syntax.

func (*Po) GetNC added in v1.0.0 

func (po *Po) GetNC(str, plural string, n int, ctx string, vars ...interface{}) string

GetNC retrieves the (N)th plural form of translation for the given string in the given context. Supports optional parameters (vars... interface{}) to be inserted on the formatted string using the fmt.Printf syntax.

func (*Po) Parse 

func (po *Po) Parse(str string)

Parse loads the translations specified in the provided string (str)

func (*Po) ParseFile 

func (po *Po) ParseFile(f string)

ParseFile tries to read the file by its provided path (f) and parse its content as a .po file.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.