MCPcopy Index your code
hub / github.com/go-playground/universal-translator

github.com/go-playground/universal-translator @v0.18.1

Chat with this repo
repository ↗ · DeepWiki ↗ · release v0.18.1 ↗ · + Follow
106 symbols 366 edges 10 files 66 documented · 62% 310 cross-repo links
What it actually does AI analysis from the code graph — generated when you open this
loading…
README

universal-translator

Project status Coverage Status Go Report Card GoDoc License

Universal Translator is an i18n Translator for Go/Golang using CLDR data + pluralization rules

Why another i18n library?

Because none of the plural rules seem to be correct out there, including the previous implementation of this package, so I took it upon myself to create locales for everyone to use; this package is a thin wrapper around locales in order to store and translate text for use in your applications.

Features

  • [x] Rules generated from the CLDR data, v36.0.1
  • [x] Contains Cardinal, Ordinal and Range Plural Rules
  • [x] Contains Month, Weekday and Timezone translations built in
  • [x] Contains Date & Time formatting functions
  • [x] Contains Number, Currency, Accounting and Percent formatting functions
  • [x] Supports the "Gregorian" calendar only ( my time isn't unlimited, had to draw the line somewhere )
  • [x] Support loading translations from files
  • [x] Exporting translations to file(s), mainly for getting them professionally translated
  • [ ] Code Generation for translation files -> Go code.. i.e. after it has been professionally translated
  • [ ] Tests for all languages, I need help with this, please see here

Installation

Use go get

go get github.com/go-playground/universal-translator

Usage & Documentation

Please see https://godoc.org/github.com/go-playground/universal-translator for usage docs

Examples:

File formatting

All types, Plain substitution, Cardinal, Ordinal and Range translations can all be contained within the same file(s); they are only separated for easy viewing.

Examples:
Basic Makeup

NOTE: not all fields are needed for all translation types, see examples

{
    "locale": "en",
    "key": "days-left",
    "trans": "You have {0} day left.",
    "type": "Cardinal",
    "rule": "One",
    "override": false
}
Field Description
locale The locale for which the translation is for.
key The translation key that will be used to store and lookup each translation; normally it is a string or integer.
trans The actual translation text.
type The type of translation Cardinal, Ordinal, Range or "" for a plain substitution(not required to be defined if plain used)
rule The plural rule for which the translation is for eg. One, Two, Few, Many or Other.(not required to be defined if plain used)
override If you wish to override an existing translation that has already been registered, set this to 'true'. 99% of the time there is no need to define it.

Help With Tests

To anyone interesting in helping or contributing, I sure could use some help creating tests for each language. Please see issue here for details.

License

Distributed under MIT License, please see license file in code for more details.

Extension points exported contracts — how you extend this code

Translator (Interface)
Translator is universal translators translator instance which is a thin wrapper around locales.Translator instance provi
translator.go
Translator (Interface)
Translator wraps ut.Translator in order to handle errors transparently it is totally optional but recommended as it can
_examples/full-with-files/main.go
Translator (Interface)
Translator wraps ut.Translator in order to handle errors transparently it is totally optional but recommended as it can
_examples/full-no-files/main.go

Core symbols most depended-on inside this repo

Error
called by 42
errors.go
GetTranslator
called by 23
universal_translator.go
New
called by 22
universal_translator.go
Import
called by 13
import_export.go
AddOrdinal
called by 13
translator.go
AddCardinal
called by 12
translator.go
VerifyTranslations
called by 12
translator.go
T
called by 12
_examples/full-no-files/main.go

Shape

Method 56
Function 30
Struct 16
Interface 3
TypeAlias 1

Languages

Go100%

Modules by API surface

translator.go22 symbols
errors.go20 symbols
_examples/full-with-files/main.go16 symbols
_examples/full-no-files/main.go16 symbols
translator_test.go10 symbols
universal_translator.go7 symbols
import_export_test.go7 symbols
import_export.go6 symbols
benchmarks_test.go1 symbols
_examples/basic/main.go1 symbols

For agents

$ claude mcp add universal-translator \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact

Ask about this repo answers extend the page