create-rulecad 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 JoniBach and contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,11 @@
-# Temporary Holding Version
+# create-rulecad
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+```sh
+npm create rulecad my-designs
+cd my-designs
+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`.

package/index.mjs

@@ -0,0 +1,27 @@
+#!/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
+import fs from 'node:fs';
+import path from 'node:path';
+import { execSync } from 'node:child_process';
+
+const args = process.argv.slice(2), install = !args.includes('--no-install');
+const dir = path.resolve(args.find((a) => !a.startsWith('--')) || 'my-designs'), name = path.basename(dir);
+if (fs.existsSync(dir) && fs.readdirSync(dir).length) { console.error(`${dir} isn't empty: name a new folder (npm create rulecad my-designs)`); process.exit(1); }
+
+const TEMPLATE = new URL('./template/', import.meta.url).pathname;
+fs.cpSync(TEMPLATE, dir, { recursive: true });
+fs.renameSync(path.join(dir, 'gitignore'), path.join(dir, '.gitignore')); // npm drops files named .gitignore from packages
+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');
+fs.writeFileSync(path.join(dir, 'package.json'), `${JSON.stringify({
+  name, private: true, type: 'module',
+  scripts: { check: 'cad check home/soap-tray' },
+  dependencies: { '@rulecad/cad': from('cad'), '@jscad/modeling': '^2.12.0' },
+}, null, 2)}\n`);
+
+console.log(`made ${path.relative(process.cwd(), dir) || '.'}: a soap tray to start from, in projects/home`);
+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,31 @@
 {
   "name": "create-rulecad",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0",
+  "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": {
+    "create-rulecad": "index.mjs"
+  },
+  "files": [
+    "index.mjs",
+    "template",
+    "README.md",
+    "LICENSE"
+  ],
+  "license": "MIT",
+  "keywords": [
+    "rulecad",
+    "create",
+    "3d-printing",
+    "jscad",
+    "scaffold"
+  ],
+  "engines": {
+    "node": ">=20.6"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/JoniBach/rulecad.git",
+    "directory": "packages/create-rulecad"
+  }
+}

package/template/README.md

@@ -0,0 +1,19 @@
+# NAME
+
+Designs for 3D printing, made with [rulecad](https://github.com/JoniBach/rulecad). Every measurement is a variable,
+and every variable says where it comes from.
+
+```sh
+npx cad check home/soap-tray                    # is it printable? (and: no raw numbers in the design)
+npx cad check home/soap-tray --set length=140   # try another size (each tweakable variable has a range)
+npx cad preview home/soap-tray                  # six views, in .preview/
+npx cad export home/soap-tray                   # a 3MF for your slicer, in exports/
+npx cad link home/soap-tray --md                # a link that opens the model in a browser: nothing is uploaded
+npx cad new home/hook                           # your own design
+```
+
+- `projects/home/objects/soap-tray.json` holds the variables, `soap-tray.js` the shape ([JSCAD](https://openjscad.xyz)).
+- `rules/` holds the facts designs use, such as your printer's (`x1c.json`, copied in on first use). Measure your own
+  printer and correct them: every design that uses them follows.
+- `cad.config.json` names the printer. For another printer, copy `rules/x1c.json` under a new name and change the
+  values.

package/template/cad.config.json

@@ -0,0 +1,4 @@
+{
+  "printer": "x1c",
+  "targets": {}
+}

package/template/gitignore

@@ -0,0 +1,6 @@
+node_modules/
+exports/
+.preview/
+.versions/
+.cache/
+.DS_Store

package/template/projects/home/objects/soap-tray.js

@@ -0,0 +1,19 @@
+// A soap tray: a shallow box with ribs across the floor to hold the soap up, and drain slots between them.
+// Every measurement is a variable in soap-tray.json; this file only says how they combine. Z is up, the bed is z = 0.
+import jscad from '@jscad/modeling'
+const { cuboid } = jscad.primitives
+const { translate } = jscad.transforms
+const { subtract, union } = jscad.booleans
+
+// A box sitting on z = z0, centred in x and y
+const box = (x, y, z0, h, cx = 0) => translate([cx, 0, z0 + h / 2], cuboid({ size: [x, y, h] }))
+
+export function main (v) {
+  const inside = [v.length - v.wall * 2, v.width - v.wall * 2]
+  const count = Math.floor(inside[0] / v.pitch) // ribs, centred along the length
+  const at = (i) => (i - (count - 1) / 2) * v.pitch
+  const ribs = Array.from({ length: count }, (_, i) => box(v.rib_width, inside[1], v.floor / 2, v.rib_height + v.floor / 2, at(i)))
+  const slots = Array.from({ length: count - 1 }, (_, i) => box(v.slot, inside[1] - v.margin * 2, -v.floor / 2, v.floor * 2, (at(i) + at(i + 1)) / 2))
+  const tray = subtract(box(v.length, v.width, 0, v.height), box(inside[0], inside[1], v.floor, v.height))
+  return subtract(union(tray, ...ribs), ...slots)
+}

package/template/projects/home/objects/soap-tray.json

@@ -0,0 +1,20 @@
+{
+  "name": "soap-tray",
+  "title": "Soap tray",
+  "version": "0.1.0",
+  "uses": ["x1c"],
+  "material": "PLA",
+  "orientation": "Flat side down on the bed. Walls are straight up, so it prints without supports.",
+  "variables": {
+    "length": { "value": 110, "unit": "mm", "rule": "Long enough for a bar of soap", "label": "Length", "show": true, "tweak": { "min": 70, "max": 180 } },
+    "width": { "value": 75, "unit": "mm", "rule": "Wide enough for a bar of soap", "label": "Width", "show": true, "tweak": { "min": 50, "max": 120 } },
+    "height": { "value": "x1c.layer * 60", "unit": "mm", "rule": "A whole number of layers", "label": "Height", "show": true },
+    "wall": { "value": "x1c.line * 4", "unit": "mm", "rule": "Four print lines: stiff, and no gaps between lines", "label": "Wall" },
+    "floor": { "value": "x1c.layer * 8", "unit": "mm", "rule": "Eight layers under the ribs" },
+    "rib_height": { "value": "x1c.layer * 15", "unit": "mm", "rule": "Holds the soap up out of the water", "label": "Rib height", "show": true },
+    "rib_width": { "value": "x1c.line * 4", "unit": "mm", "rule": "Four print lines" },
+    "pitch": { "value": 12, "unit": "mm", "rule": "Ribs this far apart: soap rests on several, water runs between", "label": "Rib spacing", "show": true, "tweak": { "min": 8, "max": 20 } },
+    "slot": { "value": "3 + x1c.hole_comp", "unit": "mm", "rule": "Drain slots between the ribs, widened for how holes print small" },
+    "margin": { "value": 6, "unit": "mm", "rule": "Solid floor between the slots and the walls" }
+  }
+}

package/template/projects/home/project.json

@@ -0,0 +1,6 @@
+{
+  "name": "home",
+  "description": "Things for the house.",
+  "material": "PLA",
+  "objects": ["soap-tray"]
+}