Code Monkey home page Code Monkey logo

go-i18n's Introduction

go-i18n Build Status

go-i18n is a Go package and a command that can be used to translate Go programs into multiple languages.

Package i18n GoDoc

The i18n package provides runtime APIs for fetching translated strings.

Command goi18n GoDoc

The goi18n command provides functionality for managing the translation process.

Installation

Make sure you have setup GOPATH.

go get -u github.com/nicksnyder/go-i18n/goi18n
goi18n -help

Workflow

A typical workflow looks like this:

  1. Add a new string to your source code.

    T("settings_title")
  2. Add the string to en-US.all.json

    [
      {
        "id": "settings_title",
        "translation": "Settings"
      }
    ]
  3. Run goi18n

    goi18n path/to/*.all.json
    
  4. Send path/to/*.untranslated.json to get translated.

  5. Run goi18n again to merge the translations

    goi18n path/to/*.all.json path/to/*.untranslated.json

Translation files

A translation file stores translated and untranslated strings.

Example:

[
  {
    "id": "d_days",
    "translation": {
      "one": "{{.Count}} day",
      "other": "{{.Count}} days"
    }
  },
  {
    "id": "my_height_in_meters",
    "translation": {
      "one": "I am {{.Count}} meter tall.",
      "other": "I am {{.Count}} meters tall."
    }
  },
  {
    "id": "person_greeting",
    "translation": "Hello {{.Person}}"
  },
  {
    "id": "person_unread_email_count",
    "translation": {
      "one": "{{.Person}} has {{.Count}} unread email.",
      "other": "{{.Person}} has {{.Count}} unread emails."
    }
  },
  {
    "id": "person_unread_email_count_timeframe",
    "translation": {
      "one": "{{.Person}} has {{.Count}} unread email in the past {{.Timeframe}}.",
      "other": "{{.Person}} has {{.Count}} unread emails in the past {{.Timeframe}}."
    }
  },
  {
    "id": "program_greeting",
    "translation": "Hello world"
  },
  {
    "id": "your_unread_email_count",
    "translation": {
      "one": "You have {{.Count}} unread email.",
      "other": "You have {{.Count}} unread emails."
    }
  }
]

Supported languages

  • Arabic (ar)
  • Belarusian (be)
  • Bulgarian (bg)
  • Catalan (ca)
  • Chinese (simplified and traditional) (zh)
  • Czech (cs)
  • Danish (da)
  • Dutch (nl)
  • English (en)
  • French (fr)
  • German (de)
  • Icelandic (is)
  • Indonesian (id)
  • Italian (it)
  • Korean (ko)
  • Japanese (ja)
  • Lithuanian (lt)
  • Malay (ms)
  • Polish (pl)
  • Portuguese (pt)
  • Portuguese (Brazilian) (pt-BR)
  • Russian (ru)
  • Spanish (es)
  • Swedish (sv)
  • Turkish (tr)
  • Ukrainian (uk)

Adding new languages

It is easy to add support for additional languages:

  1. Lookup the language's CLDR plural rules.

  2. Add the language to pluralspec.go:

    var pluralSpecs = map[string]*PluralSpec{
        // ...
    			// English
    			"en": &PluralSpec{
    				Plurals: newPluralSet(One, Other),
    				PluralFunc: func(ops *operands) Plural {
    					if ops.I == 1 && ops.V == 0 {
    						return One
    					}
    					return Other
    				},
    			},
        // ...
    }
  3. Add a test to pluralspec_test.go

  4. Update this README with the new language.

  5. Submit a pull request!

License

go-i18n is available under the MIT license. See the LICENSE file for more info.

go-i18n's People

Contributors

dorajistyle avatar jondal avatar nicksnyder avatar ottob avatar rtfb avatar sogko avatar soktherat avatar udokmeci avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.