@decohere/workspace 0.0.1-dev.125 → 0.0.1-dev.5

package/tests/workspace.factory.spec.ts

@@ -0,0 +1,147 @@
+import { WorkspaceFactory, type WorkspaceOptions } from "@decohere/workspace";
+import { resetMemfs } from "@decohere/core/testing";
+import { fs, vol } from "memfs";
+import { afterEach, beforeEach, expect, it, vi } from "vitest";
+
+const root = "/MOCK_ROOT";
+const projects = "projects";
+const projPath = `${projects}/path/to`;
+const projPath2 = `${projects}/path/other`;
+const MOCK_PROJ1 = "MOCK_PROJ1";
+const MOCK_PROJ2 = "MOCK_PROJ2";
+
+const defaultOptions: WorkspaceOptions = {
+	rootDir: root,
+	outDir: "dist",
+	includeProjects: ["projects/**/package.json"],
+	ignoreProjects: ["**/node_modules/**", "**/__fixtures__/**"],
+	copyFiles: [],
+	configurations: [{ name: "debug" }],
+};
+
+const mockFiles = {
+	[`${root}/package.json`]: JSON.stringify({ name: "ROOT" }),
+	[`${root}/${projPath}/package.json`]: JSON.stringify({ name: MOCK_PROJ1 }),
+	[`${root}/${projPath}/src/index.ts`]: "export const value = 1;",
+	[`${root}/${projPath2}/package.json`]: JSON.stringify({ name: MOCK_PROJ2 }),
+} satisfies Record<string, string>;
+
+beforeEach(() => {
+	vi.spyOn(process, "cwd").mockReturnValue(root);
+});
+
+afterEach(() => {
+	resetMemfs();
+	vi.restoreAllMocks();
+});
+
+it("creates a workspace and discovers projects", async () => {
+	vol.fromJSON(mockFiles);
+	const workspace = await WorkspaceFactory.create(defaultOptions);
+	expect(workspace.getProjects("debug")).toHaveLength(2);
+});
+
+it("ignores node_modules", async () => {
+	vol.fromJSON({
+		...mockFiles,
+		[`${root}/${projPath}/node_modules/foo/package.json`]: JSON.stringify({ name: "LIB" }),
+	});
+	const workspace = await WorkspaceFactory.create(defaultOptions);
+	expect(workspace.getProjects("debug")).toHaveLength(2);
+});
+
+it("ignores fixture folders", async () => {
+	vol.fromJSON({
+		...mockFiles,
+		[`${root}/${projPath}/__fixtures__/foo/package.json`]: JSON.stringify({ name: "LIB" }),
+	});
+	const workspace = await WorkspaceFactory.create(defaultOptions);
+	expect(workspace.getProjects("debug")).toHaveLength(2);
+});
+
+it("creates workspace projects with expected directories", async () => {
+	vol.fromJSON(mockFiles);
+	const workspace = await WorkspaceFactory.create(defaultOptions);
+	const projectNamesToDirs = workspace
+		.getProjects("debug")
+		.map((p) => [p.name, p.projectDirectory] as const);
+
+	expect(projectNamesToDirs).toEqual(
+		expect.arrayContaining([
+			[MOCK_PROJ1, projPath],
+			[MOCK_PROJ2, projPath2],
+		]),
+	);
+});
+
+it("throws when duplicate project names exist", async () => {
+	vol.fromJSON({
+		...mockFiles,
+		[`${root}/${projects}/duplicate/package.json`]: JSON.stringify({ name: MOCK_PROJ1 }),
+	});
+
+	await expect(() => WorkspaceFactory.create(defaultOptions)).rejects.toThrow();
+});
+
+it("creates a project with default include when no options are passed (flux path)", async () => {
+	const root = "/FLUX_ROOT";
+	vol.fromJSON({
+		[`${root}/projects/app/package.json`]: JSON.stringify({
+			name: "my-app",
+			main: "src/index.ts",
+		}),
+		[`${root}/projects/app/src/index.ts`]: "export default {};",
+	});
+	vi.spyOn(process, "cwd").mockReturnValue(root);
+
+	// FluxModule.createWorkspace calls WorkspaceFactory.create({ configFile: undefined })
+	// — the workspace package's WorkspaceDefaults provides the TypeScript includes, so fileInfoMap is populated.
+	const workspace = await WorkspaceFactory.create({ configFile: undefined, rootDir: root });
+	const projects = workspace.getProjects("debug");
+
+	expect(projects).toHaveLength(1);
+	expect(projects[0].include).toEqual(["**/*.ts", "**/*.tsx", "**/*.mts", "**/*.cts"]);
+});
+
+it("fires projectFileChanged$ when a source file is written after watch starts", async () => {
+	const root = "/WATCH_ROOT";
+	const filePath = `${root}/projects/app/src/index.ts`;
+	vol.fromJSON({
+		[`${root}/projects/app/package.json`]: JSON.stringify({
+			name: "watch-app",
+			main: "src/index.ts",
+		}),
+		[filePath]: "export const v = 1;",
+	});
+	vi.spyOn(process, "cwd").mockReturnValue(root);
+
+	const workspace = await WorkspaceFactory.create({ configFile: undefined, rootDir: root });
+
+	// workspace.watch() calls project.watch() internally and subscribes project events
+	// into workspace.projectFileChanged$
+	await workspace.watch("debug");
+
+	const [project] = workspace.getProjects("debug");
+
+	await new Promise<void>((resolve, reject) => {
+		const subscription = workspace.projectFileChanged$.subscribe((evt) => {
+			if (evt.file.relativePath !== "src/index.ts") return;
+			subscription.unsubscribe();
+			workspace.stopWatching();
+			resolve();
+		});
+
+		// project.watch() was already called by workspace.watch(); use its ready promise
+		project.watch("debug").then((watcher) => {
+			watcher.ready.then(() => {
+				fs.writeFileSync(filePath, "export const v = 2;", { encoding: "utf8" });
+			});
+		});
+
+		setTimeout(() => {
+			subscription.unsubscribe();
+			workspace.stopWatching();
+			reject(new Error("projectFileChanged$ did not fire within timeout"));
+		}, 800);
+	});
+});

package/LICENSE

@@ -1,15 +0,0 @@
-ISC License
-
-Copyright (c) 2025-2026 Typesmiths
-
-Permission to use, copy, modify, and/or distribute this software for any
-purpose with or without fee is hereby granted, provided that the above
-copyright notice and this permission notice appear in all copies.
-
-THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
-WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
-MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
-ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
-WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
-ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
-OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

package/commonjs/src/const.js

@@ -1,69 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-function _export(target, all) {
-    for(var name in all)Object.defineProperty(target, name, {
-        enumerable: true,
-        get: Object.getOwnPropertyDescriptor(all, name).get
-    });
-}
-_export(exports, {
-    get FIXTURES () {
-        return FIXTURES;
-    },
-    get NODE_MODULES () {
-        return NODE_MODULES;
-    },
-    get PACKAGE_JSON () {
-        return PACKAGE_JSON;
-    },
-    get PROJECTS_DIR () {
-        return PROJECTS_DIR;
-    },
-    get TS_CONFIG () {
-        return TS_CONFIG;
-    },
-    get WORKSPACE_CONFIG () {
-        return WORKSPACE_CONFIG;
-    },
-    get WorkspaceDefaults () {
-        return WorkspaceDefaults;
-    }
-});
-const TS_CONFIG = "tsconfig.json";
-const PACKAGE_JSON = "package.json";
-const NODE_MODULES = "node_modules";
-const FIXTURES = "__fixtures__";
-const WORKSPACE_CONFIG = ".decohere.js";
-const PROJECTS_DIR = "projects";
-const WorkspaceDefaults = {
-    rootDir: "./",
-    outDir: "dist",
-    includeProjects: [
-        `${PROJECTS_DIR}/**/${PACKAGE_JSON}`
-    ],
-    ignoreProjects: [
-        `**/${NODE_MODULES}/**`,
-        `**/${FIXTURES}/**`,
-        "**/dist/**"
-    ],
-    include: [
-        "**/*.ts",
-        "**/*.tsx",
-        "**/*.mts",
-        "**/*.cts"
-    ],
-    ignore: [
-        "**/*.d.ts",
-        "**/*.d.mts",
-        "**/*.d.cts",
-        `**/${NODE_MODULES}/**`
-    ],
-    copyFiles: [],
-    configurations: [
-        {
-            name: "debug"
-        }
-    ]
-};

package/commonjs/src/errors.js

@@ -1,12 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-Object.defineProperty(exports, "WorkspaceConfigurationError", {
-    enumerable: true,
-    get: function() {
-        return WorkspaceConfigurationError;
-    }
-});
-class WorkspaceConfigurationError extends Error {
-}

package/commonjs/src/factories/config.factory.js

@@ -1,90 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-Object.defineProperty(exports, "UserConfigFactory", {
-    enumerable: true,
-    get: function() {
-        return UserConfigFactory;
-    }
-});
-const _nodepath = /*#__PURE__*/ _interop_require_default(require("node:path"));
-const _nodeurl = require("node:url");
-const _caching = require("@decohere/core/caching");
-const _io = require("@decohere/core/io");
-const _const = require("../const.js");
-function _interop_require_default(obj) {
-    return obj && obj.__esModule ? obj : {
-        default: obj
-    };
-}
-function _getRequireWildcardCache(nodeInterop) {
-    if (typeof WeakMap !== "function") return null;
-    var cacheBabelInterop = new WeakMap();
-    var cacheNodeInterop = new WeakMap();
-    return (_getRequireWildcardCache = function(nodeInterop) {
-        return nodeInterop ? cacheNodeInterop : cacheBabelInterop;
-    })(nodeInterop);
-}
-function _interop_require_wildcard(obj, nodeInterop) {
-    if (!nodeInterop && obj && obj.__esModule) {
-        return obj;
-    }
-    if (obj === null || typeof obj !== "object" && typeof obj !== "function") {
-        return {
-            default: obj
-        };
-    }
-    var cache = _getRequireWildcardCache(nodeInterop);
-    if (cache && cache.has(obj)) {
-        return cache.get(obj);
-    }
-    var newObj = {
-        __proto__: null
-    };
-    var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor;
-    for(var key in obj){
-        if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) {
-            var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null;
-            if (desc && (desc.get || desc.set)) {
-                Object.defineProperty(newObj, key, desc);
-            } else {
-                newObj[key] = obj[key];
-            }
-        }
-    }
-    newObj.default = obj;
-    if (cache) {
-        cache.set(obj, newObj);
-    }
-    return newObj;
-}
-function _ts_decorate(decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for(var i = decorators.length - 1; i >= 0; i--)if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-    return c > 3 && r && Object.defineProperty(target, key, r), r;
-}
-function _ts_metadata(k, v) {
-    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
-}
-class ConfigFactory {
-    async getUserConfig(configFile) {
-        const file = configFile ?? _const.WORKSPACE_CONFIG;
-        if (!file || !await _io.io.fileExists(file)) {
-            return {};
-        }
-        const fileUrl = (0, _nodeurl.pathToFileURL)(_nodepath.default.resolve(file)).href;
-        const conf = (await Promise.resolve(fileUrl).then((p)=>/*#__PURE__*/ _interop_require_wildcard(require(p)))).default;
-        return conf;
-    }
-}
-_ts_decorate([
-    (0, _caching.cache)(),
-    _ts_metadata("design:type", Function),
-    _ts_metadata("design:paramtypes", [
-        String
-    ]),
-    _ts_metadata("design:returntype", Promise)
-], ConfigFactory.prototype, "getUserConfig", null);
-const UserConfigFactory = new ConfigFactory();

package/commonjs/src/factories/find-workspace-root.js

@@ -1,37 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-Object.defineProperty(exports, "findWorkspaceRoot", {
-    enumerable: true,
-    get: function() {
-        return findWorkspaceRoot;
-    }
-});
-const _nodefs = require("node:fs");
-const _nodepath = /*#__PURE__*/ _interop_require_default(require("node:path"));
-const _const = require("../const.js");
-function _interop_require_default(obj) {
-    return obj && obj.__esModule ? obj : {
-        default: obj
-    };
-}
-function findWorkspaceRoot(startDir) {
-    const start = _nodepath.default.resolve(startDir);
-    let dir = start;
-    for(;;){
-        if ((0, _nodefs.existsSync)(_nodepath.default.join(dir, _const.PACKAGE_JSON)) && isDirectory(_nodepath.default.join(dir, _const.PROJECTS_DIR))) {
-            return dir;
-        }
-        const parent = _nodepath.default.dirname(dir);
-        if (parent === dir) return start;
-        dir = parent;
-    }
-}
-function isDirectory(fullPath) {
-    try {
-        return (0, _nodefs.statSync)(fullPath).isDirectory();
-    } catch  {
-        return false;
-    }
-}

package/commonjs/src/factories/project.factory.js

@@ -1,73 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-Object.defineProperty(exports, "ProjectFactory", {
-    enumerable: true,
-    get: function() {
-        return ProjectFactory;
-    }
-});
-const _nodepath = /*#__PURE__*/ _interop_require_default(require("node:path"));
-const _io = require("@decohere/core/io");
-const _io1 = require("@decohere/devkit/io");
-const _objects = require("@decohere/core/objects");
-const _errors = require("../errors.js");
-const _packagejsonmodel = require("../models/package-json.model.js");
-const _projectmodel = require("../models/project.model.js");
-function _interop_require_default(obj) {
-    return obj && obj.__esModule ? obj : {
-        default: obj
-    };
-}
-class ProjectFactory {
-    static async getProjectSeeds(config) {
-        const { includeProjects, ignoreProjects, rootDir } = config;
-        const cwd = rootDir ?? "./";
-        const discoveredPackageJsonFiles = await (0, _io1.findFiles)(includeProjects, {
-            cwd,
-            ignore: ignoreProjects
-        });
-        const packageJsonFiles = ProjectFactory.filterNestedPackageJsonFiles(discoveredPackageJsonFiles);
-        const projects = await Promise.all(packageJsonFiles.map((file)=>ProjectFactory.projectFrom(file, config)));
-        return projects.sort((a, b)=>a.name.localeCompare(b.name));
-    }
-    static filterNestedPackageJsonFiles(files) {
-        const normalize = (filePath)=>filePath.replaceAll("\\", "/");
-        const packageJsonSet = new Set(files.map((file)=>normalize(file.relativePath)));
-        return files.filter((file)=>{
-            const relativePath = normalize(file.relativePath);
-            const projectDir = _nodepath.default.posix.dirname(relativePath);
-            let dir = _nodepath.default.posix.dirname(projectDir);
-            while(dir !== "." && dir !== "/"){
-                if (packageJsonSet.has(`${dir}/package.json`)) {
-                    return false;
-                }
-                dir = _nodepath.default.posix.dirname(dir);
-            }
-            return true;
-        });
-    }
-    static async getProjects(config, configuration) {
-        const seeds = await ProjectFactory.getProjectSeeds(config);
-        return seeds.map((seed)=>new _projectmodel.Project(seed.name, seed.config, configuration));
-    }
-    static async projectFrom(file, config) {
-        const packageJsonData = await _io.io.readJsonFile(file.fullPath).catch((error)=>{
-            throw new _errors.WorkspaceConfigurationError(`Error reading package.json ${file.fullPath}`, error);
-        });
-        const name = packageJsonData.name;
-        const packageJson = new _packagejsonmodel.PackageJson(packageJsonData);
-        const projectDir = _nodepath.default.dirname(file.relativePath);
-        const mergedConfig = _objects.merge.withOptions({
-            mergeArrays: false
-        }, config, config?.projects?.[name] ?? {}, {
-            projectDir,
-            packageJson
-        });
-        return {
-            name,
-            config: mergedConfig
-        };
-    }
-}

package/commonjs/src/factories/workspace.factory.js

@@ -1,50 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-Object.defineProperty(exports, "WorkspaceFactory", {
-    enumerable: true,
-    get: function() {
-        return WorkspaceFactory;
-    }
-});
-const _nodepath = /*#__PURE__*/ _interop_require_default(require("node:path"));
-const _io = require("@decohere/core/io");
-const _objects = require("@decohere/core/objects");
-const _const = require("../const.js");
-const _packagejsonmodel = require("../models/package-json.model.js");
-const _workspacemodel = require("../models/workspace.model.js");
-const _configfactory = require("./config.factory.js");
-const _projectfactory = require("./project.factory.js");
-function _interop_require_default(obj) {
-    return obj && obj.__esModule ? obj : {
-        default: obj
-    };
-}
-class Factory {
-    async create(options = {}) {
-        const config = await this.getMergedConfig(options);
-        const projectSeeds = await _projectfactory.ProjectFactory.getProjectSeeds(config);
-        const packageJson = await this.getPackageJson(config.rootDir ?? "./");
-        const workspace = new _workspacemodel.Workspace({
-            packageJson,
-            config,
-            projects: projectSeeds
-        });
-        return workspace;
-    }
-    async getMergedConfig(options) {
-        const { configFile, ...rest } = options;
-        const userConfig = await _configfactory.UserConfigFactory.getUserConfig(configFile);
-        return _objects.merge.withOptions({
-            mergeArrays: false
-        }, _const.WorkspaceDefaults, userConfig, rest);
-    }
-    async getPackageJson(rootDir) {
-        const packageJsonPath = _nodepath.default.join(rootDir, _const.PACKAGE_JSON);
-        if (!await _io.io.fileExists(packageJsonPath)) return;
-        const data = await _io.io.readJsonFile(packageJsonPath);
-        return new _packagejsonmodel.PackageJson(data);
-    }
-}
-const WorkspaceFactory = new Factory();

package/commonjs/src/index.js

@@ -1,74 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-function _export(target, all) {
-    for(var name in all)Object.defineProperty(target, name, {
-        enumerable: true,
-        get: Object.getOwnPropertyDescriptor(all, name).get
-    });
-}
-_export(exports, {
-    get DEFAULT_COMPILER_OPTIONS () {
-        return _tsconfigmodel.DEFAULT_COMPILER_OPTIONS;
-    },
-    get HasPackageJson () {
-        return _haspackagejsonmixin.HasPackageJson;
-    },
-    get HasTsConfig () {
-        return _hastsconfigmixin.HasTsConfig;
-    },
-    get PackageJson () {
-        return _packagejsonmodel.PackageJson;
-    },
-    get Project () {
-        return _projectmodel.Project;
-    },
-    get ProjectFactory () {
-        return _projectfactory.ProjectFactory;
-    },
-    get Tsconfig () {
-        return _tsconfigmodel.Tsconfig;
-    },
-    get UserConfigFactory () {
-        return _configfactory.UserConfigFactory;
-    },
-    get WORKSPACE_CONFIG () {
-        return _const.WORKSPACE_CONFIG;
-    },
-    get Workspace () {
-        return _workspacemodel.Workspace;
-    },
-    get WorkspaceConfigurationError () {
-        return _errors.WorkspaceConfigurationError;
-    },
-    get WorkspaceDefaults () {
-        return _const.WorkspaceDefaults;
-    },
-    get WorkspaceFactory () {
-        return _workspacefactory.WorkspaceFactory;
-    },
-    get findWorkspaceRoot () {
-        return _findworkspaceroot.findWorkspaceRoot;
-    },
-    get packageAliases () {
-        return _packagealiases.packageAliases;
-    },
-    get sourceExtensions () {
-        return _sourceextensions.sourceExtensions;
-    }
-});
-const _const = require("./const.js");
-const _errors = require("./errors.js");
-const _configfactory = require("./factories/config.factory.js");
-const _findworkspaceroot = require("./factories/find-workspace-root.js");
-const _projectfactory = require("./factories/project.factory.js");
-const _workspacefactory = require("./factories/workspace.factory.js");
-const _haspackagejsonmixin = require("./models/has-package-json.mixin.js");
-const _hastsconfigmixin = require("./models/has-tsconfig.mixin.js");
-const _packagealiases = require("./models/package-aliases.js");
-const _packagejsonmodel = require("./models/package-json.model.js");
-const _projectmodel = require("./models/project.model.js");
-const _sourceextensions = require("./models/source-extensions.js");
-const _tsconfigmodel = require("./models/tsconfig.model.js");
-const _workspacemodel = require("./models/workspace.model.js");

package/commonjs/src/models/has-package-json.mixin.js

@@ -1,50 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-Object.defineProperty(exports, "HasPackageJson", {
-    enumerable: true,
-    get: function() {
-        return HasPackageJson;
-    }
-});
-const _nodepath = /*#__PURE__*/ _interop_require_default(require("node:path"));
-const _caching = require("@decohere/core/caching");
-const _io = require("@decohere/core/io");
-const _const = require("../const.js");
-const _packagejsonmodel = require("./package-json.model.js");
-function _interop_require_default(obj) {
-    return obj && obj.__esModule ? obj : {
-        default: obj
-    };
-}
-function _ts_decorate(decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for(var i = decorators.length - 1; i >= 0; i--)if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-    return c > 3 && r && Object.defineProperty(target, key, r), r;
-}
-function _ts_metadata(k, v) {
-    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
-}
-class HasPackageJson {
-    async getPackageJson() {
-        return new _packagejsonmodel.PackageJson(await _io.io.readJsonFile(_nodepath.default.join(this.packageJsonDirectory, _const.PACKAGE_JSON)));
-    }
-    get packageJsonPath() {
-        return _nodepath.default.join(this.packageJsonDirectory, _const.PACKAGE_JSON);
-    }
-    async getVersion() {
-        return (await this.getPackageJson()).version;
-    }
-    async persistPackageJson(packageJson) {
-        await _io.io.writeFile(this.packageJsonPath, packageJson.toJSON());
-        _caching.invalidateMemoize.evict(this, HasPackageJson.prototype.getPackageJson);
-    }
-}
-_ts_decorate([
-    (0, _caching.memoize)(),
-    _ts_metadata("design:type", Function),
-    _ts_metadata("design:paramtypes", []),
-    _ts_metadata("design:returntype", Promise)
-], HasPackageJson.prototype, "getPackageJson", null);