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

package/README.md

@@ -4,10 +4,12 @@ Workspace and project model for Decohere tooling. Forge and Flux call it to find
 
 ## Workspace layout
 
-A **project** is a directory whose root contains a `package.json`. The workspace package discovers those files with `includeProjects` globs (cwd = the workspace root, usually `process.cwd()`).
+A **project** is a directory whose root contains a `package.json`. The workspace package discovers those files with `includeProjects` globs from the workspace root: the folder the tool runs in. Nothing searches the folders above it; to run from elsewhere, pass `--root-dir <dir>` to `forge` or `flux`.
 
 The workspace root may also have a `package.json`. That file is workspace metadata (name/version). It is **not** a project unless it also matches `includeProjects`.
 
+**Standalone projects.** A folder with a `package.json` and no `projects/` folder, and no `includeProjects` of your own, is one project: its root `package.json` is the package, with its sources at the root (build output, `node_modules` and `.git` excluded). Every tool works on that one package; `forge dependencies sync`, `dependencies report` and `paths` have nothing to do, since there is no other package. Adding a `projects/` folder turns it into a monorepo: move the sources into `projects/<name>/` with their own `package.json`.
+
 ### Defaults
 
 | Option | Default |
@@ -42,7 +44,7 @@ export default {
 
 Per-project settings go under `projects`, keyed by package name: `docker` (image, Dockerfile, tags, build args) and `ui` (the UI project a deployable ships, see [forge](../forge/README.md#shipping-the-ui-with-the-api)).
 
-`--config-file` on `forge` / `flux` selects a different config path. The default filename is still `.decohere.js`.
+`--config-file` on `forge` / `flux` selects a different config path. The default is `.decohere.js` in the workspace root (`--root-dir`, else the current folder).
 
 ### Package aliases
 

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

@@ -12,6 +12,7 @@ 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 _const = require("../const.js");
 const _errors = require("../errors.js");
 const _packagejsonmodel = require("../models/package-json.model.js");
 const _projectmodel = require("../models/project.model.js");
@@ -29,9 +30,39 @@ class ProjectFactory {
             ignore: ignoreProjects
         });
         const packageJsonFiles = ProjectFactory.filterNestedPackageJsonFiles(discoveredPackageJsonFiles);
+        if (packageJsonFiles.length === 0 && await ProjectFactory.isStandalone(config)) {
+            return [
+                await ProjectFactory.standaloneProject(config)
+            ];
+        }
         const projects = await Promise.all(packageJsonFiles.map((file)=>ProjectFactory.projectFrom(file, config)));
         return projects.sort((a, b)=>a.name.localeCompare(b.name));
     }
+    /**
+	 * A standalone project: no `projects/` folder and no `includeProjects` of the user's own, but
+	 * a root `package.json`. That `package.json` is then the one project, at the root.
+	 */ static async isStandalone(config) {
+        const rootDir = config.rootDir ?? "./";
+        const defaultInclude = JSON.stringify(config.includeProjects) === JSON.stringify(_const.WorkspaceDefaults.includeProjects);
+        return defaultInclude && !await _io.io.directoryExists(_nodepath.default.join(rootDir, _const.PROJECTS_DIR)) && await _io.io.fileExists(_nodepath.default.join(rootDir, _const.PACKAGE_JSON));
+    }
+    /** The root `package.json` as the one project. Build output and `.git` aren't its sources. */ static async standaloneProject(config) {
+        const [packageJsonFile] = await (0, _io1.findFiles)([
+            _const.PACKAGE_JSON
+        ], {
+            cwd: config.rootDir ?? "./"
+        });
+        const outDir = (config.outDir ?? _const.WorkspaceDefaults.outDir).replace(/[/\\]+$/, "");
+        const ignore = [
+            ...config.ignore ?? [],
+            `${outDir}/**`,
+            ".git/**"
+        ];
+        return ProjectFactory.projectFrom(packageJsonFile, {
+            ...config,
+            ignore
+        });
+    }
     static filterNestedPackageJsonFiles(files) {
         const normalize = (filePath)=>filePath.replaceAll("\\", "/");
         const packageJsonSet = new Set(files.map((file)=>normalize(file.relativePath)));

package/commonjs/src/index.js

@@ -48,9 +48,6 @@ _export(exports, {
     get WorkspaceFactory () {
         return _workspacefactory.WorkspaceFactory;
     },
-    get findWorkspaceRoot () {
-        return _findworkspaceroot.findWorkspaceRoot;
-    },
     get packageAliases () {
         return _packagealiases.packageAliases;
     },
@@ -61,7 +58,6 @@ _export(exports, {
 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");

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

@@ -68,6 +68,13 @@ class Workspace extends (0, _extensibility.mixwith)(_haspackagejsonmixin.HasPack
     get rootDir() {
         return this.#config.rootDir ?? "./";
     }
+    /**
+	 * One project, whose `package.json` is the root's: a folder without `projects/`. Commands
+	 * that write a project's manifest from the root's (dependency sync) or map projects to each
+	 * other (paths) have nothing to do then.
+	 */ get isStandalone() {
+        return this.#projectSeeds.length === 1 && this.#projectSeeds[0]?.config?.projectDir === ".";
+    }
     get packageJsonDirectory() {
         return this.rootDir;
     }

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

@@ -2,6 +2,7 @@ import path from "node:path";
 import { io } from "@decohere/core/io";
 import { findFiles } from "@decohere/devkit/io";
 import { merge } from "@decohere/core/objects";
+import { PACKAGE_JSON, PROJECTS_DIR, WorkspaceDefaults } from "../const.js";
 import { WorkspaceConfigurationError } from "../errors.js";
 import { PackageJson } from "../models/package-json.model.js";
 import { Project } from "../models/project.model.js";
@@ -14,9 +15,39 @@ export class ProjectFactory {
             ignore: ignoreProjects
         });
         const packageJsonFiles = ProjectFactory.filterNestedPackageJsonFiles(discoveredPackageJsonFiles);
+        if (packageJsonFiles.length === 0 && await ProjectFactory.isStandalone(config)) {
+            return [
+                await ProjectFactory.standaloneProject(config)
+            ];
+        }
         const projects = await Promise.all(packageJsonFiles.map((file)=>ProjectFactory.projectFrom(file, config)));
         return projects.sort((a, b)=>a.name.localeCompare(b.name));
     }
+    /**
+	 * A standalone project: no `projects/` folder and no `includeProjects` of the user's own, but
+	 * a root `package.json`. That `package.json` is then the one project, at the root.
+	 */ static async isStandalone(config) {
+        const rootDir = config.rootDir ?? "./";
+        const defaultInclude = JSON.stringify(config.includeProjects) === JSON.stringify(WorkspaceDefaults.includeProjects);
+        return defaultInclude && !await io.directoryExists(path.join(rootDir, PROJECTS_DIR)) && await io.fileExists(path.join(rootDir, PACKAGE_JSON));
+    }
+    /** The root `package.json` as the one project. Build output and `.git` aren't its sources. */ static async standaloneProject(config) {
+        const [packageJsonFile] = await findFiles([
+            PACKAGE_JSON
+        ], {
+            cwd: config.rootDir ?? "./"
+        });
+        const outDir = (config.outDir ?? WorkspaceDefaults.outDir).replace(/[/\\]+$/, "");
+        const ignore = [
+            ...config.ignore ?? [],
+            `${outDir}/**`,
+            ".git/**"
+        ];
+        return ProjectFactory.projectFrom(packageJsonFile, {
+            ...config,
+            ignore
+        });
+    }
     static filterNestedPackageJsonFiles(files) {
         const normalize = (filePath)=>filePath.replaceAll("\\", "/");
         const packageJsonSet = new Set(files.map((file)=>normalize(file.relativePath)));

package/es6/src/index.js

@@ -1,7 +1,6 @@
 export { WORKSPACE_CONFIG, WorkspaceDefaults } from "./const.js";
 export { WorkspaceConfigurationError } from "./errors.js";
 export { UserConfigFactory } from "./factories/config.factory.js";
-export { findWorkspaceRoot } from "./factories/find-workspace-root.js";
 export { ProjectFactory } from "./factories/project.factory.js";
 export { WorkspaceFactory } from "./factories/workspace.factory.js";
 export { HasPackageJson } from "./models/has-package-json.mixin.js";

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

@@ -58,6 +58,13 @@ export class Workspace extends mixwith(HasPackageJson, HasTsConfig) {
     get rootDir() {
         return this.#config.rootDir ?? "./";
     }
+    /**
+	 * One project, whose `package.json` is the root's: a folder without `projects/`. Commands
+	 * that write a project's manifest from the root's (dependency sync) or map projects to each
+	 * other (paths) have nothing to do then.
+	 */ get isStandalone() {
+        return this.#projectSeeds.length === 1 && this.#projectSeeds[0]?.config?.projectDir === ".";
+    }
     get packageJsonDirectory() {
         return this.rootDir;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@decohere/workspace",
-  "version": "0.0.1-dev.128",
+  "version": "0.0.1-dev.130",
   "description": "Workspace and project model primitives for monorepo tooling",
   "keywords": [
     "typescript",
@@ -33,9 +33,9 @@
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "dependencies": {
-    "@decohere/core": "0.0.1-dev.128",
-    "@decohere/crucible": "0.0.1-dev.128",
-    "@decohere/devkit": "0.0.1-dev.128",
+    "@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"

package/types/src/factories/project.factory.d.ts

@@ -2,6 +2,13 @@ import { Project, type ProjectSeed } from "../models/project.model.js";
 import type { WorkspaceOptions } from "../models/workspace-config.type.js";
 export declare class ProjectFactory {
     static getProjectSeeds(config: WorkspaceOptions): Promise<ProjectSeed[]>;
+    /**
+     * A standalone project: no `projects/` folder and no `includeProjects` of the user's own, but
+     * a root `package.json`. That `package.json` is then the one project, at the root.
+     */
+    private static isStandalone;
+    /** The root `package.json` as the one project. Build output and `.git` aren't its sources. */
+    private static standaloneProject;
     private static filterNestedPackageJsonFiles;
     static getProjects(config: WorkspaceOptions, configuration?: string): Promise<Project[]>;
     private static projectFrom;

package/types/src/index.d.ts

@@ -1,7 +1,6 @@
 export { WORKSPACE_CONFIG, WorkspaceDefaults } from "./const.js";
 export { WorkspaceConfigurationError } from "./errors.js";
 export { UserConfigFactory } from "./factories/config.factory.js";
-export { findWorkspaceRoot } from "./factories/find-workspace-root.js";
 export { ProjectFactory } from "./factories/project.factory.js";
 export { WorkspaceFactory } from "./factories/workspace.factory.js";
 export { HasPackageJson } from "./models/has-package-json.mixin.js";

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

@@ -19,6 +19,12 @@ export declare class Workspace extends Workspace_base {
     protected get projectSeeds(): readonly ProjectSeed[];
     getProjects(configuration: string): readonly Project[];
     get rootDir(): string;
+    /**
+     * One project, whose `package.json` is the root's: a folder without `projects/`. Commands
+     * that write a project's manifest from the root's (dependency sync) or map projects to each
+     * other (paths) have nothing to do then.
+     */
+    get isStandalone(): boolean;
     get packageJsonDirectory(): string;
     protected get tsConfigDirectory(): string;
     protected get fallbackTsConfigDirectory(): string | undefined;

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/es6/src/factories/find-workspace-root.js

@@ -1,26 +0,0 @@
-import { existsSync, statSync } from "node:fs";
-import path from "node:path";
-import { PACKAGE_JSON, PROJECTS_DIR } from "../const.js";
-/**
- * The workspace root for a command run from `startDir`: the nearest directory at or above
- * it with a `package.json` and a `projects/` folder. Falls back to `startDir`, so running
- * from a package directory (`projects/api`) still sees the whole workspace.
- */ export function findWorkspaceRoot(startDir) {
-    const start = path.resolve(startDir);
-    let dir = start;
-    for(;;){
-        if (existsSync(path.join(dir, PACKAGE_JSON)) && isDirectory(path.join(dir, PROJECTS_DIR))) {
-            return dir;
-        }
-        const parent = path.dirname(dir);
-        if (parent === dir) return start;
-        dir = parent;
-    }
-}
-function isDirectory(fullPath) {
-    try {
-        return statSync(fullPath).isDirectory();
-    } catch  {
-        return false;
-    }
-}

package/types/src/factories/find-workspace-root.d.ts

@@ -1,6 +0,0 @@
-/**
- * The workspace root for a command run from `startDir`: the nearest directory at or above
- * it with a `package.json` and a `projects/` folder. Falls back to `startDir`, so running
- * from a package directory (`projects/api`) still sees the whole workspace.
- */
-export declare function findWorkspaceRoot(startDir: string): string;