ferrovue 0.1.0 → 0.2.0

package/dist/compiler.d.ts

@@ -1,56 +1,19 @@
-/** A type a helper takes or returns, as the configuration spells it. */
-export type TypeName = "string" | "string?" | "int" | "int?" | "bool";
-/** A function a template may call, and the Rust function that is its twin. */
-export interface HelperSpec {
-    /** The Rust path the generated code calls, e.g. `crate::helpers::format_count`. */
-    rust: string;
-    params: TypeName[];
-    returns: TypeName;
-    /** The longest string it returns, which is what a call adds to the buffer reservation. */
-    maxLen?: number;
-}
-/** What `ferrovue.config.json` holds. Paths are relative to the project root. */
-export interface Config {
-    /** The directory of `.vue` files to compile. */
-    components: string;
-    /** The directory the Rust modules are written to. Everything in it is replaced. */
-    out: string;
-    /** The module components import their helpers from, and the Rust twin of each export. */
-    helpers?: {
-        module: string;
-        functions: Record<string, HelperSpec>;
-    };
-    /** The Rust type a `TrustedHtml` prop is, which must implement `ferrovue::TrustedHtml`, e.g.
-     * `crate::sanitize::SafeHtml`. A type that borrows names the props' lifetime, `'a`:
-     * `crate::render::Trusted<'a>`. Without it, a component cannot use `v-html` at all. */
-    trustedHtml?: string;
-    /** A JSON file listing the app's routes as vue-router paths (`/users/:id`), which `<RouterLink>`
-     * resolves against. Without it, a component cannot use `<RouterLink>`. */
-    routes?: string;
-    /** The router, in full: its routes file, the history's base, and the class names
-     * `createRouter` gives active links. `routes` alone is shorthand for `{ routes }`. */
-    router?: {
-        routes: string;
-        base?: string;
-        linkActiveClass?: string;
-        linkExactActiveClass?: string;
-    };
-    /** The directory of Pinia stores (`.ts` files), whose state a component may read while it renders
-     * on the server. */
-    stores?: string;
-    /** Custom directives that render nothing on the server — no `getSSRProps` — by name, without
-     * `v-`: `["focus", "click-outside"]`. Any other custom directive is refused, since the server
-     * cannot know what its `getSSRProps` would add. */
-    clientDirectives?: string[];
-}
-export declare const CONFIG_FILE = "ferrovue.config.json";
-/** Read the project's configuration. */
-export declare function loadConfig(root: string): Config;
-/** Where `TrustedHtml` comes from. Only that import names the type `v-html` will write raw. */
-export declare const TYPES_MODULE = "ferrovue/types";
-export declare class GenError extends Error {
-}
+import { type Config } from "./context.ts";
 /** Every generated file, keyed by its name in the output directory. */
 export declare function generate(root: string, config?: Config): Map<string, string>;
 /** Write what `generate` produces to the configured directory, replacing what is there. */
-export declare function write(root: string, config?: Config): string[];
+/** What \`write\` changed in the output directory. */
+export interface Written {
+    /** Every file the output directory now holds. */
+    files: string[];
+    /** The files whose text changed, or that are new. */
+    changed: string[];
+    /** The files removed, which the components no longer produce. */
+    removed: string[];
+}
+/** Write what \`generate\` produces to the configured directory: only the files whose text changed,
+ * so a Rust build that watches them rebuilds no more than it must, and removing what no component
+ * produces any more. */
+export declare function write(root: string, config?: Config): Written;
+export { CONFIG_FILE, loadConfig, TYPES_MODULE, type Config, type HelperSpec, type TypeName } from "./context.ts";
+export { GenError } from "./model.ts";