Regression fix since v9.3.4

Previously, you could manually render files in a specific order. For example, in the output this code would render docs for two.js before one.js.

const output = await jsdocApi.explain({ files: ['src/two.js', 'src/one.js'] })

This behaviour was broken in jsdoc-api v9.0.0 - instead, it first sorted the files into alphabetical order, thus rendering one.js before two.js.

Jsdoc-api v9.3.5 fixes that regression - previous behaviour restored.

Non-breaking changes since v9.3.3

• Fixed regression where spaces in the jsdoc binary path caused jsdoc-api to fail. jsdoc2md/jsdoc-to-markdown#307
• Add Windows testing to CI

Non-breaking change

• Implemented a permanent fix for the critical util.isRegExp is not a function issue in Node v23, replacing the previous temporary workaround. jsdoc2md/jsdoc-to-markdown#306

Non-breaking change

• Temporary workaround fix for critical util.isRegExp is not a function issue in Node v23: jsdoc2md/jsdoc-to-markdown#306

Non breaking changes since v9.2.0

• The minimum supported Node version has been restored to v12.17.
  • In version v9.0.0, I upgraded file-set (a dependency of this project) to use the latest version of node-glob to avoid deprecation messages. However, the minimum Node version required by node-glob is v20, subsequently forcing jsdoc-api to require Node v20. I wasn't comfortable with this so I rewrote file-set to use fast-glob v3 which supports Node v12.

New features since v9.1.0

• If you need to use a specific jsdoc version or fork, specify its path via JSDOC_PATH and jsdoc-api will use it instead of the default. #29

$ export JSDOC_PATH=./node_modules/.bin/jsdoc # An alternative jsdoc version you installed
$ node my-jsdoc-api-script.js                 # Run your jsdoc-api app as usual

Non-breaking changes since v9.0.2

• To avoid this jsdoc issue (regarding jsdoc failing if a directory contains underscores), jsdoc-api now uses its own bespoke cache directory at ~/.jsdoc-api/cache instead of os.tmpdir(). See #19.
• While running the underlying jsdoc child process, the maxBuffer used is now 100MB to help users processing huge amounts of input #24

There are no changes to the jsdoc-api output.

Breaking changes since v8.1.1

• The minimum required Node version is now v20.
  • A change imposed upon the project by node-glob (used, via file-set, by this lib). It was necessary to upgrade node-glob to the latest version to avoid using a deprecated, unsupported old version.
  • 30th Aug 2024: Update! Support for Node v12 was restored in jsdoc-api v9.3.0
• Removed all synchronous methods. Both .explain() and .render() are now async-only.
• Previously, passing either option.files or option.source was mandatory. Now, it is either option.files, option.source or option.configure. #27

Non-breaking changes

• Fixed an issue where setting { pedantic: false } confused the underlying jsdoc. #22
• Can now pass an array of strings to .source. #11

Other improvements

• Jsdoc-api is now an ES Module.
• Dependency tree cleaned up
  • Coveralls, collect-json, collect-all, fs-then-native and temp-path all factored out of the project.
  • Many others upgraded to the latest versions, removing deprecation warnings.
• Readme examples improved
• Example code added in the /examples folder.
• Codebase simplified, in general.

Upgrade notes

• Update your code replacing any use of explainSync() with await explain() and renderSync() with await render().
• Ensure you're on Node v20 or above
• That's it. There are no changes to the jsdoc-api output - your generated documentation should look the same.

Breaking change since 7.1.1

• Upgraded to use jsdoc v4.0.0. Jsdoc replaced its internal use of taffy-db with a handrolled polyfill.

• Removed the streaming interface (.createExplainStream()).

The main (and possibly only) benefit of streams is the ability to receive and process data as it is being created, without first needing to wait for the data source to finish. However, jsdoc-api was unable to supply output to .createExplainStream() before the underlying jsdoc process had completed, thus leaving no reason for the streaming interface to exist.