README
¶
go-i18n
Lightweight internationalization for Go services built on top of
nicksnyder/go-i18n, with request
language detection and a Gin middleware.
Features
- Resolve the active language from
context.Context, falling back to a default. - Per-language localizer with automatic fallback to the default language.
- Gin middleware reading
X-Language/Accept-Language. - Bundle initializer that loads translation files from configured paths.
Install
go get github.com/tech-nimble/go-i18n
Configuration
Translation files are JSON named <lang>.json (ru.json, kk.json,
en.json). Their paths are read from environment variables:
RU_TRANSLATE_RESOURCE_PATH
KK_TRANSLATE_RESOURCE_PATH
Usage
import (
"github.com/tech-nimble/go-i18n"
i18ninit "github.com/tech-nimble/go-i18n/initializers/i18n"
)
func main() {
bundle := i18ninit.Initialize()
lang := i18n.NewDefault(bundle)
// Gin middleware
router.Use(lang /* via */ )
localize := i18n.NewLocalize(bundle, "ru")
fmt.Println(localize.Tf("privileges.remain_days_from_day", map[string]any{"Days": "1"}, 1))
}
If templateData and pluralCount are omitted, the other form is used.
Supported languages
Defaults: ru (default), kk, en. Override via NewLang.
License
MIT © Nimble Tech
Documentation
¶
Overview ¶
Package i18n provides language detection, localization and a Gin middleware for selecting the request language.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Lang ¶
type Lang struct {
// contains filtered or unexported fields
}
Lang resolves the active language from a context.
func NewDefault ¶
NewDefault builds a Lang with the default set of languages.
func (*Lang) GetDefaultLang ¶
GetDefaultLang returns the default language.
func (*Lang) GetLangFromContext ¶
GetLangFromContext returns the language stored in the context, or the default.
func (*Lang) GetLocalize ¶
GetLocalize returns the localizer for the context language.
func (*Lang) IsAvailableLang ¶
IsAvailableLang reports whether the language is supported. An empty string is treated as unsupported.
type Localize ¶
type Localize struct {
// contains filtered or unexported fields
}
Localize translates message ids for a single language.
func NewLocalize ¶
NewLocalize builds a localizer for the given languages.
type Middleware ¶
type Middleware struct {
// contains filtered or unexported fields
}
Middleware stores the request language in the context.
func NewMiddleware ¶
func NewMiddleware(settings Settings) *Middleware
NewMiddleware builds the middleware.
func (*Middleware) SetLanguage ¶
func (m *Middleware) SetLanguage(ctx *gin.Context)
SetLanguage extracts the language from the request and stores it in the context.
type Responder ¶
Responder exposes the translation bundle.
func NewResponder ¶
NewResponder builds a Responder.
Source Files
Directories