create-brepjs 0.1.0

package/bin/create-brepjs.mjs

@@ -0,0 +1,67 @@
+#!/usr/bin/env node
+/**
+ * create-brepjs — scaffold a brepjs + brepjs-families project.
+ *
+ *   npm create brepjs@latest my-project
+ *
+ * Copies the template (package.json, tsconfig, a working src/main.ts) into
+ * the target directory and prints the copy-in next steps (`npx brepjs add`).
+ */
+
+import { cp, mkdir, readFile, readdir, rename, writeFile } from 'node:fs/promises';
+import { join, dirname, resolve } from 'node:path';
+import { fileURLToPath } from 'node:url';
+import process from 'node:process';
+
+const TEMPLATES = join(dirname(fileURLToPath(import.meta.url)), '../templates');
+
+async function main() {
+  const name = process.argv[2] ?? 'brepjs-app';
+  // A relative path is allowed; its basename becomes the package name. No
+  // traversal, no absolute paths, no scopes (a scope is not a directory).
+  const segments = name.split('/');
+  const base = segments[segments.length - 1] ?? '';
+  const valid =
+    !name.startsWith('/') &&
+    !name.endsWith('/') &&
+    segments.every((s) => /^[a-z0-9][a-z0-9-_.]*$/.test(s) && s !== '.' && s !== '..');
+  if (!valid) {
+    console.error(
+      `create-brepjs: invalid project name '${name}' (relative path ending in a lowercase package name; no '..', no scopes)`
+    );
+    process.exitCode = 1;
+    return;
+  }
+  const target = resolve(name);
+  const existing = await readdir(target).catch(() => null);
+  if (existing !== null && existing.length > 0) {
+    console.error(`create-brepjs: target directory is not empty: ${target}`);
+    process.exitCode = 1;
+    return;
+  }
+
+  await mkdir(target, { recursive: true });
+  await cp(TEMPLATES, target, { recursive: true });
+  // npm mangles nested package.json files in published packages; the template
+  // ships under a neutral name and is renamed on scaffold.
+  await rename(join(target, 'package.json.tpl'), join(target, 'package.json'));
+  // npm drops .gitignore from published tarballs; ship under a neutral name.
+  await rename(join(target, 'gitignore'), join(target, '.gitignore'));
+  const pkgPath = join(target, 'package.json');
+  const pkg = JSON.parse(await readFile(pkgPath, 'utf8'));
+  pkg.name = base;
+  await writeFile(pkgPath, `${JSON.stringify(pkg, null, 2)}\n`);
+
+  console.warn(`Scaffolded ${target}`);
+  console.warn('');
+  console.warn('Next steps:');
+  console.warn(`  cd ${name}`);
+  console.warn('  npm install');
+  console.warn('  npx brepjs add room storey slab   # copy in starter families');
+  console.warn('  npx tsx src/main.ts');
+}
+
+main().catch((err) => {
+  console.error(`create-brepjs: ${err instanceof Error ? err.message : String(err)}`);
+  process.exitCode = 1;
+});

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "create-brepjs",
+  "version": "0.1.0",
+  "description": "Scaffold a brepjs + brepjs-families project (npm create brepjs)",
+  "keywords": [
+    "cad",
+    "bim",
+    "create",
+    "scaffold"
+  ],
+  "type": "module",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/andymai/brepjs.git",
+    "directory": "packages/create-brepjs"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "bin": {
+    "create-brepjs": "bin/create-brepjs.mjs"
+  },
+  "files": [
+    "bin",
+    "templates"
+  ],
+  "engines": {
+    "node": ">=20"
+  }
+}

package/templates/README.md

@@ -0,0 +1,13 @@
+# brepjs-app
+
+A [brepjs](https://github.com/andymai/brepjs) + brepjs-families project.
+
+```sh
+npm install
+npm start                          # evaluate src/main.ts and print mesh stats
+npx brepjs add room storey slab    # copy starter families into src/families/
+npx brepjs diff room               # compare a copied family against the registry
+```
+
+Families copied in by `brepjs add` are yours: edit them freely. `brepjs diff`
+compares your copies against the registry when you want to see upstream drift.

package/templates/gitignore

@@ -0,0 +1,3 @@
+node_modules
+dist
+*.log

package/templates/package.json.tpl

@@ -0,0 +1,18 @@
+{
+  "name": "brepjs-app",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "start": "tsx src/main.ts",
+    "typecheck": "tsc --noEmit"
+  },
+  "dependencies": {
+    "brepjs": "^18.0.0",
+    "brepjs-families": "^0.1.0",
+    "zod": "^4.0.0"
+  },
+  "devDependencies": {
+    "tsx": "^4.0.0",
+    "typescript": "^5.0.0"
+  }
+}

package/templates/src/main.ts

@@ -0,0 +1,40 @@
+/**
+ * A minimal brepjs-families model: a wall with a doorway, resolved to an
+ * element tree and materialized as a mesh. Run with `npm start`.
+ *
+ * Copy in richer starter families with `npx brepjs add room storey slab` —
+ * they land in src/families/ as code you own.
+ */
+
+import 'brepjs/quick';
+import { csg } from 'brepjs';
+import { family, el, resolve, evaluateModel, tTranslate } from 'brepjs-families';
+
+const Doorway = family<{ readonly width: number; readonly height: number; readonly at: number }>(
+  'Doorway',
+  (p) =>
+    el('Box', {
+      size: [p.width, 300, p.height],
+      transform: [tTranslate([p.at, 0, 0])],
+    }),
+  { role: 'fill' }
+);
+
+const Wall = family<{ readonly length: number; readonly height: number }>('Wall', (p) =>
+  el('Box', {
+    size: [p.length, 200, p.height],
+    voids: [Doorway({ key: 'door', width: 1000, height: 2100, at: 1500 })],
+  })
+);
+
+using evaluator = new csg.Evaluator();
+const model = evaluateModel(resolve(Wall({ key: 'wall-1', length: 4000, height: 2700 })), evaluator);
+
+for (const [keyPath, node] of model.byKeyPath) {
+  if (node.mesh.ok) {
+    const triangles = node.mesh.value.triangles.length / 3;
+    console.log(`${keyPath}: ${triangles} triangles`);
+  } else {
+    console.error(`${keyPath}: ${node.mesh.error.message}`);
+  }
+}

package/templates/tsconfig.json

@@ -0,0 +1,12 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "strict": true,
+    "skipLibCheck": true,
+    "noEmit": true,
+    "allowImportingTsExtensions": false
+  },
+  "include": ["src"]
+}