i18next

Documentation

Overview

Package i18next implements reading and writing of i18next JSON translation files.

The expected file format is:

{
    "_meta": { "name": "Русский", "flag": "🇷🇺" },
    "translations": {
        "English key text": "Translated value",
        "Another key": ""
    }
}

Keys are natural English text. Empty string values mean untranslated (i18next falls back to the key itself as the English text).

Index

• Variables
• type File
  • func Parse(data []byte) (*File, error)
  • func ParseFile(path string) (*File, error)
  • func (f *File) Keys() []string
  • func (f *File) Marshal() ([]byte, error)
  • func (f *File) Set(key, value string) bool
  • func (f *File) SourceValues() map[string]string
  • func (f *File) Stats() (total, translated int, pct float64)
  • func (f *File) UntranslatedKeys() []string
  • func (f *File) WriteFile(path string) error
• type Meta
  • func ResolveMeta(lang string) Meta

Variables

var LangMeta = func() map[string]Meta {
	out := make(map[string]Meta, len(langmeta.Registry))
	for k, v := range langmeta.Registry {
		out[k] = Meta{Name: v.Name, Flag: v.Flag}
	}
	return out
}()

LangMeta contains known language metadata for auto-fill.

Types

type File

type File struct {
	Meta         Meta
	Translations map[string]string // key (English) -> value (translated)
	// contains filtered or unexported fields
}

File represents a parsed i18next translation file.

func Parse

func Parse(data []byte) (*File, error)

Parse parses i18next JSON data.

func ParseFile

func ParseFile(path string) (*File, error)

ParseFile reads and parses an i18next JSON translation file.

func (*File) Keys

func (f *File) Keys() []string

Keys returns the translation keys in their original order.

func (*File) Marshal

func (f *File) Marshal() ([]byte, error)

Marshal produces the JSON output matching the original i18next format with 4-space indentation and sorted keys.

func (*File) Set

func (f *File) Set(key, value string) bool

Set updates an existing translation value.

func (*File) SourceValues

func (f *File) SourceValues() map[string]string

SourceValues returns key -> source string mapping. In i18next files keys are natural English source strings.

func (*File) Stats

func (f *File) Stats() (total, translated int, pct float64)

Stats returns (total, translated, percent).

func (*File) UntranslatedKeys

func (f *File) UntranslatedKeys() []string

UntranslatedKeys returns keys that have empty translations.

func (*File) WriteFile

func (f *File) WriteFile(path string) error

WriteFile writes the translation file back to disk in the original format, preserving key order and using 4-space indentation.

type Meta

type Meta struct {
	Name string `json:"name"`
	Flag string `json:"flag"`
}

Meta holds the language metadata from the _meta field.

func ResolveMeta

func ResolveMeta(lang string) Meta

ResolveMeta returns best-effort language metadata for language codes, supporting variants like pt_BR, pt-BR, and region fallbacks.