planning-space 0.0.1

package/README.md

@@ -0,0 +1,21 @@
+# planning-space
+
+CLI that creates a new [npm workspace](https://docs.npmjs.com/cli/using-npm/workspaces) inside your current project.
+
+## Usage
+
+```sh
+npx planning-space             # creates ./planning-space/ and registers it as a workspace
+npx planning-space my-folder   # creates ./my-folder/ instead
+```
+
+It will:
+
+- create the target folder with a minimal `package.json`;
+- add the folder to the `workspaces` array of the root `package.json`
+  in the current directory (creating that root file if it does not exist);
+- abort with an error if the target folder already exists.
+
+## License
+
+MIT

package/dist/cli.js

@@ -0,0 +1,49 @@
+#!/usr/bin/env node
+import { existsSync, mkdirSync, readFileSync, writeFileSync } from "node:fs";
+import { basename, dirname, join, resolve } from "node:path";
+import { fileURLToPath } from "node:url";
+const scriptDir = dirname(fileURLToPath(import.meta.url));
+const ownPkg = JSON.parse(readFileSync(join(scriptDir, "..", "package.json"), "utf8"));
+const requested = process.argv[2]?.trim();
+const workspaceName = requested && requested.length > 0 ? requested : ownPkg.name;
+// A workspace folder name must be filesystem- and package-name-safe.
+if (!/^[a-zA-Z0-9][a-zA-Z0-9._-]*$/.test(workspaceName)) {
+    console.error(`Error: invalid workspace name "${workspaceName}".`);
+    process.exit(1);
+}
+const cwd = process.cwd();
+const targetDir = resolve(cwd, workspaceName);
+if (targetDir === cwd || existsSync(targetDir)) {
+    console.error(`Error: folder "${workspaceName}" already exists. Aborting.`);
+    process.exit(1);
+}
+const rootPkgPath = join(cwd, "package.json");
+const rootPkg = existsSync(rootPkgPath)
+    ? JSON.parse(readFileSync(rootPkgPath, "utf8"))
+    : { name: basename(cwd), version: "0.0.0", private: true };
+// npm accepts `workspaces` as an array; some tools use `{ packages: [] }`.
+let workspaces;
+const ws = rootPkg.workspaces;
+if (Array.isArray(ws)) {
+    workspaces = ws;
+}
+else if (ws && typeof ws === "object" && Array.isArray(ws.packages)) {
+    workspaces = ws.packages;
+}
+else {
+    workspaces = [];
+    rootPkg.workspaces = workspaces;
+}
+if (!workspaces.includes(workspaceName)) {
+    workspaces.push(workspaceName);
+}
+mkdirSync(targetDir);
+const childPkg = {
+    name: workspaceName,
+    version: "0.0.0",
+    private: true,
+};
+writeFileSync(join(targetDir, "package.json"), `${JSON.stringify(childPkg, null, 2)}\n`);
+writeFileSync(rootPkgPath, `${JSON.stringify(rootPkg, null, 2)}\n`);
+console.log(`Created npm workspace "${workspaceName}" at ${targetDir}`);
+console.log(`Registered it in ${rootPkgPath}`);

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "planning-space",
+  "version": "0.0.1",
+  "description": "CLI that scaffolds a new npm workspace (default folder name \"planning-space\") inside the current project.",
+  "type": "module",
+  "bin": {
+    "planning-space": "dist/cli.js"
+  },
+  "files": [
+    "dist"
+  ],
+  "keywords": [
+    "workspace",
+    "workspaces",
+    "monorepo",
+    "scaffold",
+    "cli"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "prepublishOnly": "npm run build"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "license": "MIT"
+}