create-rulecad 0.1.2 → 0.2.1

package/README.md

@@ -8,4 +8,6 @@ npx cad check home/soap-tray
 
 Makes a [rulecad](https://github.com/JoniBach/rulecad) workspace with one design to start from: a soap tray with
 ribs and drain slots, every measurement a variable that names its rule. `--no-install` makes the files without
-running `npm install`.
+running `npm install`. It asks how you'll share models: short links keep each shared model in a secret GitHub Gist
+(needs the `gh` command, signed in); long links carry the model and upload nothing. `--share gist` or `--share long`
+answers in advance (without either, and with no one to ask, links stay long).

package/index.mjs

@@ -1,9 +1,13 @@
 #!/usr/bin/env node
 // npm create rulecad [folder]: a new rulecad workspace with a design to start from (a soap tray), then npm install.
 //   --no-install   make the files only
+//   --share gist   short model links: each model you share is stored in a secret GitHub Gist (needs gh, signed in)
+//   --share long   links that carry the whole model (nothing is uploaded; too long for chat on bigger models)
+// Without --share it asks, in a terminal; elsewhere it keeps links long, since nothing is uploaded without a choice.
 import fs from 'node:fs';
 import path from 'node:path';
-import { execSync } from 'node:child_process';
+import { execSync, execFileSync } from 'node:child_process';
+import readline from 'node:readline/promises';
 import { fileURLToPath } from 'node:url';
 
 const args = process.argv.slice(2), install = !args.includes('--no-install');
@@ -16,7 +20,7 @@ fs.renameSync(path.join(dir, 'gitignore'), path.join(dir, '.gitignore')); // npm
 const readme = path.join(dir, 'README.md');
 fs.writeFileSync(readme, fs.readFileSync(readme, 'utf8').replaceAll('NAME', name));
 // $RULECAD_LOCAL: a rulecad checkout to use instead of npm (to try unpublished changes)
-const from = (pkg) => (process.env.RULECAD_LOCAL ? `file:${path.join(path.resolve(process.env.RULECAD_LOCAL), 'packages', pkg)}` : '^0.1.0');
+const from = (pkg) => (process.env.RULECAD_LOCAL ? `file:${path.join(path.resolve(process.env.RULECAD_LOCAL), 'packages', pkg)}` : '^0.2.0');
 fs.writeFileSync(path.join(dir, 'package.json'), `${JSON.stringify({
   name, private: true, type: 'module',
   scripts: { check: 'cad check home/soap-tray' },
@@ -24,5 +28,24 @@ fs.writeFileSync(path.join(dir, 'package.json'), `${JSON.stringify({
 }, null, 2)}\n`);
 
 console.log(`made ${path.relative(process.cwd(), dir) || '.'}: a soap tray to start from, in projects/home`);
+
+// How models are shared: short links need somewhere to keep the model (a secret Gist); long links carry it
+let share = args.includes('--share') ? args[args.indexOf('--share') + 1] : null;
+if (share && !['gist', 'long'].includes(share)) { console.error(`--share is gist or long (got "${share}")`); process.exit(1); }
+if (!share && process.stdin.isTTY && process.stdout.isTTY) {
+  const rl = readline.createInterface({ input: process.stdin, output: process.stdout });
+  const a = await rl.question('\nModel links: short ones are easy to paste into chat, but each model you share is stored in a secret\nGitHub Gist (needs the gh command, signed in). Long ones carry the model and upload nothing. Short links? [y/N] ');
+  rl.close();
+  share = /^y/i.test(a.trim()) ? 'gist' : 'long';
+}
+if (share === 'gist') {
+  const cfg = path.join(dir, 'cad.config.json'), c = JSON.parse(fs.readFileSync(cfg, 'utf8'));
+  c.targets = { ...c.targets, shorten: 'gist' };
+  fs.writeFileSync(cfg, `${JSON.stringify(c, null, 2)}\n`);
+  let ready = true;
+  try { execFileSync('gh', ['auth', 'status'], { stdio: 'ignore' }); } catch { ready = false; }
+  console.log(ready ? 'short links: models you share go into secret Gists (unlisted: only people with the link find them)'
+    : 'short links are on, but the gh command isn\'t installed or signed in: install it from cli.github.com and run gh auth login');
+} else console.log(`model links carry the whole model${share ? '' : ' (no --share given)'}; for short ones later, add "shorten": "gist" to "targets" in cad.config.json`);
 if (install) execSync('npm install', { cwd: dir, stdio: 'inherit' });
 console.log(`\n  cd ${path.relative(process.cwd(), dir)}\n  npx cad check home/soap-tray\n  npx cad preview home/soap-tray\n\nREADME.md says what's where.`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-rulecad",
-  "version": "0.1.2",
+  "version": "0.2.1",
   "description": "Start a rulecad project: npm create rulecad my-designs. A workspace with a soap tray to start from, ready to check, preview, export and share.",
   "type": "module",
   "bin": {

package/template/AGENTS.md

@@ -47,10 +47,23 @@ variable says which rule it comes from. Follow these steps; they're what makes a
   with ranges from rules. An overlap or gap outside its range is a finding: report it with the numbers, and never
   widen a range to make it pass without saying why.
 - Build bigger things from checked assemblies used as items, rather than placing their objects again.
+- A part is named in fits as `<item>.<part>`; an object that returns one unnamed shape has one part, `body`.
+- A gap fit can't tell whether holes line up. Where a board screws into a part, add a holes fit
+  (`{ "holes": "pcb.board", "into": "case.body", "depth": "m2.insert_length" }`).
+- A part built around another (a case around its board) reads it: `"uses": ["node/carrier"]`, then
+  `carrier.board_w` and `v.carrier.board_holes`. Never copy another object's numbers by hand.
+
+## Circuit boards
+- `"engine": "pcb"` in the .json; `main(v)` returns a board built with `v.pcb` (see @rulecad/pcb's README).
+- Parts come from rule sets where one exists (`v.pcb.xiao`, `qwiic`, `jstph`, `header`), or any standard footprint by
+  name (`v.pcb.part('U2', 'soic8', x, y)`). Turn parts in quarter turns with `rotation`, held in a variable.
+- Join pins with `nets` (`GND: ['U1.GND', 'J1.GND']`) and let the autorouter draw them; `cad check` runs the fab's
+  design rules. Look at the copper preview: connectors should face the edge their plug comes from.
 
 ## Talking to the person
 - Give links as one labelled line (`npx cad link <project>/<object> --md`), never a raw URL. If it says
-  "(not a release)", say so.
+  "(not a release)", say so. If it says the link is too long for chat, don't paste it: tell the person, and offer
+  short links (a secret Gist), which upload the model, so ask first.
 - Say what the checks found, with numbers. Ask before anything that leaves the computer: releases with `--push`,
   ordering boards, publishing.
 - Designs are code: only run designs you or the person trust. Links and rule files are data and never run.