generator-jscad 3.0.1 → 4.0.0

package/README.md

@@ -27,11 +27,74 @@ You can also create a VitePress site with a live viewer.
 
 ## Running
 
-The jscad project uses gulp to create a `dist` directory and watch for changes. You can drag the `dist` directory into the drop area on [openjscad.org](http://openjscad.org). Make sure you check `Auto Reload` and any time you save, glup will recreate the `dist` directory files and your model should refresh.
+The jscad project uses gulp to create a `dist` directory and watches your source for changes. To view your model during development, you can use one of the following options:
+
+### Development Environment (tmux)
+
+If you have [tmux] and [jscad1-server] installed globally, `start-dev.sh` launches both panes in a single tmux session — `npm start` on the left watching for file changes, and `jscad1-server` on the right serving the model:
+
+```bash
+./start-dev.sh
+```
+
+The script will error with install instructions if either `tmux` or `jscad1-server` is missing. To install the global dependency:
+
+```bash
+npm install -g jscad1-server
+```
+
+Once running, open `http://localhost:3000` and load the `dist` file. Any time you save a source file, gulp rebuilds the dist file automatically.
+
+### Local JSCAD Server (Recommended)
+
+Run [jscad1-server] locally to preview your model in real-time:
+
+```bash
+npm install -g jscad1-server
+jscad1-server
+```
+
+Then navigate to `http://localhost:3000` and load the `dist` file by dragging it into the OpenJsCad browser.
+
+### VitePress Documentation Preview
+
+Alternatively, you can build and preview the documentation site with a live model viewer:
+
+```bash
+npm run docs:build && npm run docs:preview
+```
+
+### start
+
+`npm start` or `npm run start` will launch gulp and watch for file changes, recreating the dist file on each save.
+
+### clean
+
+Deletes the `dist` directory when you run `npm run clean`.
+
+### inject
+
+Run gulp to combine the source files and inject the dependent libraries with `npm run inject`. Libraries are found using a gulp plugin that looks for a `jscad.json` file in a package. These files are combined and minimized before injecting into the dist file.
+
+### build
+
+Build the [VitePress] static site by running `npm run build`. This script combines the readme with a [vue-openjscad] component to display a live view of the model. When hosted on [GitLab], the `.gitlab-ci.yml` CICD file uses this script to publish to [GitLab Pages].
+
+### serve
+
+Run [VitePress] in dev mode with `npm run serve`. This script watches for file changes and hot reloads changes made to the README file. Changes to the model are not automatically reloaded; a manual reload is required.
 
 ## jscad-utils
 
-The example project uses [jscad-utils](https://www.npmjs.com/package/jscad-utils). This is a set of utilities that make object creation and alignment easier. To remove it, `npm uninstall --save jscad-utils`.
+The example project uses [jscad-utils]. This is a set of utilities that make object creation and alignment easier. To remove it, `npm uninstall --save jscad-utils`.
+
+## Sharing Your Model
+
+To share your model publicly, publish the [VitePress] site by running `npm run build` and deploying the generated output. This produces a static site with a live interactive viewer embedded directly in the page.
+
+Hosting on [GitLab Pages] is handled automatically by the included `.gitlab-ci.yml` CICD pipeline. For GitHub, the build output can be deployed via GitHub Pages.
+
+jscad1-server is a local development tool only and cannot be used to share models.
 
 ## License
 
@@ -39,3 +102,10 @@ MIT © [John Cole](https://jwc.dev/)
 
 [npm-image]: https://badge.fury.io/js/generator-jscad.svg
 [npm-url]: https://npmjs.org/package/generator-jscad
+[tmux]: https://github.com/tmux/tmux/wiki
+[jscad1-server]: https://www.npmjs.com/package/jscad1-server
+[jscad-utils]: https://www.npmjs.com/package/jscad-utils
+[VitePress]: https://vitepress.dev/
+[GitLab]: https://gitlab.com/
+[GitLab Pages]: https://gitlab.com/help/user/project/pages/index.md
+[vue-openjscad]: https://gitlab.com/johnwebbcole/vue-openjscad

package/generators/app/index.js

@@ -1,21 +1,63 @@
-'use strict';
-const Generator = require('yeoman-generator');
-const chalk = require('chalk');
-const yosay = require('yosay');
-const path = require('path');
-const camelCase = require('lodash/camelCase');
-const commandExists = require('command-exists').sync;
-
-module.exports = class extends Generator {
+import chalk from 'chalk';
+import { camelCase } from 'lodash-es';
+import { createRequire } from 'node:module';
+import path from 'node:path';
+import Generator from 'yeoman-generator';
+import yosay from 'yosay';
+
+const require = createRequire(import.meta.url);
+const { sync: commandExists } = require('command-exists');
+
+/**
+ * JSCAD Project Generator
+ *
+ * A Yeoman generator for scaffolding JSCAD projects with support for single
+ * and multiple part configurations.
+ *
+ * @extends Generator
+ * @property {Object} props - Prompt responses
+ * @property {string} props.name - Project name
+ * @property {string} props.description - Project description
+ * @property {string} props.author - Project author
+ * @property {string} props.homepage - Project homepage
+ * @property {string} props.projectType - Type of project (single, multi-list, multi-checkbox)
+ * @property {Object} gitc - Git configuration
+ * @property {Object} gitc.user - Git user info
+ * @property {string} gitc.user.name - Git user name
+ * @property {string} gitc.user.email - Git user email
+ */
+export default class JscadGenerator extends Generator {
+  /**
+   * Initialize the generator by setting up git configuration
+   *
+   * @returns {void}
+   */
   initializing() {
-    this.gitc = {
-      user: {
-        name: this.user.git.name(),
-        email: this.user.git.email()
-      }
-    };
+    try {
+      // @ts-ignore - user property exists on Yeoman generator context
+      const gitUser = this.user.git;
+      this.gitc = {
+        user: {
+          name: gitUser.name(),
+          email: gitUser.email()
+        }
+      };
+    } catch {
+      // Git config not available (e.g., in test environment)
+      this.gitc = {
+        user: {
+          name: 'Test User',
+          email: 'test@example.com'
+        }
+      };
+    }
   }
 
+  /**
+   * Prompt user for project configuration
+   *
+   * @returns {Promise<void>}
+   */
   prompting() {
     // Have Yeoman greet the user.
     this.log(
@@ -28,12 +70,14 @@ module.exports = class extends Generator {
       {
         name: 'name',
         message: 'Your project name',
-        default: this.config.get('name') || path.basename(process.cwd())
+        default: this.config.get('name') || path.basename(process.cwd()),
+        type: 'input'
       },
       {
         name: 'description',
         message: 'Description',
-        default: this.config.get('description')
+        default: this.config.get('description'),
+        type: 'input'
       },
       {
         name: 'projectType',
@@ -52,17 +96,53 @@ module.exports = class extends Generator {
       {
         name: 'author',
         message: 'Author',
-        default: this.config.get('author') || this.gitc.user.name
+        type: 'input',
+        // @ts-ignore - gitc is guaranteed to exist after initializing()
+        default:
+          this.config.get('author') || (this.gitc?.user?.name ?? 'Unknown')
       },
       {
         name: 'homepage',
         message: 'Do you have a homepage?',
+        type: 'input',
         default: this.config.get('homepage') || 'http://github.com'
+      },
+      {
+        name: 'githubUser',
+        message: 'GitHub username or org (leave blank to skip)',
+        type: 'input',
+        default: this.config.get('githubUser') || ''
+      },
+      {
+        name: 'gitlabUser',
+        message: 'GitLab username or group (leave blank to skip)',
+        type: 'input',
+        default: this.config.get('gitlabUser') || ''
+      },
+      {
+        name: 'twitterUser',
+        message: 'Twitter/X username (leave blank to skip)',
+        type: 'input',
+        default: this.config.get('twitterUser') || ''
+      },
+      {
+        name: 'linkedinUser',
+        message: 'LinkedIn username (leave blank to skip)',
+        type: 'input',
+        default: this.config.get('linkedinUser') || ''
+      },
+      {
+        name: 'blueskyUser',
+        message: 'Bluesky handle, e.g. user.bsky.social (leave blank to skip)',
+        type: 'input',
+        default: this.config.get('blueskyUser') || ''
       }
     ];
 
+    // @ts-ignore - Yeoman prompt type definitions are overly strict
     return this.prompt(prompts).then((props) => {
       // To access props later use this.props.someAnswer;
+      // @ts-ignore - props type is valid from prompts
       this.props = props;
 
       this.config.set('name', this.props.name);
@@ -70,18 +150,31 @@ module.exports = class extends Generator {
       this.config.set('projectType', this.props.projectType);
       this.config.set('author', this.props.author);
       this.config.set('homepage', this.props.homepage);
+      this.config.set('githubUser', this.props.githubUser);
+      this.config.set('gitlabUser', this.props.gitlabUser);
+      this.config.set('twitterUser', this.props.twitterUser);
+      this.config.set('linkedinUser', this.props.linkedinUser);
+      this.config.set('blueskyUser', this.props.blueskyUser);
     });
   }
 
+  /**
+   * Write template files to destination directory
+   *
+   * @returns {void}
+   */
   writing() {
+    // @ts-ignore - props is guaranteed to exist after prompting()
+    /** @type {any} */
+    const props = this.props || {};
     this.fs.copyTpl(
       this.templatePath('gulpfile.js'),
       this.destinationPath('gulpfile.js'),
       {
-        name: this.props.name,
-        description: this.props.description,
-        author: this.props.author,
-        nameslug: camelCase(this.props.name)
+        name: props.name,
+        description: props.description,
+        author: props.author,
+        nameslug: camelCase(props.name)
       }
     );
 
@@ -99,11 +192,11 @@ module.exports = class extends Generator {
       this.templatePath('package.json'),
       this.destinationPath('package.json'),
       {
-        name: this.props.name,
-        description: this.props.description,
-        author: this.props.author,
-        nameslug: camelCase(this.props.name),
-        homepage: this.props.homepage
+        name: props.name,
+        description: props.description,
+        author: props.author,
+        nameslug: camelCase(props.name),
+        homepage: props.homepage
       }
     );
 
@@ -111,33 +204,36 @@ module.exports = class extends Generator {
       this.templatePath('README.md'),
       this.destinationPath('README.md'),
       {
-        name: this.props.name,
-        description: this.props.description,
-        author: this.props.author,
-        nameslug: camelCase(this.props.name),
-        homepage: this.props.homepage
+        name: props.name,
+        description: props.description,
+        author: props.author,
+        nameslug: camelCase(props.name),
+        homepage: props.homepage
       }
     );
 
     /**
      * Do not overwrite the main code file.
      */
-    if (!this.fs.exists(this.props.name + '.jscad')) {
-      var template =
-        this.props.projectType == 'single'
-          ? 'main.jscad'
-          : this.props.projectType == 'multi-list'
-            ? 'main-list.jscad'
-            : 'main-checkbox.jscad';
+    if (!this.fs.exists(props.name + '.jscad')) {
+      let template;
+      if (props.projectType === 'single') {
+        template = 'main.jscad';
+      } else if (props.projectType === 'multi-list') {
+        template = 'main-list.jscad';
+      } else {
+        template = 'main-checkbox.jscad';
+      }
+
       this.fs.copyTpl(
         this.templatePath(template),
-        this.destinationPath(this.props.name + '.jscad'),
+        this.destinationPath(props.name + '.jscad'),
         {
-          name: this.props.name,
-          description: this.props.description,
-          author: this.props.author,
-          nameslug: camelCase(this.props.name),
-          homepage: this.props.homepage
+          name: props.name,
+          description: props.description,
+          author: props.author,
+          nameslug: camelCase(props.name),
+          homepage: props.homepage
         }
       );
     }
@@ -158,8 +254,53 @@ module.exports = class extends Generator {
     );
 
     this.fs.copy(
+      this.templatePath('start-dev.sh'),
+      this.destinationPath('start-dev.sh')
+    );
+
+    const socialLinks = [];
+    if (props.githubUser) {
+      socialLinks.push({
+        icon: 'github',
+        link: `https://github.com/${props.githubUser}`
+      });
+    }
+    if (props.gitlabUser) {
+      socialLinks.push({
+        icon: 'gitlab',
+        link: `https://gitlab.com/${props.gitlabUser}`
+      });
+    }
+    if (props.twitterUser) {
+      socialLinks.push({
+        icon: 'x',
+        link: `https://x.com/${props.twitterUser}`
+      });
+    }
+    if (props.linkedinUser) {
+      socialLinks.push({
+        icon: 'linkedin',
+        link: `https://www.linkedin.com/in/${props.linkedinUser}`
+      });
+    }
+    if (props.blueskyUser) {
+      socialLinks.push({
+        icon: 'bluesky',
+        link: `https://bsky.app/profile/${props.blueskyUser}`
+      });
+    }
+
+    this.fs.copyTpl(
       this.templatePath('_vitepress/config.mjs'),
-      this.destinationPath('.vitepress/config.mjs')
+      this.destinationPath('.vitepress/config.mjs'),
+      {
+        name: props.name,
+        description: props.description,
+        author: props.author,
+        nameslug: camelCase(props.name),
+        homepage: props.homepage,
+        socialLinks
+      }
     );
 
     this.fs.copy(
@@ -173,22 +314,34 @@ module.exports = class extends Generator {
     );
   }
 
+  /**
+   * Install dependencies and compose with other generators
+   *
+   * @returns {void}
+   */
   install() {
-    this.npmInstall();
-
     if (commandExists('git')) {
-      this.composeWith(require.resolve('generator-git-init'), {});
+      const gitInitPath = require.resolve('generator-git-init');
+      this.composeWith(gitInitPath, {});
     }
   }
 
+  /**
+   * Display final message with available npm scripts
+   *
+   * @returns {void}
+   */
   end() {
+    // @ts-ignore - props is guaranteed to exist after prompting()
+    /** @type {any} */
+    const props = this.props || {};
     this.log(`
 
 jscad generator is finished.
 
 Available scripts:
 
-Bundle the '${this.props.name + '.jscad'}' file into the 'dist' directory.
+Bundle the '${props.name + '.jscad'}' file into the 'dist' directory.
 npm start
 
 Run the development VuePress site.
@@ -199,4 +352,4 @@ npm run build
 
 `);
   }
-};
+}

package/generators/app/templates/README.md

@@ -6,7 +6,42 @@
 
 ## Running
 
-The jscad project `<%= name %>` uses gulp to create a `dist/<%= name %>.jscad` file and watches your source for changes. You can drag the `dist/<%= name %>.jscad` directory into the drop area on [openjscad.org](http://openjscad.org). Make sure you check `Auto Reload` and any time you save, gulp creates the `dist/<%= name %>.jscad` file, and your model should refresh.
+The jscad project `<%= name %>` uses gulp to create a `dist/<%= name %>.jscad` file and watches your source for changes. To view your model during development, you can use one of the following options:
+
+### Development Environment (tmux)
+
+If you have [tmux] and [jscad1-server] installed globally, `start-dev.sh` launches both panes in a single tmux session — `npm start` on the left watching for file changes, and `jscad1-server` on the right serving the model:
+
+```bash
+./start-dev.sh
+```
+
+The script will error with install instructions if either `tmux` or `jscad1-server` is missing. To install the global dependency:
+
+```bash
+npm install -g jscad1-server
+```
+
+Once running, open `http://localhost:3000` and load `dist/<%= name %>.jscad`. Any time you save a source file, gulp rebuilds the dist file automatically.
+
+### Local JSCAD Server (Recommended)
+
+Run the [jscad1-server](https://www.npmjs.com/package/jscad1-server) locally to preview your model in real-time:
+
+```bash
+npm install -g jscad1-server
+jscad1-server
+```
+
+Then navigate to `http://localhost:3000` and load the `dist/<%= name %>.jscad` file by dragging the file into the OpenJsCad browser.
+
+### VitePress Documentation Preview
+
+Alternatively, you can build and preview the documentation site with a live model viewer:
+
+```bash
+npm run docs:build && npm run docs:preview
+```
 
 ### start
 
@@ -56,34 +91,21 @@ main() {
 // endinject
 ```
 
-## OpenJSCAD.org
-
-If you publish the `dist/<%= name %>.jscad` file, you can open it directly in
-[openjscad.org](http://openjscad.org) by using the following URL:
-
-<code>
-<a href="http://openjscad.org/#">http://openjscad.org/#</a>
-</code> + the url to your file.
-
-### Gist
-
-You can save your file to a GitHub [gist](https://gist.github.com/) and append the URL to the raw gist.
-
-For example <http://openjscad.org/#https://gist.githubusercontent.com/johnwebbcole/43f2ef58532a204c694e5ada16888ecd/raw/d0972463f70222e6d4c6c6196a1c759bb3e2362a/snap.jscad>
-
-### Gitlab Snippet
+## Sharing Your Model
 
-If you save to a gitlab public snippet, you can open it using the following URL:
+To share your model publicly, publish the [VitePress] site by running `npm run build` and deploying the generated output. This produces a static site with a live interactive viewer embedded directly in the page.
 
-<https://openjscad.org/#https://gitlab.com/snippets/1795323/raw.jscad>
+Hosting on [GitLab] is handled automatically by the included `.gitlab-ci.yml` CICD pipeline. For GitHub, the build output can be deployed via GitHub Pages.
 
-Make sure you change the snippet id to the correct value and add `.jscad` at the end.
+jscad1-server is a local development tool only and cannot be used to share models.
 
 ## License
 
 ISC © [<%= author %>](<%= homepage %>)
 
 [raspberrypi jscad library]: https://gitlab.com/johnwebbcole/jscad-raspberrypi
+[tmux]: https://github.com/tmux/tmux/wiki
+[jscad1-server]: https://www.npmjs.com/package/jscad1-server
 [vuepress]: https://vuepress.vuejs.org/
 [jscad-utils]: https://www.npmjs.com/package/jscad-utils
 [gitlab]: https://gitlab.com/

package/generators/app/templates/_gitignore

@@ -23,3 +23,4 @@ public
 
 .vitepress/dist
 .vitepress/cache
+!.vitepress/public

package/generators/app/templates/_gitlab-ci.yml

@@ -12,4 +12,4 @@ pages:
     paths:
       - public
   only:
-    - master
+    - main

package/generators/app/templates/_vitepress/config.mjs

@@ -5,6 +5,15 @@ export default defineConfig({
   title: "<%= name %>",
   description: "<%= description %>",
   srcDir: '.',
+  head: [
+    ['link', { rel: 'icon', type: 'image/x-icon', href: '/favicon.ico' }],
+    ['link', { rel: 'shortcut icon', href: '/favicon.ico' }],
+    ['link', { rel: 'icon', type: 'image/png', sizes: '32x32', href: '/favicon-32x32.png' }],
+    ['link', { rel: 'icon', type: 'image/png', sizes: '16x16', href: '/favicon-16x16.png' }],
+    ['link', { rel: 'apple-touch-icon', sizes: '180x180', href: '/apple-touch-icon.png' }],
+    ['link', { rel: 'manifest', href: '/site.webmanifest' }],
+    ['meta', { name: 'theme-color', content: '#ffffff' }]
+  ],
   rewrites: {
     'README.md': 'index.md'
   },
@@ -15,7 +24,7 @@ export default defineConfig({
     ],
 
     socialLinks: [
-      { icon: 'gitlab', link: 'https://gitlab.com/johnwebbcole/<%= name %>' }
+<% - socialLinks.map(l => `      { icon: '${l.icon}', link: '${l.link}' }`).join(',\n') %>
     ]
   },
   vite: {

package/generators/app/templates/gulpfile.js

@@ -38,7 +38,7 @@ gulp.task('inject', function () {
                 mangle: false,
                 compress: false,
                 output: {
-                  beautify: false,
+                  beautify: true,
                   max_line_len: 80
                 }
               })

package/generators/app/templates/main-checkbox.jscad

@@ -4,10 +4,20 @@
 // file       : <%= nameslug %>.jscad
 
 /* exported main, getParameterDefinitions */
+/** @typedef { import("@jwc/jscad-utils/src/group").JsCadUtilsGroup } JsCadUtilsGroup */
 
 /** @type {import('@jwc/jscad-utils')} JscadUtils */
 var util;
 
+/** @type {import('@jwc/jscad-utils/src/parts')} Parts */
+var Parts;
+
+/** @type {import('@jwc/jscad-hardware/src/hardware')} Hardware */
+var Hardware;
+
+/** @type {import('@jwc/jscad-utils/src/boxes')} Boxes */
+var Boxes;
+
 function getParameterDefinitions() {
   /**
    * Add the keys to the `Parts` object
@@ -15,7 +25,7 @@ function getParameterDefinitions() {
    * parameters.
    * @type {Record<string, boolean>}
    */
-  var ENABLED = {
+  const ENABLED = {
     example1: true,
     example2: false
   };
@@ -67,15 +77,19 @@ function getParameterDefinitions() {
   ];
 }
 
+/**
+ * @typedef {Object} Params
+ * @property {boolean} example1
+ * @property {boolean} example2
+ * @property {"0"|"1"|"2"|"3"|"4"} resolution
+ * @property {boolean} center
+ * @property {boolean} cutawayEnable
+ * @property {'x'|'y'|'z'} cutawayAxis
+ */
+
 /**
  *
- * @param {object} params
- * @param {boolean} params.example1
- * @param {boolean} params.example2
- * @param {"0"|"1"|"2"|"3"|"4"} params.resolution
- * @param {boolean} params.center
- * @param {boolean} params.cutawayEnable
- * @param {'x'|'y'|'z'} params.cutawayAxis
+ * @param {Params} params
  * @returns {CSG[]}
  */
 function main(params) {
@@ -87,9 +101,8 @@ function main(params) {
     [24, 64],
     [48, 128]
   ];
-  var [defaultResolution3D, defaultResolution2D] = resolutions[
-    parseInt(params.resolution)
-  ];
+  var [defaultResolution3D, defaultResolution2D] =
+    resolutions[Number.parseInt(params.resolution)];
   CSG.defaultResolution3D = defaultResolution3D;
   CSG.defaultResolution2D = defaultResolution2D;
   util.init(CSG);
@@ -98,11 +111,13 @@ function main(params) {
    * The `Parts` object needs to contain
    * the values from the `ENABLED` object.
    */
+  /** @type {Object<string, () => CSG>} */
   var Parts = {
     example1: () => example1(),
     example2: () => example2()
   };
 
+  /** @type {Array<CSG>} */
   var selectedParts = Object.entries(Parts)
     .filter(([key, value]) => {
       return params[key];

package/generators/app/templates/main-list.jscad

@@ -4,12 +4,26 @@
 // file       : <%= nameslug %>.jscad
 
 /* exported main, getParameterDefinitions */
+/** @typedef { import("@jwc/jscad-utils/src/group").JsCadUtilsGroup } JsCadUtilsGroup */
+
+/** @type {import('@jwc/jscad-utils')} JscadUtils */
+var util;
+
+/** @type {import('@jwc/jscad-utils/src/parts')} Parts */
+var Parts;
+
+/** @type {import('@jwc/jscad-hardware/src/hardware')} Hardware */
+var Hardware;
+
+/** @type {import('@jwc/jscad-utils/src/boxes')} Boxes */
+var Boxes;
 
 function getParameterDefinitions() {
   /**
    * Add the keys to the `Parts` object
    * here and they will be listed in the
    * parameters.
+   * @type {Record<string, boolean>}
    */
   var ENABLED = {
     example1: true,
@@ -63,6 +77,21 @@ function getParameterDefinitions() {
     }
   ];
 }
+
+/**
+ * @typedef {Object} Params
+ * @property {"example1"|"example2"} Parts
+ * @property {"0"|"1"|"2"|"3"|"4"} resolution
+ * @property {boolean} center
+ * @property {boolean} cutawayEnable
+ * @property {'x'|'y'|'z'} cutawayAxis
+ */
+
+/**
+ *
+ * @param {Params} params
+ * @returns {CSG[]}
+ */
 function main(params) {
   var start = performance.now();
   var resolutions = [
@@ -81,8 +110,9 @@ function main(params) {
 
   /**
    * The `Parts` object needs to contain
-   * the values from the `ENALBED` object.
+   * the values from the `ENABLED` object.
    */
+  /** @type {Object<string, () => CSG>} */
   var Parts = {
     example1: () => example1(),
     example2: () => example2()

package/generators/app/templates/main.jscad

@@ -4,6 +4,19 @@
 // file       : <%= nameslug %>.jscad
 
 /* exported main, getParameterDefinitions */
+/** @typedef { import("@jwc/jscad-utils/src/group").JsCadUtilsGroup } JsCadUtilsGroup */
+
+/** @type {import('@jwc/jscad-utils')} JscadUtils */
+var util;
+
+/** @type {import('@jwc/jscad-utils/src/parts')} Parts */
+var Parts;
+
+/** @type {import('@jwc/jscad-hardware/src/hardware')} Hardware */
+var Hardware;
+
+/** @type {import('@jwc/jscad-utils/src/boxes')} Boxes */
+var Boxes;
 
 function getParameterDefinitions() {
   return [
@@ -25,6 +38,19 @@ function getParameterDefinitions() {
   ];
 }
 
+/**
+ * @typedef {Object} Params
+ * @property {"0"|"1"|"2"|"3"|"4"} resolution
+ * @property {boolean} center
+ * @property {boolean} cutawayEnable
+ * @property {'x'|'y'|'z'} cutawayAxis
+ */
+
+/**
+ *
+ * @param {Params} params
+ * @returns {CSG[]}
+ */
 function main(params) {
   var resolutions = [
     [6, 16],

package/generators/app/templates/package.json

@@ -34,7 +34,7 @@
   "dependencies": {
     "@jscad/scad-api": "0.5.1",
     "@jwc/jscad-hardware": "3.3.0",
-    "@jwc/jscad-raspberrypi": "3.2.1",
+    "@jwc/jscad-raspberrypi": "3.3.0",
     "@jwc/jscad-utils": "4.9.0"
   }
 }

package/generators/app/templates/start-dev.sh

@@ -0,0 +1,37 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+
+ROOT_DIR="$(cd "$(dirname "$0")" && pwd)"
+SESSION_NAME="pipiece-dev"
+WINDOW_NAME="dev"
+
+if ! command -v tmux >/dev/null 2>&1; then
+  echo "tmux is required but was not found in PATH." >&2
+  exit 1
+fi
+
+if ! command -v jscad1-server >/dev/null 2>&1; then
+  echo "jscad1-server is required but was not found in PATH." >&2
+  echo "Install it with: npm install -g jscad1-server" >&2
+  exit 1
+fi
+
+if tmux has-session -t "$SESSION_NAME" 2>/dev/null; then
+  tmux kill-session -t "$SESSION_NAME"
+fi
+
+tmux new-session -d -s "$SESSION_NAME" -n "$WINDOW_NAME" -c "$ROOT_DIR" "npm start"
+tmux split-window -h -t "$SESSION_NAME:$WINDOW_NAME" -c "$ROOT_DIR" "jscad1-server"
+tmux select-layout -t "$SESSION_NAME:$WINDOW_NAME" even-horizontal
+
+tmux setw -t "$SESSION_NAME:$WINDOW_NAME" pane-border-status top
+tmux select-pane -t "$SESSION_NAME:$WINDOW_NAME".0 -T "npm start"
+tmux select-pane -t "$SESSION_NAME:$WINDOW_NAME".1 -T "jscad1-server"
+tmux select-pane -t "$SESSION_NAME:$WINDOW_NAME".0
+
+if [[ -n "${TMUX:-}" ]]; then
+  tmux switch-client -t "$SESSION_NAME"
+else
+  exec tmux attach-session -t "$SESSION_NAME"
+fi

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "generator-jscad",
-  "version": "3.0.1",
+  "version": "4.0.0",
   "description": "Create a jscad project",
   "homepage": "https://gitlab.com/johnwebbcole/generator-jscad",
   "author": {
@@ -11,39 +11,45 @@
   "files": [
     "generators"
   ],
-  "main": "generators/index.js",
+  "type": "module",
+  "main": "generators/app/index.js",
   "keywords": [
     "jscad",
     "yeoman-generator"
   ],
   "devDependencies": {
-    "conventional-changelog-cli": "^2.0.34",
-    "coveralls": "^3.1.0",
-    "eslint": "^7.3.0",
-    "eslint-config-prettier": "^6.11.0",
-    "eslint-config-xo": "^0.31.0",
-    "eslint-plugin-prettier": "^3.1.4",
-    "husky": "^4.2.5",
-    "jest": "^26.0.1",
-    "lint-staged": "^10.2.11",
-    "np": "^6.2.4",
-    "prettier": "^2.0.5",
-    "yeoman-assert": "^3.1.0",
-    "yeoman-test": "^2.6.0"
+    "@eslint/eslintrc": "^2.1.4",
+    "@eslint/js": "^9.0.0",
+    "@vitest/coverage-v8": "4.1.2",
+    "conventional-changelog-cli": "^5.0.0",
+    "coveralls": "^3.1.1",
+    "eslint": "^10.1.0",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-config-xo": "^0.51.0",
+    "eslint-plugin-prettier": "^5.5.5",
+    "husky": "^9.1.7",
+    "lint-staged": "^16.4.0",
+    "np": "^11.0.2",
+    "prettier": "^3.8.1",
+    "vitest": "4.1.2",
+    "yeoman-assert": "^3.1.1",
+    "yeoman-test": "^11.3.1"
   },
   "engines": {
-    "npm": ">= 4.0.0"
+    "npm": ">= 11.0.0",
+    "node": ">= 24.0.0"
   },
   "dependencies": {
-    "chalk": "^4.1.0",
+    "chalk": "^5.6.2",
     "command-exists": "^1.2.9",
     "generator-git-init": "^1.1.3",
-    "lodash": "^4.17.15",
-    "yeoman-generator": "^4.10.1",
-    "yosay": "^2.0.1"
+    "globals": "^15.11.0",
+    "lodash-es": "^4.17.23",
+    "yeoman-generator": "^8.1.2",
+    "yosay": "^3.0.0"
   },
-  "jest": {
-    "testEnvironment": "node"
+  "vitest": {
+    "environment": "node"
   },
   "lint-staged": {
     "*.js": [
@@ -55,28 +61,15 @@
       "git add"
     ]
   },
-  "eslintConfig": {
-    "extends": [
-      "xo",
-      "prettier"
-    ],
-    "env": {
-      "jest": true,
-      "node": true
-    },
-    "rules": {
-      "prettier/prettier": "error"
-    },
-    "plugins": [
-      "prettier"
-    ]
-  },
   "scripts": {
     "pretest": "eslint .",
-    "test": "jest --coverage",
+    "test": "vitest --coverage",
     "version": "conventional-changelog -r 0 -o CHANGELOG.md && git add CHANGELOG.md",
     "release": "np --no-yarn"
   },
-  "repository": "https://gitlab.com/johnwebbcole/generator-jscad",
+  "repository": {
+    "type": "git",
+    "url": "git+https://gitlab.com/johnwebbcole/generator-jscad.git"
+  },
   "license": "MIT"
 }