@palamedes/config

Exports

• defineConfig(config)
• loadPalamedesConfig(options?)
• loadPalamedesConfigSync(options?)
• CONFIG_FILENAMES
• expandFallbackLocales(locales, fallbackLocales?)
• resolveCatalogPath(config, catalogPath, locale)
• resolveConfigPattern(config, pattern)
• LoadPalamedesConfigOptions
• PalamedesConfig
• LoadedPalamedesConfig
• PalamedesCatalogConfig
• PalamedesPoOutputOptions
• PalamedesFallbackLocales
• PalamedesSourceReferenceRoot
• PalamedesMdxConfig
• PalamedesLintConfig
• PalamedesSourceRuleLevel
• PalamedesPluginDeclaration

Config Files

Supported file names:

• palamedes.yaml
• palamedes.yml
• palamedes.json
• palamedes.toml
• palamedes.config.ts
• palamedes.config.js
• palamedes.config.mjs
• palamedes.config.cjs

See the configuration reference for every field.

defineConfig(config)

Returns the config unchanged while giving TypeScript users a typed authoring surface.

import { defineConfig } from "@palamedes/config"

export default defineConfig({
  locales: ["en", "de"],
  sourceLocale: "en",
  referenceScopes: false,
  catalogs: [{ path: "src/locales/{locale}", include: ["src"] }],
  plugins: [["@acme/palamedes-workflows", { policy: "strict" }]],
})

referenceScopes controls whether catalog source references carry a stable component or function suffix. It defaults to true, producing references such as src/App.tsx#CheckoutButton; the false above opts into file-only references such as src/App.tsx. The example sets it explicitly only to show the field — omit it to keep the default. See Source references.

PO is the default catalog storage. Opt into FCL by adding format: "fcl":

export default defineConfig({
  locales: ["en", "de"],
  sourceLocale: "en",
  catalogs: [{ path: "src/locales/{locale}", format: "fcl", include: ["src"] }],
})

loadPalamedesConfig(options?)

Searches from cwd for a supported config file unless configPath is passed. The returned object includes configPath, rootDir, sourceReferenceRoot, and the resolved referenceScopes boolean.

const config = await loadPalamedesConfig({ cwd: process.cwd() })

Options include cwd, configPath, and skipValidation. Use skipValidation only for tooling that needs to inspect partially-authored config files.

plugins is returned in declaration order. Each entry is a package specifier or [specifier, options]; the native CLI resolves binary plugins relative to a data config's configPath. JavaScript hosts may inspect the same field but do not execute CLI plugins.

loadPalamedesConfigSync(options?)

Synchronous variant of loadPalamedesConfig with the same options, return shape, and file support (including legacy palamedes.config.ts/.js). Use it in hosts that cannot await, such as synchronous loader hooks — the Remix register hook loads its config this way.