feat(cli): reworked command line argument parsing to use commander

z3dev · z3dev · commit 95498660f09f · 2026-01-04T15:42:50.000+09:00
diff --git a/packages/cli/cli.js b/packages/cli/cli.js
@@ -1,46 +1,22 @@
 #!/usr/bin/env node
 // --log_all
 
-// NOTE: this will only run on Node > 6 or needs to be transpiled
-
-// == JSCAD CLI interface, written by Rene K. Mueller <spiritdude@gmail.com>, Licensed under MIT License
-//
-// Description:
-//   jscad <file> [-of <format>] [-o <output>]
-// e.g.
-//   jscad test.jscad
-//   jscad test.jscad -o test.stl
-//   jscad test.jscad -o test.amf
-//   jscad test.jscad -o test.dxf
-//   jscad test.scad -o testFromSCAD.jscad
-//   jscad test.scad -o test.stl
-//   jscad test.stl -o test2.stl      # reprocessed: stl -> jscad -> stl
-//   jscad test.amf -o test2.jscad
-//   jscad test.jscad -of amf
-//   jscad test.jscad -of dxf
-//   jscad test.jscad -of stl
-//   jscad name_plate.jscad --name "Just Me" --title "CEO" -o amf test.amf
-//
+/*
+ * Command Line Interface (CLI) for converting JSCAD designs to differnt external formats.
+ *
+ * Example:
+ *   node ./cli.js --help
+ */
 import fs from 'fs'
+import path from 'path'
+
 import JSZip from 'jszip'
 
 import { supportedFormats } from '@jscad/io'
 
+import { parseArgs } from './src/parseArgs.js'
 import { generateOutputData } from './src/generateOutputData.js'
-import { determineOutputNameAndFormat } from './src/determineOutputNameAndFormat.js'
 import { writeOutput } from './src/writeOutput.js'
-import { parseArgs } from './src/parseArgs.js'
-
-const version = '[VI]{version}[/VI]' // version is injected by rollup
-
-// handle arguments (inputs, outputs, etc)
-const args = process.argv.splice(2)
-let { inputFile, inputFormat, outputFile, outputFormat, generateParts, zip, params, addMetaData, inputIsDirectory } = parseArgs(args)
-
-// outputs
-const output = determineOutputNameAndFormat(outputFormat, outputFile, inputFile)
-outputFormat = output.outputFormat
-outputFile = output.outputFile
 
 const clicolors = {
   red: '\u{1b}[31m',
@@ -50,10 +26,30 @@ const clicolors = {
   black: '\u{1b}[0m'
 }
 
-const logFileOutput = (outputFile) => {
+const version = '[VI]{version}[/VI]' // version is injected by rollup
+
+// handle arguments (inputs, outputs, etc)
+let { filepaths, outputFile, outputFormat, generateParts, zip, params, addMetaData, inputIsDirectory } = parseArgs()
+
+// FIXME handle N input files
+let inputFile = filepaths[0]
+let inputFormat = path.extname(inputFile).substring(1)
+
+// outputs
+if (!outputFile) {
+  // create a base name from the input file
+  const fileElements = path.parse(inputFile)
+  fileElements.ext = '.' + outputFormat
+  if (fileElements.ext == '.stla') fileElements.ext = '.stl'
+  if (fileElements.ext == '.stlb') fileElements.ext = '.stl'
+  fileElements.base = undefined
+  outputFile = path.format(fileElements)
+}
+
+const logFileOutput = (inputPath, outputPath) => {
   console.log(`${clicolors.blue}JSCAD: generating output ${clicolors.red}
-    from: ${clicolors.green} ${inputFile} ${clicolors.red}
-    to: ${clicolors.green} ${outputFile} ${clicolors.yellow}(${supportedFormats[outputFormat].description}) ${clicolors.black}
+    from: ${clicolors.green} ${inputPath} ${clicolors.red}
+    to: ${clicolors.green} ${outputPath} ${clicolors.yellow}(${supportedFormats[outputFormat].description}) ${clicolors.black}
   `)
 }
 
@@ -81,14 +77,14 @@ generateOutputData(src, params, { outputFile, outputFormat, inputFile, inputForm
             if (err) {
               console.error(err)
             } else {
-              logFileOutput(zipFilename)
+              logFileOutput(inputFile, zipFilename)
             }
           })
         })
       } else {
         for (let i = 0; i < outputData.length; i++) {
           const filename = outputFile.replace(/\.(\w+)$/, `-part-${i + 1}-of-${outputData.length}.$1`)
-          logFileOutput(filename)
+          logFileOutput(inputFile, filename)
           writeOutput(filename, outputData[i])
         }
       }
@@ -102,12 +98,12 @@ generateOutputData(src, params, { outputFile, outputFormat, inputFile, inputForm
             if (err) {
               console.error(err)
             } else {
-              logFileOutput(zipFilename)
+              logFileOutput(inputFile, zipFilename)
             }
           })
         })
       } else {
-        logFileOutput(outputFile)
+        logFileOutput(inputFile, outputFile)
         writeOutput(outputFile, outputData)
       }
     }
diff --git a/packages/cli/package.json b/packages/cli/package.json
@@ -41,7 +41,8 @@
     "@jscad/io": "workspace:3.0.2-alpha.0",
     "@jscad/io-utils": "workspace:3.0.2-alpha.0",
     "@jscad/modeling": "workspace:3.0.2-alpha.0",
-    "jszip": "^3.10.1"
+    "jszip": "^3.10.1",
+    "commander": "^14.0.0"
   },
   "devDependencies": {
     "ava": "^4.3.3",
diff --git a/packages/cli/src/env.js b/packages/cli/src/env.js
@@ -1,9 +1,12 @@
 import os from 'os'
+import process from 'process'
 
 const version = '[VI]{version}[/VI]' // version is injected by rollup
 
 export const env = () => {
-  let env = 'JSCAD ' + version
+  const nodeVersion = process.version
+
+  let env = 'JSCAD CLI ' + version + ', Node.js ' + nodeVersion
   if (typeof document !== 'undefined') {
     const w = document.defaultView
     env = env + ' [' + w.navigator.userAgent + ']'
diff --git a/packages/cli/src/parseArgs.js b/packages/cli/src/parseArgs.js
@@ -1,6 +1,8 @@
 import fs from 'fs'
 import path from 'path'
 
+import { Command, Option } from 'commander'
+
 import { loading } from '@jscad/core'
 
 import { supportedInputExtensions, supportedOutputExtensions, supportedOutputFormats } from '@jscad/io'
@@ -9,113 +11,105 @@ import { env } from './env.js'
 
 const { getDesignEntryPoint } = loading
 
-export const parseArgs = (args) => {
-  const inputExtensions = supportedInputExtensions()
-  const outputExtensions = supportedOutputExtensions()
-  const outputFormats = supportedOutputFormats()
-
-  // hint: https://github.com/substack/node-optimist
-  //       https://github.com/visionmedia/commander.js
-  if (args.length < 1) {
-    console.log('USAGE:\n\njscad [-v]\n\n')
-    console.log('jscad [-gp] [-z] <file> [-of <format>] [-o <output>]')
-    console.log(`\t<file>  :\tinput (Supported types: folder, .${inputExtensions.join(', .')})`)
-    console.log(`\t<output>:\toutput (Supported types: folder, .${outputExtensions.join(', .')})`)
-    console.log(`\t<format>:\t${outputFormats.join(', ')}`)
-    process.exit(1)
+const outputFormats = supportedOutputFormats()
+const inputExtensions = supportedInputExtensions()
+
+const isValidInputFileFormat = (input) => {
+  if (input === undefined || input === null || !(typeof input === 'string')) {
+    return false
+  }
+  return inputExtensions.reduce((acc, format) => input.toLowerCase().endsWith('.' + format) || acc, false)
+}
+
+export const parseArgs = () => {
+  const filepaths = [] // list of input file paths
+  const parameters = [] // parameter values for main(parameters) and serialize(parameters)
+
+  /*
+   * Setup command line arguments
+   */
+  const program = new Command();
+  program.name('cli.js')
+  program.usage('[options] <files...> -- parameter values')
+  program.argument('[files...]')
+  program.addOption(new Option('-f, --output-format <format>', 'output format').choices(outputFormats).default('stla'))
+  program.option('-p, --generate-parts', 'generate unique parts from the files', false)
+  program.option('-z, --zip', 'zip the output file contents', false)
+  program.option('-o, --output-file <filepath>', 'output file name (optional)')
+  program.option('-m, --add-metadata', 'add metadata to output format', false)
+  program.option('-v, --version', 'show version and environment information', false)
+  program.action((args) => {
+    // handle the provided arguments
+    args.forEach((arg) => {
+      try {
+        fs.statSync(arg)
+        filepaths.push(arg)
+      } catch (e) {
+        parameters.push(arg)
+      }
+    })
+  })
+  program.parse()
+
+  const options = program.opts();
+
+  // show the runtime environment if requested
+  if (options.version) {
+    env()
   }
 
-  let inputFile
-  let inputFormat
-  let outputFile
-  let outputFormat
-  let generateParts = false
-  let zip = false
-  const params = {} // parameters to feed the script if applicable
-  let addMetaData = false // wether to add metadata to outputs or not : ie version info, timestamp etc
-  let inputIsDirectory = false // did we pass in a folder or a file ?
-
-  const isValidInputFileFormat = (input) => {
-    if (input === undefined || input === null || !(typeof input === 'string')) {
-      return false
+//console.log(options)
+//console.log(filepaths)
+//console.log(parameters)
+
+  if (filepaths.length === 0) process.exit(1)
+
+  if (options.outputFile) {
+    // check that the output file name implies a valid output format
+    let outputFormat = path.extname(options.outputFile).substring(1)
+    if (outputFormat === 'stl') outputFormat = 'stla'
+    if (!outputFormats.includes(outputFormat)) {
+      console.log('ERROR: invalid output file format <' + outputFormat + '>')
+      process.exit(1)
     }
-    return inputExtensions.reduce((acc, format) => input.toLowerCase().endsWith('.' + format) || acc, false)
+    // check for toxic combinations
+    if (filepaths.length !== 1) {
+      console.log('ERROR: multiple inputs cannot be converted to a single output file.')
+      process.exit(1)
+    }
+    options.outputFormat = outputFormat
+  } else {
+    options.outputFile = undefined
   }
-  const getFileExtensionFromString = (input) => (input.substring(input.lastIndexOf('.') + 1)).toLowerCase()
-
-  const parseBool = (input) => input.toLowerCase() === 'true'
-
-  for (let i = 0; i < args.length; i++) {
-    if (args[i] === '-of') { // -of <format>
-      outputFormat = args[++i]
-    } else if (args[i] === '-gp') {
-      generateParts = true
-    } else if (args[i] === '-z') {
-      zip = true
-    } else if (args[i].match(/^-o(\S.+)/)) { // -o<output>
-      outputFile = args[i]
-      outputFile = outputFile.replace(/^-o(\S+)$/, '$1')
-    } else if (args[i] === '-o') { // -o <output>
-      outputFile = args[++i]
-    } else if (args[i] === '-add-metadata') { // -metadata true/false
-      addMetaData = parseBool(args[++i])
-    } else if (args[i].match(/^--(\w+)=(.*)/)) { // params for main()
-      params[RegExp.$1] = RegExp.$2
-    } else if (args[i].match(/^--(\w+)$/)) { // params for main()
-      params[RegExp.$1] = args[++i]
-    } else if (isValidInputFileFormat(args[i])) {
-      inputFile = args[i]
-      inputFormat = getFileExtensionFromString(args[i])
-      if (!fs.statSync(inputFile).isFile()) {
-        console.log('ERROR: cannot open input file/directory <' + inputFile + '>')
-        process.exit(1)
-      }
-    } else if (args[i].match(/^-v$/)) { // show the version and the environment information
-      env()
-    } else {
-      inputFile = args[i]
-      if (fs.statSync(inputFile).isDirectory()) {
-        inputIsDirectory = true
-        // get actual design entry point if applicable (if passed a folder as input etc)
-        inputFile = getDesignEntryPoint(fs, inputFile)
-        if (!inputFile) {
-          console.log('ERROR: could not determine entry point of project.')
-          console.log('Verify main or index exists')
-          process.exit(1)
-        }
-        inputFormat = path.extname(inputFile).substring(1)
-      } else {
-        console.log('ERROR: invalid file name or argument <' + args[i] + '>')
-        console.log("Type 'jscad' for a list of supported types")
+
+  // check for use of a directory, and determine the design entry point
+  options.inputIsDirectory = false
+  if (filepaths.length === 1) {
+    if (fs.statSync(filepaths[0]).isDirectory()) {
+      options.inputIsDirectory = true
+      // get actual design entry point
+      const filepath = getDesignEntryPoint(fs, filepaths[0])
+      if (!filepath) {
+        console.log('ERROR: could not determine entry point of project <' + filepaths[0] + '>')
+        console.log('Verify project main or index exists')
         process.exit(1)
       }
+      filepaths[0] = filepath // use the entry point for conversion
     }
   }
-  // exit if a input file was not provided
-  if (!inputFile) process.exit(1)
 
-  if (!outputFormat && !outputFile) {
-    outputFormat = 'stla'
-  }
-  if (!outputFormat && outputFile) {
-    outputFormat = path.extname(outputFile).substring(1)
-    if (outputFormat === 'stl') outputFormat = 'stla'
-  }
-  if (!outputFormats.includes(outputFormat)) {
-    console.log('ERROR: invalid output format <' + outputFormat + '>')
-    console.log("Type 'jscad' for a list of supported types")
-    process.exit(1)
-  }
+  // check that all input files are valid formats for conversion
+  filepaths.forEach((filepath) => {
+    if (!isValidInputFileFormat(filepath)) {
+      console.log('ERROR: invalid input file format <' + filepath + '>')
+      process.exit(1)
+    }
+  })
 
-  return {
-    inputFile,
-    inputFormat,
-    outputFile,
-    outputFormat,
-    generateParts,
-    zip,
-    params,
-    addMetaData,
-    inputIsDirectory
-  }
+  options.filepaths = filepaths
+  options.params = parameters
+
+//console.log('RETURN',options)
+
+  return options
 }
