ss-keel-i18n

Coming Soon

This addon is under development. The interface it implements is stable — see Translator.

ss-keel-i18n provides a Translator implementation that loads translation files and resolves keys by locale. Locale is detected automatically from the Accept-Language header.

Implements: Translator

Planned Installation

go get github.com/slice-soft/ss-keel-i18n

Planned Usage

Setup

import "github.com/slice-soft/ss-keel-i18n"

translator, err := ssi18n.New(ssi18n.Config{
    DefaultLocale: "en",
    Path:          "./locales",  // directory with translation files
})

app.SetTranslator(translator)

Translation Files

locales/
├── en.json
├── es.json
└── pt-BR.json

locales/en.json

{
  "welcome": "Welcome, {{.Name}}!",
  "errors": {
    "user_not_found": "User not found",
    "email_taken": "This email is already in use"
  }
}

locales/es.json

{
  "welcome": "¡Bienvenido, {{.Name}}!",
  "errors": {
    "user_not_found": "Usuario no encontrado",
    "email_taken": "Este correo ya está en uso"
  }
}

Using in Handlers

func (c *UserController) create(ctx *core.Ctx) error {
    var dto CreateUserDTO
    if err := ctx.ParseBody(&dto); err != nil {
        return err
    }

    if emailTaken {
        // ctx.T reads Accept-Language automatically
        msg := ctx.T("errors.email_taken")
        return core.Conflict(msg)
    }

    welcome := ctx.T("welcome", dto.Name)
    return ctx.Created(map[string]string{"message": welcome})
}

ctx.T(key, args...) resolves the key for the locale detected from the Accept-Language header. Falls back to DefaultLocale if the requested locale is not available.

Reading the Current Locale

locale := ctx.Lang() // "en", "es", "pt-BR"

Supported Formats

Format	Extension
JSON	.json
YAML	.yaml / .yml (planned)
TOML	.toml (planned)

Pluralization

{
  "items": {
    "one": "{{.Count}} item",
    "other": "{{.Count}} items"
  }
}

ctx.T("items", map[string]int{"Count": 5}) // "5 items"
ctx.T("items", map[string]int{"Count": 1}) // "1 item"