apidoc 0.50.0

apidoc-0.50.0

on Node.js NPM

This release marks a new era of this project. Many things have been done and a lot of the code has been improved/modified/fixed. One major change is for instance the merge of apidoc-core back in the main apidoc repo.

Normally you will be able to run this new version on your existing codebase with no changes and it should work. But as you can imagine, there are still probably a few bugs here and there, so please make sure to report them through a GitHub issue!

0.50.0

BREAKING CHANGES

• --silent renamed to --quiet or -q for short
• --color renamed to --no-color to disable color in log output
• --parse was deleted because it is the same as --simulate
• --simulate renamed to --dry-run / -n
• Default output is not json, use "--log-format json" to get json
• --config / -c must be a path to a file, not a directory
• Node v14.x required

FIXED

• Fix sampleUrl config option behavior:

  • if it is absent or false, no sample block will be generated
  • if it is true, the current page location will be used
  • if it is an url, that will be used
    Note that the option useHostUrlAsSampleUrl has no longer any effect and can be safely removed. Use a value of true for sampleUrl to get the same behavior.

• Fix non working sortFields function (fix #968)

• Fix syntax highlighting for markdown parsed text

• Fix color in logs was not showing since upgrade to winston 3

• Fix newlines being removed in pre tags (fix #809 by @JayBerlin)

• Fix header/footer in aloneDisplay mode (fix #905 via #1027 by @esaracco)

• Fix duplicated content in aloneDisplay mode (fix #938 via #1025 by @esaracco)

• Fix apiSampleRequest not working (fix #984 via #1023 by @esaracco)

• Fix error with parenthesis in apiGroup (fix #994 via #1022 by @esaracco)

• Fix absent diff on different api route (fix #963 via #1030 by @esaracco)

ADDED

• Add request method to compare template (#986 by @klickagent)
• Add some shorthand options, see apidoc -h
• Add --log-format option for json output (default is not json)
• Add ascii art in verbose mode
• Add --warn-error to treat warnings as error (fix #703)

ENHANCEMENTS

• HUGE CLEANUP OF THE CODEBASE
• Merge apidoc-core back into the apidoc repository. The apidoc-core repository is now read-only.
• Add .eslintrc.js and enforce coding style everywhere
• Update many dependencies to their latest version
• Make sidenav wider and template more responsive (fix #851)
• Big CSS code overhaul and change
• Ignore node_modules by default (fix #936)
• Add ASCII art in verbose mode
• Allow setting input and output in apidoc.json (fix #630)
• Take standard parameters of URL query string into account (#1014 by @esaracco)
• Allow colon character in apiDefine (fix #877 via #1021 by @esaracco)