Configuration Reference

Main configuration

wuchale can be configured using wuchale.config.js at the root of your project. TypeScript or other formats for configuration are not supported. An example configuration looks like:

wuchale.config.js

// @ts-check
import { defineConfig } from "wuchale"
import { adapter as svelte } from "@wuchale/svelte"

export default defineConfig({
    sourceLocale: 'en', // default
    otherLocales: ['es', 'fr'],
    adapters: {
        main: svelte({
            catalog: './src/locales/{locale}',
        }),
    }
})

The above configuration shows how to configure wuchale with the Svelte adapter. The adapter accepts a configuration object as an argument. The configuration for each adapter is discussed in the adapter’s documentation. The main configuration is discussed here.

sourceLocale

type: string default: en

The key of the source languages from the locales config. This is the language you use in the source code and will not need to be translated. In most cases this will be English.

otherLocales

type: string[]

The locales to translate to. They must be valid BCP 47 tags. For example, en, en-US, eng, zh-Hans are valid, but en_US, cn-simplified are invalid. The validation is done using Intl.DisplayNames.

adapters

type: Record<string, Adapter> default: {}

Adapters are what handle the project specific operations like extracting the messages from the code and transforming it. They have to be provided with their own keys. The keys are how you can separate different parts of the project into smaller pieces and refer to them. The key also has to be a valid keyword like locale keys.

hmr

type: boolean default: true

Enable HMR updates during development. You can disable this to avoid the small overhead of live translation updates and work solely with the source language. HMR is highly optimized: it updates only the affected components, preserving application state and avoiding full reloads.

geminiAPIKey

type: string default: env

If you want to use Gemini live translation, you can provide your API key here directly, or use the special value env to use the GEMINI_API_KEY environment variable. If the environment variable is not set, Gemini will not be used, as if it was disabled. It can also be always disabled by setting this to null, in which case the environment variable will not be used even if it is set.

messages

type: string default: true

If you find wuchale to be too chatty, you can silence it by setting this to false.