Remix: PalamedesRemixRegisterOptions

import type { PalamedesRemixRegisterOptions } from "@palamedes/remix"

type PalamedesRemixRegisterOptions = {
    /**
     * Files eligible for macro transformation: a glob, a RegExp, or an array of
     * both. Relative globs resolve from `projectRoot`; RegExps test the absolute
     * file path.
     * @default /\.(tsx?|jsx?|mjs|mts)$/
     */
    include?: PalamedesFilterPattern;
    /**
     * Files excluded from macro transformation, with the same pattern rules as
     * `include`.
     * @default /[/\\]node_modules[/\\]/
     */
    exclude?: PalamedesFilterPattern;
    /**
     * Project directory used for a relative `configPath` and relative
     * `include`/`exclude` globs. Relative values resolve from the current
     * working directory.
     * @default process.cwd()
     */
    projectRoot?: string;
    /**
     * Advanced override for the module imported for the runtime i18n getter.
     * @default "@palamedes/runtime"
     */
    runtimeModule?: string;
    /**
     * Include authored source messages as diagnostic source metadata.
     * Defaults to `false` in every environment. Set to `true` for diagnostic
     * metadata when deployment skew makes authored source text useful.
     * V2 runtime misses throw; this metadata never provides replacement output.
     */
    includeSourceMetadata?: boolean;
    /**
     * Optional Palamedes config path used for `.po` catalog imports. Relative
     * paths resolve from `projectRoot`. Without it, each imported catalog
     * discovers its config from the catalog file's directory upward.
     */
    configPath?: string;
    /**
     * Fail `.po` catalog compilation when a translation is missing.
     * @default false
     */
    failOnMissing?: boolean;
};