@inlang/paraglide-js 2.24.1 → 2.25.0

package/dist/services/config/config-schema.js

@@ -0,0 +1,78 @@
+import * as v from "valibot";
+/**
+ * Strategy names that are built into the runtime. Custom strategies are
+ * prefixed with `custom-` and are matched separately.
+ */
+const BUILTIN_STRATEGY_NAMES = [
+    "cookie",
+    "baseLocale",
+    "globalVariable",
+    "url",
+    "preferredLanguage",
+    "localStorage",
+];
+// Value-position pins so the type-level asserts below are actually
+// evaluated by tsc — an unused alias resolving to `never` would compile.
+export const allStrategiesCovered = true;
+/**
+ * Matches strategy names like `custom-myStrategy`.
+ *
+ * The pattern mirrors the runtime's `isCustomStrategy` check
+ * (`custom-[A-Za-z0-9_-]+`) so the config file rejects names the runtime
+ * would refuse.
+ *
+ * Valibot has no template-literal schema, so the regex-checked string
+ * schema is narrowed to the compiler's type here.
+ */
+const customStrategySchema = v.pipe(v.string(), v.regex(/^custom-[A-Za-z0-9_-]+$/, 'Custom strategies must match "custom-" followed by alphanumeric characters, hyphens, or underscores.'));
+export const strategyNameSchema = v.union([
+    v.picklist(BUILTIN_STRATEGY_NAMES),
+    customStrategySchema,
+]);
+const routeStrategySchema = v.union([
+    v.object({
+        match: v.string(),
+        strategy: v.array(strategyNameSchema),
+        exclude: v.optional(v.never()),
+    }),
+    v.object({
+        match: v.string(),
+        exclude: v.literal(true),
+        strategy: v.optional(v.never()),
+    }),
+]);
+/**
+ * The valibot schema behind {@link ParaglideConfig}.
+ *
+ * Every option is optional — values that are not provided fall back to
+ * the bundler plugin options / command line flags and ultimately to
+ * `defaultCompilerOptions`.
+ */
+export const paraglideConfigSchema = v.object({
+    outdir: v.optional(v.pipe(v.string(), v.nonEmpty('"outdir" must not be empty'))),
+    strategy: v.optional(v.array(strategyNameSchema)),
+    routeStrategies: v.optional(v.array(routeStrategySchema)),
+    experimentalMiddlewareLocaleSplitting: v.optional(v.boolean()),
+    localStorageKey: v.optional(v.string()),
+    isServer: v.optional(v.string()),
+    experimentalStaticLocale: v.optional(v.string()),
+    cookieName: v.optional(v.string()),
+    cookieMaxAge: v.optional(v.number()),
+    cookieDomain: v.optional(v.string()),
+    additionalFiles: v.optional(v.record(v.string(), v.string())),
+    emitPrettierIgnore: v.optional(v.boolean()),
+    emitReadme: v.optional(v.boolean()),
+    emitTsDeclarations: v.optional(v.boolean()),
+    urlPatterns: v.optional(v.array(v.object({
+        pattern: v.string(),
+        localized: v.array(v.tuple([v.string(), v.string()])),
+    }))),
+    trailingSlash: v.optional(v.picklist(["always", "never"])),
+    includeEslintDisableComment: v.optional(v.boolean()),
+    disableAsyncLocalStorage: v.optional(v.boolean()),
+    emitGitIgnore: v.optional(v.boolean()),
+    outputStructure: v.optional(v.picklist(["message-modules", "locale-modules"])),
+    cleanOutdir: v.optional(v.boolean()),
+});
+export const schemaMatchesCompilerOptions = true;
+//# sourceMappingURL=config-schema.js.map

package/dist/services/config/config-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config-schema.js","sourceRoot":"","sources":["../../../src/services/config/config-schema.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAe7B;;;GAGG;AACH,MAAM,sBAAsB,GAAG;IAC9B,QAAQ;IACR,YAAY;IACZ,gBAAgB;IAChB,KAAK;IACL,mBAAmB;IACnB,cAAc;CAIZ,CAAC;AAYJ,mEAAmE;AACnE,yEAAyE;AACzE,MAAM,CAAC,MAAM,oBAAoB,GAAyB,IAAI,CAAC;AAE/D;;;;;;;;;GASG;AACH,MAAM,oBAAoB,GAAG,CAAC,CAAC,IAAI,CAClC,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,KAAK,CACN,yBAAyB,EACzB,sGAAsG,CACtG,CAKD,CAAC;AAEF,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC;IACzC,CAAC,CAAC,QAAQ,CAAC,sBAAsB,CAAC;IAClC,oBAAoB;CACpB,CAAC,CAAC;AAEH,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC;IACnC,CAAC,CAAC,MAAM,CAAC;QACR,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;QACjB,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC,kBAAkB,CAAC;QACrC,OAAO,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC;KAC9B,CAAC;IACF,CAAC,CAAC,MAAM,CAAC;QACR,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;QACjB,OAAO,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC;QACxB,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC;KAC/B,CAAC;CACF,CAAC,CAAC;AAEH;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC7C,MAAM,EAAE,CAAC,CAAC,QAAQ,CACjB,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,QAAQ,CAAC,4BAA4B,CAAC,CAAC,CAC5D;IACD,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC;IACjD,eAAe,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAC;IACzD,qCAAqC,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;IAC9D,eAAe,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IACvC,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAChC,wBAAwB,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAChD,UAAU,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAClC,YAAY,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IACpC,YAAY,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IACpC,eAAe,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;IAC7D,kBAAkB,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;IAC3C,UAAU,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;IACnC,kBAAkB,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;IAC3C,WAAW,EAAE,CAAC,CAAC,QAAQ,CACtB,CAAC,CAAC,KAAK,CACN,CAAC,CAAC,MAAM,CAAC;QACR,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;QACnB,SAAS,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;KACrD,CAAC,CACF,CACD;IACD,aAAa,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC;IAC1D,2BAA2B,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;IACpD,wBAAwB,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;IACjD,aAAa,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;IACtC,eAAe,EAAE,CAAC,CAAC,QAAQ,CAC1B,CAAC,CAAC,QAAQ,CAAC,CAAC,iBAAiB,EAAE,gBAAgB,CAAC,CAAC,CACjD;IACD,WAAW,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;CACpC,CAAC,CAAC;AAyBH,MAAM,CAAC,MAAM,4BAA4B,GAAiC,IAAI,CAAC","sourcesContent":["import * as v from \"valibot\";\nimport type { CompilerOptions } from \"../../compiler/compiler-options.js\";\nimport type { Runtime } from \"../../compiler/runtime/type.js\";\n\n/**\n * The schema of a `paraglide.config.js/ts` file inside the project\n * directory.\n *\n * The config cannot specify `project` — it lives inside the inlang project\n * directory and therefore cannot name it. Values that are not provided\n * fall back to the bundler plugin options / command line flags and\n * ultimately to the built-in defaults.\n */\nexport type ParaglideConfig = Partial<Omit<CompilerOptions, \"fs\" | \"project\">>;\n\n/**\n * Strategy names that are built into the runtime. Custom strategies are\n * prefixed with `custom-` and are matched separately.\n */\nconst BUILTIN_STRATEGY_NAMES = [\n\t\"cookie\",\n\t\"baseLocale\",\n\t\"globalVariable\",\n\t\"url\",\n\t\"preferredLanguage\",\n\t\"localStorage\",\n] as const satisfies readonly Exclude<\n\tRuntime[\"strategy\"][number],\n\t`custom-${string}`\n>[];\n\n// Fails to compile when the runtime gains a strategy name that is neither\n// built-in above nor a `custom-` prefixed name.\ntype UncoveredStrategies = Exclude<\n\tRuntime[\"strategy\"][number],\n\t(typeof BUILTIN_STRATEGY_NAMES)[number] | `custom-${string}`\n>;\nexport type AllStrategiesCovered = [UncoveredStrategies] extends [never]\n\t? true\n\t: never;\n\n// Value-position pins so the type-level asserts below are actually\n// evaluated by tsc — an unused alias resolving to `never` would compile.\nexport const allStrategiesCovered: AllStrategiesCovered = true;\n\n/**\n * Matches strategy names like `custom-myStrategy`.\n *\n * The pattern mirrors the runtime's `isCustomStrategy` check\n * (`custom-[A-Za-z0-9_-]+`) so the config file rejects names the runtime\n * would refuse.\n *\n * Valibot has no template-literal schema, so the regex-checked string\n * schema is narrowed to the compiler's type here.\n */\nconst customStrategySchema = v.pipe(\n\tv.string(),\n\tv.regex(\n\t\t/^custom-[A-Za-z0-9_-]+$/,\n\t\t'Custom strategies must match \"custom-\" followed by alphanumeric characters, hyphens, or underscores.'\n\t)\n) as v.BaseSchema<\n\tstring,\n\t`custom-${string}`,\n\tv.StringIssue | v.RegexIssue<string>\n>;\n\nexport const strategyNameSchema = v.union([\n\tv.picklist(BUILTIN_STRATEGY_NAMES),\n\tcustomStrategySchema,\n]);\n\nconst routeStrategySchema = v.union([\n\tv.object({\n\t\tmatch: v.string(),\n\t\tstrategy: v.array(strategyNameSchema),\n\t\texclude: v.optional(v.never()),\n\t}),\n\tv.object({\n\t\tmatch: v.string(),\n\t\texclude: v.literal(true),\n\t\tstrategy: v.optional(v.never()),\n\t}),\n]);\n\n/**\n * The valibot schema behind {@link ParaglideConfig}.\n *\n * Every option is optional — values that are not provided fall back to\n * the bundler plugin options / command line flags and ultimately to\n * `defaultCompilerOptions`.\n */\nexport const paraglideConfigSchema = v.object({\n\toutdir: v.optional(\n\t\tv.pipe(v.string(), v.nonEmpty('\"outdir\" must not be empty'))\n\t),\n\tstrategy: v.optional(v.array(strategyNameSchema)),\n\trouteStrategies: v.optional(v.array(routeStrategySchema)),\n\texperimentalMiddlewareLocaleSplitting: v.optional(v.boolean()),\n\tlocalStorageKey: v.optional(v.string()),\n\tisServer: v.optional(v.string()),\n\texperimentalStaticLocale: v.optional(v.string()),\n\tcookieName: v.optional(v.string()),\n\tcookieMaxAge: v.optional(v.number()),\n\tcookieDomain: v.optional(v.string()),\n\tadditionalFiles: v.optional(v.record(v.string(), v.string())),\n\temitPrettierIgnore: v.optional(v.boolean()),\n\temitReadme: v.optional(v.boolean()),\n\temitTsDeclarations: v.optional(v.boolean()),\n\turlPatterns: v.optional(\n\t\tv.array(\n\t\t\tv.object({\n\t\t\t\tpattern: v.string(),\n\t\t\t\tlocalized: v.array(v.tuple([v.string(), v.string()])),\n\t\t\t})\n\t\t)\n\t),\n\ttrailingSlash: v.optional(v.picklist([\"always\", \"never\"])),\n\tincludeEslintDisableComment: v.optional(v.boolean()),\n\tdisableAsyncLocalStorage: v.optional(v.boolean()),\n\temitGitIgnore: v.optional(v.boolean()),\n\toutputStructure: v.optional(\n\t\tv.picklist([\"message-modules\", \"locale-modules\"])\n\t),\n\tcleanOutdir: v.optional(v.boolean()),\n});\n\n// Fails to compile when the schema and the compiler options drift apart:\n// every compiler option (except the internal `fs` and the `project` path,\n// which the config cannot specify about itself) must be represented in the\n// schema, the schema must not contain extra options, and the parsed\n// values must match the compiler option types in both directions — a\n// schema narrower than a widened compiler option would wrongly reject\n// valid values.\ntype SchemaOutput = v.InferOutput<typeof paraglideConfigSchema>;\n// `keyof ParaglideConfig` already excludes `fs` and `project` (see its\n// definition) — this assertion is the only place that needs the\n// configurable-keys view.\nexport type SchemaMatchesCompilerOptions = [keyof ParaglideConfig] extends [\n\tkeyof SchemaOutput,\n]\n\t? [keyof SchemaOutput] extends [keyof ParaglideConfig]\n\t\t? SchemaOutput extends ParaglideConfig\n\t\t\t? ParaglideConfig extends SchemaOutput\n\t\t\t\t? true\n\t\t\t\t: never\n\t\t\t: never\n\t\t: never\n\t: never;\n\nexport const schemaMatchesCompilerOptions: SchemaMatchesCompilerOptions = true;\n"]}

package/dist/services/config/defaults.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Default path to the inlang project directory, relative to the working
+ * directory of the integration (CLI: process cwd; bundler plugins: the
+ * tool's project root).
+ */
+export declare const DEFAULT_PROJECT_PATH = "./project.inlang";
+/**
+ * Default output directory for compiled messages, relative to the working
+ * directory of the integration.
+ */
+export declare const DEFAULT_OUTDIR = "./src/paraglide";

package/dist/services/config/defaults.js

@@ -0,0 +1,12 @@
+/**
+ * Default path to the inlang project directory, relative to the working
+ * directory of the integration (CLI: process cwd; bundler plugins: the
+ * tool's project root).
+ */
+export const DEFAULT_PROJECT_PATH = "./project.inlang";
+/**
+ * Default output directory for compiled messages, relative to the working
+ * directory of the integration.
+ */
+export const DEFAULT_OUTDIR = "./src/paraglide";
+//# sourceMappingURL=defaults.js.map

package/dist/services/config/defaults.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"defaults.js","sourceRoot":"","sources":["../../../src/services/config/defaults.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,kBAAkB,CAAC;AAEvD;;;GAGG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,iBAAiB,CAAC","sourcesContent":["/**\n * Default path to the inlang project directory, relative to the working\n * directory of the integration (CLI: process cwd; bundler plugins: the\n * tool's project root).\n */\nexport const DEFAULT_PROJECT_PATH = \"./project.inlang\";\n\n/**\n * Default output directory for compiled messages, relative to the working\n * directory of the integration.\n */\nexport const DEFAULT_OUTDIR = \"./src/paraglide\";\n"]}

package/dist/services/config/discover-config-file.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Config file names that are resolved inside the project directory, in
+ * order of precedence. Do not reorder without updating the documentation.
+ */
+export declare const CONFIG_FILE_NAMES: readonly ["paraglide.config.js", "paraglide.config.mjs", "paraglide.config.ts", "paraglide.config.cjs"];
+/**
+ * Resolves the active paraglide config file inside a project directory.
+ *
+ * The config lives inside `<projectDir>` (the inlang project itself), so
+ * there is no searching and no ambiguity: candidates are checked in
+ * precedence order and the first existing file wins. Returns `undefined`
+ * when no config file exists.
+ */
+export declare function resolveConfigCandidate(projectDir: string): Promise<string | undefined>;
+/**
+ * Checks whether a changed path is one of the config file names. Used to
+ * filter filesystem watch events in the project directory.
+ */
+export declare function isConfigFileName(path: string): boolean;

package/dist/services/config/discover-config-file.js

@@ -0,0 +1,39 @@
+import { stat } from "node:fs/promises";
+import { basename, join } from "node:path";
+/**
+ * Config file names that are resolved inside the project directory, in
+ * order of precedence. Do not reorder without updating the documentation.
+ */
+export const CONFIG_FILE_NAMES = [
+    "paraglide.config.js",
+    "paraglide.config.mjs",
+    "paraglide.config.ts",
+    "paraglide.config.cjs",
+];
+/**
+ * Resolves the active paraglide config file inside a project directory.
+ *
+ * The config lives inside `<projectDir>` (the inlang project itself), so
+ * there is no searching and no ambiguity: candidates are checked in
+ * precedence order and the first existing file wins. Returns `undefined`
+ * when no config file exists.
+ */
+export async function resolveConfigCandidate(projectDir) {
+    for (const fileName of CONFIG_FILE_NAMES) {
+        const filePath = join(projectDir, fileName);
+        // stat follows symlinks; a symlinked config is followed once and
+        // validated to be a file.
+        const stats = await stat(filePath).catch(() => undefined);
+        if (stats?.isFile())
+            return filePath;
+    }
+    return undefined;
+}
+/**
+ * Checks whether a changed path is one of the config file names. Used to
+ * filter filesystem watch events in the project directory.
+ */
+export function isConfigFileName(path) {
+    return CONFIG_FILE_NAMES.includes(basename(path));
+}
+//# sourceMappingURL=discover-config-file.js.map

package/dist/services/config/discover-config-file.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"discover-config-file.js","sourceRoot":"","sources":["../../../src/services/config/discover-config-file.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AACxC,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAE3C;;;GAGG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG;IAChC,qBAAqB;IACrB,sBAAsB;IACtB,qBAAqB;IACrB,sBAAsB;CACb,CAAC;AAEX;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAC3C,UAAkB;IAElB,KAAK,MAAM,QAAQ,IAAI,iBAAiB,EAAE,CAAC;QAC1C,MAAM,QAAQ,GAAG,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;QAC5C,iEAAiE;QACjE,0BAA0B;QAC1B,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;QAC1D,IAAI,KAAK,EAAE,MAAM,EAAE;YAAE,OAAO,QAAQ,CAAC;IACtC,CAAC;IACD,OAAO,SAAS,CAAC;AAClB,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,gBAAgB,CAAC,IAAY;IAC5C,OAAQ,iBAAuC,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;AAC1E,CAAC","sourcesContent":["import { stat } from \"node:fs/promises\";\nimport { basename, join } from \"node:path\";\n\n/**\n * Config file names that are resolved inside the project directory, in\n * order of precedence. Do not reorder without updating the documentation.\n */\nexport const CONFIG_FILE_NAMES = [\n\t\"paraglide.config.js\",\n\t\"paraglide.config.mjs\",\n\t\"paraglide.config.ts\",\n\t\"paraglide.config.cjs\",\n] as const;\n\n/**\n * Resolves the active paraglide config file inside a project directory.\n *\n * The config lives inside `<projectDir>` (the inlang project itself), so\n * there is no searching and no ambiguity: candidates are checked in\n * precedence order and the first existing file wins. Returns `undefined`\n * when no config file exists.\n */\nexport async function resolveConfigCandidate(\n\tprojectDir: string\n): Promise<string | undefined> {\n\tfor (const fileName of CONFIG_FILE_NAMES) {\n\t\tconst filePath = join(projectDir, fileName);\n\t\t// stat follows symlinks; a symlinked config is followed once and\n\t\t// validated to be a file.\n\t\tconst stats = await stat(filePath).catch(() => undefined);\n\t\tif (stats?.isFile()) return filePath;\n\t}\n\treturn undefined;\n}\n\n/**\n * Checks whether a changed path is one of the config file names. Used to\n * filter filesystem watch events in the project directory.\n */\nexport function isConfigFileName(path: string): boolean {\n\treturn (CONFIG_FILE_NAMES as readonly string[]).includes(basename(path));\n}\n"]}

package/dist/services/config/index.d.ts

@@ -0,0 +1,24 @@
+import type { ParaglideConfig } from "./config-schema.js";
+export { CONFIG_FILE_NAMES, isConfigFileName, resolveConfigCandidate, } from "./discover-config-file.js";
+export { strategyNameSchema } from "./config-schema.js";
+export { loadParaglideConfig, clearParaglideConfigCache, type LoadedParaglideConfig, } from "./load-paraglide-config.js";
+export { resolveCompilerOptions } from "./resolve-compiler-options.js";
+export { DEFAULT_OUTDIR, DEFAULT_PROJECT_PATH } from "./defaults.js";
+export type { ParaglideConfig } from "./config-schema.js";
+/**
+ * Helper for defining a paraglide configuration in
+ * `<project>/paraglide.config.js` or `.ts` with type inference and
+ * validation.
+ *
+ * @example
+ * ```ts
+ * // project.inlang/paraglide.config.ts
+ * import { defineConfig } from "@inlang/paraglide-js";
+ *
+ * export default defineConfig({
+ *   outdir: "./src/paraglide",
+ *   strategy: ["cookie", "preferredLanguage", "baseLocale"],
+ * });
+ * ```
+ */
+export declare function defineConfig(config: ParaglideConfig): ParaglideConfig;

package/dist/services/config/index.js

@@ -0,0 +1,25 @@
+export { CONFIG_FILE_NAMES, isConfigFileName, resolveConfigCandidate, } from "./discover-config-file.js";
+export { strategyNameSchema } from "./config-schema.js";
+export { loadParaglideConfig, clearParaglideConfigCache, } from "./load-paraglide-config.js";
+export { resolveCompilerOptions } from "./resolve-compiler-options.js";
+export { DEFAULT_OUTDIR, DEFAULT_PROJECT_PATH } from "./defaults.js";
+/**
+ * Helper for defining a paraglide configuration in
+ * `<project>/paraglide.config.js` or `.ts` with type inference and
+ * validation.
+ *
+ * @example
+ * ```ts
+ * // project.inlang/paraglide.config.ts
+ * import { defineConfig } from "@inlang/paraglide-js";
+ *
+ * export default defineConfig({
+ *   outdir: "./src/paraglide",
+ *   strategy: ["cookie", "preferredLanguage", "baseLocale"],
+ * });
+ * ```
+ */
+export function defineConfig(config) {
+    return config;
+}
+//# sourceMappingURL=index.js.map

package/dist/services/config/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/services/config/index.ts"],"names":[],"mappings":"AAEA,OAAO,EACN,iBAAiB,EACjB,gBAAgB,EAChB,sBAAsB,GACtB,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AACxD,OAAO,EACN,mBAAmB,EACnB,yBAAyB,GAEzB,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAAE,sBAAsB,EAAE,MAAM,+BAA+B,CAAC;AACvE,OAAO,EAAE,cAAc,EAAE,oBAAoB,EAAE,MAAM,eAAe,CAAC;AAGrE;;;;;;;;;;;;;;;GAeG;AACH,MAAM,UAAU,YAAY,CAAC,MAAuB;IACnD,OAAO,MAAM,CAAC;AACf,CAAC","sourcesContent":["import type { ParaglideConfig } from \"./config-schema.js\";\n\nexport {\n\tCONFIG_FILE_NAMES,\n\tisConfigFileName,\n\tresolveConfigCandidate,\n} from \"./discover-config-file.js\";\nexport { strategyNameSchema } from \"./config-schema.js\";\nexport {\n\tloadParaglideConfig,\n\tclearParaglideConfigCache,\n\ttype LoadedParaglideConfig,\n} from \"./load-paraglide-config.js\";\nexport { resolveCompilerOptions } from \"./resolve-compiler-options.js\";\nexport { DEFAULT_OUTDIR, DEFAULT_PROJECT_PATH } from \"./defaults.js\";\nexport type { ParaglideConfig } from \"./config-schema.js\";\n\n/**\n * Helper for defining a paraglide configuration in\n * `<project>/paraglide.config.js` or `.ts` with type inference and\n * validation.\n *\n * @example\n * ```ts\n * // project.inlang/paraglide.config.ts\n * import { defineConfig } from \"@inlang/paraglide-js\";\n *\n * export default defineConfig({\n *   outdir: \"./src/paraglide\",\n *   strategy: [\"cookie\", \"preferredLanguage\", \"baseLocale\"],\n * });\n * ```\n */\nexport function defineConfig(config: ParaglideConfig): ParaglideConfig {\n\treturn config;\n}\n"]}

package/dist/services/config/load-paraglide-config.d.ts

@@ -0,0 +1,44 @@
+import { Logger } from "../logger/index.js";
+import { type ParaglideConfig } from "./config-schema.js";
+export type LoadedParaglideConfig = {
+    /**
+     * Absolute path of the loaded config file.
+     */
+    path: string;
+    /**
+     * The validated config. Paths stay as written — the integration
+     * resolves them against its working directory/root.
+     */
+    config: ParaglideConfig;
+};
+/**
+ * Loads the paraglide config file from a project directory.
+ *
+ * The config lives inside `<projectDir>` as one of `paraglide.config.js`,
+ * `paraglide.config.mjs`, `paraglide.config.ts`, or `paraglide.config.cjs`
+ * (checked in this order). Returns `undefined` when no config file exists.
+ *
+ * Results are cached per process. Watch-mode integrations clear the cache
+ * when the config changed on disk — see {@link clearParaglideConfigCache}.
+ */
+export declare function loadParaglideConfig(args: {
+    /**
+     * Absolute path of the inlang project directory that contains the
+     * config file.
+     */
+    projectDir: string;
+    /**
+     * Logger used for warnings (e.g. unknown options). Defaults to a
+     * module-scoped logger. Pass a silent logger to suppress warnings.
+     */
+    logger?: Logger | undefined;
+}): Promise<LoadedParaglideConfig | undefined>;
+/**
+ * Clears the paraglide config cache.
+ *
+ * When called without arguments the entire cache is cleared. When
+ * `projectDir` is provided only that entry is evicted.
+ */
+export declare function clearParaglideConfigCache(args?: {
+    projectDir?: string;
+}): void;

package/dist/services/config/load-paraglide-config.js

@@ -0,0 +1,109 @@
+import { createJiti } from "jiti";
+import * as v from "valibot";
+import { createRequire } from "node:module";
+import { resolve } from "node:path";
+import { nodeNormalizePath } from "../../utilities/node-normalize-path.js";
+import { Logger } from "../logger/index.js";
+import { resolveConfigCandidate } from "./discover-config-file.js";
+import { paraglideConfigSchema, } from "./config-schema.js";
+const defaultLogger = new Logger();
+const configCache = new Map();
+/**
+ * Loads the paraglide config file from a project directory.
+ *
+ * The config lives inside `<projectDir>` as one of `paraglide.config.js`,
+ * `paraglide.config.mjs`, `paraglide.config.ts`, or `paraglide.config.cjs`
+ * (checked in this order). Returns `undefined` when no config file exists.
+ *
+ * Results are cached per process. Watch-mode integrations clear the cache
+ * when the config changed on disk — see {@link clearParaglideConfigCache}.
+ */
+export async function loadParaglideConfig(args) {
+    // Normalized so callers handing over differently-separated paths
+    // (Windows) hit the same cache entry.
+    const cacheKey = nodeNormalizePath(resolve(args.projectDir));
+    let cached = configCache.get(cacheKey);
+    if (cached === undefined) {
+        cached = load(cacheKey, args.logger ?? defaultLogger).catch((error) => {
+            configCache.delete(cacheKey);
+            throw error;
+        });
+        configCache.set(cacheKey, cached);
+    }
+    return cached;
+}
+/**
+ * Clears the paraglide config cache.
+ *
+ * When called without arguments the entire cache is cleared. When
+ * `projectDir` is provided only that entry is evicted.
+ */
+export function clearParaglideConfigCache(args) {
+    if (args?.projectDir === undefined) {
+        configCache.clear();
+        return;
+    }
+    configCache.delete(nodeNormalizePath(resolve(args.projectDir)));
+}
+async function load(projectDir, logger) {
+    const configPath = await resolveConfigCandidate(projectDir);
+    if (configPath === undefined)
+        return undefined;
+    // A fresh jiti instance per load with a disabled module cache ensures
+    // that reloading a changed config file picks up the new content.
+    const jiti = createJiti(configPath, { moduleCache: false });
+    evictConfigModule(configPath);
+    let exported;
+    try {
+        // Loaded synchronously (instead of `jiti.import`): async imports are
+        // cached by Node's ESM module registry, which cannot be invalidated.
+        const mod = jiti(configPath);
+        exported = mod?.default ?? mod;
+    }
+    catch (error) {
+        throw new Error(`Failed to load paraglide config file "${configPath}": ${error?.message ?? String(error)}`, { cause: error });
+    }
+    return {
+        path: configPath,
+        config: validateConfig(exported, configPath, logger),
+    };
+}
+function validateConfig(exported, filePath, logger) {
+    if (typeof exported !== "object" ||
+        exported === null ||
+        Array.isArray(exported)) {
+        throw new Error(`Invalid paraglide config file "${filePath}": expected an object with options as the default export.`);
+    }
+    const result = v.safeParse(paraglideConfigSchema, exported);
+    if (!result.success) {
+        const details = result.issues
+            .map((issue) => `"${v.getDotPath(issue) ?? "(root)"}": ${issue.message}`)
+            .join(", ");
+        throw new Error(`Invalid paraglide config file "${filePath}": ${details}.`);
+    }
+    const knownKeys = new Set(Object.keys(paraglideConfigSchema.entries));
+    const unknownKeys = Object.keys(exported).filter((key) => !knownKeys.has(key) && Object.prototype.hasOwnProperty.call(exported, key));
+    if (unknownKeys.length > 0) {
+        logger.warn(`Unknown option${unknownKeys.length === 1 ? "" : "s"} ${unknownKeys.map((key) => `"${key}"`).join(", ")} in paraglide config file "${filePath}".`);
+    }
+    return result.output;
+}
+/**
+ * Clears only the config module itself, never unrelated project modules.
+ *
+ * Required despite `moduleCache: false`: jiti delegates plain-CJS files
+ * (.cjs) to Node's native `require`, whose module cache is unaffected by
+ * jiti's option. Without this eviction, reloading a changed `.cjs` config
+ * serves the stale first load forever.
+ */
+function evictConfigModule(configPath) {
+    const require = createRequire(configPath);
+    delete require.cache[configPath];
+    try {
+        delete require.cache[require.resolve(configPath)];
+    }
+    catch {
+        // The file was removed between discovery and loading.
+    }
+}
+//# sourceMappingURL=load-paraglide-config.js.map

package/dist/services/config/load-paraglide-config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"load-paraglide-config.js","sourceRoot":"","sources":["../../../src/services/config/load-paraglide-config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,MAAM,CAAC;AAClC,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAC7B,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,iBAAiB,EAAE,MAAM,wCAAwC,CAAC;AAC3E,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAC5C,OAAO,EAAE,sBAAsB,EAAE,MAAM,2BAA2B,CAAC;AACnE,OAAO,EACN,qBAAqB,GAErB,MAAM,oBAAoB,CAAC;AAE5B,MAAM,aAAa,GAAG,IAAI,MAAM,EAAE,CAAC;AAcnC,MAAM,WAAW,GAAG,IAAI,GAAG,EAGxB,CAAC;AAEJ;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,mBAAmB,CAAC,IAWzC;IACA,iEAAiE;IACjE,sCAAsC;IACtC,MAAM,QAAQ,GAAG,iBAAiB,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;IAE7D,IAAI,MAAM,GAAG,WAAW,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IACvC,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QAC1B,MAAM,GAAG,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,IAAI,aAAa,CAAC,CAAC,KAAK,CAC1D,CAAC,KAAc,EAAE,EAAE;YAClB,WAAW,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YAC7B,MAAM,KAAK,CAAC;QACb,CAAC,CACD,CAAC;QACF,WAAW,CAAC,GAAG,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IACnC,CAAC;IACD,OAAO,MAAM,CAAC;AACf,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,yBAAyB,CAAC,IAEzC;IACA,IAAI,IAAI,EAAE,UAAU,KAAK,SAAS,EAAE,CAAC;QACpC,WAAW,CAAC,KAAK,EAAE,CAAC;QACpB,OAAO;IACR,CAAC;IACD,WAAW,CAAC,MAAM,CAAC,iBAAiB,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;AACjE,CAAC;AAED,KAAK,UAAU,IAAI,CAClB,UAAkB,EAClB,MAAc;IAEd,MAAM,UAAU,GAAG,MAAM,sBAAsB,CAAC,UAAU,CAAC,CAAC;IAC5D,IAAI,UAAU,KAAK,SAAS;QAAE,OAAO,SAAS,CAAC;IAE/C,sEAAsE;IACtE,iEAAiE;IACjE,MAAM,IAAI,GAAG,UAAU,CAAC,UAAU,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE,CAAC,CAAC;IAC5D,iBAAiB,CAAC,UAAU,CAAC,CAAC;IAE9B,IAAI,QAAiB,CAAC;IACtB,IAAI,CAAC;QACJ,qEAAqE;QACrE,qEAAqE;QACrE,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,CAAsC,CAAC;QAClE,QAAQ,GAAG,GAAG,EAAE,OAAO,IAAI,GAAG,CAAC;IAChC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QAChB,MAAM,IAAI,KAAK,CACd,yCAAyC,UAAU,MACjD,KAAe,EAAE,OAAO,IAAI,MAAM,CAAC,KAAK,CAC1C,EAAE,EACF,EAAE,KAAK,EAAE,KAAK,EAAE,CAChB,CAAC;IACH,CAAC;IAED,OAAO;QACN,IAAI,EAAE,UAAU;QAChB,MAAM,EAAE,cAAc,CAAC,QAAQ,EAAE,UAAU,EAAE,MAAM,CAAC;KACpD,CAAC;AACH,CAAC;AAED,SAAS,cAAc,CACtB,QAAiB,EACjB,QAAgB,EAChB,MAAc;IAEd,IACC,OAAO,QAAQ,KAAK,QAAQ;QAC5B,QAAQ,KAAK,IAAI;QACjB,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,EACtB,CAAC;QACF,MAAM,IAAI,KAAK,CACd,kCAAkC,QAAQ,2DAA2D,CACrG,CAAC;IACH,CAAC;IAED,MAAM,MAAM,GAAG,CAAC,CAAC,SAAS,CAAC,qBAAqB,EAAE,QAAQ,CAAC,CAAC;IAC5D,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QACrB,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM;aAC3B,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,QAAQ,MAAM,KAAK,CAAC,OAAO,EAAE,CAAC;aACxE,IAAI,CAAC,IAAI,CAAC,CAAC;QACb,MAAM,IAAI,KAAK,CAAC,kCAAkC,QAAQ,MAAM,OAAO,GAAG,CAAC,CAAC;IAC7E,CAAC;IAED,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAC,CAAC;IACtE,MAAM,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,MAAM,CAC/C,CAAC,GAAG,EAAE,EAAE,CACP,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,QAAQ,EAAE,GAAG,CAAC,CAC3E,CAAC;IACF,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC5B,MAAM,CAAC,IAAI,CACV,iBACC,WAAW,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GACjC,IAAI,WAAW,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,GAAG,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,8BAA8B,QAAQ,IAAI,CAC7F,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAC,MAAM,CAAC;AACtB,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,iBAAiB,CAAC,UAAkB;IAC5C,MAAM,OAAO,GAAG,aAAa,CAAC,UAAU,CAAC,CAAC;IAC1C,OAAO,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IACjC,IAAI,CAAC;QACJ,OAAO,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC;IACnD,CAAC;IAAC,MAAM,CAAC;QACR,sDAAsD;IACvD,CAAC;AACF,CAAC","sourcesContent":["import { createJiti } from \"jiti\";\nimport * as v from \"valibot\";\nimport { createRequire } from \"node:module\";\nimport { resolve } from \"node:path\";\nimport { nodeNormalizePath } from \"../../utilities/node-normalize-path.js\";\nimport { Logger } from \"../logger/index.js\";\nimport { resolveConfigCandidate } from \"./discover-config-file.js\";\nimport {\n\tparaglideConfigSchema,\n\ttype ParaglideConfig,\n} from \"./config-schema.js\";\n\nconst defaultLogger = new Logger();\n\nexport type LoadedParaglideConfig = {\n\t/**\n\t * Absolute path of the loaded config file.\n\t */\n\tpath: string;\n\t/**\n\t * The validated config. Paths stay as written — the integration\n\t * resolves them against its working directory/root.\n\t */\n\tconfig: ParaglideConfig;\n};\n\nconst configCache = new Map<\n\tstring,\n\tPromise<LoadedParaglideConfig | undefined>\n>();\n\n/**\n * Loads the paraglide config file from a project directory.\n *\n * The config lives inside `<projectDir>` as one of `paraglide.config.js`,\n * `paraglide.config.mjs`, `paraglide.config.ts`, or `paraglide.config.cjs`\n * (checked in this order). Returns `undefined` when no config file exists.\n *\n * Results are cached per process. Watch-mode integrations clear the cache\n * when the config changed on disk — see {@link clearParaglideConfigCache}.\n */\nexport async function loadParaglideConfig(args: {\n\t/**\n\t * Absolute path of the inlang project directory that contains the\n\t * config file.\n\t */\n\tprojectDir: string;\n\t/**\n\t * Logger used for warnings (e.g. unknown options). Defaults to a\n\t * module-scoped logger. Pass a silent logger to suppress warnings.\n\t */\n\tlogger?: Logger | undefined;\n}): Promise<LoadedParaglideConfig | undefined> {\n\t// Normalized so callers handing over differently-separated paths\n\t// (Windows) hit the same cache entry.\n\tconst cacheKey = nodeNormalizePath(resolve(args.projectDir));\n\n\tlet cached = configCache.get(cacheKey);\n\tif (cached === undefined) {\n\t\tcached = load(cacheKey, args.logger ?? defaultLogger).catch(\n\t\t\t(error: unknown) => {\n\t\t\t\tconfigCache.delete(cacheKey);\n\t\t\t\tthrow error;\n\t\t\t}\n\t\t);\n\t\tconfigCache.set(cacheKey, cached);\n\t}\n\treturn cached;\n}\n\n/**\n * Clears the paraglide config cache.\n *\n * When called without arguments the entire cache is cleared. When\n * `projectDir` is provided only that entry is evicted.\n */\nexport function clearParaglideConfigCache(args?: {\n\tprojectDir?: string;\n}): void {\n\tif (args?.projectDir === undefined) {\n\t\tconfigCache.clear();\n\t\treturn;\n\t}\n\tconfigCache.delete(nodeNormalizePath(resolve(args.projectDir)));\n}\n\nasync function load(\n\tprojectDir: string,\n\tlogger: Logger\n): Promise<LoadedParaglideConfig | undefined> {\n\tconst configPath = await resolveConfigCandidate(projectDir);\n\tif (configPath === undefined) return undefined;\n\n\t// A fresh jiti instance per load with a disabled module cache ensures\n\t// that reloading a changed config file picks up the new content.\n\tconst jiti = createJiti(configPath, { moduleCache: false });\n\tevictConfigModule(configPath);\n\n\tlet exported: unknown;\n\ttry {\n\t\t// Loaded synchronously (instead of `jiti.import`): async imports are\n\t\t// cached by Node's ESM module registry, which cannot be invalidated.\n\t\tconst mod = jiti(configPath) as { default?: unknown } | undefined;\n\t\texported = mod?.default ?? mod;\n\t} catch (error) {\n\t\tthrow new Error(\n\t\t\t`Failed to load paraglide config file \"${configPath}\": ${\n\t\t\t\t(error as Error)?.message ?? String(error)\n\t\t\t}`,\n\t\t\t{ cause: error }\n\t\t);\n\t}\n\n\treturn {\n\t\tpath: configPath,\n\t\tconfig: validateConfig(exported, configPath, logger),\n\t};\n}\n\nfunction validateConfig(\n\texported: unknown,\n\tfilePath: string,\n\tlogger: Logger\n): ParaglideConfig {\n\tif (\n\t\ttypeof exported !== \"object\" ||\n\t\texported === null ||\n\t\tArray.isArray(exported)\n\t) {\n\t\tthrow new Error(\n\t\t\t`Invalid paraglide config file \"${filePath}\": expected an object with options as the default export.`\n\t\t);\n\t}\n\n\tconst result = v.safeParse(paraglideConfigSchema, exported);\n\tif (!result.success) {\n\t\tconst details = result.issues\n\t\t\t.map((issue) => `\"${v.getDotPath(issue) ?? \"(root)\"}\": ${issue.message}`)\n\t\t\t.join(\", \");\n\t\tthrow new Error(`Invalid paraglide config file \"${filePath}\": ${details}.`);\n\t}\n\n\tconst knownKeys = new Set(Object.keys(paraglideConfigSchema.entries));\n\tconst unknownKeys = Object.keys(exported).filter(\n\t\t(key) =>\n\t\t\t!knownKeys.has(key) && Object.prototype.hasOwnProperty.call(exported, key)\n\t);\n\tif (unknownKeys.length > 0) {\n\t\tlogger.warn(\n\t\t\t`Unknown option${\n\t\t\t\tunknownKeys.length === 1 ? \"\" : \"s\"\n\t\t\t} ${unknownKeys.map((key) => `\"${key}\"`).join(\", \")} in paraglide config file \"${filePath}\".`\n\t\t);\n\t}\n\n\treturn result.output;\n}\n\n/**\n * Clears only the config module itself, never unrelated project modules.\n *\n * Required despite `moduleCache: false`: jiti delegates plain-CJS files\n * (.cjs) to Node's native `require`, whose module cache is unaffected by\n * jiti's option. Without this eviction, reloading a changed `.cjs` config\n * serves the stale first load forever.\n */\nfunction evictConfigModule(configPath: string): void {\n\tconst require = createRequire(configPath);\n\tdelete require.cache[configPath];\n\ttry {\n\t\tdelete require.cache[require.resolve(configPath)];\n\t} catch {\n\t\t// The file was removed between discovery and loading.\n\t}\n}\n"]}

package/dist/services/config/load-paraglide-config.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/services/config/load-paraglide-config.test.js

@@ -0,0 +1,201 @@
+import { describe, expect, test, vi, beforeEach, afterEach } from "vitest";
+import { mkdtemp, rm, writeFile } from "node:fs/promises";
+import { tmpdir } from "node:os";
+import path from "node:path";
+import consola from "consola";
+import { clearParaglideConfigCache, loadParaglideConfig, CONFIG_FILE_NAMES, resolveConfigCandidate, isConfigFileName, } from "./index.js";
+import { Logger } from "../logger/index.js";
+let testDirectories = [];
+async function createProjectDirectory() {
+    const directory = await mkdtemp(path.join(tmpdir(), "paraglide-config-"));
+    testDirectories.push(directory);
+    return directory;
+}
+beforeEach(() => {
+    clearParaglideConfigCache();
+    vi.spyOn(consola, "warn").mockImplementation(() => { });
+});
+afterEach(async () => {
+    vi.restoreAllMocks();
+    for (const directory of testDirectories.splice(0)) {
+        await rm(directory, { recursive: true, force: true });
+    }
+});
+describe("resolveConfigCandidate", () => {
+    test("returns undefined when no config file exists", async () => {
+        const projectDir = await createProjectDirectory();
+        expect(await resolveConfigCandidate(projectDir)).toBeUndefined();
+    });
+    test("prefers .js over .mjs over .ts over .cjs", async () => {
+        const projectDir = await createProjectDirectory();
+        for (const fileName of CONFIG_FILE_NAMES) {
+            await writeFile(path.join(projectDir, fileName), "export default {}");
+        }
+        expect(await resolveConfigCandidate(projectDir)).toBe(path.join(projectDir, "paraglide.config.js"));
+        await rm(path.join(projectDir, "paraglide.config.js"));
+        expect(await resolveConfigCandidate(projectDir)).toBe(path.join(projectDir, "paraglide.config.mjs"));
+        await rm(path.join(projectDir, "paraglide.config.mjs"));
+        expect(await resolveConfigCandidate(projectDir)).toBe(path.join(projectDir, "paraglide.config.ts"));
+        await rm(path.join(projectDir, "paraglide.config.ts"));
+        expect(await resolveConfigCandidate(projectDir)).toBe(path.join(projectDir, "paraglide.config.cjs"));
+    });
+    test("isConfigFileName matches exactly the config names", () => {
+        expect(isConfigFileName("/x/paraglide.config.js")).toBe(true);
+        expect(isConfigFileName("/x/paraglide.config.cjs")).toBe(true);
+        expect(isConfigFileName("/x/README.md")).toBe(false);
+        expect(isConfigFileName("/x/other.config.js")).toBe(false);
+    });
+});
+describe("loadParaglideConfig", () => {
+    test("returns undefined when no config file exists", async () => {
+        const projectDir = await createProjectDirectory();
+        expect(await loadParaglideConfig({ projectDir })).toBeUndefined();
+    });
+    test("loads every supported file format with a default export", async () => {
+        const cases = [
+            ["paraglide.config.js", `export default { outdir: './out-js' }`],
+            ["paraglide.config.mjs", `export default { outdir: './out-mjs' }`],
+            ["paraglide.config.cjs", `module.exports = { outdir: './out-cjs' }`],
+            [
+                "paraglide.config.ts",
+                [
+                    "const config = {",
+                    '  outdir: "./out-ts",',
+                    '  strategy: ["cookie", "baseLocale"],',
+                    "}",
+                    "export default config",
+                ].join("\n"),
+            ],
+        ];
+        for (const [fileName, content] of cases) {
+            const projectDir = await createProjectDirectory();
+            await writeFile(path.join(projectDir, fileName), content);
+            const loaded = await loadParaglideConfig({ projectDir });
+            expect(loaded?.path).toBe(path.join(projectDir, fileName));
+        }
+    });
+    test("leaves outdir paths untouched — the integration resolves them", async () => {
+        const projectDir = await createProjectDirectory();
+        await writeFile(path.join(projectDir, "paraglide.config.ts"), "export default { outdir: '../out' }");
+        expect((await loadParaglideConfig({ projectDir }))?.config.outdir).toBe("../out");
+        clearParaglideConfigCache();
+        const absoluteOut = path.join(projectDir, "abs-out");
+        await writeFile(path.join(projectDir, "paraglide.config.ts"), `export default { outdir: ${JSON.stringify(absoluteOut)} }`);
+        expect((await loadParaglideConfig({ projectDir }))?.config.outdir).toBe(absoluteOut);
+    });
+    test("throws when the config file has no object export", async () => {
+        const projectDir = await createProjectDirectory();
+        await writeFile(path.join(projectDir, "paraglide.config.ts"), "export default 42");
+        await expect(loadParaglideConfig({ projectDir })).rejects.toThrow(/expected an object/);
+    });
+    test("throws when an option has an invalid value", async () => {
+        const projectDir = await createProjectDirectory();
+        await writeFile(path.join(projectDir, "paraglide.config.ts"), "export default { cookieMaxAge: 'forever' }");
+        await expect(loadParaglideConfig({ projectDir })).rejects.toThrow(/"cookieMaxAge"/);
+    });
+    test("throws when a strategy name is unknown", async () => {
+        const projectDir = await createProjectDirectory();
+        await writeFile(path.join(projectDir, "paraglide.config.ts"), "export default { strategy: ['cookie', 'cookies'] }");
+        await expect(loadParaglideConfig({ projectDir })).rejects.toThrow(/"strategy\.1"/);
+    });
+    test("accepts custom strategies matching the runtime pattern", async () => {
+        const projectDir = await createProjectDirectory();
+        await writeFile(path.join(projectDir, "paraglide.config.ts"), "export default { strategy: ['custom-server', 'custom-my_strategy-2', 'cookie'] }");
+        const loaded = await loadParaglideConfig({ projectDir });
+        expect(loaded?.config.strategy).toEqual([
+            "custom-server",
+            "custom-my_strategy-2",
+            "cookie",
+        ]);
+    });
+    test("rejects malformed custom strategy names", async () => {
+        const projectDir = await createProjectDirectory();
+        await writeFile(path.join(projectDir, "paraglide.config.ts"), "export default { strategy: ['custom-', 'custom-my strategy'] }");
+        await expect(loadParaglideConfig({ projectDir })).rejects.toThrow(/"strategy\.0"/);
+    });
+    test("throws when routeStrategies combine strategy and exclude", async () => {
+        const projectDir = await createProjectDirectory();
+        await writeFile(path.join(projectDir, "paraglide.config.ts"), [
+            "export default {",
+            "  routeStrategies: [{ match: '/admin', strategy: ['url'], exclude: true }],",
+            "}",
+        ].join("\n"));
+        await expect(loadParaglideConfig({ projectDir })).rejects.toThrow(/routeStrategies/);
+    });
+    test("throws when outputStructure is invalid", async () => {
+        const projectDir = await createProjectDirectory();
+        await writeFile(path.join(projectDir, "paraglide.config.ts"), "export default { outputStructure: 'modules' }");
+        await expect(loadParaglideConfig({ projectDir })).rejects.toThrow(/"outputStructure"/);
+    });
+    test("rejects an empty outdir", async () => {
+        const projectDir = await createProjectDirectory();
+        await writeFile(path.join(projectDir, "paraglide.config.ts"), "export default { outdir: '' }");
+        await expect(loadParaglideConfig({ projectDir })).rejects.toThrow(/"outdir"/);
+    });
+    test("warns about unknown options but loads the rest", async () => {
+        const projectDir = await createProjectDirectory();
+        await writeFile(path.join(projectDir, "paraglide.config.ts"), "export default { outdir: './out', outdirKye: './typo' }");
+        const loaded = await loadParaglideConfig({ projectDir });
+        expect(loaded?.config.outdir).toBe("./out");
+        expect(consola.warn).toHaveBeenCalledWith(expect.stringContaining('"outdirKye"'));
+    });
+    test("treats a legacy project key as an unknown option", async () => {
+        const projectDir = await createProjectDirectory();
+        await writeFile(path.join(projectDir, "paraglide.config.ts"), "export default { project: './elsewhere.inlang', outdir: './out' }");
+        const loaded = await loadParaglideConfig({ projectDir });
+        expect(loaded?.config.outdir).toBe("./out");
+        expect(consola.warn).toHaveBeenCalledWith(expect.stringContaining('"project"'));
+    });
+    test("accepts cleanOutdir silently (it is ignored)", async () => {
+        const projectDir = await createProjectDirectory();
+        await writeFile(path.join(projectDir, "paraglide.config.ts"), "export default { outdir: './out', cleanOutdir: true }");
+        const loaded = await loadParaglideConfig({ projectDir });
+        expect(loaded?.config.cleanOutdir).toBe(true);
+        for (const call of vi.mocked(consola.warn).mock.calls) {
+            expect(String(call[0])).not.toContain("cleanOutdir");
+        }
+    });
+    test("respects a silent logger for warnings", async () => {
+        const projectDir = await createProjectDirectory();
+        await writeFile(path.join(projectDir, "paraglide.config.ts"), "export default { outdir: './out', cleanOutdir: true, typoKey: 1 }");
+        const loaded = await loadParaglideConfig({
+            projectDir,
+            logger: new Logger({ silent: true, prefix: true }),
+        });
+        expect(loaded?.config.outdir).toBe("./out");
+        expect(consola.warn).not.toHaveBeenCalled();
+    });
+    test("caches results until the cache is cleared", async () => {
+        const projectDir = await createProjectDirectory();
+        const configPath = path.join(projectDir, "paraglide.config.ts");
+        await writeFile(configPath, "export default { outdir: './first' }");
+        const first = await loadParaglideConfig({ projectDir });
+        const second = await loadParaglideConfig({ projectDir });
+        expect(second).toBe(first);
+        await writeFile(configPath, "export default { outdir: './second' }");
+        const stale = await loadParaglideConfig({ projectDir });
+        expect(stale?.config.outdir).toBe("./first");
+        clearParaglideConfigCache();
+        const fresh = await loadParaglideConfig({ projectDir });
+        expect(fresh?.config.outdir).toBe("./second");
+    });
+    // Reloading must pick up new content for every config file format —
+    // async module imports would keep serving stale content for .mjs/.cjs.
+    test("reloading picks up changed content for every file format", async () => {
+        for (const fileName of CONFIG_FILE_NAMES) {
+            const projectDir = await createProjectDirectory();
+            const configPath = path.join(projectDir, fileName);
+            const write = (outdir) => writeFile(configPath, fileName.endsWith(".cjs")
+                ? `module.exports = { outdir: './${outdir}' }`
+                : `export default { outdir: './${outdir}' }`);
+            await write("first");
+            const first = await loadParaglideConfig({ projectDir });
+            expect(first?.config.outdir).toBe("./first");
+            clearParaglideConfigCache();
+            await write("second");
+            const second = await loadParaglideConfig({ projectDir });
+            expect(second?.config.outdir).toBe("./second");
+        }
+    });
+});
+//# sourceMappingURL=load-paraglide-config.test.js.map