docma - npm Package Versions

3.2.2 (2019-01-08)

Fixed

• An issue where enumeration value would be incorrectly displayed as undefined in docs parsed from ES5 code.
• An issue where jsdoc.predicate (or jsdoc.filter) option would not be taken into account.
• An issue where favicon would not be copied over to the output dir.
• (Zebra Template) An issue where some special characters within the location hash would cause an error.
• Invalid assignment error due to ES2015 syntax.

Added

• Support for handling notation with multiple sub-types. e.g. Map<String, Object>. (PR #65 by @MaienM)

Changed

• Improved / cleaner symbol names and long names. This also fixes a JSDoc bug that unnecessarily and incorrectly wraps the last level of the notation in quotes and brackets.
• Updated dependencies to their latest versions.

3.1.0 (2018-12-04)

Fixed

• An issue with "path" routing which led to 404 page, occurred when a (deep) route was refreshed or loaded directly. (Due to a bug in core dependency.) Fixes #62.
• An issue where a (harmless) TypeError was thrown when debug is enabled.
• An issue with $docmaLink due to missing trailing slash, when routing method is "path".

Added

• (Zebra Template) Added JSDoc @default tag support for symbols. Fixes #60.
• (Zebra Template) Added option contentView.faLibs that defines FontAwesome libraries to be included, such as solid, regular, brands. Set to null to completely exclude FontAwesome from the output. See Zebra documentation. Fixes #63.
• (Zebra Template) Added option contentView.faVersion that defines FontAwesome icon library version to be included.

Changed

• Improved SPA route handling.
• Updated dependencies to latest versions.

3.0.0 (2018-11-18)

Changed

• BREAKING: Dropped support for Node.js versions 6 & 7. Requires Node.js v8 and later. This change is due to updates to the core dependencies such as fs-extra, jsdoc-x and jsdom.
• Improved path/query routing.
• BREAKING: Linking logic has some changes.
• (Zebra template) Improved support for constant symbols.

Added

• Ability to force parser type on defined files/paths; by appending a suffix. For Markdown, append :md or :markdown. For HTML, append :htm or html. For example, LICENSE:md will force-parse LICENSE file as markdown. file.partial:html will force-parse file.partial as HTML.
• Ability to create deeper paths for named groups/routes. e.g. mylib/latest
• Support for favicon. Set app.favicon to your ICO file's local path.
• Support for collapsable markdown (i.e. with <details> and <summary> tags). This is great for generating styled collapsable lists (such as F.A.Q.) from your markdown files. If a bookmark (id) is passed in the location hash, that item will auto-expand. See [Docma F.A.Q.][faq] for an example. Note that Edge does not support details/summary tags yet. All other modern browsers have support.
• Ability to hide or remove specific, partial content from Docma output. For example if you want some part of your README to be visible in GitHub repo but not in your Docma generated documentation... See this for details.
• New CLI option (-b or --base) for docma serve command to override/set the base path.
• (Zebra Template) Added support for collapsable markdown (i.e. with <details> and <summary> tags).

Fixed

• An issue where documentation build would fail due to a symbol name being a non-string value. Fixes #54.
• An issue where the web app would throw Uncaught TypeError when invalid JSDoc type specified for @returns. Fixes #55.
• Fixed ["Reverse Tabnabbing" vulnerability][tabnabbing] with generated documentation links. (This is also fixed for Zebra template.)
• An issue where base tag would not be added to the head of main document.
• An issue where Docma would not set default app.base path to / as expected. Fixes #59.
• An issue where symbol link would be parsed as absolute path rather than relative. Fixes #50.
• (Zebra template) Fixed an issue where tags such as @constant and @module would cause an Uncaught TypeError. Fixes #41 and #45.

2.1.0 (2018-04-29)

Docma CLI

Thanks to @feugy for this PR.

Added

• serve command now takes conf.app.base parameter into consideration, and will redirect http://localhost:9000/ to it.

Fixed

• serve command can handle conf.app.dest relative path, and resolves them against current working directory.
• A file name issue that produces cannot find module error in case-sensitive systems. Fixes #38.

Changed

• Renamed the --quite option to --quiet. Alias -q remains the same.

2.0.0 (2018-04-12)

This is a big release with some breaking changes.
Please read this changelog thoroughly before updating your Docma configuration.

Docma (Builder)

Added

• Support for documenting code with ES2015 syntax. (JSDoc and jsdoc-x dep. update.) Fixes #18 and #21.
• assets build configuration which provides ability to copy defined asset files/directories to build directory; so you can use/link to non-source, static asset files (such as images, PDFs, etc). See [build configuration][build-config]. Fixes #29.
• Pre-build and post-build process support for Docma templates. See Docma Templates documentation.
• markdown.xhtml option for build configuration.
• Docma version compatibility check for Docma templates.
• clean option that specifies whether to empty destination directory before the build. Default is false.
• Build statistics logs to console output. Now, displaying gzipped size of generated (docma-web) script, in addition to minified size; and more detailed summary of routes configured.

Fixed

• An issue where the builder would not check for duplicate route names with the same route type (and silently overwrite the generated content file).
• An issue where compiled template scripts were altered when full-debug is enabled.
• An issue with redirecting a page when the routing method is set to "path".
• An issue with images in HTML (generated from markdown) that would overflow out of page. Now, limiting the image width to 100% of parent container while keeping the aspect ratio.
• An issue with generated heading ids when building docs from markdown. Other HTML tags contained within the heading were not ignored, resulting in too complex ids (bookmarks).

Changed

• BREAKING: Due to several upgrades (such as jsdom), Docma v2+ requires Node.js v6 or newer.
• Greatly improved the symbol sorting logic ([jsdoc-x][jsdoc-x]). You can now sort by scope, by access type, by kind, grouped or alphabetic (default). See jsdoc.sort option in [build configuration][build-config].
• The destination directory is not auto-cleaned anymore before the build. Use clean option for the old behavior. Fixes #34.
• Improved markdown parser. Both <h1 /> and <h2 /> tags are now followed with a <hr/>, like on GitHub.
• Updated core dependencies to their latest versions.
• Migrated all code to ES2015.
• BREAKING: Docma templates are now node modules. Docma still comes with an updated, built-in default template (Zebra). But templates designed for Docma v1.x will not work with Docma v2.x.

Removed

• For template authors only:
  • BREAKING: docma.template.json file that defines the template build and configuration options is dropped in favor of template module main (JS) file or package.json. There are several other improvements. See updated documentation on Creating Docma Templates.
  • BREAKING: compile property of template configuration is removed. Now, scripts or less/sass files of the template should be pre-compiled. This is logical and speeds up the documentation build process of Docma.

Docma CLI

Added

• Option --clean to empty destination directory before the build.
• Command docma serve for starting a static server for serving / testing the generated SPA.
• Command docma template init for initializing a new Docma template project.
• Command docma template doctor for diagnosing a Docma template. Useful for template authors.

Changed

• Dropped default configuration file name docma.config.json in favor of docma.json (shorter) and .docma.json if you need to hide it. This does not break anything, you can still use the former if you want.
• CLI will now auto-check for a docma.json (or .docma.json) file in the current working directory if -c option is omitted.
• Options -v (lowercase) and -V (uppercase) are swapped. -v gets the Docma version now (alias --version). And -V is --verbose.

See [CLI documentation][cli] for detailed information on updated CLI.

Docma Web Core

Added

• Event navigate that's triggered either when route is changed or on hash-change.
• Each symbol in docma.apis[name].documentation instances, now has a .$docmaLink property.
• New utility methods to DocmaWeb.Utils: .type(), .getSymbolLink(), .getLevels(), .getParentName(), .getParent(), .isPackagePrivate(), .isEvent(), .isGenerator(), .isCallback(), .isConstant(), .isInterface(), .isExternal() and .isMixin().
• Utility methods .getCodeTags(), .getFormattedTypeList(). Fixes #33.
• Utility method .trimNewLines(). This also has a dust filter $tnl.

Fixed

• Broken bookmark links due to URI encoded characters after hash (#). e.g. when navigated to #MyClass%7EInnerObject instead of #MyClass~InnerObject.
• An issue with DocmaWeb.Utils.getLongName(), occured after JSDoc core upgrade.
• currentRoute parameter of the route event. Passing null instead of empty route object when route does not exist.
• An issue with DocmaWeb.Utils.isClass() utility method where meta.code.type is not set to ClassDeclaration.
• DocmaWeb.Utils.isProperty() utility method. It'll now return false if symbol is a method/function. This also affects the following methods: .isStaticProperty(), .isInstanceProperty().

Changed

• BREAKING: Docma utility methods are moved to DocmaWeb.Utils static namespace (formerly under docma.utils).
• DocmaWeb.Utils.getSymbolByName() signature is changed.
• Updated web-core dependencies.

Docma Template API

Changed

• Docma templates are now node modules. This is the initial Template API. See updated documentation on Creating Docma Templates.

1.5.3 (2017-12-21)

Docma Web Core

Fixed

• A parser issue where carriage return (CR) of Windows newlines (CRLF) were removed. Fixes #28.

<br />

1.5.2 (2017-12-09)

Docma Web Core

Fixed

• $ is not a function error on Windows. PR #23 by @warpdesign.
• Some typos in documentation. PRs #13, #17.

Note: For this release, some dependencies (such as jsdoc-x, jsdom) are NOT updated on purpose 'cause they introduce breaking changes. In v2 (WIP, to be released) these will be updated and many things will be improved.

<br />

1.5.1 (2017-03-11)

Docma Web Core

Fixed

• slice error for non-string default value.

<br />