config

@saykit/config

Configuration schema and CLI for SayKit.

Provides the defineConfig helper, the Zod-validated schema for saykit.config.ts, and the saykit CLI used to extract messages from your source.

Install

pnpm add -D @saykit/config

Configuration

import { defineConfig } from '@saykit/config';
import po from '@saykit/format-po';
import js from '@saykit/transform-js';

export default defineConfig({
  locales: ['en', 'fr'],
  // Optional per-locale fallback chains, most specific first. The source locale
  // (the first entry in `locales`) is always the final fallback.
  fallbackLocales: {
    'en-NZ': ['en-GB'],
    'es-MX': 'es',
  },
  buckets: [
    {
      include: ['src/**/*.ts'],
      output: 'src/locales/{locale}.{extension}',
      formatter: po(),
      transformer: js(),
    },
  ],
});

CLI

saykit extract           # extract messages once
saykit extract --watch   # extract and watch for changes
saykit clean             # prune dead entries from other locales

Extraction only writes the source locale (the first entry in locales). Locales that don't have a file yet are bootstrapped with an empty, header-only catalogue so a TMS can register them; existing translation files are left untouched. Translated content is owned by your TMS.

At load time (via the unplugin or Babel plugin), each locale module is filled from its fallback chain, so an untranslated key resolves to a fallback locale and ultimately the source string — the runtime still loads a single locale.

saykit clean only ever subtracts from non-source locales: it drops entries that no longer exist in the source catalogue and entries with an empty translation, and leaves everything else exactly as it is. It never adds source keys to a locale file, that stays your TMS's job.

Documentation

Full configuration guide and CLI reference at saykit.js.org.