create-macroscope 0.0.0

package/README.md

@@ -0,0 +1,10 @@
+# create-macroscope
+
+Project initializer for macroscope. Run via `npm create macroscope` — npm transparently maps this to `npx create-macroscope`.
+
+```bash
+npm create macroscope my-project
+cd my-project
+npm install
+npm run macroscope ui
+```

package/dist/index.d.ts

@@ -0,0 +1,15 @@
+#!/usr/bin/env node
+interface ScaffoldOptions {
+    target: string;
+    template: string;
+    force: boolean;
+    json: boolean;
+}
+declare function scaffold(opts: ScaffoldOptions): Promise<{
+    ok: boolean;
+    target: string;
+    files: string[];
+}>;
+declare function main(argv?: string[]): Promise<void>;
+
+export { main, scaffold };

package/dist/index.js

@@ -0,0 +1,101 @@
+#!/usr/bin/env node
+
+// src/index.ts
+import { existsSync, realpathSync } from "fs";
+import { cp, mkdir } from "fs/promises";
+import { dirname, join, resolve } from "path";
+import { fileURLToPath } from "url";
+import { Command } from "commander";
+var here = dirname(fileURLToPath(import.meta.url));
+var TEMPLATES_DIR = resolve(here, "..", "templates");
+async function scaffold(opts) {
+  const target = resolve(opts.target);
+  const templateDir = join(TEMPLATES_DIR, opts.template);
+  if (!existsSync(templateDir)) {
+    throw new Error(`Template not found: ${opts.template} (looked in ${templateDir})`);
+  }
+  if (existsSync(target) && !opts.force) {
+    if (existsSync(join(target, ".macroscope"))) {
+      throw new Error(
+        `Target already contains a .macroscope directory: ${target}. Pass --force to overwrite.`
+      );
+    }
+  }
+  await mkdir(target, { recursive: true });
+  await cp(templateDir, target, { recursive: true, force: opts.force });
+  const files = await listFilesRecursive(target);
+  return { ok: true, target, files };
+}
+async function listFilesRecursive(dir) {
+  const { readdir, stat } = await import("fs/promises");
+  const out = [];
+  async function walk(d, prefix) {
+    const entries = await readdir(d);
+    for (const entry of entries) {
+      const full = join(d, entry);
+      const rel = prefix ? `${prefix}/${entry}` : entry;
+      const s = await stat(full);
+      if (s.isDirectory()) {
+        await walk(full, rel);
+      } else {
+        out.push(rel);
+      }
+    }
+  }
+  await walk(dir, "");
+  return out.sort();
+}
+async function main(argv = process.argv) {
+  const program = new Command();
+  program.name("create-macroscope").description("Scaffold a macroscope-enabled project").argument("[target]", "target directory (defaults to current dir)", ".").option("-t, --template <name>", "template to use", "default").option("-f, --force", "overwrite existing files", false).option("--json", "output machine-readable JSON", false).action(async (target, opts) => {
+    try {
+      const result = await scaffold({
+        target,
+        template: opts.template,
+        force: opts.force,
+        json: opts.json
+      });
+      if (opts.json) {
+        process.stdout.write(`${JSON.stringify(result)}
+`);
+      } else {
+        process.stdout.write(`Scaffolded macroscope project at ${result.target}
+`);
+        process.stdout.write(`  ${result.files.length} files created
+`);
+        process.stdout.write(
+          `Next: cd ${result.target} && npm install && npm run macroscope ui
+`
+        );
+      }
+    } catch (err) {
+      const msg = err instanceof Error ? err.message : String(err);
+      if (opts.json) {
+        process.stderr.write(`${JSON.stringify({ ok: false, error: msg })}
+`);
+      } else {
+        process.stderr.write(`create-macroscope: ${msg}
+`);
+      }
+      process.exit(1);
+    }
+  });
+  await program.parseAsync(argv);
+}
+var invokedDirectly = (() => {
+  const entry = process.argv[1];
+  if (!entry) return false;
+  try {
+    return realpathSync(entry) === fileURLToPath(import.meta.url);
+  } catch {
+    return false;
+  }
+})();
+if (invokedDirectly) {
+  main();
+}
+export {
+  main,
+  scaffold
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["#!/usr/bin/env node\nimport { existsSync, realpathSync } from 'node:fs';\nimport { cp, mkdir, readFile, writeFile } from 'node:fs/promises';\nimport { dirname, join, resolve } from 'node:path';\nimport { fileURLToPath } from 'node:url';\nimport { Command } from 'commander';\n\nconst here = dirname(fileURLToPath(import.meta.url));\nconst TEMPLATES_DIR = resolve(here, '..', 'templates');\n\ninterface ScaffoldOptions {\n  target: string;\n  template: string;\n  force: boolean;\n  json: boolean;\n}\n\nexport async function scaffold(\n  opts: ScaffoldOptions,\n): Promise<{ ok: boolean; target: string; files: string[] }> {\n  const target = resolve(opts.target);\n  const templateDir = join(TEMPLATES_DIR, opts.template);\n\n  if (!existsSync(templateDir)) {\n    throw new Error(`Template not found: ${opts.template} (looked in ${templateDir})`);\n  }\n\n  if (existsSync(target) && !opts.force) {\n    if (existsSync(join(target, '.macroscope'))) {\n      throw new Error(\n        `Target already contains a .macroscope directory: ${target}. Pass --force to overwrite.`,\n      );\n    }\n  }\n\n  await mkdir(target, { recursive: true });\n  await cp(templateDir, target, { recursive: true, force: opts.force });\n\n  // Discover what was copied so tests + JSON output can assert it.\n  const files = await listFilesRecursive(target);\n  return { ok: true, target, files };\n}\n\nasync function listFilesRecursive(dir: string): Promise<string[]> {\n  const { readdir, stat } = await import('node:fs/promises');\n  const out: string[] = [];\n  async function walk(d: string, prefix: string): Promise<void> {\n    const entries = await readdir(d);\n    for (const entry of entries) {\n      const full = join(d, entry);\n      const rel = prefix ? `${prefix}/${entry}` : entry;\n      const s = await stat(full);\n      if (s.isDirectory()) {\n        await walk(full, rel);\n      } else {\n        out.push(rel);\n      }\n    }\n  }\n  await walk(dir, '');\n  return out.sort();\n}\n\nexport async function main(argv: string[] = process.argv): Promise<void> {\n  const program = new Command();\n\n  program\n    .name('create-macroscope')\n    .description('Scaffold a macroscope-enabled project')\n    .argument('[target]', 'target directory (defaults to current dir)', '.')\n    .option('-t, --template <name>', 'template to use', 'default')\n    .option('-f, --force', 'overwrite existing files', false)\n    .option('--json', 'output machine-readable JSON', false)\n    .action(async (target: string, opts: { template: string; force: boolean; json: boolean }) => {\n      try {\n        const result = await scaffold({\n          target,\n          template: opts.template,\n          force: opts.force,\n          json: opts.json,\n        });\n        if (opts.json) {\n          process.stdout.write(`${JSON.stringify(result)}\\n`);\n        } else {\n          process.stdout.write(`Scaffolded macroscope project at ${result.target}\\n`);\n          process.stdout.write(`  ${result.files.length} files created\\n`);\n          process.stdout.write(\n            `Next: cd ${result.target} && npm install && npm run macroscope ui\\n`,\n          );\n        }\n      } catch (err) {\n        const msg = err instanceof Error ? err.message : String(err);\n        if (opts.json) {\n          process.stderr.write(`${JSON.stringify({ ok: false, error: msg })}\\n`);\n        } else {\n          process.stderr.write(`create-macroscope: ${msg}\\n`);\n        }\n        process.exit(1);\n      }\n    });\n\n  await program.parseAsync(argv);\n}\n\nconst invokedDirectly = (() => {\n  const entry = process.argv[1];\n  if (!entry) return false;\n  try {\n    return realpathSync(entry) === fileURLToPath(import.meta.url);\n  } catch {\n    return false;\n  }\n})();\n\nif (invokedDirectly) {\n  main();\n}\n"],"mappings":";;;AACA,SAAS,YAAY,oBAAoB;AACzC,SAAS,IAAI,aAAkC;AAC/C,SAAS,SAAS,MAAM,eAAe;AACvC,SAAS,qBAAqB;AAC9B,SAAS,eAAe;AAExB,IAAM,OAAO,QAAQ,cAAc,YAAY,GAAG,CAAC;AACnD,IAAM,gBAAgB,QAAQ,MAAM,MAAM,WAAW;AASrD,eAAsB,SACpB,MAC2D;AAC3D,QAAM,SAAS,QAAQ,KAAK,MAAM;AAClC,QAAM,cAAc,KAAK,eAAe,KAAK,QAAQ;AAErD,MAAI,CAAC,WAAW,WAAW,GAAG;AAC5B,UAAM,IAAI,MAAM,uBAAuB,KAAK,QAAQ,eAAe,WAAW,GAAG;AAAA,EACnF;AAEA,MAAI,WAAW,MAAM,KAAK,CAAC,KAAK,OAAO;AACrC,QAAI,WAAW,KAAK,QAAQ,aAAa,CAAC,GAAG;AAC3C,YAAM,IAAI;AAAA,QACR,oDAAoD,MAAM;AAAA,MAC5D;AAAA,IACF;AAAA,EACF;AAEA,QAAM,MAAM,QAAQ,EAAE,WAAW,KAAK,CAAC;AACvC,QAAM,GAAG,aAAa,QAAQ,EAAE,WAAW,MAAM,OAAO,KAAK,MAAM,CAAC;AAGpE,QAAM,QAAQ,MAAM,mBAAmB,MAAM;AAC7C,SAAO,EAAE,IAAI,MAAM,QAAQ,MAAM;AACnC;AAEA,eAAe,mBAAmB,KAAgC;AAChE,QAAM,EAAE,SAAS,KAAK,IAAI,MAAM,OAAO,aAAkB;AACzD,QAAM,MAAgB,CAAC;AACvB,iBAAe,KAAK,GAAW,QAA+B;AAC5D,UAAM,UAAU,MAAM,QAAQ,CAAC;AAC/B,eAAW,SAAS,SAAS;AAC3B,YAAM,OAAO,KAAK,GAAG,KAAK;AAC1B,YAAM,MAAM,SAAS,GAAG,MAAM,IAAI,KAAK,KAAK;AAC5C,YAAM,IAAI,MAAM,KAAK,IAAI;AACzB,UAAI,EAAE,YAAY,GAAG;AACnB,cAAM,KAAK,MAAM,GAAG;AAAA,MACtB,OAAO;AACL,YAAI,KAAK,GAAG;AAAA,MACd;AAAA,IACF;AAAA,EACF;AACA,QAAM,KAAK,KAAK,EAAE;AAClB,SAAO,IAAI,KAAK;AAClB;AAEA,eAAsB,KAAK,OAAiB,QAAQ,MAAqB;AACvE,QAAM,UAAU,IAAI,QAAQ;AAE5B,UACG,KAAK,mBAAmB,EACxB,YAAY,uCAAuC,EACnD,SAAS,YAAY,8CAA8C,GAAG,EACtE,OAAO,yBAAyB,mBAAmB,SAAS,EAC5D,OAAO,eAAe,4BAA4B,KAAK,EACvD,OAAO,UAAU,gCAAgC,KAAK,EACtD,OAAO,OAAO,QAAgB,SAA8D;AAC3F,QAAI;AACF,YAAM,SAAS,MAAM,SAAS;AAAA,QAC5B;AAAA,QACA,UAAU,KAAK;AAAA,QACf,OAAO,KAAK;AAAA,QACZ,MAAM,KAAK;AAAA,MACb,CAAC;AACD,UAAI,KAAK,MAAM;AACb,gBAAQ,OAAO,MAAM,GAAG,KAAK,UAAU,MAAM,CAAC;AAAA,CAAI;AAAA,MACpD,OAAO;AACL,gBAAQ,OAAO,MAAM,oCAAoC,OAAO,MAAM;AAAA,CAAI;AAC1E,gBAAQ,OAAO,MAAM,KAAK,OAAO,MAAM,MAAM;AAAA,CAAkB;AAC/D,gBAAQ,OAAO;AAAA,UACb,YAAY,OAAO,MAAM;AAAA;AAAA,QAC3B;AAAA,MACF;AAAA,IACF,SAAS,KAAK;AACZ,YAAM,MAAM,eAAe,QAAQ,IAAI,UAAU,OAAO,GAAG;AAC3D,UAAI,KAAK,MAAM;AACb,gBAAQ,OAAO,MAAM,GAAG,KAAK,UAAU,EAAE,IAAI,OAAO,OAAO,IAAI,CAAC,CAAC;AAAA,CAAI;AAAA,MACvE,OAAO;AACL,gBAAQ,OAAO,MAAM,sBAAsB,GAAG;AAAA,CAAI;AAAA,MACpD;AACA,cAAQ,KAAK,CAAC;AAAA,IAChB;AAAA,EACF,CAAC;AAEH,QAAM,QAAQ,WAAW,IAAI;AAC/B;AAEA,IAAM,mBAAmB,MAAM;AAC7B,QAAM,QAAQ,QAAQ,KAAK,CAAC;AAC5B,MAAI,CAAC,MAAO,QAAO;AACnB,MAAI;AACF,WAAO,aAAa,KAAK,MAAM,cAAc,YAAY,GAAG;AAAA,EAC9D,QAAQ;AACN,WAAO;AAAA,EACT;AACF,GAAG;AAEH,IAAI,iBAAiB;AACnB,OAAK;AACP;","names":[]}

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "create-macroscope",
+  "version": "0.0.0",
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "description": "Scaffold a macroscope-enabled project (run via `npm create macroscope`)",
+  "license": "MIT",
+  "type": "module",
+  "engines": {
+    "node": ">=20"
+  },
+  "bin": {
+    "create-macroscope": "dist/index.js"
+  },
+  "files": ["dist", "templates", "README.md"],
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "test": "vitest run",
+    "typecheck": "tsc --noEmit"
+  },
+  "dependencies": {
+    "commander": "^12.1.0"
+  },
+  "devDependencies": {
+    "@types/node": "^22.7.0",
+    "tsup": "^8.3.0",
+    "typescript": "^5.6.0",
+    "vitest": "^2.1.0"
+  }
+}

package/templates/default/.macroscope/config.yaml

@@ -0,0 +1,8 @@
+# Macroscope project config. Edit to tune scanner behavior.
+scanRoots:
+  - blocks
+ignore:
+  - node_modules
+  - .git
+  - dist
+  - .macroscope

package/templates/default/README.md

@@ -0,0 +1,10 @@
+# my-macroscope-project
+
+Scaffolded by `create-macroscope`. Run:
+
+```bash
+npm install
+npm run macroscope ui
+```
+
+Your blocks live under `blocks/`. Each block is a folder containing a `macroscope.yaml` manifest.

package/templates/default/blocks/sample/README.md

@@ -0,0 +1,5 @@
+# Sample block
+
+This is your first macroscope block. Run `npm run macroscope ui` to see it in the catalogue.
+
+Edit this README, change `macroscope.yaml`, or copy this folder to start authoring your own blocks.

package/templates/default/blocks/sample/macroscope.yaml

@@ -0,0 +1,7 @@
+name: SampleBlock
+description: A starter block to verify your macroscope setup works
+kind: markdown
+tags:
+  - sample
+  - getting-started
+docs: README.md

package/templates/default/package.json

@@ -0,0 +1,12 @@
+{
+  "name": "my-macroscope-project",
+  "version": "0.0.0",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "macroscope": "macroscope"
+  },
+  "devDependencies": {
+    "@macroscope/cli": "^0.0.0"
+  }
+}