merging docker work

Author: kevinkhill

README.md

@@ -17,20 +17,23 @@ npm install eleventy-plugin-scad
 - **launchPath** _(string)_: Location of the OpenSCAD executable (required)
   - `auto` - Attempts to use `process.platform` to find OpenSCAD in the default install locations
   - `nightly` - Works the same as above for the `nightly` version of OpenSCAD
-  - `"C:/openscad.exe"` - Absolute paths work too.
-  - `osc` - Maybe you aliased OpenSCAD and have it on your `$PATH`
+  - `docker` - Download and use containerized OpenSCAD. Defaults to `trixie`
+    - `docker:TAG` - You can append a [container tag](https://hub.docker.com/r/openscad/openscad) to use a specific version.
+  - `C:/openscad.exe` - Absolute paths work too
+  - `openscad` - or in a bin folder and available on your `$PATH`
 - **theme**: Use one of the core W3.org themes
   - Traditional, Modernist, Midnight, Chocolate, Oldstyle, Steely, Swiss, Ultramarine
 - **layout**: Use a custom layout for the scad files
   - This is an escape hatch to make and use your own STL viewer layout. _(needs docs)_
-- **collectionPage**: Set `false` to disable the generation of a listing page with links from the `scad` tagged files _(uses Collections API)_
-- **verbose**: Set `true` to view the compilation output from OpenSCAD
+- **collectionPage** _(default: true)_: Set `false` to disable the generation of a listing page with links from the `scad` tagged files _(uses Collections API)_
+- **verbose** _(default: false)_: Set `true` to view the compilation output from OpenSCAD
   - If your model uses `echo()` this is how to see the output
-- **silent**: Set `true` to disable all logging from the plugin
-- **noSTL**: Set `true` to skip generating STLs
+- **silent** _(default: false)_: Set `true` to disable all logging from the plugin
+- **noSTL** _(default: false)_: Set `true` to skip generating STLs
   - Useful when models do not change frequently. Generate once, then disable STLs.
-- **checkLaunchPath**: Set `false` to disable the validity check of `launchPath`
-  - Disable checking if the given `launchPath` exists _(added for testing)_
+- **resolveLaunchPath** _(default: true)_: Set `false` to disable internally resolving `launchPath`
+  - This was added to disable trying to verify if the passed `launchPath` exists and/or is callable.
+  - Whatever is set to `launchPath` will be passed to `spawn(launchPath, ["--o", STL_OUT_FILE, SCAD_INPUT]);`
 
 ## Add Plugin to Eleventy
 

biome.jsonc

@@ -1,5 +1,5 @@
 {
-  "$schema": "https://biomejs.dev/schemas/2.2.5/schema.json",
+  "$schema": "https://biomejs.dev/schemas/2.3.4/schema.json",
   "root": true,
   "vcs": {
     "enabled": true,

demo.ts

@@ -2,6 +2,7 @@ import z from "zod";
 import { EleventyScope, EleventySuppliedData } from "11ty.ts";
 
 //#region rolldown:runtime
+
 //#endregion
 //#region src/core/const.d.ts
 declare const THEMES: readonly ["Traditional", "Modernist", "Midnight", "Chocolate", "Oldstyle", "Steely", "Swiss", "Ultramarine"];
@@ -20,23 +21,24 @@ declare const PluginOptionsSchema: z.ZodObject<{
     Ultramarine: "Ultramarine";
   }>>, z.ZodTransform<"Traditional" | "Modernist" | "Midnight" | "Chocolate" | "Oldstyle" | "Steely" | "Swiss" | "Ultramarine", "Traditional" | "Modernist" | "Midnight" | "Chocolate" | "Oldstyle" | "Steely" | "Swiss" | "Ultramarine" | undefined>>;
   layout: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-  checkLaunchPath: z.ZodDefault<z.ZodPipe<z.ZodTransform<{} | undefined, unknown>, z.ZodUnion<readonly [z.ZodBoolean, z.ZodCodec<z.ZodString, z.ZodBoolean>]>>>;
+  resolveLaunchPath: z.ZodDefault<z.ZodPipe<z.ZodTransform<{} | undefined, unknown>, z.ZodUnion<readonly [z.ZodBoolean, z.ZodCodec<z.ZodString, z.ZodBoolean>]>>>;
   collectionPage: z.ZodDefault<z.ZodPipe<z.ZodTransform<{} | undefined, unknown>, z.ZodUnion<readonly [z.ZodBoolean, z.ZodCodec<z.ZodString, z.ZodBoolean>]>>>;
   verbose: z.ZodDefault<z.ZodPipe<z.ZodTransform<{} | undefined, unknown>, z.ZodUnion<readonly [z.ZodBoolean, z.ZodCodec<z.ZodString, z.ZodBoolean>]>>>;
   silent: z.ZodDefault<z.ZodPipe<z.ZodTransform<{} | undefined, unknown>, z.ZodUnion<readonly [z.ZodBoolean, z.ZodCodec<z.ZodString, z.ZodBoolean>]>>>;
   noSTL: z.ZodDefault<z.ZodPipe<z.ZodTransform<{} | undefined, unknown>, z.ZodUnion<readonly [z.ZodBoolean, z.ZodCodec<z.ZodString, z.ZodBoolean>]>>>;
 }, z.core.$strip>;
 declare namespace types_d_exports {
-  export { EleventyDirs, FullPageData, MainPlatforms, ModelViewerTheme, ParsedPluginOptions, PlatformMap, PluginOptions, PluginOptionsInput, ScadTemplateData };
+  export { DockerTag, EleventyDirs, FullPageData, MainPlatforms, ModelViewerTheme, ParsedPluginOptions, PlatformMap, PluginOptions, PluginOptionsInput, ScadTemplateData };
 }
 import * as import__11ty_ts from "11ty.ts";
 __reExport(types_d_exports, import__11ty_ts);
 type ModelViewerTheme = (typeof THEMES)[number];
 type PluginOptions = z.infer<typeof PluginOptionsSchema>;
 type ParsedPluginOptions = z.output<typeof PluginOptionsSchema>;
 type PluginOptionsInput = Omit<z.input<typeof PluginOptionsSchema>, "launchPath"> & {
-  launchPath: "auto" | "nightly" | (string & {});
+  launchPath: "auto" | "nightly" | "docker" | (string & {});
 };
+type DockerTag = "latest" | "trixie" | "bookworm" | (string & {});
 type ScadTemplateData = {
   layout: string;
   title: string;
@@ -99,9 +101,9 @@ declare const SCAD_BINS: {
  * Returns the OpenSCAD binary path for the current platform.
  */
 declare namespace index_d_exports {
-  export { EleventyDirs, EleventyPluginOpenSCAD, FullPageData, MainPlatforms, ModelViewerTheme, ParsedPluginOptions, PlatformMap, PluginOptions, PluginOptionsInput, SCAD_BINS, ScadTemplateData, addOpenSCADPlugin, EleventyPluginOpenSCAD as default };
+  export { DockerTag, EleventyDirs, EleventyPluginOpenSCAD, FullPageData, MainPlatforms, ModelViewerTheme, ParsedPluginOptions, PlatformMap, PluginOptions, PluginOptionsInput, SCAD_BINS, ScadTemplateData, addOpenSCADPlugin, EleventyPluginOpenSCAD as default };
 }
 __reExport(index_d_exports, types_d_exports);
 
 //#endregion
-export { EleventyDirs, EleventyPluginOpenSCAD, FullPageData, MainPlatforms, ModelViewerTheme, ParsedPluginOptions, PlatformMap, PluginOptions, PluginOptionsInput, SCAD_BINS, ScadTemplateData, addOpenSCADPlugin, EleventyPluginOpenSCAD as default };
+export { DockerTag, EleventyDirs, EleventyPluginOpenSCAD, FullPageData, MainPlatforms, ModelViewerTheme, ParsedPluginOptions, PlatformMap, PluginOptions, PluginOptionsInput, SCAD_BINS, ScadTemplateData, addOpenSCADPlugin, EleventyPluginOpenSCAD as default };