generator-jscad 2.2.0 → 3.0.1

package/README.md

@@ -21,7 +21,7 @@ You can select the type of project you want to build. A single object project is
 
 ![yo jscad cli example](./yo-jscad.gif)
 
-You can also create a VuePress site with a live viewer.
+You can also create a VitePress site with a live viewer.
 
 ![example vuepress site](./example.gif)
 

package/generators/app/index.js

@@ -127,8 +127,8 @@ module.exports = class extends Generator {
         this.props.projectType == 'single'
           ? 'main.jscad'
           : this.props.projectType == 'multi-list'
-          ? 'main-list.jscad'
-          : 'main-checkbox.jscad';
+            ? 'main-list.jscad'
+            : 'main-checkbox.jscad';
       this.fs.copyTpl(
         this.templatePath(template),
         this.destinationPath(this.props.name + '.jscad'),
@@ -143,13 +143,23 @@ module.exports = class extends Generator {
     }
 
     this.fs.copy(
-      this.templatePath('_vuepress/components/VuepressOpenJscad.vue'),
-      this.destinationPath('.vuepress/components/VuepressOpenJscad.vue')
+      this.templatePath('_vitepress/theme/components/VuepressOpenJscad.vue'),
+      this.destinationPath('.vitepress/theme/components/VuepressOpenJscad.vue')
     );
 
     this.fs.copy(
-      this.templatePath('_vuepress/config.js'),
-      this.destinationPath('.vuepress/config.js')
+      this.templatePath('_vitepress/theme/custom.css'),
+      this.destinationPath('.vitepress/theme/custom.css')
+    );
+
+    this.fs.copy(
+      this.templatePath('_vitepress/theme/index.js'),
+      this.destinationPath('.vitepress/theme/index.js')
+    );
+
+    this.fs.copy(
+      this.templatePath('_vitepress/config.mjs'),
+      this.destinationPath('.vitepress/config.mjs')
     );
 
     this.fs.copy(

package/generators/app/templates/_gitignore

@@ -19,4 +19,7 @@ coverage
 
 # Dependency directories
 node_modules/
-public
+public
+
+.vitepress/dist
+.vitepress/cache

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

@@ -4,6 +4,9 @@ pages:
   script:
     - npm install
     - npm run build
+    - npm run docs:build
+    - mv .vitepress/dist public
+    - cp dist/PiPiece.jscad public/
     - ls -al -R public
   artifacts:
     paths:

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

@@ -0,0 +1,26 @@
+import { defineConfig } from 'vitepress'
+
+// https://vitepress.dev/reference/site-config
+export default defineConfig({
+  title: "<%= name %>",
+  description: "<%= description %>",
+  srcDir: '.',
+  rewrites: {
+    'README.md': 'index.md'
+  },
+  themeConfig: {
+    // https://vitepress.dev/reference/default-theme-config
+    nav: [
+      { text: 'Home', link: '/' }
+    ],
+
+    socialLinks: [
+      { icon: 'gitlab', link: 'https://gitlab.com/johnwebbcole/<%= name %>' }
+    ]
+  },
+  vite: {
+    ssr: {
+      noExternal: ['@jwc/vue-openjscad', 'debug']
+    }
+  }
+})

package/generators/app/templates/_vitepress/theme/components/VuepressOpenJscad.vue

@@ -0,0 +1,17 @@
+<template>
+  <div>
+    <ClientOnly>
+      <OpenJscad v-bind="$attrs"></OpenJscad>
+    </ClientOnly>
+  </div>
+</template>
+
+<script setup>
+import { defineClientComponent } from 'vitepress';
+
+const OpenJscad = defineClientComponent(() => {
+  return import('@jwc/vue-openjscad/')
+})
+</script>
+
+

package/generators/app/templates/_vitepress/theme/custom.css

@@ -0,0 +1,6 @@
+/* Custom styles for your VitePress site */
+
+/* Add your custom CSS here */
+.custom-component {
+  /* Example styles */
+}

package/generators/app/templates/_vitepress/theme/index.js

@@ -0,0 +1,13 @@
+import DefaultTheme from 'vitepress/theme'
+import './custom.css'
+
+// Import your custom components
+import VuepressOpenJscad from './components/VuepressOpenJscad.vue'
+
+export default {
+  extends: DefaultTheme,
+  enhanceApp({ app }) {
+    // Register global components
+    app.component('VuepressOpenJscad', VuepressOpenJscad)
+  }
+}

package/generators/app/templates/gulpfile.js

@@ -1,30 +1,33 @@
-var gulp = require('gulp');
-var del = require('del');
-var jscadFiles = require('gulp-jscad-files');
-var { getInjected } = require('gulp-jscad-files/getPackage');
-var merge2 = require('merge2');
-var debug = require('gulp-debug');
-var inject = require('gulp-inject');
-var plumber = require('gulp-plumber');
-var terser = require('gulp-terser');
+/* globals import */
+import { deleteSync } from 'del';
+import { readFileSync } from 'fs';
+import gulp from 'gulp';
+import debug from 'gulp-debug';
+import inject from 'gulp-inject';
+import jscadFiles from 'gulp-jscad-files';
+import { getInjected } from 'gulp-jscad-files/getPackage.js';
+import plumber from 'gulp-plumber';
+import terser from 'gulp-terser';
+import merge2 from 'merge2';
+
+const pkg = JSON.parse(readFileSync('./package.json', 'utf8'));
 
-var pkg = require('./package.json');
 
 gulp.task('clean', function (done) {
-  del(['dist/*']).then((paths) => {
-    console.log('Deleted files and folders:\n', paths.join('\n')); // eslint-disable-line no-console, no-undef
-    done();
-  });
+  const paths = deleteSync(['dist/*'])
+  console.log('Deleted files and folders:\n', paths.join('\n')); // eslint-disable-line no-console, no-undef
+  done();
 });
 
 gulp.task('inject', function () {
   return gulp
     .src('<%= name %>.jscad')
     .pipe(plumber())
+    .pipe(debug({ title: 'start:' }))
     .pipe(
       inject(
         merge2(
-          gulp.src(['*.jscad'], { ignore: ['<%= name %>.jscad'] }),
+          gulp.src(['*.jscad'], { ignore: ['<%= name %>.jscad'] }).pipe(debug({ title: 'src:' })),
           gulp
             .src('package.json')
             .pipe(jscadFiles())
@@ -39,7 +42,7 @@ gulp.task('inject', function () {
                   max_line_len: 80
                 }
               })
-            )
+            ).pipe(debug({ title: 'package.json:' }))
         ).pipe(debug({ title: 'injecting:' })),
         {
           relative: true,
@@ -54,30 +57,30 @@ gulp.task('inject', function () {
     .pipe(gulp.dest('dist'));
 });
 
+
 gulp.task(
-  'vuepress',
-  gulp.series(['inject'], function () {
+  'vitepress',
+  gulp.series('inject', function () {
     return gulp
       .src('dist/<%= name %>.jscad')
-      .pipe(debug({ title: 'vuepress:' }))
-      .pipe(gulp.dest('.vuepress/public/'));
+      .pipe(debug({ title: 'vitepress:' }))
+      .pipe(gulp.dest('.vitepress/public/'));
   })
 );
 
 gulp.task(
   'default',
-  gulp.series(['clean', 'inject'], function () {
+  gulp.series('clean', 'inject', function () {
     gulp.watch(
       ['**/*.jscad', ...getInjected(pkg)],
       {
-        verbose: true,
         followSymlinks: true,
         delay: 500,
         queue: false,
         ignoreInitial: false,
         ignored: ['**/*.*~', 'dist/*', '.vuepress/*', 'public', 'node_modules']
       },
-      gulp.series(['inject'])
+      gulp.series('inject')
     );
   })
 );

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

@@ -5,11 +5,15 @@
 
 /* exported main, getParameterDefinitions */
 
+/** @type {import('@jwc/jscad-utils')} JscadUtils */
+var util;
+
 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,
@@ -62,6 +66,18 @@ function getParameterDefinitions() {
     }
   ];
 }
+
+/**
+ *
+ * @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
+ * @returns {CSG[]}
+ */
 function main(params) {
   var start = performance.now();
   var resolutions = [
@@ -80,7 +96,7 @@ function main(params) {
 
   /**
    * The `Parts` object needs to contain
-   * the values from the `ENALBED` object.
+   * the values from the `ENABLED` object.
    */
   var Parts = {
     example1: () => example1(),

package/generators/app/templates/package.json

@@ -6,31 +6,35 @@
   "scripts": {
     "start": "gulp",
     "clean": "gulp clean",
-    "inject": "gulp inject",
+    "build": "gulp inject",
     "test": "echo \"Error: no test specified\" && exit 1",
-    "build": "gulp vuepress && cross-env BASEPATH=/<%= name %>/ vuepress build",
-    "serve": "gulp vuepress && vuepress dev"
+    "docs:dev": "vitepress dev",
+    "docs:build": "vitepress build",
+    "docs:preview": "vitepress preview"
   },
   "author": "<%= author %>",
   "license": "ISC",
-  "dependencies": {
-    "@jwc/jscad-utils": "*",
-    "@jwc/jscad-hardware": "*"
-  },
   "devDependencies": {
-    "@jscad/web": "*",
-    "@jwc/vue-openjscad": "*",
-    "cross-env": "^7.0.2",
-    "del": "^5.1.0",
-    "gulp": "^4.0.2",
-    "gulp-cli": "^2.2.0",
-    "gulp-debug": "^4.0.0",
+    "@jscad/web": "^1.10.0",
+    "@jwc/vue-openjscad": "2.0.4",
+    "copy-dir": "0.3.0",
+    "cross-env": "10.0.0",
+    "del": "8.0.1",
+    "gulp": "5.0.1",
+    "gulp-cli": "3.1.0",
+    "gulp-debug": "5.0.1",
     "gulp-inject": "^5.0.4",
     "gulp-jscad-files": "^4.0.0",
     "gulp-plumber": "^1.1.0",
-    "gulp-terser": "^1.2.0",
+    "gulp-terser": "^2.0.1",
     "gulp-watch": "^5.0.1",
     "merge2": "^1.3.0",
-    "vuepress": "^1.1.0"
+    "vitepress": "2.0.0-alpha.12"
+  },
+  "dependencies": {
+    "@jscad/scad-api": "0.5.1",
+    "@jwc/jscad-hardware": "3.3.0",
+    "@jwc/jscad-raspberrypi": "3.2.1",
+    "@jwc/jscad-utils": "4.9.0"
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "generator-jscad",
-  "version": "2.2.0",
+  "version": "3.0.1",
   "description": "Create a jscad project",
   "homepage": "https://gitlab.com/johnwebbcole/generator-jscad",
   "author": {

package/CHANGELOG.md

@@ -1,68 +0,0 @@
-## 2.2.0 (2020-09-13)
-
-* Add options for multiple part projects ([63005a5](https://gitlab.com/johnwebbcole/generator-jscad/commit/63005a5))
-* Updating readme ([ed33447](https://gitlab.com/johnwebbcole/generator-jscad/commit/ed33447))
-
-
-
-## <small>2.1.2 (2019-01-12)</small>
-
-* 2.1.2 ([44051d1](https://gitlab.com/johnwebbcole/generator-jscad/commit/44051d1))
-* cicd changes ([decc610](https://gitlab.com/johnwebbcole/generator-jscad/commit/decc610))
-
-
-
-## <small>2.1.1 (2019-01-12)</small>
-
-* 2.1.1 ([0461e7c](https://gitlab.com/johnwebbcole/generator-jscad/commit/0461e7c))
-* update watch to match v4 ([05d96f1](https://gitlab.com/johnwebbcole/generator-jscad/commit/05d96f1))
-
-
-
-## 2.1.0 (2019-01-06)
-
-* 2.1.0 ([d06e677](https://gitlab.com/johnwebbcole/generator-jscad/commit/d06e677))
-* add vuepress and vue-openjscad ([5204f44](https://gitlab.com/johnwebbcole/generator-jscad/commit/5204f44))
-* add vuepress and vue-openjscad ([dac022b](https://gitlab.com/johnwebbcole/generator-jscad/commit/dac022b))
-
-
-
-## <small>2.0.2 (2018-12-24)</small>
-
-* 2.0.2 ([7203c0e](https://gitlab.com/johnwebbcole/generator-jscad/commit/7203c0e))
-* renamed dot template files ([d23e7a0](https://gitlab.com/johnwebbcole/generator-jscad/commit/d23e7a0))
-
-
-
-## <small>2.0.1 (2018-12-24)</small>
-
-* 2.0.1 ([5208a2b](https://gitlab.com/johnwebbcole/generator-jscad/commit/5208a2b))
-* add lodash ([e53a8f0](https://gitlab.com/johnwebbcole/generator-jscad/commit/e53a8f0))
-
-
-
-## 2.0.0 (2018-12-24)
-
-* 2.0.0 ([a805277](https://gitlab.com/johnwebbcole/generator-jscad/commit/a805277))
-* add cicd ([d341b77](https://gitlab.com/johnwebbcole/generator-jscad/commit/d341b77))
-* add release script ([e90810a](https://gitlab.com/johnwebbcole/generator-jscad/commit/e90810a))
-* Added `node_modules` to watch list ([20d72d0](https://gitlab.com/johnwebbcole/generator-jscad/commit/20d72d0))
-* Added readme to generator and moved one into the project.  Camel cased the name to make it a valid o ([66880e6](https://gitlab.com/johnwebbcole/generator-jscad/commit/66880e6))
-* added yarn files ([8c96cff](https://gitlab.com/johnwebbcole/generator-jscad/commit/8c96cff))
-* changed to use new gulp-jscadfiles plugin ([567183f](https://gitlab.com/johnwebbcole/generator-jscad/commit/567183f))
-* Fix gulp file, it needed to be a template. ([ccab77e](https://gitlab.com/johnwebbcole/generator-jscad/commit/ccab77e))
-* Initial commit ([e43fb5b](https://gitlab.com/johnwebbcole/generator-jscad/commit/e43fb5b))
-* no message ([857331c](https://gitlab.com/johnwebbcole/generator-jscad/commit/857331c))
-* no message ([9572114](https://gitlab.com/johnwebbcole/generator-jscad/commit/9572114))
-* no message ([bb05b43](https://gitlab.com/johnwebbcole/generator-jscad/commit/bb05b43))
-* publish 1.0.1 ([8c26637](https://gitlab.com/johnwebbcole/generator-jscad/commit/8c26637))
-* Rebuit using `generator-generator`. ([d7ea44e](https://gitlab.com/johnwebbcole/generator-jscad/commit/d7ea44e))
-* removed fileExists dependency ([a239839](https://gitlab.com/johnwebbcole/generator-jscad/commit/a239839))
-* reset version ([0932c0e](https://gitlab.com/johnwebbcole/generator-jscad/commit/0932c0e))
-* updated dependencies ([93c19df](https://gitlab.com/johnwebbcole/generator-jscad/commit/93c19df))
-* updated example, added readme from generator. ([b0df213](https://gitlab.com/johnwebbcole/generator-jscad/commit/b0df213))
-* updated to use newer utils ([17b81ea](https://gitlab.com/johnwebbcole/generator-jscad/commit/17b81ea))
-* Updating to use `jscad-utils` 2.0 ([7ca7621](https://gitlab.com/johnwebbcole/generator-jscad/commit/7ca7621))
-
-
-

package/generators/app/templates/_vuepress/components/VuepressOpenJscad.vue

@@ -1,14 +0,0 @@
-<template>
-  <div>
-    <open-jscad v-bind="$attrs"></open-jscad>
-  </div>
-</template>
-<script>
-import OpenJscad from "@jwc/vue-openjscad";
-
-export default {
-  name: "VuepressOpenJscad",
-  components: { OpenJscad },
-  inheritAttrs: false
-};
-</script>

package/generators/app/templates/_vuepress/config.js

@@ -1,10 +0,0 @@
-const pkg = require('../package.json');
-module.exports = {
-  title: pkg.name,
-  description: pkg.description,
-  dest: 'public',
-  themeConfig: {
-    navbar: false
-  },
-  base: process.env.BASEPATH || '/'
-};