jibberjabber

README

Jibber Jabber

Jibber Jabber is a GoLang Library that can be used to detect an operating system's current language, plus helper functionalities for app development.

OS Support

UNIX: GNU/Linux, macOS, FreeBSD, OpenBSD, NetBSD
via the LC_MESSAGES, LC_ALL and LANG environment variables. They are checked in the aforementioned order.
These variables are used in ALL versions of UNIX for language detection.

Windows
via GetUserDefaultLocaleName and GetSystemDefaultLocaleName system calls. These calls are supported in Windows Vista and up.

DetectIETF

DetectIETF will return the current locale as a string. The format of the locale will be the ISO 639 two-letter language code, a DASH, then an ISO 3166 two-letter country code.

Example:

	userLocale, err := jibberjabber.DetectIETF()
	println("Locale:", userLocale)

DetectLanguage

DetectLanguage will return the current language as a string. The format will be the ISO 639 two-letter language code.

also import the following packages for parsing the returned locale

	"golang.org/x/text/language"
	"golang.org/x/text/language/display"

Example:

	userLanguage, err := jibberjabber.DetectLanguage()
	println("Language:", userLanguage)
	languageTag, parseErr := language.Parse(userLanguage)
	println("Language:", display.Self.Name(languageTag))
	

DetectLanguageTag

DetectLanguageTag will return the current language as a language tag as specified by "golang.org/x/text/language".

Example:

	languageTag, parseErr := jibberjabber.DetectLanguageTag()
	println("Language:", display.Self.Name(languageTag))
	

DetectTerritory

DetectTerritory will return the current locale territory as a string. The format will be the ISO 3166 two-letter country code.

Example:

	localeTerritory, err := jibberjabber.DetectTerritory()
	println("Territory:", localeTerritory)

About Errors in Detect

All the Detect commands will return an error if they are unable to read the Locale from the system.

For Windows, additional error information is provided due to the nature of the system call being used.

Helper Singleton

There is a singleton you can, but don't have to, use. It helps you define and later check which locales you support in your application - if not, apply a fallback language locale.

Example:

	langServer := jibberjabber.LanguageServer()
	langServer.SetSupportedLanguages(map[language.Tag]string{
		language.German:  "active.de.toml",
		language.English: "active.en.toml",
	}
	langServer.SetFallbackLanguage(language.English)
	langLocale, err := langServer.StringToSupportedLanguageTag("something") // returns `language.English`
	if err != nil {
		log.Printf("failed fetching supported language locale, use fallback language locale %q\n", display.Self.Name(langLocale))
	}

Documentation

Index

• Variables
• func DetectIETF() (string, error)
• func IsError(err error, jjError error) bool

Variables

var (
	ErrLangDetectFail          = errors.New("could not detect Language")
	ErrLangFallbackUndefined   = errors.New("no fallback language defined")
	ErrLangFallbackUnsupported = errors.New("defined fallback language is not supported")
	ErrLangUnsupported         = errors.New("language not supported")
	ErrLangParse               = errors.New("language identifier cannot be parsed")
)

Functions

func DetectIETF

func DetectIETF() (string, error)

DetectIETF detects and returns the IETF language tag of UNIX systems, like Linux and macOS. If a territory is defined, the returned value will be in the format of `[language]-[territory]`, e.g. `en-GB`.

func IsError

func IsError(err error, jjError error) bool

IsError checks an error you received from one of jibberjabber's funcs for a jibberjabber error like `ErrLangDetectFail`. Reason you cannot use e.g. `errors.Is()`: currently, golang does not allow native chain-wrapping errors. Therefore, `errors.Unwrap()`, `errors.Is()` & Co. won't return `true` for jibberjabber errors.