All notable changes to this project will be documented in this file. See standard-version for commit guidelines.
9.0.0-alpha.0 (2018-09-21)
- Babel 7 support (49c0f72)
- This moves documentation.js to Babel 7. From now on, documentation.js will only support Babel 7: please stick to older releases if you need to support Babel 6. Additionally, this work temporarily disables support for following dynamic imports.
8.1.2 (2018-08-23)
8.1.1 (2018-08-17)
- Serve on correct port (4d59f6f)
8.1.0 (2018-08-03)
- package: update get-port to version 4.0.0 (9ca8c06)
- added project description (45a9ea9)
8.0.2 (2018-07-20)
- package: update git-url-parse to version 10.0.1 (91ade89)
8.0.1 (2018-07-16)
- package: update read-pkg-up to version 4.0.0 (c700d3f)
8.0.0 (2018-06-04)
- changes Markdown output
7.1.0 (2018-05-26)
- support flow comment types (85d50f9)
7.0.0 (2018-05-22)
- Auto-detect readme filename (4fd776b)
- the --readme-file option now has a smart default value
6.3.3 (2018-05-14)
6.3.2 (2018-04-24)
- vue: Make vue parser tolerant of components that don't contain scripts (#1061) (8f9bc7b), closes #1060
6.3.1 (2018-04-23)
6.3.0 (2018-04-20)
- package: update git-url-parse to version 9.0.0 (94a1fb6)
- Vue Support (f60d90c)
6.2.0 (2018-04-11)
- get rid of shelljs dependency (630625d)
- doctrine: Support decorator syntax in examples (b309d39), closes #1016
- inferTypes: Support class properties (22d8740), closes #1043
6.1.0 (2018-03-08)
6.0.0 (2018-03-02)
- documentation.js requires node v6 or newer.
5.5.0 (2018-03-02)
- github links for @typedef comments should link to comment, not context (#1024) (37a91b2)
- Make documentation.js compatible with node 4.x for one more version (#1033) (5067ee0)
- Support
--shallowargument forlintcommand. Closes #956 (#995) (64f660d) - Support the .mjs extension by default. (#1023) (b8a7e0d)
- use reference links for Markdown output, improving brevity (ab494dd)
5.4.0 (2018-02-10)
- package: update remark-toc to version 5.0.0 (0bb3d0d)
5.3.5 (2017-12-12)
5.3.4 (2017-12-12)
- package: update babelify to version 8.0.0 (10dff6f)
- package: update read-pkg-up to version 3.0.0 (d8fbf2c)
- package: update remark-html to version 7.0.0 (9842814)
- package: update vinyl-fs to version 3.0.0 (#966) (1d6fe80)
5.3.3 (2017-10-12)
- html: Display all levels of parameter properties. (#933) (7a548eb)
- package: update github-slugger to version 1.2.0 (2b74956)
- Fix the split in HTML at 33/67% instead of calculating percentages (#939) (e4781eb), closes #927
5.3.2 (2017-09-15)
- special property names in flowtypes (7fc6ca8)
5.3.1 (2017-09-07)
- cover more hideconstructor cases (5bdbf1f)
- Enable dynamicImport plugin to support import() syntax (#903) (b97241f), closes #902
- regression in toc causing crash (125a577)
5.3.0 (2017-09-04)
- groups in toc (#895) (c94412a)
- implement @hideconstructor (#898) (7a07d51)
5.2.2 (2017-08-22)
- $compile: prevent babel from transpiling non-module scripts in default_theme's assets (1286a1f)
5.2.1 (2017-08-12)
5.2.0 (2017-08-09)
- alphabetical sort and add flow notation to sort file (#861) (aa3496a), closes #838
- make html and markdown second option optional (#871) (0324865), closes #869
5.1.1 (2017-08-04)
- theme: Remove dead stepsibling navigation code (dccb151)
- cli options should override package.json options (ecf16bd), closes #845
5.1.0 (2017-07-31)
- scripts: Remove changelog package.json task (dddac19)
- theme: Flexible sidebar for default theme (6509ae8)
5.0.1 (2017-07-28)
5.0.0 (2017-07-27)
- polyglot: I'd like to still support C++ and other languages in the future! But I'm much happier doing so by separating the extraction & input phases to the degree that documentation.js can read the output of another module that extracts JSDoc comments from C++ code, rather than having CPP support in it.
4.0.0 (2017-07-27)
- html output: Fix links between navigation and items in HTML documentation (5fb77bc)
- package: update babel-generator to version 6.25.0 (#804) (65f5a37)
- package: update chalk to version 2.0.0 (#833) (2329db4)
- package: update github-slugger to version 1.1.3 (#793) (74392cc)
- Show () for callbacks (61968c7)
- package: update micromatch to version 3.0.0 (#792) (3f2bf90)
- package: update remark to version 8.0.0 (1ae8136)
- Fix filtering in the default theme (473f317)
- Report nesting errors instead of throwing them as errors (ea69608), closes #832
- package: update remark-html to version 6.0.1 (#815) (e472550)
- package: update vfile-reporter to version 4.0.0 (a3e1fb8)
4.0.0-rc.1 (2017-05-01)
- Infer parameters for classes from constructors (355038d), closes #689
- document-exported: Ensure that document-exported does not document constructors separately (96a6d13)
- flow: Fix inference of Flow types with properties (#751) (7c00acc), closes #749
- params: Parameters with default use = not ? (3cc4426), closes #737
- lint: Identify explicit tags that don't match inference in lint stage (ed5c2a0)
4.0.0-rc.0 (2017-04-21)
- html output: Fix github links in HTML output (#745) (9554b2f), closes #738
- params: added code path for type RestElement (6961ee8)
- nest: referencing inferred destructure params without renaming them, like $0.x, from JSDoc comments will no longer work. To reference them, instead add a param tag to name the destructuring param, and then refer to members of that name.
Before:
/**
* @param {number} $0.x a member of x
*/
function a({ x }) {}After:
/**
* @param {Object} options
* @param {number} options.x a member of x
*/
function a({ x }) {}-
Address review comments
-
Reduce testing node requirement back down to 4
-
Don't output empty properties, reduce diff noise
-
Rearrange and document params
-
Simplify param inference, update test fixtures. This is focused around Array destructuring: documenting destructured array elements with indices instead of names, because the names are purely internal details
-
Use temporary fork to get through blocker
4.0.0-beta.19 (2017-04-10)
- inference: Refactor membership inference (84c9215)
- inference: Robust parsing for shorthand object methods (802dc4c)
- scopes: Support inner scope (#665) (8cc34b6)
- core: Support Flow interface declarations (e2915dc)
- core: Switch to Promises everywhere. Adopt Node v4 ES6 (#648) (631c692)
- markdown: Add
[@see](https://github.com/see)tag output in Markdown (#682) (f07285a)
4.0.0-beta.18 (2016-12-29)
- cli: Fix error reporting in the CLI (88c8f9a)
- markdown: Start headings in Markdown at h2 (#644) (2ae5d8f)
- bin: Support globs on windows and use smarter recursion (#629) (cb8fdfa), closes #607
- markdown: Add table of contents support for Markdown mode (#645) (4c66fb1)
- dependencies: Move standard-changelog to devDependencies (#636) (7a66b3f)
4.0.0-beta.17 (2016-12-23)
This release also fixes a mistake I was making with semver: pre-v4 beta
releases will be called beta.17 and beta.18 and so on, rather than
non-standard beta16 without the ..
4.0.0-beta16 (2016-12-07)
- bin: Remove dead code in documentation.js command (#627) (ab16a20)
- extractors: Document export default value (#623) (363a108), closes #543
- parser: Avoid error about deoptimization on very large files (#621) (846ab94)
- build: load passed in config option (#625) (89fb67f)
- output: Display type information for typedefs in Markdown and HTML (8b04029)
4.0.0-beta15 (2016-11-23)
- Infer class augments tag in cases like
Foo extends React.Component
- Highlight all Markdown, not just examples. Fixes #610
- Fix for
--configonly strip comments on json files (#611) - Merge inferred return type like we do for params. Refs #359 (#604)
- Support webpack's System.import with nice handy babel plugin (#603)
- Format optional types with ? instead of [] (#538)
- Fix membership assignment for old-fashioned prototype members (#599)
- Update Node API documentation to include only exposed API surface
- Add too-much-inference troubleshooting topic
- Fix linker null reference error
- Update Doctrine to handle more JSDoc types
- Fix ReferenceError in default theme
- Show GitHub link for nested elements in default theme
- Fix linking resolution order
- Improved support for Flow: function types, object types, mixed types, null, void, typedefs
- New option: sort-order
- Updates to Babylon 6.10.x
- Updates to dependencies, including yargs.
document-exportednow traverses only exported code.
- Lower memory consumption when dealing with large codebases
- Better support for detecting names and kinds of ES6-exported values
- New
document-exportedflag allows you to automatically document ES6-exported values, without even a comment! 490
- Add decorator support (zacharygolba)
- Add support to infer whether functions are private based on their name,
like starting with
_(arv) - Improve internal documentation
- Fix minor dependency mistake
- Updates theme to a much-improved design
- Fix augments tag display in HTML
- Improve name detection of ES6-exported methods and variables
- Allow documentation of Object.prototype methods
Minor fixes
- Fixes
export { foo } from './bar'style export - Fixed CLI usage examples to simply say
documentationinstead of/usr/bin/documentationor similar.
Now using Babel 6!
Much long-awaited upgrade makes documentation.js compatible with fresh new Babel-using codebases.
And also:
- GitHub Enterprise support
- New tag support: abstract, override, readonly, interface, variation, see, todo (only in parsing phase, not yet in all outputs)
- Parses jsx and es6 extensions by default, as well as .js
- Fixes polyglot mode
- Now shows the
@throwstag content in Markdown output - Support for example captions
Revitalized documentation.js command line interface!
The documentation utility now takes commands:
documentation buildextracts and formats documentationdocumentation serveprovides an auto-reloading server (#236)documentation lintreviews files for inconsistenciesdocumentation readmepatches API documentation into a readme (#313 by @anandthakker)
This functionality was previously included in dev-documentation and has
been folded into documentation proper.
Much more flexible themes
Themes are now much more customizable. In documentation.js 3.x and before, themes were required to use Handlebars templates and produce a single page. In documentation.js 4.x and beyond, they are JavaScript modules that can use any template engine and produce any number of files. See the new theme documentation for details.
More precise traversal
Inference in 4.x is stricter than in 3.x: comments must be adjacent to the statements they document. This should make documentation generation much more predictable.
Support for the revealing module pattern
/** Foo */
function Foo() {
/** Test */
function bar() {}
return {
bar: bar
};
}New support for the JavaScript module pattern! This was implemented in #324 by Charlie Brown.
Breaking changes
- documentation.js now follows the JSDoc standard's interpretation of the @name tag: specifying a name tag will turn off inference. If you still want inference but want to call code something else, use the @alias tag instead.
- Allow parameter types to be mixed into explicit parameter documentation. (#239 and #232)
- Support GitHub links in Markdown output (#238)
- Infer typedefs from Flow type aliases. Fixes #227
- Fix type-annotated rest expressions, raised in #230
- Infer rest parameters. Fixes #223
- Avoid filtering comments in lint mode. Fixes #186
- Nest both properties and params. Fixes #164
- BUGFIX: Fix default theme resolution #212
The largest change to documentation.js so far.
Dropping streams
This a major refactor of the documentation.js interface with a focus on simplifying the system. Up until this point, documentation.js was built around node.js streams, which are low-level representations of asynchronous series of data. While this abstraction was appropriate for the input and github streams, which are asynchronous, the majority of documentation.js's internals are simple and synchronous functions for which basic functional composition makes more sense than stream semantics.
Documentation 3.0.0 uses simple functional composition for operations like parmameter inference, rather than streams.
Stronger support for ES6, ES7, and Flow
We've switched to Babel as our source code parser, which means that we have much broader support of new JavaScript features, including import/export syntax and new features in ES6.
Babel also parses Flow type annotations, and new inference code means that we can infer
- Parameter names & types
- Return types
Without any explicit JSDoc tags. This means that for many simple functions, we can generate great documentation with less writing.
Stronger module support
Documentation.js now has much better inference for membership and names of symbols
exported via exports or module.exports.
Support for nested symbols
The parent/child relationship between symbols is now fully hierarchical, and symbols can be nested to any depth. For instance:
/**
* A global Parent class.
*/
var Parent = function () {};
/**
* A Child class.
*/
Parent.Child = function () {};
/**
* A Grandchild class.
*/
Parent.Child.Grandchild = function () {};
In addition, filtering by access is now applied to the entire hierarchy: if you
mark a class as @private, neither it nor its children will be included in the
output by default, regardless of the access specifiers of the children.
mdast-based Markdown output
We've switched from templating Markdown output with Handlebars.js to generating an abstract syntax tree of desired output and stringifying it with mdast. This lets documentation.js output complex Markdown without having to worry about escaping and properly formatting certain elements.
Test coverage 100%
documentation.js returns to 100% test coverage, so every single line of code is covered by our large library of text fixtures and specific tests.
--lint mode
Specifying the --lint flag makes documentation.js check for non-standard
types, like String, or missing namespaces. If the encountered files have
any problems, it pretty-prints helpful debug messages and exits with status 1,
and otherwise exits with no output and status 0.
Breaking changes
- The
--versionflag is now--project-version.--versionnow outputs documentation.js's version
- Fixes
@paramtags that refer to properties of unmentioned objects: these will warn instead of crashing. For instance,/** @param {boolean} foo.bar */. - Expose
--shallowoption in CLI
- Breaking: Removes
docsetsupport from documentation.js: this will be supported by a 3rd party tool in the future. This removal means that we no longer have node-sqlite3 as a dependency, and documentation can be installed on systems without a compile toolchain. - JSDoc parse errors are now printed to stderr.
- Parameter tags that document sub-parameters, such as
@param {Type} options.option, are now nested under their parent parameter. - HTML output now includes events.
- Error messages now include source file name and line number.
- @typedef names are now inferred correctly.
- Output for the
@throwstag. - Output in HTML for the
@propertiestag.
- Now infers
namefromclassandeventtags - Support for documenting C++ code with the
polyglotoption and--polyglotCLI option - Fixed github linking
- Support for JSDoc3-style bracketed optional parameters, like
/**
* @param {Type} [param=defaultValue]
*/- Transforms in package.json
browserify.transformfields are now applied to source code so that babel, etc can be supported. - Fixes crash caused by requiring JSON files
- Add
externaloption that allows the user to whitelist specific external modules to be included in with documentation.
- Fixes sorting order of documentation
- Switches order of static and instance members in output