i18n

Documentation

Overview

Package i18n provides internationalization support for PixivFE.

This file contains global functions and variables for setting and retrieving the current locale, as well as functions for translating user-facing errors and formatted strings.

This file loads translation files and looks up translations for given strings.

This file rewrites strings in Jet templates before they are parsed.

Index

• Constants
• Variables
• func Error(text string) error
• func Errorf(format string, a ...any) error
• func GetLocale() string
• func Replacer(locale string, file string) *strings.Replacer
• func SetLocale(locale string)
• func Setup() error
• func Sprintf(format string, a ...any) string
• func SuccintID(file string, text string) string
• func Tag(tag string) string
• func Tr(text string) string
• type TrPairs

Constants

const BaseLocale = "en"

BaseLocale is the default locale used when no specific locale is set.

const (
	// CallerSkipFrames is the number of stack frames to skip to reach the calling function
	// that invokes the translation lookup.
	CallerSkipFrames int = 2
)

Variables

var AvailableLanguages = []language{
	{"en", "English"},
	{"vi-VN", "Vietnamese"},
	{"zh-TW", "Traditional Chinese"},
}

AvailableLanguages lists the languages supported by package i18n.

Functions

func Error

func Error(text string) error

func Errorf

func Errorf(format string, a ...any) error

func GetLocale

func GetLocale() string

func Replacer

func Replacer(locale string, file string) *strings.Replacer

Replacer returns nil when nothing needs to be replaced.

func SetLocale

func SetLocale(locale string)

func Setup

func Setup() error

func Sprintf

func Sprintf(format string, a ...any) string

func SuccintID

func SuccintID(file string, text string) string

func Tag

func Tag(tag string) string

Tag returns the English translation for a given tag.

If no translation is found, it returns the original tag.

func Tr

func Tr(text string) string

Tr returns a translation for the provided string.

Types

type TrPairs

type TrPairs = []string

format: old0, new0, old1, new1, ...