@fulcro/transform-core 0.9.0 → 0.11.0

package/dist/program/index.d.ts

@@ -1,5 +1,82 @@
+import typescript from 'typescript';
 import { CallRewriter } from '../shared/index.js';
 import { TransformerOptions } from '../transformer/index.js';
+/**
+ * Rewrites a path the way the compiler spells it.
+ *
+ * TypeScript keeps every file name with forward slashes, on every platform,
+ * while the bundler and `path.normalize` hand back the native separator. Mixing
+ * the two silently defeats every lookup against the files of the program: a
+ * file already in it looks new, gets added as another root, and invalidates the
+ * whole program — turning one startup cost into one per file.
+ *
+ * @param fileName Path in whatever spelling it arrived.
+ * @returns The path as the compiler spells it.
+ */
+export declare const toCompilerPath: (fileName: string) => string;
+/**
+ * Keeps a TypeScript program alive across recompilations.
+ *
+ * A language service rather than a one shot program: a watch run recompiles the
+ * same files repeatedly, and rebuilding the whole program on each edit would
+ * cost seconds every keystroke. The service reuses everything that did not
+ * change, and the version counters below are what tell it what did.
+ */
+export declare class ProgramHost implements typescript.LanguageServiceHost {
+    /** Files of the program, as resolved from the tsconfig. */
+    private readonly rootNames;
+    /** Compiler options resolved from the tsconfig. */
+    private readonly options;
+    /** Content handed over by the bundler, which may be ahead of the disk. */
+    private readonly overlays;
+    /** Bumped whenever a file changes, which is how the service invalidates. */
+    private readonly versions;
+    /** Directory the relative paths of the program resolve against. */
+    private readonly currentDirectory;
+    /**
+     * Initializes the host from a parsed tsconfig.
+     *
+     * @param parsed Parsed contents of the tsconfig.
+     * @param currentDirectory Directory the program resolves against.
+     */
+    constructor(parsed: typescript.ParsedCommandLine, currentDirectory: string);
+    /**
+     * Records the content of a file as the bundler sees it.
+     *
+     * @param fileName File being compiled.
+     * @param content Current content of the file.
+     */
+    update(fileName: string, content: string): void;
+    /**
+     * Tells whether the content handed over matches what is on disk.
+     *
+     * @param fileName File being compiled.
+     * @param content Content handed over by the bundler.
+     * @returns `true` when the two are identical.
+     */
+    private matchesDisk;
+    getScriptFileNames(): string[];
+    getScriptVersion(fileName: string): string;
+    getScriptSnapshot(fileName: string): typescript.IScriptSnapshot | undefined;
+    getCurrentDirectory(): string;
+    getCompilationSettings(): typescript.CompilerOptions;
+    getDefaultLibFileName(options: typescript.CompilerOptions): string;
+    readFile(fileName: string, encoding?: string): string | undefined;
+    fileExists(fileName: string): boolean;
+    readDirectory: (path: string, extensions?: readonly string[], exclude?: readonly string[], include?: readonly string[], depth?: number) => string[];
+    directoryExists: (path: string) => boolean;
+    getDirectories: (path: string) => string[];
+    realpath: ((path: string) => string) | undefined;
+}
+/**
+ * Locates and parses the tsconfig driving the program.
+ *
+ * @param root Directory the search starts from.
+ * @param explicit Path given in the options, when there is one.
+ * @returns The parsed tsconfig.
+ * @throws {Error} When no tsconfig can be found or it cannot be read.
+ */
+export declare const parseTsconfig: (root: string, explicit: string | undefined) => typescript.ParsedCommandLine;
 /** Options accepted by the transformer core. */
 export interface TransformCoreOptions extends TransformerOptions {
     /** Path of the tsconfig driving the program. Defaults to the nearest one. */

package/dist/program/index.js

@@ -36,7 +36,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createFileTransformer = void 0;
+exports.createFileTransformer = exports.parseTsconfig = exports.ProgramHost = exports.toCompilerPath = void 0;
 const fs = __importStar(require("node:fs"));
 const path = __importStar(require("node:path"));
 const typescript_1 = __importDefault(require("typescript"));
@@ -86,6 +86,7 @@ const buildUtilityPattern = (rewriters) => {
  * @returns The path as the compiler spells it.
  */
 const toCompilerPath = (fileName) => path.resolve(fileName).split(path.sep).join('/');
+exports.toCompilerPath = toCompilerPath;
 /**
  * Keeps a TypeScript program alive across recompilations.
  *
@@ -112,7 +113,7 @@ class ProgramHost {
      * @param currentDirectory Directory the program resolves against.
      */
     constructor(parsed, currentDirectory) {
-        this.rootNames = parsed.fileNames.map(toCompilerPath);
+        this.rootNames = parsed.fileNames.map(exports.toCompilerPath);
         this.options = parsed.options;
         this.currentDirectory = currentDirectory;
     }
@@ -192,6 +193,7 @@ class ProgramHost {
     getDirectories = typescript_1.default.sys.getDirectories;
     realpath = typescript_1.default.sys.realpath;
 }
+exports.ProgramHost = ProgramHost;
 /**
  * Locates and parses the tsconfig driving the program.
  *
@@ -214,6 +216,7 @@ const parseTsconfig = (root, explicit) => {
     }
     return typescript_1.default.parseJsonConfigFileContent(read.config, typescript_1.default.sys, path.dirname(configPath));
 };
+exports.parseTsconfig = parseTsconfig;
 /**
  * Creates the transformer core.
  *
@@ -244,9 +247,9 @@ const createFileTransformer = (rewriters, options = {}) => {
         // would cost seconds for nothing.
         if (!utilityPattern.test(code))
             return null;
-        const fileName = toCompilerPath(id.split('?')[0]);
+        const fileName = (0, exports.toCompilerPath)(id.split('?')[0]);
         if (host === undefined || service === undefined) {
-            host = new ProgramHost(parseTsconfig(root, options.tsconfig), root);
+            host = new ProgramHost((0, exports.parseTsconfig)(root, options.tsconfig), root);
             service = typescript_1.default.createLanguageService(host, typescript_1.default.createDocumentRegistry());
         }
         host.update(fileName, code);

package/dist/unplugin/index.mjs

@@ -8,7 +8,15 @@ import { createFileTransformer, } from '../program/index.js';
  * in its logs and timings.
  * @returns Every adapter `unplugin` can produce.
  */
-export const createTransformerUnplugin = (rewriters, name) => {
+export const createTransformerUnplugin = (rewriters, name) => createAdapters((options) => createFileTransformer(rewriters, options), name);
+/**
+ * Builds the adapters around the core of a package.
+ *
+ * @param build Builds the core for a set of options.
+ * @param name Name the plugin reports to the bundler.
+ * @returns Every adapter `unplugin` can produce.
+ */
+const createAdapters = (build, name) => {
     const unpluginFactory = (options = {}) => {
         let transformer;
         /**
@@ -18,7 +26,7 @@ export const createTransformerUnplugin = (rewriters, name) => {
          * @returns The transformer core.
          */
         const resolve = () => {
-            transformer ??= createFileTransformer(rewriters, options);
+            transformer ??= build(options);
             return transformer;
         };
         return {
@@ -39,10 +47,7 @@ export const createTransformerUnplugin = (rewriters, name) => {
                     // The root of the bundler wins over the working directory, which
                     // is what makes the plugin behave inside a monorepo.
                     if (config.root !== undefined && options.root === undefined) {
-                        transformer = createFileTransformer(rewriters, {
-                            ...options,
-                            root: config.root,
-                        });
+                        transformer = build({ ...options, root: config.root });
                     }
                 },
             },

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@fulcro/transform-core",
-	"version": "0.9.0",
+	"version": "0.11.0",
 	"description": "Shared machinery behind the Fulcro compile time transformers. Installed for you; not meant to be depended on directly.",
 	"keywords": [
 		"typescript",