Update jsdoc-to-markdown to version 2.0.0 🚀

[greenkeeperio-bot]

Hello lovely humans,

jsdoc-to-markdown just published its new version 2.0.0.

State	Update 🚀
Dependency	jsdoc-to-markdown
New version	2.0.0
Type	devDependency

This version is not covered by your current version range.

Without accepting this pull request your project will work just like it did before. There might be a bunch of new features, fixes and perf improvements that the maintainers worked on for you though.

I recommend you look into these changes and try to get onto the latest version of jsdoc-to-markdown.
Given that you have a decent test suite, a passing build is a strong indicator that you can take advantage of these changes by merging the proposed change into your project. Otherwise this branch is a great starting point for you to work on the update.

Do you have any ideas how I could improve these pull requests? Did I report anything you think isn’t right?
Are you unsure about how things are supposed to work?

There is a collection of frequently asked questions and while I’m just a bot, there is a group of people who are happy to teach me new things. Let them know.

Good luck with your project ✨

You rock!

🌴

---

GitHub Release

This release is intended to freshen up the codebase and make a few improvements while longer-term goals continue to be developed. The majority of improvements relate to performance, the API and dependency tree cleansing - the data and rendered docs output are largely unchanged. For now.

Breaking since 1.3.6

• Whole new API.
  • The streaming interface has gone in favour of sync (node >= 0.12.0) and async (Promise) methods.
  • Methods added to get raw jsdoc data.
  • Generated docs are cached internally by default. Meaning, repeat runs against the same input will return the previous output straight from cache.
  • source option added, you can now pass in source code as a string.
• Command-line tool changes
  • Updated the usage guide
  • options added
    • --namepaths returns all namepaths found in the supplied code
    • --source takes source code in as a string. Useful in scripting.
    • --jsdoc returns the raw, unchanged jsdoc data.
    • --clear clears the cache
    • --no-cache skips the cache
    • --version
  • options changed
    • -c is now the alias for --configure instead of --member-index-format to match the jsdoc -c option.
    • --conf option renamed to --configure to match the jsdoc --configure option.
    • --src option renamed to --files to avoid confusion between --src and --source
  • options removed
    • --sort-by and --group-by removed for now, back in a future version or by popular demand.
• Data and rendered output changes
  • enum is now interpreted as a kind (like member, class etc.) not doclet property, as before. The isEnum property in the --json (and jsdoc-parse) output has gone.
  • @private and @ignored doclets and are now left in the --json (jsdoc-parse) data, and filtered out at template (dmd) level instead.

Other updates

Dependency tree

Old package and deprecation warnings should now be gone.

Documentation

Fresh tutorials in the wiki, more to come.

Usage stats

I'm curious to know whether i can drop node 0.10 or 0.12 support. Also, i'd like to know which features are used/unused, need improving or better documentation. So, the tool keeps count of the features and node versions used. Only count totals are sent, no data, filenames or source code.

To disable collection of stats, run this command:

$ echo '{ "no-usage-stats": true }' > ~/.jsdoc2md.json

jsdoc-parse changes

• Streaming interface removed. jsdoc-parse now exports a single, synchronous function to transform the raw jsdoc data.
• CLI removed.

dmd changes

• Streaming interface removed. dmd now exports both sync and sync functions generate the markdown output.
• Memoisation cache added to speed up repeat invocations.
• CLI removed.

---

The new version differs by 149 commits .

• d9fb19b 2.0.0
• 10ff1b3 readme
• 97ac0a6 readme
• 24025b4 more tests
• a4530a0 2.0.0-alpha.23
• de7f688 deps.. jsdoc now receiving correct cache option
• 0f47f2d switch 'cache' option with 'no-cache'.. guaranteed exit.. linting, more tests
• 25dfd18 readme
• 5536e3b API docs
• c2e3185 merge in next
• ad3e9e7 deps
• 8458398 docs
• f8edb4c docs
• e4ab270 2.0.0-alpha.22
• 4d76a79 correct module.exports

There are 149 commits in total. See the full diff.

---

This pull request was created by greenkeeper.io.

_{Tired of seeing this sponsor message? ⚡ greenkeeper upgrade}

[coveralls]

Coverage remained the same at 100.0% when pulling be01c92 on greenkeeper-jsdoc-to-markdown-2.0.0 into 9f8e152 on dev.

[coveralls]

Coverage remained the same at 100.0% when pulling be01c92 on greenkeeper-jsdoc-to-markdown-2.0.0 into 9f8e152 on dev.