@sebbro/paraglide-lite 0.1.0

package/dist/compiler/compile.test.js

@@ -0,0 +1,66 @@
+import { memfs } from "memfs";
+import { test, expect, vi } from "vitest";
+import { compile } from "./compile.js";
+import { createTestFsWithMessages, defaultCompileOptions } from "./test-helpers.js";
+import consola from "consola";
+test("loads message files and compiles them", async () => {
+    const fs = createTestFsWithMessages({
+        messages: {
+            en: { hello: "Hello" },
+            de: { hello: "Hallo" },
+            fr: { hello: "Bonjour" },
+        },
+    });
+    await compile({
+        messages: defaultCompileOptions.messages,
+        locales: ["en", "de", "fr"],
+        baseLocale: "en",
+        outdir: "/output",
+        fs,
+    });
+    const files = await fs.promises.readdir("/output");
+    expect(files).toEqual(expect.arrayContaining(["runtime.js", "server.js", "messages.js"]));
+});
+test("cleans the output directory", async () => {
+    const fs = memfs({
+        "/output/old-file.js": "old",
+        "/messages/en.json": JSON.stringify({ hello: "Hello" }),
+        "/messages/de.json": JSON.stringify({ hello: "Hallo" }),
+    }).fs;
+    await compile({
+        messages: "/messages/{locale}.json",
+        locales: ["en", "de"],
+        baseLocale: "en",
+        outdir: "/output",
+        fs,
+        cleanOutdir: true,
+    });
+    await expect(fs.promises.readFile("/output/old-file.js", "utf8")).rejects.toThrow();
+});
+test("deduplicates concurrent compilations", async () => {
+    const fs = createTestFsWithMessages({
+        messages: { en: { hello: "Hello" }, de: { hello: "Hallo" } },
+    });
+    const compileSpy = vi.fn(compile);
+    consola.mockTypes(() => vi.fn());
+    await Promise.all([
+        compile({ ...defaultCompileOptions, outdir: "/output", fs }),
+        compile({ ...defaultCompileOptions, outdir: "/output", fs }),
+    ]);
+    void compileSpy;
+});
+test("applies strategy from compiler options to runtime output", async () => {
+    const fs = createTestFsWithMessages({
+        messages: { en: { hello: "Hello" }, de: { hello: "Hallo" } },
+    });
+    await compile({
+        ...defaultCompileOptions,
+        outdir: "/output",
+        fs,
+        strategy: ["url", "cookie", "baseLocale"],
+    });
+    const runtime = await fs.promises.readFile("/output/runtime.js", "utf8");
+    expect(runtime).toContain('"url"');
+    expect(runtime).toContain('"cookie"');
+});
+//# sourceMappingURL=compile.test.js.map

package/dist/compiler/compile.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"compile.test.js","sourceRoot":"","sources":["../../src/compiler/compile.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,OAAO,CAAC;AAC9B,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAC1C,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAEvC,OAAO,EAAE,wBAAwB,EAAE,qBAAqB,EAAE,MAAM,mBAAmB,CAAC;AACpF,OAAO,OAAO,MAAM,SAAS,CAAC;AAE9B,IAAI,CAAC,uCAAuC,EAAE,KAAK,IAAI,EAAE;IACxD,MAAM,EAAE,GAAG,wBAAwB,CAAC;QACnC,QAAQ,EAAE;YACT,EAAE,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE;YACtB,EAAE,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE;YACtB,EAAE,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE;SACxB;KACD,CAAC,CAAC;IAEH,MAAM,OAAO,CAAC;QACb,QAAQ,EAAE,qBAAqB,CAAC,QAAQ;QACxC,OAAO,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC;QAC3B,UAAU,EAAE,IAAI;QAChB,MAAM,EAAE,SAAS;QACjB,EAAE;KACF,CAAC,CAAC;IAEH,MAAM,KAAK,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACnD,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CACpB,MAAM,CAAC,eAAe,CAAC,CAAC,YAAY,EAAE,WAAW,EAAE,aAAa,CAAC,CAAC,CAClE,CAAC;AACH,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,6BAA6B,EAAE,KAAK,IAAI,EAAE;IAC9C,MAAM,EAAE,GAAG,KAAK,CAAC;QAChB,qBAAqB,EAAE,KAAK;QAC5B,mBAAmB,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC;QACvD,mBAAmB,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC;KACvD,CAAC,CAAC,EAAyC,CAAC;IAE7C,MAAM,OAAO,CAAC;QACb,QAAQ,EAAE,yBAAyB;QACnC,OAAO,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC;QACrB,UAAU,EAAE,IAAI;QAChB,MAAM,EAAE,SAAS;QACjB,EAAE;QACF,WAAW,EAAE,IAAI;KACjB,CAAC,CAAC;IAEH,MAAM,MAAM,CAAC,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,qBAAqB,EAAE,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;AACrF,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,sCAAsC,EAAE,KAAK,IAAI,EAAE;IACvD,MAAM,EAAE,GAAG,wBAAwB,CAAC;QACnC,QAAQ,EAAE,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE;KAC5D,CAAC,CAAC;IAEH,MAAM,UAAU,GAAG,EAAE,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC;IAClC,OAAO,CAAC,SAAS,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;IAEjC,MAAM,OAAO,CAAC,GAAG,CAAC;QACjB,OAAO,CAAC,EAAE,GAAG,qBAAqB,EAAE,MAAM,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC;QAC5D,OAAO,CAAC,EAAE,GAAG,qBAAqB,EAAE,MAAM,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC;KAC5D,CAAC,CAAC;IAEH,KAAK,UAAU,CAAC;AACjB,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,0DAA0D,EAAE,KAAK,IAAI,EAAE;IAC3E,MAAM,EAAE,GAAG,wBAAwB,CAAC;QACnC,QAAQ,EAAE,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE;KAC5D,CAAC,CAAC;IAEH,MAAM,OAAO,CAAC;QACb,GAAG,qBAAqB;QACxB,MAAM,EAAE,SAAS;QACjB,EAAE;QACF,QAAQ,EAAE,CAAC,KAAK,EAAE,QAAQ,EAAE,YAAY,CAAwB;KAChE,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,oBAAoB,EAAE,MAAM,CAAC,CAAC;IACzE,MAAM,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IACnC,MAAM,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;AACvC,CAAC,CAAC,CAAC","sourcesContent":["import { memfs } from \"memfs\";\nimport { test, expect, vi } from \"vitest\";\nimport { compile } from \"./compile.js\";\nimport type { Runtime } from \"./runtime/type.js\";\nimport { createTestFsWithMessages, defaultCompileOptions } from \"./test-helpers.js\";\nimport consola from \"consola\";\n\ntest(\"loads message files and compiles them\", async () => {\n\tconst fs = createTestFsWithMessages({\n\t\tmessages: {\n\t\t\ten: { hello: \"Hello\" },\n\t\t\tde: { hello: \"Hallo\" },\n\t\t\tfr: { hello: \"Bonjour\" },\n\t\t},\n\t});\n\n\tawait compile({\n\t\tmessages: defaultCompileOptions.messages,\n\t\tlocales: [\"en\", \"de\", \"fr\"],\n\t\tbaseLocale: \"en\",\n\t\toutdir: \"/output\",\n\t\tfs,\n\t});\n\n\tconst files = await fs.promises.readdir(\"/output\");\n\texpect(files).toEqual(\n\t\texpect.arrayContaining([\"runtime.js\", \"server.js\", \"messages.js\"])\n\t);\n});\n\ntest(\"cleans the output directory\", async () => {\n\tconst fs = memfs({\n\t\t\"/output/old-file.js\": \"old\",\n\t\t\"/messages/en.json\": JSON.stringify({ hello: \"Hello\" }),\n\t\t\"/messages/de.json\": JSON.stringify({ hello: \"Hallo\" }),\n\t}).fs as unknown as typeof import(\"node:fs\");\n\n\tawait compile({\n\t\tmessages: \"/messages/{locale}.json\",\n\t\tlocales: [\"en\", \"de\"],\n\t\tbaseLocale: \"en\",\n\t\toutdir: \"/output\",\n\t\tfs,\n\t\tcleanOutdir: true,\n\t});\n\n\tawait expect(fs.promises.readFile(\"/output/old-file.js\", \"utf8\")).rejects.toThrow();\n});\n\ntest(\"deduplicates concurrent compilations\", async () => {\n\tconst fs = createTestFsWithMessages({\n\t\tmessages: { en: { hello: \"Hello\" }, de: { hello: \"Hallo\" } },\n\t});\n\n\tconst compileSpy = vi.fn(compile);\n\tconsola.mockTypes(() => vi.fn());\n\n\tawait Promise.all([\n\t\tcompile({ ...defaultCompileOptions, outdir: \"/output\", fs }),\n\t\tcompile({ ...defaultCompileOptions, outdir: \"/output\", fs }),\n\t]);\n\n\tvoid compileSpy;\n});\n\ntest(\"applies strategy from compiler options to runtime output\", async () => {\n\tconst fs = createTestFsWithMessages({\n\t\tmessages: { en: { hello: \"Hello\" }, de: { hello: \"Hallo\" } },\n\t});\n\n\tawait compile({\n\t\t...defaultCompileOptions,\n\t\toutdir: \"/output\",\n\t\tfs,\n\t\tstrategy: [\"url\", \"cookie\", \"baseLocale\"] as Runtime[\"strategy\"],\n\t});\n\n\tconst runtime = await fs.promises.readFile(\"/output/runtime.js\", \"utf8\");\n\texpect(runtime).toContain('\"url\"');\n\texpect(runtime).toContain('\"cookie\"');\n});\n"]}

package/dist/compiler/compiler-options.d.ts

@@ -0,0 +1,466 @@
+import type { Runtime } from "./runtime/type.js";
+export type RouteStrategy = {
+    /**
+     * URLPattern-compatible matcher.
+     */
+    match: string;
+    /**
+     * Strategy override for matching requests.
+     */
+    strategy: Runtime["strategy"];
+    /**
+     * Prevent mutually exclusive configuration (`exclude` + `strategy`).
+     */
+    exclude?: never;
+} | {
+    /**
+     * URLPattern-compatible matcher.
+     */
+    match: string;
+    /**
+     * Exclude matching requests from i18n middleware behavior.
+     */
+    exclude: true;
+    /**
+     * Prevent mutually exclusive configuration (`exclude` + `strategy`).
+     */
+    strategy?: never;
+};
+export declare const defaultCompilerOptions: {
+    readonly messages: "./messages/{locale}.json";
+    readonly locales: ["en"];
+    readonly baseLocale: "en";
+    readonly outputStructure: "message-modules";
+    readonly emitGitIgnore: true;
+    readonly includeEslintDisableComment: true;
+    readonly emitPrettierIgnore: true;
+    readonly emitReadme: true;
+    readonly emitTsDeclarations: false;
+    readonly emitFiles: true;
+    readonly cleanOutdir: true;
+    readonly disableAsyncLocalStorage: false;
+    readonly experimentalMiddlewareLocaleSplitting: false;
+    readonly localStorageKey: "PARAGLIDE_LOCALE";
+    readonly isServer: "typeof window === 'undefined'";
+    readonly strategy: ["cookie", "globalVariable", "baseLocale"];
+    readonly cookieName: "PARAGLIDE_LOCALE";
+    readonly cookieMaxAge: number;
+    readonly cookieDomain: "";
+};
+/**
+ * Per-host URL routing rule.
+ *
+ * Path shape is always `/{locale}/{path}`, except the host `baseLocale`
+ * which is bare (`/{path}`).
+ */
+export type HostRoutingRule = {
+    /**
+     * Locale served without a path prefix on this host.
+     *
+     * @example
+     *   // fin.example.com/ → fi, fin.example.com/en → en
+     *   baseLocale: "fi"
+     */
+    baseLocale?: string;
+    /**
+     * Locales allowed on this host. Defaults to all project locales.
+     */
+    locales?: string[];
+};
+/**
+ * Hostname → routing rule map.
+ *
+ * Use `"*"` as the fallback for hosts that are not listed.
+ *
+ * @example
+ * ```ts
+ * routing: {
+ *   "fin.example.com": { baseLocale: "fi" },
+ *   "app.example.com": { baseLocale: "sv", locales: ["sv", "en", "pt-PT"] },
+ *   "*": { baseLocale: "en" },
+ * }
+ * ```
+ */
+export type RoutingConfig = Record<string, HostRoutingRule>;
+export type CompilerOptions = {
+    /**
+     * Path pattern to locale message files. Must contain `{locale}`.
+     *
+     * @example "./messages/{locale}.json"
+     */
+    messages: string;
+    /**
+     * Locales to compile.
+     */
+    locales: string[];
+    /**
+     * Default locale used for fallbacks.
+     */
+    baseLocale: string;
+    /**
+     * The path to the output directory.
+     *
+     * @example
+     * ```diff
+     * await compile({
+     *   messages: "./messages/{locale}.json",
+     * + outdir: "./src/paraglide"
+     * })
+     * ```
+     */
+    outdir: string;
+    /**
+     * The strategy to use for getting the locale.
+     *
+     * The order of the strategy defines the precedence of matches.
+     *
+     * For example, in `['url', 'cookie', 'baseLocale']`, the locale will be
+     * first tried to be detected in the url, then in a cookie, and finally
+     * fallback to the base locale.
+     *
+     * The default ensures that the browser takes a cookie approach,
+     * server-side takes the globalVariable (because cookie is unavailable),
+     * whereas both fallback to the base locale if not available.
+     *
+     * Custom strategies with the pattern `custom-[A-Za-z0-9]+` are supported.
+     *
+     * @default ["cookie", "globalVariable", "baseLocale"]
+     */
+    strategy?: Runtime["strategy"];
+    /**
+     * Route-level strategy overrides.
+     *
+     * Routes are matched in declaration order. The first matching rule wins.
+     * `match` uses URLPattern syntax and therefore requires the global URLPattern API
+     * (polyfill older targets; see https://paraglidejs.com/i18n-routing#urlpattern-compatibility).
+     *
+     * - `strategy`: Override locale resolution for the matched route.
+     * - `exclude: true`: Skip i18n middleware behavior for the matched route.
+     *
+     * @example
+     * ```ts
+     * routeStrategies: [
+     *   { match: "/dashboard/:path(.*)?", strategy: ["cookie", "baseLocale"] },
+     *   { match: "/api/:path(.*)?", exclude: true }
+     * ]
+     * ```
+     */
+    routeStrategies?: RouteStrategy[];
+    /**
+     * Whether or not to use experimental middleware locale splitting.
+     *
+     * ⚠️ This feature is experimental and only works in SSR/SSG environment
+     *   without client-side routing. Do not rely on this feature for production.
+     *
+     * This feature is part of the exploration of per locale splitting. The
+     * issue is ongoing and can be followed here [#88](https://github.com/opral/inlang-paraglide-js/issues/88).
+     *
+     * - The client bundle will tree-shake all messages (have close to 0kb JS).
+     * - The server middleware will inject the used messages into the HTML.
+     * - The client will re-trieve the messages from the injected HTML.
+     *
+     * @default false
+     */
+    experimentalMiddlewareLocaleSplitting?: boolean;
+    /**
+     * The name of the localStorage key to use for the localStorage strategy.
+     *
+     * @default 'PARAGLIDE_LOCALE'
+     */
+    localStorageKey?: string;
+    /**
+     * Tree-shaking flag if the code is running on the server.
+     *
+     * Dependent on the bundler, this flag must be adapted to
+     * enable tree-shaking.
+     *
+     * @example
+     *   // vite
+     *   isServer: "import.meta.env.SSR"
+     *
+     * @default typeof window === "undefined"
+     */
+    isServer?: string;
+    /**
+     * Compile-time locale constant used for per-locale tree-shaking.
+     *
+     * This is experimental and opt-in. It should be a JavaScript expression
+     * (not a quoted literal) that resolves to a locale or `undefined` at build time.
+     * You can pass a string literal (e.g. `"de"`) for programmatic builds, or an
+     * injected env/define expression for bundler-driven builds.
+     *
+     * High-level flow for per-locale builds:
+     *
+     * client request (/)
+     *         |
+     *         v
+     *   +----------------------+
+     *   | detect locale        |
+     *   | (cookie/Accept-L)    |
+     *   | pick build prefix    |
+     *   +----------------------+
+     *         | if "de"
+     *         v
+     *    serve dist/de/...  <----> serve dist/en/...
+     *    (HTML + assets)          (HTML + assets)
+     *
+     * @see https://github.com/opral/paraglide-js/issues/88#issuecomment-3634754638
+     *
+     * @example
+     *   // Vite define
+     *   experimentalStaticLocale: "typeof __PARAGLIDE_STATIC_LOCALE__ === 'undefined' ? undefined : __PARAGLIDE_STATIC_LOCALE__"
+     *
+     * @example
+     *   // Programmatic compile (literal)
+     *   experimentalStaticLocale: '"de"'
+     */
+    experimentalStaticLocale?: string;
+    /**
+     * The name of the cookie to use for the cookie strategy.
+     *
+     * @default 'PARAGLIDE_LOCALE'
+     */
+    cookieName?: string;
+    /**
+     * The max-age in seconds of the cookie until it expires.
+     *
+     * @default 60 * 60 * 24 * 400
+     */
+    cookieMaxAge?: number;
+    /**
+     * The host to which the cookie will be sent.
+     * If undefined or empty, the domain attribute is omitted from the cookie, scoping it to the exact current domain only (no subdomains).
+     * If specified, the cookie will be available to the specified domain and all its subdomains.
+     *
+     * Use this when you need cookies to be shared across subdomains (e.g., between `app.example.com` and `api.example.com`).
+     * The default behavior (no domain) ensures better compatibility with server-side cookies that don't specify a domain attribute.
+     *
+     * @example
+     * ```ts
+     * // Default: exact domain only (compatible with server-side cookies)
+     * cookieDomain: undefined // Cookie: "PARAGLIDE_LOCALE=en; path=/; max-age=34560000"
+     *
+     * // Subdomain sharing: available across all subdomains
+     * cookieDomain: "example.com" // Cookie: "PARAGLIDE_LOCALE=en; path=/; max-age=34560000; domain=example.com"
+     * ```
+     *
+     * @default "" (no domain attribute, exact domain only)
+     */
+    cookieDomain?: string;
+    /**
+     * The `additionalFiles` option is an array of paths to additional files that should be copied to the output directory.
+     *
+     * @example
+     *
+     * ```diff
+     * await compile({
+     *   project: "./project.inlang",
+     *   outdir: "./src/paraglide",
+     *   additionalFiles: [
+     * +    "my-file.js": "console.log('hello')"
+     *   ]
+     * })
+     * ```
+     *
+     * The output will look like this:
+     *
+     * ```diff
+     *   - outdir/
+     *     - messages/
+     * +   - my-file.js
+     *     - messages.js
+     *     - runtime.js
+     * ```
+     */
+    additionalFiles?: Record<string, string>;
+    /**
+     * If `emitPrettierIgnore` is set to `true` a `.prettierignore` file will be emitted in the output directory. Defaults to `true`.
+     *
+     * ```diff
+     *   - outdir/
+     *     - messages/
+     * +   - .prettierignore
+     *     - messages.js
+     *     - runtime.js
+     * ```
+     *
+     * @default true
+     */
+    emitPrettierIgnore?: boolean;
+    /**
+     * If `emitReadme` is set to `true` a `README.md` file will be emitted in the output directory. Defaults to `true`.
+     *
+     * The README helps LLMs understand the compiled output.
+     * See https://llmstxt.org/ for format guidelines.
+     *
+     * ```diff
+     *   - outdir/
+     *     - messages/
+     * +   - README.md
+     *     - messages.js
+     *     - runtime.js
+     * ```
+     *
+     * @default true
+     */
+    emitReadme?: boolean;
+    /**
+     * Emit `.d.ts` files for the generated output using the TypeScript compiler.
+     *
+     * Useful when `allowJs: true` cannot be set in your `tsconfig.json`
+     * (e.g., due to project constraints or conflicting compiler options), or when
+     * an editor language server caches stale JSDoc types for generated messages.
+     *
+     * Requires `typescript` to be resolvable in your toolchain.
+     *
+     * **Note:** Enabling this option reduces compiler speed because TypeScript
+     * needs to generate declaration files for all output modules.
+     *
+     * **Note:** With TypeScript 5/6 the declarations are generated in-process.
+     * TypeScript 7+ no longer provides the compiler API, so its `tsc` CLI is
+     * invoked in a child process instead; the emitted declarations are
+     * semantically equivalent but differ cosmetically between the two.
+     *
+     * @example
+     * ```ts
+     * await compile({
+     *   project: "./project.inlang",
+     *   outdir: "./src/paraglide",
+     *   emitTsDeclarations: true,
+     * });
+     * ```
+     *
+     * @default false
+     */
+    emitTsDeclarations?: boolean;
+    /**
+     * Controls which compiled files are written to `outdir`.
+     *
+     * - `true` — write the full output tree (default). Required for the CLI
+     *   and for bundlers that cannot load virtual modules (webpack, etc.).
+     * - `"types"` — write `.d.ts` plus meta files (`.gitignore`,
+     *   `.prettierignore`, `README.md`, `messages/package.json`). Generated
+     *   `.js` is served from memory by the Vite/Rolldown plugins.
+     * - `false` — write nothing except `.d.ts` when `emitTsDeclarations` is
+     *   enabled. Generated `.js` is virtual only.
+     *
+     * @default true
+     */
+    emitFiles?: true | false | "types";
+    /**
+     * Custom URL patterns for advanced i18n routing (translated pathnames, domains, etc.).
+     *
+     * Uses the global [URLPattern](https://developer.mozilla.org/en-US/docs/Web/API/URL_Pattern_API) API.
+     * Default locale-prefix routing and {@link CompilerOptions.routing} do not need URLPattern.
+     * For older browsers/runtimes, load a polyfill (e.g. `import "urlpattern-polyfill"`) before the
+     * generated runtime. See https://paraglidejs.com/i18n-routing#urlpattern-compatibility
+     *
+     * https://paraglidejs.com/strategy#url
+     */
+    urlPatterns?: Runtime["urlPatterns"];
+    /**
+     * Fast per-host locale prefix routing (no URLPattern).
+     *
+     * When set, Paraglide uses string path ops instead of `urlPatterns`.
+     * Do not combine with `urlPatterns`.
+     *
+     * @see RoutingConfig
+     */
+    routing?: RoutingConfig;
+    /**
+     * Whether to include an eslint-disable comment at the top of each .js file.
+     *
+     * @default true
+     */
+    includeEslintDisableComment?: boolean;
+    /**
+     * Replaces AsyncLocalStorage with a synchronous implementation.
+     *
+     * Leave AsyncLocalStorage enabled by default. This option is a
+     * compatibility fallback for runtimes that do not provide
+     * AsyncLocalStorage or `node:async_hooks`.
+     *
+     * ⚠️ WARNING: Only use this option when your runtime also guarantees
+     * request isolation. Disabling AsyncLocalStorage in multi-request
+     * server environments risks cross-request pollution where state from
+     * one request could leak into another concurrent request.
+     */
+    disableAsyncLocalStorage?: boolean;
+    /**
+     * If `emitGitIgnore` is set to `true` a `.gitignore` file will be emitted in the output directory. Defaults to `true`.
+     *
+     * ```diff
+     *   - outdir/
+     *     - messages/
+     * +   - .gitignore
+     *     - messages.js
+     *     - runtime.js
+     * ```
+     *
+     * @default true
+     */
+    emitGitIgnore?: boolean;
+    /**
+     * The `outputStructure` defines how modules are structured in the output.
+     *
+     * - `message-modules` - Each module is a message. This is the default.
+     * - `locale-modules` - Each module is a locale.
+     *
+     * It is recommended to use `locale-modules` for development and `message-modules` for production.
+     * Bundlers speed up the dev mode by bypassing bundling which can lead to many http requests
+     * during the dev mode with `message-modules`. See https://github.com/opral/inlang-paraglide-js/issues/486.
+     *
+     * **`message-modules`**
+     *
+     * Messages have their own module which eases tree-shaking for bundlers.
+     *
+     * ```diff
+     *   - outdir/
+     *     - messages/
+     * +   - blue_elephant_tree/
+     * +     - index.js
+     * +     - en.js
+     * +     - fr.js
+     * +   - sky_phone_bottle/
+     * +     - index.js
+     * +     - en.js
+     * +     - fr.js
+     *     - ...
+     *   - messages.js
+     *   - runtime.js
+     * ```
+     *
+     * **`locale-modules`**
+     *
+     * Messages are bundled in a per locale module. Bundlers often struggle with tree-shaking this structure,
+     * which can lead to more inefficient tree-shaking and larger bundle sizes compared to `message-modules`.
+     *
+     * The benefit are substantially fewer files which is needed in large projects.
+     *
+     * ```diff
+     *   - outdir/
+     *     - messages/
+     * +     - de.js
+     * +     - en.js
+     * +     - fr.js
+     *       - ...
+     *   - messages.js
+     *   - runtime.js
+     * ```
+     *
+     * @default "message-modules"
+     */
+    outputStructure?: "locale-modules" | "message-modules";
+    /**
+     * Whether to clean the output directory before writing the new files.
+     *
+     * @default true
+     */
+    cleanOutdir?: boolean;
+    /**
+     * The file system to use. Defaults to `await import('node:fs')`.
+     *
+     * Useful for testing the paraglide compiler by mocking the fs.
+     */
+    fs?: any;
+};

package/dist/compiler/compiler-options.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"compiler-options.d.ts","sourceRoot":"","sources":["../../src/compiler/compiler-options.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAEjD,MAAM,MAAM,aAAa,GACtB;IACA;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;IAC9B;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC;CACf,GACD;IACA;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,OAAO,EAAE,IAAI,CAAC;IACd;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC;CAChB,CAAC;AAEL,eAAO,MAAM,sBAAsB;uBACxB,0BAA0B;;yBAExB,IAAI;8BACC,iBAAiB;;;;;;;;;;8BAUjB,kBAAkB;uBACzB,+BAA+B;;yBAE7B,kBAAkB;;2BAEhB,EAAE;CAC4B,CAAC;AAE9C;;;;;GAKG;AACH,MAAM,MAAM,eAAe,GAAG;IAC7B;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;AAE5D,MAAM,MAAM,eAAe,GAAG;IAC7B;;;;OAIG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;;;;;;;;;OAUG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;;;;;;;;;;;;;;;OAgBG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;IAC/B;;;;;;;;;;;;;;;;;OAiBG;IACH,eAAe,CAAC,EAAE,aAAa,EAAE,CAAC;IAClC;;;;;;;;;;;;;;OAcG;IACH,qCAAqC,CAAC,EAAE,OAAO,CAAC;IAChD;;;;OAIG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAClC;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;;;;;;;;;;;;;;;;OAkBG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACzC;;;;;;;;;;;;OAYG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;;;;;;;;;;;;;;OAeG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;;;;;;;;;;;OAYG;IACH,SAAS,CAAC,EAAE,IAAI,GAAG,KAAK,GAAG,OAAO,CAAC;IACnC;;;;;;;;;OASG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC,aAAa,CAAC,CAAC;IACrC;;;;;;;OAOG;IACH,OAAO,CAAC,EAAE,aAAa,CAAC;IACxB;;;;OAIG;IACH,2BAA2B,CAAC,EAAE,OAAO,CAAC;IACtC;;;;;;;;;;;OAWG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC;;;;;;;;;;;;OAYG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiDG;IACH,eAAe,CAAC,EAAE,gBAAgB,GAAG,iBAAiB,CAAC;IACvD;;;;OAIG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;;;OAIG;IACH,EAAE,CAAC,EAAE,GAAG,CAAC;CACT,CAAC"}

package/dist/compiler/compiler-options.js

@@ -0,0 +1,22 @@
+export const defaultCompilerOptions = {
+    messages: "./messages/{locale}.json",
+    locales: ["en"],
+    baseLocale: "en",
+    outputStructure: "message-modules",
+    emitGitIgnore: true,
+    includeEslintDisableComment: true,
+    emitPrettierIgnore: true,
+    emitReadme: true,
+    emitTsDeclarations: false,
+    emitFiles: true,
+    cleanOutdir: true,
+    disableAsyncLocalStorage: false,
+    experimentalMiddlewareLocaleSplitting: false,
+    localStorageKey: "PARAGLIDE_LOCALE",
+    isServer: "typeof window === 'undefined'",
+    strategy: ["cookie", "globalVariable", "baseLocale"],
+    cookieName: "PARAGLIDE_LOCALE",
+    cookieMaxAge: 60 * 60 * 24 * 400,
+    cookieDomain: "",
+};
+//# sourceMappingURL=compiler-options.js.map

package/dist/compiler/compiler-options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"compiler-options.js","sourceRoot":"","sources":["../../src/compiler/compiler-options.ts"],"names":[],"mappings":"AAgCA,MAAM,CAAC,MAAM,sBAAsB,GAAG;IACrC,QAAQ,EAAE,0BAA0B;IACpC,OAAO,EAAE,CAAC,IAAI,CAAC;IACf,UAAU,EAAE,IAAI;IAChB,eAAe,EAAE,iBAAiB;IAClC,aAAa,EAAE,IAAI;IACnB,2BAA2B,EAAE,IAAI;IACjC,kBAAkB,EAAE,IAAI;IACxB,UAAU,EAAE,IAAI;IAChB,kBAAkB,EAAE,KAAK;IACzB,SAAS,EAAE,IAAI;IACf,WAAW,EAAE,IAAI;IACjB,wBAAwB,EAAE,KAAK;IAC/B,qCAAqC,EAAE,KAAK;IAC5C,eAAe,EAAE,kBAAkB;IACnC,QAAQ,EAAE,+BAA+B;IACzC,QAAQ,EAAE,CAAC,QAAQ,EAAE,gBAAgB,EAAE,YAAY,CAAC;IACpD,UAAU,EAAE,kBAAkB;IAC9B,YAAY,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,GAAG;IAChC,YAAY,EAAE,EAAE;CAC4B,CAAC","sourcesContent":["import type { Runtime } from \"./runtime/type.js\";\n\nexport type RouteStrategy =\n\t| {\n\t\t\t/**\n\t\t\t * URLPattern-compatible matcher.\n\t\t\t */\n\t\t\tmatch: string;\n\t\t\t/**\n\t\t\t * Strategy override for matching requests.\n\t\t\t */\n\t\t\tstrategy: Runtime[\"strategy\"];\n\t\t\t/**\n\t\t\t * Prevent mutually exclusive configuration (`exclude` + `strategy`).\n\t\t\t */\n\t\t\texclude?: never;\n\t  }\n\t| {\n\t\t\t/**\n\t\t\t * URLPattern-compatible matcher.\n\t\t\t */\n\t\t\tmatch: string;\n\t\t\t/**\n\t\t\t * Exclude matching requests from i18n middleware behavior.\n\t\t\t */\n\t\t\texclude: true;\n\t\t\t/**\n\t\t\t * Prevent mutually exclusive configuration (`exclude` + `strategy`).\n\t\t\t */\n\t\t\tstrategy?: never;\n\t  };\n\nexport const defaultCompilerOptions = {\n\tmessages: \"./messages/{locale}.json\",\n\tlocales: [\"en\"],\n\tbaseLocale: \"en\",\n\toutputStructure: \"message-modules\",\n\temitGitIgnore: true,\n\tincludeEslintDisableComment: true,\n\temitPrettierIgnore: true,\n\temitReadme: true,\n\temitTsDeclarations: false,\n\temitFiles: true,\n\tcleanOutdir: true,\n\tdisableAsyncLocalStorage: false,\n\texperimentalMiddlewareLocaleSplitting: false,\n\tlocalStorageKey: \"PARAGLIDE_LOCALE\",\n\tisServer: \"typeof window === 'undefined'\",\n\tstrategy: [\"cookie\", \"globalVariable\", \"baseLocale\"],\n\tcookieName: \"PARAGLIDE_LOCALE\",\n\tcookieMaxAge: 60 * 60 * 24 * 400,\n\tcookieDomain: \"\",\n} as const satisfies Partial<CompilerOptions>;\n\n/**\n * Per-host URL routing rule.\n *\n * Path shape is always `/{locale}/{path}`, except the host `baseLocale`\n * which is bare (`/{path}`).\n */\nexport type HostRoutingRule = {\n\t/**\n\t * Locale served without a path prefix on this host.\n\t *\n\t * @example\n\t *   // fin.example.com/ → fi, fin.example.com/en → en\n\t *   baseLocale: \"fi\"\n\t */\n\tbaseLocale?: string;\n\t/**\n\t * Locales allowed on this host. Defaults to all project locales.\n\t */\n\tlocales?: string[];\n};\n\n/**\n * Hostname → routing rule map.\n *\n * Use `\"*\"` as the fallback for hosts that are not listed.\n *\n * @example\n * ```ts\n * routing: {\n *   \"fin.example.com\": { baseLocale: \"fi\" },\n *   \"app.example.com\": { baseLocale: \"sv\", locales: [\"sv\", \"en\", \"pt-PT\"] },\n *   \"*\": { baseLocale: \"en\" },\n * }\n * ```\n */\nexport type RoutingConfig = Record<string, HostRoutingRule>;\n\nexport type CompilerOptions = {\n\t/**\n\t * Path pattern to locale message files. Must contain `{locale}`.\n\t *\n\t * @example \"./messages/{locale}.json\"\n\t */\n\tmessages: string;\n\t/**\n\t * Locales to compile.\n\t */\n\tlocales: string[];\n\t/**\n\t * Default locale used for fallbacks.\n\t */\n\tbaseLocale: string;\n\t/**\n\t * The path to the output directory.\n\t *\n\t * @example\n\t * ```diff\n\t * await compile({\n\t *   messages: \"./messages/{locale}.json\",\n\t * + outdir: \"./src/paraglide\"\n\t * })\n\t * ```\n\t */\n\toutdir: string;\n\t/**\n\t * The strategy to use for getting the locale.\n\t *\n\t * The order of the strategy defines the precedence of matches.\n\t *\n\t * For example, in `['url', 'cookie', 'baseLocale']`, the locale will be\n\t * first tried to be detected in the url, then in a cookie, and finally\n\t * fallback to the base locale.\n\t *\n\t * The default ensures that the browser takes a cookie approach,\n\t * server-side takes the globalVariable (because cookie is unavailable),\n\t * whereas both fallback to the base locale if not available.\n\t *\n\t * Custom strategies with the pattern `custom-[A-Za-z0-9]+` are supported.\n\t *\n\t * @default [\"cookie\", \"globalVariable\", \"baseLocale\"]\n\t */\n\tstrategy?: Runtime[\"strategy\"];\n\t/**\n\t * Route-level strategy overrides.\n\t *\n\t * Routes are matched in declaration order. The first matching rule wins.\n\t * `match` uses URLPattern syntax and therefore requires the global URLPattern API\n\t * (polyfill older targets; see https://paraglidejs.com/i18n-routing#urlpattern-compatibility).\n\t *\n\t * - `strategy`: Override locale resolution for the matched route.\n\t * - `exclude: true`: Skip i18n middleware behavior for the matched route.\n\t *\n\t * @example\n\t * ```ts\n\t * routeStrategies: [\n\t *   { match: \"/dashboard/:path(.*)?\", strategy: [\"cookie\", \"baseLocale\"] },\n\t *   { match: \"/api/:path(.*)?\", exclude: true }\n\t * ]\n\t * ```\n\t */\n\trouteStrategies?: RouteStrategy[];\n\t/**\n\t * Whether or not to use experimental middleware locale splitting.\n\t *\n\t * ⚠️ This feature is experimental and only works in SSR/SSG environment\n\t *   without client-side routing. Do not rely on this feature for production.\n\t *\n\t * This feature is part of the exploration of per locale splitting. The\n\t * issue is ongoing and can be followed here [#88](https://github.com/opral/inlang-paraglide-js/issues/88).\n\t *\n\t * - The client bundle will tree-shake all messages (have close to 0kb JS).\n\t * - The server middleware will inject the used messages into the HTML.\n\t * - The client will re-trieve the messages from the injected HTML.\n\t *\n\t * @default false\n\t */\n\texperimentalMiddlewareLocaleSplitting?: boolean;\n\t/**\n\t * The name of the localStorage key to use for the localStorage strategy.\n\t *\n\t * @default 'PARAGLIDE_LOCALE'\n\t */\n\tlocalStorageKey?: string;\n\t/**\n\t * Tree-shaking flag if the code is running on the server.\n\t *\n\t * Dependent on the bundler, this flag must be adapted to\n\t * enable tree-shaking.\n\t *\n\t * @example\n\t *   // vite\n\t *   isServer: \"import.meta.env.SSR\"\n\t *\n\t * @default typeof window === \"undefined\"\n\t */\n\tisServer?: string;\n\t/**\n\t * Compile-time locale constant used for per-locale tree-shaking.\n\t *\n\t * This is experimental and opt-in. It should be a JavaScript expression\n\t * (not a quoted literal) that resolves to a locale or `undefined` at build time.\n\t * You can pass a string literal (e.g. `\"de\"`) for programmatic builds, or an\n\t * injected env/define expression for bundler-driven builds.\n\t *\n\t * High-level flow for per-locale builds:\n\t *\n\t * client request (/)\n\t *         |\n\t *         v\n\t *   +----------------------+\n\t *   | detect locale        |\n\t *   | (cookie/Accept-L)    |\n\t *   | pick build prefix    |\n\t *   +----------------------+\n\t *         | if \"de\"\n\t *         v\n\t *    serve dist/de/...  <----> serve dist/en/...\n\t *    (HTML + assets)          (HTML + assets)\n\t *\n\t * @see https://github.com/opral/paraglide-js/issues/88#issuecomment-3634754638\n\t *\n\t * @example\n\t *   // Vite define\n\t *   experimentalStaticLocale: \"typeof __PARAGLIDE_STATIC_LOCALE__ === 'undefined' ? undefined : __PARAGLIDE_STATIC_LOCALE__\"\n\t *\n\t * @example\n\t *   // Programmatic compile (literal)\n\t *   experimentalStaticLocale: '\"de\"'\n\t */\n\texperimentalStaticLocale?: string;\n\t/**\n\t * The name of the cookie to use for the cookie strategy.\n\t *\n\t * @default 'PARAGLIDE_LOCALE'\n\t */\n\tcookieName?: string;\n\t/**\n\t * The max-age in seconds of the cookie until it expires.\n\t *\n\t * @default 60 * 60 * 24 * 400\n\t */\n\tcookieMaxAge?: number;\n\t/**\n\t * The host to which the cookie will be sent.\n\t * If undefined or empty, the domain attribute is omitted from the cookie, scoping it to the exact current domain only (no subdomains).\n\t * If specified, the cookie will be available to the specified domain and all its subdomains.\n\t *\n\t * Use this when you need cookies to be shared across subdomains (e.g., between `app.example.com` and `api.example.com`).\n\t * The default behavior (no domain) ensures better compatibility with server-side cookies that don't specify a domain attribute.\n\t *\n\t * @example\n\t * ```ts\n\t * // Default: exact domain only (compatible with server-side cookies)\n\t * cookieDomain: undefined // Cookie: \"PARAGLIDE_LOCALE=en; path=/; max-age=34560000\"\n\t *\n\t * // Subdomain sharing: available across all subdomains\n\t * cookieDomain: \"example.com\" // Cookie: \"PARAGLIDE_LOCALE=en; path=/; max-age=34560000; domain=example.com\"\n\t * ```\n\t *\n\t * @default \"\" (no domain attribute, exact domain only)\n\t */\n\tcookieDomain?: string;\n\t/**\n\t * The `additionalFiles` option is an array of paths to additional files that should be copied to the output directory.\n\t *\n\t * @example\n\t *\n\t * ```diff\n\t * await compile({\n\t *   project: \"./project.inlang\",\n\t *   outdir: \"./src/paraglide\",\n\t *   additionalFiles: [\n\t * +    \"my-file.js\": \"console.log('hello')\"\n\t *   ]\n\t * })\n\t * ```\n\t *\n\t * The output will look like this:\n\t *\n\t * ```diff\n\t *   - outdir/\n\t *     - messages/\n\t * +   - my-file.js\n\t *     - messages.js\n\t *     - runtime.js\n\t * ```\n\t */\n\tadditionalFiles?: Record<string, string>;\n\t/**\n\t * If `emitPrettierIgnore` is set to `true` a `.prettierignore` file will be emitted in the output directory. Defaults to `true`.\n\t *\n\t * ```diff\n\t *   - outdir/\n\t *     - messages/\n\t * +   - .prettierignore\n\t *     - messages.js\n\t *     - runtime.js\n\t * ```\n\t *\n\t * @default true\n\t */\n\temitPrettierIgnore?: boolean;\n\t/**\n\t * If `emitReadme` is set to `true` a `README.md` file will be emitted in the output directory. Defaults to `true`.\n\t *\n\t * The README helps LLMs understand the compiled output.\n\t * See https://llmstxt.org/ for format guidelines.\n\t *\n\t * ```diff\n\t *   - outdir/\n\t *     - messages/\n\t * +   - README.md\n\t *     - messages.js\n\t *     - runtime.js\n\t * ```\n\t *\n\t * @default true\n\t */\n\temitReadme?: boolean;\n\t/**\n\t * Emit `.d.ts` files for the generated output using the TypeScript compiler.\n\t *\n\t * Useful when `allowJs: true` cannot be set in your `tsconfig.json`\n\t * (e.g., due to project constraints or conflicting compiler options), or when\n\t * an editor language server caches stale JSDoc types for generated messages.\n\t *\n\t * Requires `typescript` to be resolvable in your toolchain.\n\t *\n\t * **Note:** Enabling this option reduces compiler speed because TypeScript\n\t * needs to generate declaration files for all output modules.\n\t *\n\t * **Note:** With TypeScript 5/6 the declarations are generated in-process.\n\t * TypeScript 7+ no longer provides the compiler API, so its `tsc` CLI is\n\t * invoked in a child process instead; the emitted declarations are\n\t * semantically equivalent but differ cosmetically between the two.\n\t *\n\t * @example\n\t * ```ts\n\t * await compile({\n\t *   project: \"./project.inlang\",\n\t *   outdir: \"./src/paraglide\",\n\t *   emitTsDeclarations: true,\n\t * });\n\t * ```\n\t *\n\t * @default false\n\t */\n\temitTsDeclarations?: boolean;\n\t/**\n\t * Controls which compiled files are written to `outdir`.\n\t *\n\t * - `true` — write the full output tree (default). Required for the CLI\n\t *   and for bundlers that cannot load virtual modules (webpack, etc.).\n\t * - `\"types\"` — write `.d.ts` plus meta files (`.gitignore`,\n\t *   `.prettierignore`, `README.md`, `messages/package.json`). Generated\n\t *   `.js` is served from memory by the Vite/Rolldown plugins.\n\t * - `false` — write nothing except `.d.ts` when `emitTsDeclarations` is\n\t *   enabled. Generated `.js` is virtual only.\n\t *\n\t * @default true\n\t */\n\temitFiles?: true | false | \"types\";\n\t/**\n\t * Custom URL patterns for advanced i18n routing (translated pathnames, domains, etc.).\n\t *\n\t * Uses the global [URLPattern](https://developer.mozilla.org/en-US/docs/Web/API/URL_Pattern_API) API.\n\t * Default locale-prefix routing and {@link CompilerOptions.routing} do not need URLPattern.\n\t * For older browsers/runtimes, load a polyfill (e.g. `import \"urlpattern-polyfill\"`) before the\n\t * generated runtime. See https://paraglidejs.com/i18n-routing#urlpattern-compatibility\n\t *\n\t * https://paraglidejs.com/strategy#url\n\t */\n\turlPatterns?: Runtime[\"urlPatterns\"];\n\t/**\n\t * Fast per-host locale prefix routing (no URLPattern).\n\t *\n\t * When set, Paraglide uses string path ops instead of `urlPatterns`.\n\t * Do not combine with `urlPatterns`.\n\t *\n\t * @see RoutingConfig\n\t */\n\trouting?: RoutingConfig;\n\t/**\n\t * Whether to include an eslint-disable comment at the top of each .js file.\n\t *\n\t * @default true\n\t */\n\tincludeEslintDisableComment?: boolean;\n\t/**\n\t * Replaces AsyncLocalStorage with a synchronous implementation.\n\t *\n\t * Leave AsyncLocalStorage enabled by default. This option is a\n\t * compatibility fallback for runtimes that do not provide\n\t * AsyncLocalStorage or `node:async_hooks`.\n\t *\n\t * ⚠️ WARNING: Only use this option when your runtime also guarantees\n\t * request isolation. Disabling AsyncLocalStorage in multi-request\n\t * server environments risks cross-request pollution where state from\n\t * one request could leak into another concurrent request.\n\t */\n\tdisableAsyncLocalStorage?: boolean;\n\t/**\n\t * If `emitGitIgnore` is set to `true` a `.gitignore` file will be emitted in the output directory. Defaults to `true`.\n\t *\n\t * ```diff\n\t *   - outdir/\n\t *     - messages/\n\t * +   - .gitignore\n\t *     - messages.js\n\t *     - runtime.js\n\t * ```\n\t *\n\t * @default true\n\t */\n\temitGitIgnore?: boolean;\n\t/**\n\t * The `outputStructure` defines how modules are structured in the output.\n\t *\n\t * - `message-modules` - Each module is a message. This is the default.\n\t * - `locale-modules` - Each module is a locale.\n\t *\n\t * It is recommended to use `locale-modules` for development and `message-modules` for production.\n\t * Bundlers speed up the dev mode by bypassing bundling which can lead to many http requests\n\t * during the dev mode with `message-modules`. See https://github.com/opral/inlang-paraglide-js/issues/486.\n\t *\n\t * **`message-modules`**\n\t *\n\t * Messages have their own module which eases tree-shaking for bundlers.\n\t *\n\t * ```diff\n\t *   - outdir/\n\t *     - messages/\n\t * +   - blue_elephant_tree/\n\t * +     - index.js\n\t * +     - en.js\n\t * +     - fr.js\n\t * +   - sky_phone_bottle/\n\t * +     - index.js\n\t * +     - en.js\n\t * +     - fr.js\n\t *     - ...\n\t *   - messages.js\n\t *   - runtime.js\n\t * ```\n\t *\n\t * **`locale-modules`**\n\t *\n\t * Messages are bundled in a per locale module. Bundlers often struggle with tree-shaking this structure,\n\t * which can lead to more inefficient tree-shaking and larger bundle sizes compared to `message-modules`.\n\t *\n\t * The benefit are substantially fewer files which is needed in large projects.\n\t *\n\t * ```diff\n\t *   - outdir/\n\t *     - messages/\n\t * +     - de.js\n\t * +     - en.js\n\t * +     - fr.js\n\t *       - ...\n\t *   - messages.js\n\t *   - runtime.js\n\t * ```\n\t *\n\t * @default \"message-modules\"\n\t */\n\toutputStructure?: \"locale-modules\" | \"message-modules\";\n\t/**\n\t * Whether to clean the output directory before writing the new files.\n\t *\n\t * @default true\n\t */\n\tcleanOutdir?: boolean;\n\n\t/**\n\t * The file system to use. Defaults to `await import('node:fs')`.\n\t *\n\t * Useful for testing the paraglide compiler by mocking the fs.\n\t */\n\tfs?: any;\n};\n"]}

package/dist/compiler/create-paraglide.d.ts

@@ -0,0 +1,21 @@
+import type { Runtime } from "./runtime/type.js";
+import type { ServerRuntime } from "./server/type.js";
+import { type CompilerOptions } from "./compiler-options.js";
+type CreateParaglideArgs = Pick<CompilerOptions, "baseLocale" | "locales"> & Omit<CompilerOptions, "outdir" | "messages" | "fs" | "baseLocale" | "locales">;
+/**
+ * Creates an in-memory Paraglide module for use in tests and non-bundled environments.
+ *
+ * @example
+ *   const paraglide = await createParaglide({
+ *     baseLocale: "en",
+ *     locales: ["en", "de"],
+ *     strategy: ["cookie", "baseLocale"],
+ *   })
+ *
+ *   paraglide.localizeUrl("https://example.com", { locale: "de" })
+ *   app.use(paraglide.paraglideMiddleware())
+ */
+export declare function createParaglide(args: CreateParaglideArgs): Promise<Runtime & ServerRuntime & {
+    m: Record<string, unknown>;
+}>;
+export {};

package/dist/compiler/create-paraglide.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-paraglide.d.ts","sourceRoot":"","sources":["../../src/compiler/create-paraglide.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACtD,OAAO,EAEN,KAAK,eAAe,EACpB,MAAM,uBAAuB,CAAC;AAK/B,KAAK,mBAAmB,GAAG,IAAI,CAAC,eAAe,EAAE,YAAY,GAAG,SAAS,CAAC,GACzE,IAAI,CACH,eAAe,EACf,QAAQ,GAAG,UAAU,GAAG,IAAI,GAAG,YAAY,GAAG,SAAS,CACvD,CAAC;AAEH;;;;;;;;;;;;GAYG;AACH,wBAAsB,eAAe,CACpC,IAAI,EAAE,mBAAmB,GACvB,OAAO,CAAC,OAAO,GAAG,aAAa,GAAG;IAAE,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAAE,CAAC,CA+DnE"}