lingo

lingo

Go library for streamlining language translation handling.

lingo automatically discovers translation configuration files in the input path, loads the translations, and sets up a localizer service. Users can either use the default go-i18n implementation or implement their own custom solution. It provides a simple, unified interface for managing internationalization in Go applications.

Features

• Auto-discovery: Automatically finds and loads translation files from specified directories
• Flexible implementation: Use the built-in go-i18n implementation or create your own
• Fallback support: Graceful fallback to default language when translations are missing
• Template variables: Support for dynamic content with template data
• Pluralization: Built-in support for plural forms

Supported File Formats

lingo supports the following translation file formats through go-i18n:

• TOML (.toml)
• JSON (.json)
• YAML (.yaml, .yml)

Installation

go get github.com/Zapharaos/lingo

Note: Spit uses Go Modules to manage dependencies.

Usage Examples

1. Create translation files

Create a translation file (e.g., messages.en.toml):

[hello_world]
other = "Hello, World!"

2. Initialize and use lingo

package main

import (
    "fmt"
    "log"
    
    "github.com/Zapharaos/lingo"
    "golang.org/x/text/language"
)

func main() {
    // Initialize the localizer service
    i18n, err := lingo.NewI18n(
        language.English, // default language
        "config/",        // translations directory
        "messages",       // file prefix
    )
    if err != nil {
        log.Fatalf("Failed to initialize: %v", err)
    }
    
    // Set as global service
    lingo.SetLocalizerService(i18n)
    
    // Translate a message
    result := lingo.MustTranslate(language.English, &lingo.Message{
        ID: "hello_world",
    })
    fmt.Println(result) // Output: Hello, World!
}

For comprehensive usage examples including template variables, pluralization, and fallback behavior, see the examples package.

Development

Install dependencies:

make dev-deps

Run unit tests and generate coverage report:

make test-unit

Run linters:

make lint

Some linter violations can automatically be fixed:

make fmt

Contributing

We welcome contributions to the lingo library! If you have a bug fix, feature request, or improvement, please open an issue or pull request on GitHub. We appreciate your help in making lingo better for everyone. If you are interested in contributing to the lingo library, please check out our contributing guidelines for more information on how to get started.

License

The project is licensed under the MIT License.