gotext

Documentation

Overview

gotext is a tool for managing text in Go source code.

Usage:

gotext [global options] command [arguments]

The global options are:

-srclang=<code>            source code language used (default: en-US)
-declare-var=<name>        declare variable instead of overwriting the
                           message.DefaultCatalog package global
-go-build=<constraint>     include a //go:build constraint with the
                           generated catalog

The commands are:

update      merge translations and generate catalog
extract     extracts strings to be translated from code
rewrite     rewrites fmt functions to use a message Printer
generate    generates code to insert translated messages

Use "gotext help [command]" for more information about a command.

Additional help topics:

Use "gotext help [topic]" for more information about that topic.

IMPORTANT:

This version of gotext is from github.com/go-corelibs/x-text and not the upstream golang.org/x/text. In order to use this version the codebase must use the github.com/go-corelibs/x-text package as a drop-in replacement for the upstream golang.org/x/text package. No translations will be found otherwise.

Merge translations and generate catalog

Usage:

gotext update <package>* [-out <gofile>]

Extracts strings to be translated from code

Usage:

gotext extract <package>*

Rewrites fmt functions to use a message Printer

Usage:

gotext rewrite [-w] <package>

rewrite is typically done once for a project. It rewrites all usages of fmt to use x/text's message package whenever a message.Printer is in scope. It rewrites Print and Println calls with constant strings to the equivalent using Printf to allow translators to reorder arguments.

The -w flag specifies to write files in place.

Generates code to insert translated messages

Usage:

gotext generate <package> [-out <gofile>]