If options.configure is passed, neither .files nor .source are mandatory. #27

Author: 75lb

example/explain.js

@@ -4,5 +4,5 @@ util.inspect.defaultOptions.depth = 6
 util.inspect.defaultOptions.breakLength = process.stdout.columns
 util.inspect.defaultOptions.maxArrayLength = Infinity
 
-const data = await jsdoc.explain({ files: process.argv.slice(2), cache: true, pedantic: true })
+const data = await jsdoc.explain({ files: process.argv.slice(2), cache: true })
 console.log(data)

example/using-config-explain.js

@@ -0,0 +1,8 @@
+import jsdoc from 'jsdoc-api'
+import util from 'node:util'
+util.inspect.defaultOptions.depth = 6
+util.inspect.defaultOptions.breakLength = process.stdout.columns
+util.inspect.defaultOptions.maxArrayLength = Infinity
+
+const data = await jsdoc.explain({ cache: true, configure: './example/using-config.json' })
+console.log(data)

example/using-config-input.js

@@ -0,0 +1,4 @@
+/**
+ * A documented function.
+ */
+function something () {}

example/using-config-render.js

@@ -0,0 +1,3 @@
+import jsdoc from 'jsdoc-api'
+
+await jsdoc.render({ configure: './example/using-config.json' })

example/using-config.json

@@ -0,0 +1,8 @@
+{
+    "source": {
+        "include": [ "example/using-config-input.js" ]
+    },
+    "opts": {
+        "destination": "./config-out/"
+    }
+}

lib/jsdoc-command.js

@@ -12,8 +12,8 @@ const { __dirname } = currentModulePaths(import.meta.url)
 class JsdocCommand {
   constructor (options = {}, cache) {
     assert.ok(
-      options.files?.length || options.source,
-      'Must set either .files or .source'
+      options.files?.length || options.source || options.configure,
+      'Must set at least one of .files, .source or .configure'
     )
     options.files = arrayify(options.files)