Skip to content
wuchale

CLI

wuchale provides a CLI from the package wuchale. The CLI can be invoked directly:

Terminal window
npx wuchale [command] {options}

You can get help by running it with --help

Terminal window
$ npx wuchale --help


wuchale cli


Usage:
    wuchale [command] {options}


Commands:
    [none]  Extract/compile messages from the codebase into catalogs
            deleting unused messages if --clean is specified
    status  Show current status
    check   Check for errors


Options:
    --config         use another config file instead of wuchale.config.js|wuchale.config.mjs|wuchale.config.ts|wuchale.config.mts
    --clean, -c      remove unused messages from catalogs
    --watch, -w      continuously watch for file changes
    --sync           extract sequentially instead of in parallel
    --log-level, -l  {error,warn,info,verbose} (only when no commands) set log level
    --help, -h       Show this help


You can specify --help after a sub-command for more.

You can optionally add some commands to your package.json for convenience.

// ...
"scripts": {
    // ...
    "extract": "wuchale",
    "clean": "wuchale --clean"
},
// ...

The following commands are accepted (in place of {cmd}).

(No command)

Section titled “(No command)”

You just run

Terminal window
npx wuchale

This scans all of the files that match the configured pattern for the adapters and extracts the messages. And if writeFiles is enabled, it writes the generated files. This can be used when Vite is not used/needed (for example, for server only projects). Watch mode is also supported.

Additionally, if it is running in the project for the first time, it ceates the necessay files, doing the following, for each adapter configuration:

  • If the loader specified is one of the provided ones, not custom, it is created/overwritten.
  • If the loader specified is custom, it doesn’t touch the existing loader files.

status

Section titled “status”

This shows the status information of the setup like if the loader files exist and are not empty, the number of total messages, untranslated, obsolete.

An optional --json flag can be specified to get the information in a JSON format.

check

Section titled “check”

This checks for any possible unintended errors. It checks for two things:

  • By default, it checks the translation catalog files to see if all of the translations are in the intended structure.
    • Missing/additional/different placeholders, incorrect nesting, etc produce an error.
    • Untranslated messages do not produce an error as they are in a possibly valid intermediate state until they are translated.
  • If the --full flag is specified, it goes through the codebase and does the normal extraction without actually writing anything, it then checks if there is any change not already in the catalogs and if any, it reports an error. The possible cases are:
    • New messages
    • Newly obsoleted messages
    • Reference changes