@decohere/workspace 0.0.1-dev.130 → 0.0.1-dev.131

package/README.md

@@ -56,6 +56,8 @@ For each discovered project, the workspace package maps `package.json` `name` to
 
 Root `tsconfig.json` `paths` override the same keys. In this repo they come from `forge paths`, which writes this map to `tsconfig.paths.json` for `tsc`.
 
+`tsconfig.json` is read with [get-tsconfig](https://github.com/privatenumber/get-tsconfig), which follows `extends`, not with the TypeScript compiler: loading the compiler takes longer than the rest of a `flux run`. Transpiling uses only `paths` and `baseUrl` (made absolute). Forge's type emission, which needs every option as tsc sees it, parses `Tsconfig.filePath` with the compiler itself.
+
 Forge debug and Flux consume this map (SWC `jsc.paths` / resolve hooks). Why debug uses it instead of `node_modules` workspace links: [Forge — debug path aliases](../forge/README.md#debug-path-aliases-not-node_modules-links).
 
 ## When to use

package/commonjs/src/models/jsonc.js

@@ -0,0 +1,57 @@
+/**
+ * Parses JSON with comments and trailing commas, as `tsconfig.json` allows. An empty file is
+ * `{}`, as tsc reads it. Throws a `SyntaxError` on anything else that isn't valid JSON.
+ */ "use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "parseJsonc", {
+    enumerable: true,
+    get: function() {
+        return parseJsonc;
+    }
+});
+function parseJsonc(text) {
+    if (text.trim() === "") return {};
+    return JSON.parse(stripJsonc(text));
+}
+function stripJsonc(text) {
+    let out = "";
+    let i = 0;
+    while(i < text.length){
+        const char = text[i];
+        const next = text[i + 1];
+        if (char === '"') {
+            const end = stringEnd(text, i);
+            out += text.slice(i, end);
+            i = end;
+        } else if (char === "/" && next === "/") {
+            const end = text.indexOf("\n", i);
+            i = end === -1 ? text.length : end;
+        } else if (char === "/" && next === "*") {
+            const end = text.indexOf("*/", i + 2);
+            if (end === -1) throw new SyntaxError("Unterminated comment in JSON");
+            out += " ";
+            i = end + 2;
+        } else if (char === "}" || char === "]") {
+            // Drop a trailing comma before the closing bracket.
+            out = out.trimEnd();
+            if (out.endsWith(",")) out = out.slice(0, -1);
+            out += char;
+            i++;
+        } else {
+            out += char;
+            i++;
+        }
+    }
+    return out;
+}
+/** Index just past the string starting at `start` (a `"`); an unclosed string runs to the end. */ function stringEnd(text, start) {
+    let i = start + 1;
+    while(i < text.length){
+        if (text[i] === "\\") i += 2;
+        else if (text[i] === '"') return i + 1;
+        else i++;
+    }
+    return text.length;
+}

package/commonjs/src/models/project.model.js

@@ -14,7 +14,7 @@ const _caching = require("@decohere/core/caching");
 const _extensibility = require("@decohere/core/extensibility");
 const _io = require("@decohere/devkit/io");
 const _picomatch = /*#__PURE__*/ _interop_require_default(require("picomatch"));
-const _rxjs = require("rxjs");
+const _system = require("@decohere/core/system");
 const _errors = require("../errors.js");
 const _haspackagejsonmixin = require("./has-package-json.mixin.js");
 const _hastsconfigmixin = require("./has-tsconfig.mixin.js");
@@ -36,7 +36,7 @@ function _ts_metadata(k, v) {
 }
 class Project extends (0, _extensibility.mixwith)(_haspackagejsonmixin.HasPackageJson, _hastsconfigmixin.HasTsConfig) {
     packageJson;
-    #projectFileChangedSubject = new _rxjs.Subject();
+    #projectFileChangedSubject = new _system.Subject();
     #sourceFiles = new Map();
     #projectConfig;
     #name;

package/commonjs/src/models/tsconfig.model.js

@@ -19,24 +19,14 @@ _export(exports, {
 const _nodefs = /*#__PURE__*/ _interop_require_default(require("node:fs"));
 const _nodepath = /*#__PURE__*/ _interop_require_default(require("node:path"));
 const _io = require("@decohere/core/io");
-const _typescript = /*#__PURE__*/ _interop_require_default(require("typescript"));
+const _gettsconfig = require("get-tsconfig");
 const _errors = require("../errors.js");
+const _jsonc = require("./jsonc.js");
 function _interop_require_default(obj) {
     return obj && obj.__esModule ? obj : {
         default: obj
     };
 }
-const host = _typescript.default.sys;
-host.readFile = (file)=>{
-    return _nodefs.default.readFileSync(file, {
-        encoding: "utf8"
-    });
-};
-host.readDirectory = (directoryName)=>{
-    return _nodefs.default.readdirSync(directoryName, {
-        withFileTypes: true
-    }).filter((entry)=>entry.isDirectory()).map((entry)=>entry.name);
-};
 const DEFAULT_COMPILER_OPTIONS = {
     emitDeclarationOnly: true,
     declaration: true,
@@ -50,34 +40,34 @@ class Tsconfig {
         if (!await _io.io.fileExists(filePath)) {
             throw new _errors.WorkspaceConfigurationError(`TSConfig not found ${filePath}`);
         }
-        const configFileText = await _io.io.readFile(filePath);
-        const result = _typescript.default.parseConfigFileTextToJson(filePath, configFileText);
-        if (result.error) {
-            const errorMessage = result.error.messageText.toString();
-            throw new _errors.WorkspaceConfigurationError(`Error parsing ${filePath}. ${errorMessage}`);
-        }
-        const dirName = _nodepath.default.resolve(_nodepath.default.dirname(filePath));
-        const configParseResult = _typescript.default.parseJsonConfigFileContent(result.config, host, dirName);
-        return new Tsconfig({
-            compilerOptions: configParseResult.options,
-            errors: configParseResult.errors
-        });
+        return Tsconfig.read(filePath);
     }
     static parseSync(filePath) {
         if (!Tsconfig.fileExistsSync(filePath)) {
             throw new _errors.WorkspaceConfigurationError(`TSConfig not found ${filePath}`);
         }
-        const configFileText = _nodefs.default.readFileSync(filePath, "utf8");
-        const result = _typescript.default.parseConfigFileTextToJson(filePath, configFileText);
-        if (result.error) {
-            const errorMessage = result.error.messageText.toString();
-            throw new _errors.WorkspaceConfigurationError(`Error parsing ${filePath}. ${errorMessage}`);
+        return Tsconfig.read(filePath);
+    }
+    static read(filePath) {
+        const fullPath = _nodepath.default.resolve(filePath);
+        let compilerOptions;
+        try {
+            // get-tsconfig reads broken JSON as `{}`; check the file itself first.
+            (0, _jsonc.parseJsonc)(_nodefs.default.readFileSync(fullPath, "utf8"));
+            compilerOptions = (0, _gettsconfig.parseTsconfig)(fullPath).compilerOptions ?? {};
+        } catch (error) {
+            const message = error instanceof Error ? error.message : String(error);
+            throw new _errors.WorkspaceConfigurationError(`Error parsing ${filePath}. ${message}`, {
+                cause: error
+            });
         }
-        const dirName = _nodepath.default.resolve(_nodepath.default.dirname(filePath));
-        const configParseResult = _typescript.default.parseJsonConfigFileContent(result.config, host, dirName);
+        const { baseUrl } = compilerOptions;
         return new Tsconfig({
-            compilerOptions: configParseResult.options,
-            errors: configParseResult.errors
+            filePath: fullPath,
+            compilerOptions: baseUrl == null ? compilerOptions : {
+                ...compilerOptions,
+                baseUrl: _nodepath.default.resolve(_nodepath.default.dirname(fullPath), baseUrl)
+            }
         });
     }
     static fileExistsSync(filePath) {
@@ -92,6 +82,6 @@ class Tsconfig {
     }){
         Object.assign(this, data);
     }
+    /** Absolute path of the file read; undefined for {@link Tsconfig.default}. */ filePath;
     compilerOptions;
-    errors;
 }

package/commonjs/src/models/workspace.model.js

@@ -11,7 +11,7 @@ Object.defineProperty(exports, "Workspace", {
 const _decorators = require("@decohere/crucible/decorators");
 const _collections = require("@decohere/core/collections");
 const _extensibility = require("@decohere/core/extensibility");
-const _rxjs = require("rxjs");
+const _system = require("@decohere/core/system");
 const _errors = require("../errors.js");
 const _haspackagejsonmixin = require("./has-package-json.mixin.js");
 const _hastsconfigmixin = require("./has-tsconfig.mixin.js");
@@ -38,7 +38,7 @@ class Workspace extends (0, _extensibility.mixwith)(_haspackagejsonmixin.HasPack
 	 * of every file: the Vitest plugin asks once per transformed file. Keyed by the list
 	 * `getAllFiles` returns, so a new list (after its cache is flushed) gets a new set.
 	 */ #sourcePaths = new WeakMap();
-    #projectFileChangedSubject = new _rxjs.Subject();
+    #projectFileChangedSubject = new _system.Subject();
     #projectWatchSubscriptions = new Map();
     #watchedProjects = [];
     constructor(options = {}){

package/es6/src/models/jsonc.js

@@ -0,0 +1,47 @@
+/**
+ * Parses JSON with comments and trailing commas, as `tsconfig.json` allows. An empty file is
+ * `{}`, as tsc reads it. Throws a `SyntaxError` on anything else that isn't valid JSON.
+ */ export function parseJsonc(text) {
+    if (text.trim() === "") return {};
+    return JSON.parse(stripJsonc(text));
+}
+function stripJsonc(text) {
+    let out = "";
+    let i = 0;
+    while(i < text.length){
+        const char = text[i];
+        const next = text[i + 1];
+        if (char === '"') {
+            const end = stringEnd(text, i);
+            out += text.slice(i, end);
+            i = end;
+        } else if (char === "/" && next === "/") {
+            const end = text.indexOf("\n", i);
+            i = end === -1 ? text.length : end;
+        } else if (char === "/" && next === "*") {
+            const end = text.indexOf("*/", i + 2);
+            if (end === -1) throw new SyntaxError("Unterminated comment in JSON");
+            out += " ";
+            i = end + 2;
+        } else if (char === "}" || char === "]") {
+            // Drop a trailing comma before the closing bracket.
+            out = out.trimEnd();
+            if (out.endsWith(",")) out = out.slice(0, -1);
+            out += char;
+            i++;
+        } else {
+            out += char;
+            i++;
+        }
+    }
+    return out;
+}
+/** Index just past the string starting at `start` (a `"`); an unclosed string runs to the end. */ function stringEnd(text, start) {
+    let i = start + 1;
+    while(i < text.length){
+        if (text[i] === "\\") i += 2;
+        else if (text[i] === '"') return i + 1;
+        else i++;
+    }
+    return text.length;
+}

package/es6/src/models/project.model.js

@@ -13,7 +13,7 @@ import { cache, memoize } from "@decohere/core/caching";
 import { mixwith } from "@decohere/core/extensibility";
 import { findFiles, WatchEvents, watch as watchDirectory } from "@decohere/devkit/io";
 import picomatch from "picomatch";
-import { Subject } from "rxjs";
+import { Subject } from "@decohere/core/system";
 import { WorkspaceConfigurationError } from "../errors.js";
 import { HasPackageJson } from "./has-package-json.mixin.js";
 import { HasTsConfig } from "./has-tsconfig.mixin.js";

package/es6/src/models/tsconfig.model.js

@@ -1,25 +1,18 @@
 import fs from "node:fs";
 import path from "node:path";
 import { io } from "@decohere/core/io";
-import ts from "typescript";
+import { parseTsconfig } from "get-tsconfig";
 import { WorkspaceConfigurationError } from "../errors.js";
-const host = ts.sys;
-host.readFile = (file)=>{
-    return fs.readFileSync(file, {
-        encoding: "utf8"
-    });
-};
-host.readDirectory = (directoryName)=>{
-    return fs.readdirSync(directoryName, {
-        withFileTypes: true
-    }).filter((entry)=>entry.isDirectory()).map((entry)=>entry.name);
-};
+import { parseJsonc } from "./jsonc.js";
 export const DEFAULT_COMPILER_OPTIONS = {
     emitDeclarationOnly: true,
     declaration: true,
     baseUrl: "./"
 };
-export class Tsconfig {
+/**
+ * A `tsconfig.json`, read without the TypeScript compiler so running a file doesn't load it.
+ * Code that needs the compiler's own parse (type emission) parses `filePath` itself.
+ */ export class Tsconfig {
     static default() {
         return new Tsconfig();
     }
@@ -27,34 +20,34 @@ export class Tsconfig {
         if (!await io.fileExists(filePath)) {
             throw new WorkspaceConfigurationError(`TSConfig not found ${filePath}`);
         }
-        const configFileText = await io.readFile(filePath);
-        const result = ts.parseConfigFileTextToJson(filePath, configFileText);
-        if (result.error) {
-            const errorMessage = result.error.messageText.toString();
-            throw new WorkspaceConfigurationError(`Error parsing ${filePath}. ${errorMessage}`);
-        }
-        const dirName = path.resolve(path.dirname(filePath));
-        const configParseResult = ts.parseJsonConfigFileContent(result.config, host, dirName);
-        return new Tsconfig({
-            compilerOptions: configParseResult.options,
-            errors: configParseResult.errors
-        });
+        return Tsconfig.read(filePath);
     }
     static parseSync(filePath) {
         if (!Tsconfig.fileExistsSync(filePath)) {
             throw new WorkspaceConfigurationError(`TSConfig not found ${filePath}`);
         }
-        const configFileText = fs.readFileSync(filePath, "utf8");
-        const result = ts.parseConfigFileTextToJson(filePath, configFileText);
-        if (result.error) {
-            const errorMessage = result.error.messageText.toString();
-            throw new WorkspaceConfigurationError(`Error parsing ${filePath}. ${errorMessage}`);
+        return Tsconfig.read(filePath);
+    }
+    static read(filePath) {
+        const fullPath = path.resolve(filePath);
+        let compilerOptions;
+        try {
+            // get-tsconfig reads broken JSON as `{}`; check the file itself first.
+            parseJsonc(fs.readFileSync(fullPath, "utf8"));
+            compilerOptions = parseTsconfig(fullPath).compilerOptions ?? {};
+        } catch (error) {
+            const message = error instanceof Error ? error.message : String(error);
+            throw new WorkspaceConfigurationError(`Error parsing ${filePath}. ${message}`, {
+                cause: error
+            });
         }
-        const dirName = path.resolve(path.dirname(filePath));
-        const configParseResult = ts.parseJsonConfigFileContent(result.config, host, dirName);
+        const { baseUrl } = compilerOptions;
         return new Tsconfig({
-            compilerOptions: configParseResult.options,
-            errors: configParseResult.errors
+            filePath: fullPath,
+            compilerOptions: baseUrl == null ? compilerOptions : {
+                ...compilerOptions,
+                baseUrl: path.resolve(path.dirname(fullPath), baseUrl)
+            }
         });
     }
     static fileExistsSync(filePath) {
@@ -69,6 +62,6 @@ export class Tsconfig {
     }){
         Object.assign(this, data);
     }
+    /** Absolute path of the file read; undefined for {@link Tsconfig.default}. */ filePath;
     compilerOptions;
-    errors;
 }

package/es6/src/models/workspace.model.js

@@ -10,7 +10,7 @@ function _ts_metadata(k, v) {
 import { injectable } from "@decohere/crucible/decorators";
 import { collections } from "@decohere/core/collections";
 import { mixwith } from "@decohere/core/extensibility";
-import { Subject } from "rxjs";
+import { Subject } from "@decohere/core/system";
 import { WorkspaceConfigurationError } from "../errors.js";
 import { HasPackageJson } from "./has-package-json.mixin.js";
 import { HasTsConfig } from "./has-tsconfig.mixin.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@decohere/workspace",
-  "version": "0.0.1-dev.130",
+  "version": "0.0.1-dev.131",
   "description": "Workspace and project model primitives for monorepo tooling",
   "keywords": [
     "typescript",
@@ -33,12 +33,11 @@
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "dependencies": {
-    "@decohere/core": "0.0.1-dev.130",
-    "@decohere/crucible": "0.0.1-dev.130",
-    "@decohere/devkit": "0.0.1-dev.130",
-    "picomatch": "^4.0.4",
-    "rxjs": "^7.8.2",
-    "typescript": "^6.0.3"
+    "@decohere/core": "0.0.1-dev.131",
+    "@decohere/crucible": "0.0.1-dev.131",
+    "@decohere/devkit": "0.0.1-dev.131",
+    "get-tsconfig": "^4.14.3",
+    "picomatch": "^4.0.4"
   },
   "devDependencies": {}
 }

package/types/src/index.d.ts

@@ -12,6 +12,7 @@ export type { ProjectConfig, ProjectSeed } from "./models/project.model.js";
 export { Project } from "./models/project.model.js";
 export { sourceExtensions } from "./models/source-extensions.js";
 export type { ProjectFileEvent } from "./models/project-file-event.js";
+export type { CompilerOptions } from "./models/tsconfig.model.js";
 export { DEFAULT_COMPILER_OPTIONS, Tsconfig } from "./models/tsconfig.model.js";
 export { Workspace } from "./models/workspace.model.js";
 export type { Configuration, ProjectOptions, UiConfig, WorkspaceFactoryOptions, WorkspaceOptions, } from "./models/workspace-config.type.js";

package/types/src/models/jsonc.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Parses JSON with comments and trailing commas, as `tsconfig.json` allows. An empty file is
+ * `{}`, as tsc reads it. Throws a `SyntaxError` on anything else that isn't valid JSON.
+ */
+export declare function parseJsonc(text: string): unknown;

package/types/src/models/project.model.d.ts

@@ -33,7 +33,7 @@ export declare class Project extends Project_base {
     get dockerConfig(): import("./workspace-config.type.js").DockerConfig;
     get uiConfig(): import("./workspace-config.type.js").UiConfig;
     get configurations(): Configuration[];
-    get projectFileChanged$(): import("rxjs").Observable<ProjectFileEvent>;
+    get projectFileChanged$(): import("@decohere/core/system").Observable<ProjectFileEvent>;
     getAllFiles(): Promise<FileEx[]>;
     isSourceFile(file: FileEx): boolean;
     watch(configuration: string): Promise<Watcher>;

package/types/src/models/tsconfig.model.d.ts

@@ -1,11 +1,19 @@
-import ts, { type CompilerOptions } from "typescript";
+import { type TsConfigJson } from "get-tsconfig";
+/** `compilerOptions` as written in `tsconfig.json`, after `extends`; `baseUrl` is absolute. */
+export type CompilerOptions = TsConfigJson.CompilerOptions;
 export declare const DEFAULT_COMPILER_OPTIONS: CompilerOptions;
+/**
+ * A `tsconfig.json`, read without the TypeScript compiler so running a file doesn't load it.
+ * Code that needs the compiler's own parse (type emission) parses `filePath` itself.
+ */
 export declare class Tsconfig {
     static default(): Tsconfig;
     static parse(filePath: string): Promise<Tsconfig>;
     static parseSync(filePath: string): Tsconfig;
+    private static read;
     private static fileExistsSync;
     constructor(data?: Partial<Tsconfig>);
+    /** Absolute path of the file read; undefined for {@link Tsconfig.default}. */
+    readonly filePath?: string;
     readonly compilerOptions: CompilerOptions;
-    readonly errors: readonly ts.Diagnostic[];
 }

package/types/src/models/workspace.model.d.ts

@@ -37,7 +37,7 @@ export declare class Workspace extends Workspace_base {
     watch(configuration: string): Promise<void>;
     stopWatching(): void;
     [Symbol.dispose](): void;
-    get projectFileChanged$(): import("rxjs").Observable<ProjectFileEvent>;
+    get projectFileChanged$(): import("@decohere/core/system").Observable<ProjectFileEvent>;
     findProject(filePath: string, buildConfig: string): Promise<Project | undefined>;
     private sourcePathsOf;
     private validateWorkspace;