@rulecad/cad 0.2.0 → 0.3.0

package/AGENTS.md

@@ -62,7 +62,8 @@ variable says which rule it comes from. Follow these steps; they're what makes a
 
 ## 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.

package/README.md

@@ -69,9 +69,13 @@ fragment, which never reaches the web host, so the public page can open private
 which version it holds (`keyboard/keycap@0.1.0`, or `+changes` if it isn't a release). The page is to become `@rulecad/viewer`;
 `scripts/publish-view.sh "message"` publishes it (only that folder) to the public repo.
 
-- **Short links** (`--short`, and the default for `--md`): the link's data goes in a secret GitHub Gist (unlisted,
-  but anyone with the link can open it) and the link carries only its ID: `…/#s=<id>`. The page fetches it from
-  GitHub's API. The same model reuses its Gist (`.cache/links.json`).
+- **Short links** (`--short`, and the default for `--md`, once `"shorten": "gist"` is in `cad.config.json`'s
+  `targets`): the link's data goes in a secret GitHub Gist (unlisted, but anyone with the link can open it) and the
+  link carries only its ID: `…/#s=<id>`. The page fetches it from GitHub's API. The same model reuses its Gist
+  (`.cache/links.json`). `npm create rulecad` asks which you want. Without it, links carry the model, and `cad link`
+  says when one is too long for chat or email (over 8,000 characters).
+- **Boards** travel light: the board drawn from both sides (the page makes the front and back views from its layers)
+  and the schematic, with coordinates rounded to what a screen can show.
 - **Parts panel:** the page lists parts by kind (keycap ×9), opening to each copy (key-1-1). Each row shows or hides
   its parts and sets their style (solid, wireframe, x-ray, faint); the view has a mode, an explode slider, and
   switches for supports and references. Click a part in the model to select its copy and see its size.
@@ -94,7 +98,8 @@ which version it holds (`keyboard/keycap@0.1.0`, or `+changes` if it isn't a rel
   `<namespace>.<rule>`; the object's own variables are bare names. Parsed, never evaluated as code.
 - **Other objects' numbers:** `"uses": ["node/carrier"]` reads another object as a rule set named after it:
   `carrier.board_w` in an expression, `v.carrier.board_w` in code. It gets the object's variables and, from a board, its
-  outline (`board_x`, `board_y`, `board_w`, `board_d`) and, in code, its mounting holes (`v.carrier.board_holes`, each
+  outline (`board_x`, `board_y`, `board_w`, `board_d`) and, in code, where each of its parts is (`v.carrier.board_parts`),
+  a shaped board's outline (`board_outline`) and its mounting holes (`v.carrier.board_holes`, each
   `{ x, y, d }`). So a case follows its board: change the board and the case rebuilds around it. `"node/carrier@^0.2.0"`
   also checks the version; `"node/carrier@0.2.0"` reads that release. `cad rules` shows each borrowed number with the
   object and version it came from; two objects can't read each other.
@@ -117,6 +122,10 @@ which version it holds (`keyboard/keycap@0.1.0`, or `+changes` if it isn't a rel
   text so punctuation stays small, each straight stroke thickened to whole print lines, dots drawn round, and ↑ ↓ ← →
   as arrows), `anchor(face, size, at)` (where something goes on a face, by anchor), and `cut(a, b)` (a subtract that
   only touches a's faces near b; JSCAD's own splits every face along b's planes, which can leave slivers far away).
+- A rule set can also carry `"footprints"` (pad data from @rulecad/pcb's `fromKicad`, with its source), which a
+  board's code reads as `v.parts.footprints.usb_c`.
+- An object or rule set named with a hyphen (`pod-th`) is read with an underscore in expressions (`pod_th.width`),
+  since a hyphen there is a minus.
 - Rules carry `kind`: spec (manufacturer), default (slicer), community (rule of thumb) or measured (your own test
   print, which beats the rest), plus `source` and `checked`.
 
@@ -187,6 +196,8 @@ other items' variables, so a keycap can sit exactly where its slot meets the swi
   Objects with `"role": "reference"` (the MX switch) model things you don't print: drawn faint, never exported.
 - **plate** assemblies lay objects out on the bed: they're checked as one print and `export` writes one 3MF with an
   object per part. Supports are kept.
+- **Turning:** `"rotate": [0, 180, 0]` turns an item (degrees about x, y, z, in that order) about its own origin
+  before `at` moves it: a pod on a side mount, or a lid modelled face down as it prints.
 - **Components:** an item can be a whole assembly (`"assembly": "keycap-on-switch"`). Its parts, fits and `requires`
   come along, named per copy (`key-1-1.cap.cap`), and its overlaps are still checked inside each copy.
 - **Repeats:** `"repeat": { "x": { "count": "plate.cols", "step": "plate.pitch" }, "y": { … } }` places a grid of

package/bin/cad.mjs

@@ -330,8 +330,11 @@ async function shorten(l) {
 
 // --md: one line of labelled Markdown links, the form agents paste into chat (CLAUDE.md, "Replies with links").
 // Short (a Gist) unless --long; plain output is long (nothing uploaded) unless --short.
+const TOO_LONG = 8000; // characters: past this, chat apps and email cut a link short or refuse it
 async function printLinks(l) {
   if ((opt('md') && !opt('long')) || opt('short')) l = await shorten(l);
+  if (!l.short && l.view.length > TOO_LONG) console.error(`this link is ${(l.view.length / 1024).toFixed(0)} KB, too long for chat or email. ${hasTarget('shorten')
+    ? 'Leave out --long for a short one.' : 'For short links, add "shorten": "gist" to "targets" in cad.config.json: each model you share is then stored in a secret GitHub Gist (needs the gh command, signed in).'}`);
   // One link: the page picks which parts go in a download (all of them, one key, only the case)
   if (opt('md')) return console.log(`**${[l.title, l.version].filter(Boolean).join(' ')}**${l.src.includes('+') ? ' (not a release)' : ''}: [View and download](${l.view})`);
   console.log(`${l.src}, ${l.short ? 'short links (data in a secret Gist)' : `${(l.size / 1024).toFixed(1)} KB links`}${l.src.includes('+') ? ' (not a release: the link shows it)' : ''}`);

package/lib/design.mjs

@@ -48,7 +48,7 @@ export function locate(ref) {
 // ---------- objects that read each other ----------
 // "uses": ["node/carrier"] reads another object's numbers as a rule set named after it (carrier.board_w in an
 // expression, v.carrier.board_w in code): its variables, and what a board tells the parts around it (board_x, board_y,
-// board_w, board_d, and board_holes for code). The object is built (cached) first. "node/carrier@^0.2.0" also checks
+// board_w, board_d, and for code board_holes, board_parts (where each part is) and board_outline, for a shaped board). The object is built (cached) first. "node/carrier@^0.2.0" also checks
 // its version; "node/carrier@0.2.0" reads that release instead of the working copy.
 export const isObjectRef = (u) => String(u).includes('/');
 const building = new Set();
@@ -69,7 +69,7 @@ export async function objectSets(d, object) {
         rules[k] = { value: v, unit: units[k] ?? 'mm', rule: `${ref}'s ${k}`, kind: 'design', source: `${ref}@${version}` };
       }
       sets[u] = { name: base.name, rules };
-      if (b.circuit) extra[base.name] = { board_holes: (await pcbEngine()).holes(b.circuit) };
+      if (b.circuit) { const e = await pcbEngine(), board = b.circuit.find((x) => x.type === 'pcb_board'); extra[base.name] = { board_holes: e.holes(b.circuit), board_parts: e.parts ? e.parts(b.circuit) : {}, ...(board.outline ? { board_outline: board.outline } : {}) }; }
     }
   } finally { building.delete(self); }
   return { sets, extra };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rulecad/cad",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "The cad command: JSCAD designs from traceable rules, checked for printing and fit, versioned by what fits, shared as links and exported as Bambu 3MF.",
   "type": "module",
   "bin": {
@@ -43,19 +43,19 @@
     "directory": "packages/cad"
   },
   "dependencies": {
-    "@rulecad/variables": "^0.1.0",
+    "@rulecad/variables": "^0.1.4",
     "@rulecad/keyboard-layout": "^0.1.2",
     "@rulecad/printcheck": "^0.1.0",
     "@rulecad/fit": "^0.2.0",
     "@rulecad/model-link": "^0.1.2",
     "@rulecad/versions": "^0.1.0",
-    "@rulecad/shapes": "^0.1.0",
+    "@rulecad/shapes": "^0.2.0",
     "@rulecad/rules": "^0.2.0",
     "@jscad/modeling": "^2.12.0",
     "three": "^0.186.1"
   },
   "peerDependencies": {
-    "@rulecad/pcb": "^0.1.0 || ^0.2.0"
+    "@rulecad/pcb": "^0.1.0 || ^0.2.0 || ^0.3.0"
   },
   "peerDependenciesMeta": {
     "@rulecad/pcb": {