@pracht/vite-plugin 0.8.0 → 0.10.0

package/README.md

@@ -56,12 +56,11 @@ pracht({
 Keep it opt-in for now: it is best suited to SSR-heavy pages with large static
 DOM subtrees and should be benchmarked against your app before enabling broadly.
 
-## TSRX (`.tsrx`) Support
+## Additional Route Extensions
 
-`.tsrx` modules — TSRX/Ripple-flavoured Preact components — are supported out
-of the box. Bring your own
-[`@tsrx/vite-plugin-preact`](https://github.com/Ripple-TS/ripple) and add it to
-your `plugins` array alongside `pracht()`:
+Use `additionalExtensions` when a Vite plugin compiles route or shell modules
+with another file extension. For example, TSRX can use the explicit generic
+configuration (while remaining implicitly supported for compatibility):
 
 ```ts
 // vite.config.ts
@@ -70,13 +69,28 @@ import { pracht } from "@pracht/vite-plugin";
 import { tsrxPreact } from "@tsrx/vite-plugin-preact";
 
 export default defineConfig({
-  plugins: [tsrxPreact(), pracht()],
+  plugins: [tsrxPreact(), pracht({ additionalExtensions: [".tsrx"] })],
 });
 ```
 
-The pracht plugin globs `.tsrx` files alongside `.tsx` for routes and shells
-(both manifest- and pages-router modes), and its server-only export stripping
-pass treats them the same way — no separate pracht option is required.
+Extensions must be dot-prefixed. Pracht discovers configured extensions in
+route and shell directories for both manifest and pages-router modes and strips
+server-only route exports from client bundles. Vite-scannable component formats
+join initial dependency scanning automatically; other format plugins must opt
+their extension into Vite's dependency optimizer. The companion plugin remains
+responsible for compiling the file format, and the app should provide any
+ambient TypeScript module declaration that format requires. Keep the array
+inline or in a directly referenced `const` for complete CLI verification;
+dynamic expressions still build but produce a verification warning.
+
+Configured formats are treated as potentially head-bearing even when their raw
+source has no JavaScript `head()` export. The companion transform may synthesize
+that export from frontmatter or other custom syntax, so loaderless client
+navigation conservatively keeps its route-state request.
+
+Existing `.tsrx` routes and shells remain discovered without
+`additionalExtensions`, and Pracht keeps its ambient `.tsrx` declaration so a
+compatible CLI patch cannot strand applications on the previous plugin minor.
 
 ## Peer Dependencies
 

package/dist/index.d.mts

@@ -91,6 +91,18 @@ interface PrachtAdapter {
    * into the server output.
    */
   edge?: boolean;
+  /**
+   * If true, the adapter produces a pure static export with no server at
+   * runtime (e.g. `@pracht/adapter-static`). Production builds then define
+   * `__PRACHT_STATIC_TARGET__` as `true`, which switches the client router's
+   * route-state fetching from the live `x-pracht-route-state-request`
+   * endpoint to the serialized `/_pracht/state/…` files that `pracht build`
+   * emits. Dev servers keep the live endpoint (the flag only applies to
+   * builds). Custom static targets must also expose the static artifact hooks
+   * generated by `@pracht/adapter-static`; the CLI fails when a configured
+   * not-found or fallback artifact cannot be rendered.
+   */
+  staticTarget?: boolean;
 }
 //#endregion
 //#region src/plugin-options.d.ts
@@ -124,13 +136,41 @@ interface PrachtLlmsTxtOptions {
    */
   exclude?: string[];
 }
+/**
+ * Optional client-router features, compiled out of the client bundle when
+ * disabled. Every one defaults to `true`. Turn a feature off only when the app
+ * really does not use it: the router silently stops honouring the
+ * corresponding route options and `<Link>` props.
+ */
+interface PrachtClientOptions {
+  /**
+   * JS prefetching of route-state JSON and route/shell chunks, driven by
+   * `route({ prefetch })` and `<Link prefetch>`. Off also drops the separate
+   * prefetch chunk the router loads on every page, and makes the imperative
+   * `prefetch()` export a no-op.
+   */
+  prefetch?: boolean;
+}
 interface PrachtPluginOptions {
+  /**
+   * Switch off client-router features the app does not use, so they are
+   * compiled out of the client bundle. See {@link PrachtClientOptions}.
+   */
+  client?: PrachtClientOptions;
   appFile?: string;
   routesDir?: string;
   shellsDir?: string;
   middlewareDir?: string;
   apiDir?: string;
   serverDir?: string;
+  /**
+   * Additional dot-prefixed route and shell module extensions to discover,
+   * such as `[".vue"]`. Register the Vite plugin that transforms the format
+   * separately; Pracht only discovers the modules and applies its route
+   * client/server handling. Defaults to no additional extensions. `.tsrx`
+   * remains discovered without configuration for backward compatibility.
+   */
+  additionalExtensions?: readonly string[];
   /**
    * Directory containing island components hydrated on
    * `hydration: "islands"` routes. Defaults to "/src/islands".
@@ -194,6 +234,8 @@ declare function createPrachtIslandsClientModuleSource(options?: PrachtPluginOpt
 declare function createPrachtServerModuleSource(options?: PrachtPluginOptions, buildOptions?: {
   root?: string;
   isBuild?: boolean;
+  base?: string;
+  configuredBase?: string;
 }): string;
 declare function createPrachtRegistryModuleSource(options?: PrachtPluginOptions): string;
 //#endregion
@@ -245,4 +287,4 @@ declare function createPrachtWebmcpModuleSource(options?: PrachtPluginOptions, b
 //#region src/index.d.ts
 declare function pracht(options?: PrachtPluginOptions): Plugin[];
 //#endregion
-export { type EnvLeakReference, type EnvSafetyOptions, type LlmsTxtSection, PRACHT_CAPABILITIES_MODULE_ID, PRACHT_CLIENT_MODULE_ID, PRACHT_ISLANDS_CLIENT_MODULE_ID, PRACHT_SERVER_MODULE_ID, PRACHT_WEBMCP_MODULE_ID, PUBLIC_ENV_PREFIX, type PrachtAdapter, type PrachtLlmsTxtOptions, type PrachtPluginOptions, type RenderMode, VITE_BUILTIN_ENV_VARS, createEnvSafetyPlugin, createPrachtCapabilitiesClientModuleSource, createPrachtClientModuleSource, createPrachtIslandsClientModuleSource, createPrachtRegistryModuleSource, createPrachtServerModuleSource, createPrachtWebmcpModuleSource, extractCapabilities, formatEnvLeakError, pracht, scanCodeForEnvLeaks };
+export { type EnvLeakReference, type EnvSafetyOptions, type LlmsTxtSection, PRACHT_CAPABILITIES_MODULE_ID, PRACHT_CLIENT_MODULE_ID, PRACHT_ISLANDS_CLIENT_MODULE_ID, PRACHT_SERVER_MODULE_ID, PRACHT_WEBMCP_MODULE_ID, PUBLIC_ENV_PREFIX, type PrachtAdapter, type PrachtClientOptions, type PrachtLlmsTxtOptions, type PrachtPluginOptions, type RenderMode, VITE_BUILTIN_ENV_VARS, createEnvSafetyPlugin, createPrachtCapabilitiesClientModuleSource, createPrachtClientModuleSource, createPrachtIslandsClientModuleSource, createPrachtRegistryModuleSource, createPrachtServerModuleSource, createPrachtWebmcpModuleSource, extractCapabilities, formatEnvLeakError, pracht, scanCodeForEnvLeaks };