-
Notifications
You must be signed in to change notification settings - Fork 277
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
ec04da4
commit 3dc2e04
Showing
97 changed files
with
3,740 additions
and
5,663 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,11 +1,18 @@ | ||
| language: go | ||
| sudo: false | ||
| go: | ||
| - 1.2.x | ||
| - 1.3.x | ||
| - 1.4.x | ||
| - 1.5.x | ||
| - 1.6.x | ||
| - 1.7.x | ||
| - 1.8.x | ||
| - 1.9.x | ||
|
|
||
| matrix: | ||
| include: | ||
| - go: 1.7.x | ||
| env: PKG='./...' | ||
| - go: 1.10.x | ||
| env: PKG='./...' COVER='-coverprofile=coverage.txt -covermode=count' | ||
|
|
||
| before_install: | ||
| - go get -t -v ./... | ||
|
|
||
| script: | ||
| - go test $COVER $PKG | ||
|
|
||
| after_success: | ||
| - bash <(curl -s https://codecov.io/bash) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1 @@ | ||
| Feb 24, 2015 | ||
| - Add Korean | ||
|
|
||
| Feb 18, 2015 | ||
| - Added ParseTranslationFileBytes so translation files may be loaded from an arbitrary serialization format, such as go-bindata. | ||
| https://github.com/nicksnyder/go-i18n/releases |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,186 +1,116 @@ | ||
| go-i18n [](http://travis-ci.org/nicksnyder/go-i18n) [](https://sourcegraph.com/github.com/nicksnyder/go-i18n?badge) | ||
| ======= | ||
| # go-i18n [](http://travis-ci.org/nicksnyder/go-i18n) [](https://goreportcard.com/report/github.com/nicksnyder/go-i18n) [](https://sourcegraph.com/github.com/nicksnyder/go-i18n?badge) | ||
|
|
||
| go-i18n is a Go [package](#i18n-package) and a [command](#goi18n-command) that helps you translate Go programs into multiple languages. | ||
|
|
||
| * Supports [pluralized strings](http://cldr.unicode.org/index/cldr-spec/plural-rules) for all 200+ languages in the [Unicode Common Locale Data Repository (CLDR)](http://www.unicode.org/cldr/charts/28/supplemental/language_plural_rules.html). | ||
| * Code and tests are [automatically generated](https://github.com/nicksnyder/go-i18n/tree/master/i18n/language/codegen) from [CLDR data](http://cldr.unicode.org/index/downloads) | ||
| * Code and tests are [automatically generated](https://github.com/nicksnyder/go-i18n/tree/master/i18n/language/codegen) from [CLDR data](http://cldr.unicode.org/index/downloads) | ||
| * Supports strings with named variables using [text/template](http://golang.org/pkg/text/template/) syntax. | ||
| * Translation files are simple JSON, TOML or YAML. | ||
| * Supports message files of any format (e.g. JSON, TOML, YAML, etc.). | ||
| * [Documented](http://godoc.org/github.com/nicksnyder/go-i18n) and [tested](https://travis-ci.org/nicksnyder/go-i18n)! | ||
|
|
||
| Package i18n [](http://godoc.org/github.com/nicksnyder/go-i18n/i18n) | ||
| ------------ | ||
|
|
||
| The i18n package provides runtime APIs for fetching translated strings. | ||
|
|
||
| Command goi18n [](http://godoc.org/github.com/nicksnyder/go-i18n/goi18n) | ||
| -------------- | ||
|
|
||
| The goi18n command provides functionality for managing the translation process. | ||
|
|
||
| Installation | ||
| ------------ | ||
|
|
||
| Make sure you have [setup GOPATH](http://golang.org/doc/code.html#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. | ||
|
|
||
| ```go | ||
| T("settings_title") | ||
| ``` | ||
|
|
||
| 2. Add the string to en-US.all.json | ||
|
|
||
| ```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 | ||
| ```sh | ||
| goi18n path/to/*.all.json path/to/*.untranslated.json | ||
| ``` | ||
| Translation files | ||
| ----------------- | ||
| A translation file stores translated and untranslated strings. | ||
| Here is an example of the default file format that go-i18n supports: | ||
| ```json | ||
| [ | ||
| { | ||
| "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." | ||
| } | ||
| } | ||
| ] | ||
| ## Package i18n [](http://godoc.org/github.com/nicksnyder/go-i18n/i18n) | ||
|
|
||
| The i18n package provides support for looking up messages according to a set of locale preferences. | ||
|
|
||
| ```go | ||
| import "github.com/nicksnyder/go-i18n/i18n" | ||
| ``` | ||
|
|
||
| Create a Bundle to use for the lifetime of your application. | ||
|
|
||
| ```go | ||
| bundle := i18n.NewBundle(language.English) | ||
| ``` | ||
|
|
||
| Create a Localizer to use for a set of language preferences. | ||
|
|
||
| ```go | ||
| func(w http.ResponseWriter, r \*http.Request) { | ||
| lang := r.FormValue("lang") | ||
| accept := r.Header.Get("Accept-Language") | ||
| localizer := i18n.NewLocalizer(bundle, lang, accept) | ||
| } | ||
| ``` | ||
|
|
||
| To use a different file format, write a parser for the format and add the parsed translations using [AddTranslation](https://godoc.org/github.com/nicksnyder/go-i18n/i18n#AddTranslation). | ||
| Use the Localizer to lookup messages. | ||
|
|
||
| ```go | ||
| localizer.MustLocalize(&i18n.LocalizeConfig{ | ||
| DefaultMessage: &i18n.Message{ | ||
| ID: "PersonCats", | ||
| One: "{{.Name}} has {{.Count}} cat.", | ||
| Other: "{{.Name}} has {{.Count}} cats.", | ||
| }, | ||
| TemplateData: map[string]string{ | ||
| "Name": "Nick", | ||
| "Count": 2, | ||
| }, | ||
| PluralCount: 2, | ||
| }) // Nick has 2 cats. | ||
| ``` | ||
|
|
||
| Note that TOML only supports the flat format, which is described below. | ||
| ## Command goi18n [](http://godoc.org/github.com/nicksnyder/go-i18n/goi18n) | ||
|
|
||
| More examples of translation files: [JSON](https://github.com/nicksnyder/go-i18n/tree/master/goi18n/testdata/input), [TOML](https://github.com/nicksnyder/go-i18n/blob/master/goi18n/testdata/input/flat/ar-ar.one.toml), [YAML](https://github.com/nicksnyder/go-i18n/blob/master/goi18n/testdata/input/yaml/en-us.one.yaml). | ||
| The goi18n command manages message files used by the i18n package. | ||
|
|
||
| Flat Format | ||
| ------------- | ||
| ``` | ||
| go get -u github.com/nicksnyder/go-i18n/goi18n | ||
| goi18n -help | ||
| ``` | ||
|
|
||
| You can also write shorter translation files with flat format. | ||
| E.g the example above can be written in this way: | ||
| Use `goi18n extract` to create a message file that contains the messages defined in your Go source files. | ||
|
|
||
| ```json | ||
| { | ||
| "d_days": { | ||
| "one": "{{.Count}} day.", | ||
| "other": "{{.Count}} days." | ||
| }, | ||
| ```toml | ||
| # en.toml | ||
| [PersonCats] | ||
| description = "The number of cats a person has" | ||
| one = "{{.Name}} has {{.Count}} cat." | ||
| other = "{{.Name}} has {{.Count}} cats." | ||
| ``` | ||
|
|
||
| "my_height_in_meters": { | ||
| "one": "I am {{.Count}} meter tall.", | ||
| "other": "I am {{.Count}} meters tall." | ||
| }, | ||
| Use `goi18n merge` to create message files for translation. | ||
|
|
||
| "person_greeting": { | ||
| "other": "Hello {{.Person}}" | ||
| }, | ||
| ```toml | ||
| # translate.es.toml | ||
| [PersonCats] | ||
| description = "The number of cats a person has" | ||
| hash = "sha1-f937a0e05e19bfe6cd70937c980eaf1f9832f091" | ||
| one = "{{.Name}} has {{.Count}} cat." | ||
| other = "{{.Name}} has {{.Count}} cats." | ||
| ``` | ||
|
|
||
| "person_unread_email_count": { | ||
| "one": "{{.Person}} has {{.Count}} unread email.", | ||
| "other": "{{.Person}} has {{.Count}} unread emails." | ||
| }, | ||
| Use `goi18n merge` to merge translated message files with your existing message files. | ||
|
|
||
| "person_unread_email_count_timeframe": { | ||
| "one": "{{.Person}} has {{.Count}} unread email in the past {{.Timeframe}}.", | ||
| "other": "{{.Person}} has {{.Count}} unread emails in the past {{.Timeframe}}." | ||
| }, | ||
| ```toml | ||
| # active.es.toml | ||
| [PersonCats] | ||
| description = "The number of cats a person has" | ||
| hash = "sha1-f937a0e05e19bfe6cd70937c980eaf1f9832f091" | ||
| one = "{{.Name}} tiene {{.Count}} gato." | ||
| other = "{{.Name}} tiene {{.Count}} gatos." | ||
| ``` | ||
|
|
||
| "program_greeting": { | ||
| "other": "Hello world" | ||
| }, | ||
| Load the active messages into your bundle. | ||
|
|
||
| "your_unread_email_count": { | ||
| "one": "You have {{.Count}} unread email.", | ||
| "other": "You have {{.Count}} unread emails." | ||
| } | ||
| } | ||
| ```go | ||
| bundle.RegisterUnmarshalFunc("toml", toml.Unmarshal) | ||
| bundle.MustLoadMessageFile("active.es.toml") | ||
| ``` | ||
|
|
||
| The logic of flat format is, what it is structure of structures | ||
| and name of substructures (ids) should be always a string. | ||
| If there is only one key in substructure and it is "other", then it's non-plural | ||
| translation, else plural. | ||
| ## For more information and examples: | ||
|
|
||
| More examples of flat format translation files can be found in [goi18n/testdata/input/flat](https://github.com/nicksnyder/go-i18n/tree/master/goi18n/testdata/input/flat). | ||
| * Read the [documentation](http://godoc.org/github.com/nicksnyder/go-i18n/i18n). | ||
| * Look at the [code examples](https://github.com/nicksnyder/go-i18n/blob/master/i18n/example_test.go) and [tests](https://github.com/nicksnyder/go-i18n/blob/master/i18n/localizer_test.go). | ||
| * Look at an example [application](https://github.com/nicksnyder/go-i18n/tree/master/example). | ||
|
|
||
| Contributions | ||
| ------------- | ||
| ## Contributions | ||
|
|
||
| If you would like to submit a pull request, please | ||
|
|
||
| 1. Write tests | ||
| 2. Format code with [goimports](https://github.com/bradfitz/goimports). | ||
| 3. Read the [common code review comments](https://github.com/golang/go/wiki/CodeReviewComments). | ||
| 1. Write tests. | ||
| 2. Format code with [goimports](https://github.com/bradfitz/goimports). | ||
| 3. Read the [common code review comments](https://github.com/golang/go/wiki/CodeReviewComments). | ||
|
|
||
| ## License | ||
|
|
||
| License | ||
| ------- | ||
| go-i18n is available under the MIT license. See the [LICENSE](LICENSE) file for more info. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| # Example | ||
|
|
||
| This directory contains an example project that uses go-i18n. | ||
|
|
||
| ``` | ||
| go run main.go | ||
| ``` | ||
|
|
||
| Then open http://localhost:8080 in your web browser. | ||
|
|
||
| You can customize the template data via query parameters like this: | ||
| http://localhost:8080/?name=Nick&unreadEmailCount=3&catCount=4&catColor=red |
Oops, something went wrong.