npm swagger-jsdoc 7.0.0-rc.1

latest releases: 6.2.8, 6.2.7, 6.2.6...
3 years ago

The first 7.x release. It's a major refactoring of v6 reaching 100% test coverage and a few major changes on the way:

  • Written in ESM instead of CommonJS

  • CLI has been moved to be an example => breaking change and a need for the user to create a CLI. Reason: too many varying requests for changes in the CLI which was based on commander. The module loading utility has been left in the examples' folder together with tests, so migration should be very straight-forward to your preferred CLI package. Library authors have already made alternative CLIs in parallel such https://github.com/lmammino/swagger-jsdoc-generator

  • The main function is now returning a promise. It's because during the rewrite, many sync functions have been changed to promises, especially file reading operations. This change can be considered as imminent as other features in the future will also require it to be async.

Don't miss a new swagger-jsdoc release

NewReleases is sending notifications on new releases.