docsbydoxdox / doxdox Goto Github PK

📘 JSDoc to Markdown, Bootstrap, and custom JavaScript template documentation generator.

License: MIT License

JavaScript 37.75% TypeScript 62.25%

doxdox's Introduction

⚠️ Notice: This repository is undergoing a massive rewrite. Things will be missing, broken, or incomplete as development continues.

Documentation, simple.

doxdox is a simple to use documentation generator that takes JSDoc comment blocks and generates different documentation formats; Markdown, Bootstrap, GitHub Wiki, and other custom plugins.

doxdox also features support for extendibility via custom plugins for both parsing and generating documentation.

Example

In

/**
 * Request content from URL or array of URLs.
 *
 * @example fetch('http://www.google.com/humans.txt').then(content => console.log(content));
 * @example fetch(['http://www.google.com/humans.txt']).then(contents => console.log(content[0]));
 * @param {String|String[]} urls A URL or an array of URL strings.
 * @param {Object} [options] Options object.
 * @param {String} [options.cacheDirectory] Directory to store cache. Default is `temp/cache/`.
 * @param {Object} [options.requestOptions] Custom request options object. Default is `{}`.
 * @param {Number} [options.ttl] TTL (Time to live) in seconds. Default is 1800
 * @return {Promise<String[]>} Contents of request as an array.
 * @public
 */

Out

Install

Globally

$ npm install [email protected] -g

Locally

$ npm install [email protected] --save-dev

Usage

CLI

$ doxdox '**/*.js'

Custom Meta Information

Name

$ doxdox '**/*.js' --name "doxdox-next"

Description

$ doxdox '**/*.js' --description "Preview release of the doxdox package"

Ignore

Files can be ignored via the command line.

$ doxdox '**/*.js' --ignore tests/**/*.js

$ doxdox '**/*.js' --ignore **/*.test.js

They can also be ignored via a .doxdoxignore file. This file is similar in format to .gitignore and .npmignore.

tests/**/*.js
**/*.test.js

Output

File

$ doxdox '**/*.js' --output docs.md

Stdout

$ doxdox '**/*.js' > docs.md

Renderers

Markdown

For more information on Markdown visit https://daringfireball.net/projects/markdown.

$ doxdox '**/*.js' --renderer markdown --output docs.md

Bootstrap

For more information on Bootstrap visit https://getbootstrap.com.

$ doxdox '**/*.js' --renderer bootstrap --output docs.html

JSON

$ doxdox '**/*.js' --renderer json --output docs.json

Help

Usage: doxdox <path> ... [options]

Options:

 -h, --help             Display this help message.
 -v, --version          Display the current installed version.
 -n, --name             Sets name of project.
 -d, --description      Sets description of project.
 -i, --ignore           Comma separated list of paths to ignore.
 -l, --parser           Parser used to parse the source files with. Defaults to jsdoc.
 -r, --renderer         Renderer to generate the documentation with. Defaults to Markdown.
 -o, --output           File to save documentation to. Defaults to stdout.
 -p, --package          Sets location of package.json file.

Included Layouts:

 - Markdown (default)    (https://daringfireball.net/projects/markdown)
 - Bootstrap             (https://getbootstrap.com)
 - JSON

NPM Run Scripts

For more information on NPM run scripts visit https://docs.npmjs.com/cli/v8/commands/npm-run-script.

$ npm install [email protected] --save-dev

{
  "devDependencies": {
    "doxdox": "4.0.0-preview.14"
  },
  "scripts": {
    "docs": "doxdox 'lib/**/*.js' --renderer markdown --output DOCUMENTATION.md"
  }
}

$ npm run docs

JavaScript

Note: To use doxdox in this way you must add "type": "module" to your package.json file.

import doxdox from 'doxdox';

import parser from 'doxdox-parser-jsdoc';

import renderer from 'doxdox-renderer-markdown';

doxdox(
  process.cwd(),
  ['lib/index.js', 'lib/loaders.js', 'lib/utils.js'],
  parser,
  renderer,
  {
    name: 'doxdox-example',
    description: 'Description of doxdox example.'
  }
).then(output => {
  process.stdout.write(output);
});

Next.js

Note: To use doxdox in this way you must add "type": "module" to your package.json file.

import type { NextPage } from 'next';

import doxdox from 'doxdox';

import parser from 'doxdox-parser-jsdoc';

import renderer from 'doxdox-renderer-bootstrap';

export const getServerSideProps = async () => {
  const docs = await doxdox(
    process.cwd(),
    ['lib/index.js', 'lib/loaders.js', 'lib/utils.js'],
    parser,
    renderer,
    {
      name: 'doxdox-example',
      description: 'Description of doxdox example.'
    }
  );

  return { props: { docs } };
};

const Docs: NextPage<{
  docs: string;
}> = ({ docs }) => {
  return <div dangerouslySetInnerHTML={{ __html: docs }}></div>;
};

export default Docs;

Custom Renderer

Note: To use doxdox in this way you must add "type": "module" to your package.json file.

export default async doc => JSON.stringify(doc);

doxdox -r renderer.js

Plugins

Parsers

Default Parsers

The following parsers are bundled with doxdox.

Name	Description	Version
doxdox-parser-jsdoc	JSDoc parser for doxdox.

A template for creating your own parser doxdox-parser-template.

Optional Parsers

The following parsers are not bundled with doxdox and must be installed separately.

Name	Description	Version
doxdox-parser-dox	dox parser for doxdox.

Renderers

Default Renderers

The following renderers are bundled with doxdox.

Name	Description	Version
doxdox-renderer-bootstrap	Bootstrap renderer for doxdox.
doxdox-renderer-json	JSON renderer for doxdox.
doxdox-renderer-markdown	Markdown renderer for doxdox.

A template for creating your own renderer doxdox-renderer-template.

Optional Renderers

The following renderers are not bundled with doxdox and must be installed separately.

Name	Description	Version
doxdox-renderer-dash	Dash renderer for doxdox.
doxdox-renderer-github-wiki	GitHub Wiki renderer for doxdox.
doxdox-renderer-pdf	PDF renderer for doxdox.

Questions

If you have any questions regarding the use of doxdox, please use either GitHub Discussions or Stack Overflow. The issue tracker is to be used for bug reports and feature requests only.

Contributing

Be sure to review the Contributing Guidelines before logging an issue or making a pull request.

License

MIT

doxdox's People

Contributors

Stargazers

Watchers

Forkers

kapeli stethd aretecode jameslinus relario donfanning sferadev rsp pyrotechniac matheusdsmartins matteocrippa weareinlog shliachtx rubasace milanoty ponury-kostek amit08255 kopischke

doxdox's Issues

Windows: node_modules directory was not found

PS C:\Users\hello\Desktop> doxdox test.js
(node:24348) UnhandledPromiseRejectionWarning: Error: node_modules directory was not found
    at file:///C:/Users/hello/AppData/Roaming/npm/node_modules/doxdox-cli/dist/src/index.js:65:15
(Use `node --trace-warnings ...` to show where the warning was created)
(node:24348) UnhandledPromiseRejectionWarning: Unhandled promise rejection. This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). To terminate the node process on unhandled promise rejection, use the CLI flag `--unhandled-rejections=strict` (see https://nodejs.org/api/cli.html#cli_unhandled_rejections_mode). (rejection id: 1)
(node:24348) [DEP0018] DeprecationWarning: Unhandled promise rejections are deprecated. In the future, promise rejections that are not handled will terminate the Node.js process with a non-zero exit code.

Incoherent dependencies

Hello,

It seems doxdox 3.0 requires versions of the plugins that themselves require doxdox 2.0 and this makes Yarn throw an error:

error "doxdox#doxdox-parser-dox#doxdox@~2.0.3" doesn't satisfy found match of "[email protected]"
error "doxdox#doxdox-plugin-bootstrap#doxdox@~2.0.3" doesn't satisfy found match of "[email protected]"
error "doxdox#doxdox-plugin-handlebars#doxdox@~2.0.3" doesn't satisfy found match of "[email protected]"
error "doxdox#doxdox-plugin-markdown#doxdox@~2.0.3" doesn't satisfy found match of "[email protected]"
error Found 4 errors.

It stills installs the package correctly, but it might be worth checking.

UnhandledPromiseRejectionWarning: Error: node_modules directory was not found

I am using the 4.0.0-preview.13 version, but its not working.

(node:562824) UnhandledPromiseRejectionWarning: Error: node_modules directory was not found at file:///../node_modules/doxdox-cli/dist/src/index.js:65:15 (Usenode --trace-warnings ...to show where the warning was created) (node:562824) UnhandledPromiseRejectionWarning: Unhandled promise rejection. This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). To terminate the node process on unhandled promise rejection, use the CLI flag--unhandled-rejections=strict( see https://nodejs.org/api/cli.html#cli_unhandled_rejections_mode). (rejection id: 1) (node:562824) [DEP0018] DeprecationWarning: Unhandled promise rejections are deprecated. In the future, promise rejections that are not handled will terminate the Node.js p rocess with a non-zero exit code.

This error presents in issue:
https://github.com/docsbydoxdox/doxdox/issues/106

My information environment:

Windows 10
Node v14.15.5
npm 6.14.11
doxdox 4.0.0-preview.13

Excellent app!

Long method names overflow into documentation

http://doxdox.org/schteppe/cannon.js

Windows RegEx Support

Sorry the '**' are actual directories. But there seems to be some issues with Windows 10, could someone help.

const REPLACE_FILENAME_REGEXP = new RegExp(`^(${process.cwd()}/|./)`, 'u');
                                ^

SyntaxError: Invalid regular expression: /^(C:\Users\****\Documents\****\*****\folder1/|./)/: Invalid escape
    at new RegExp (<anonymous>)
    at Object.<anonymous> (C:\Users\*****\AppData\Roaming\npm\node_modules\doxdox\lib\doxdox.js:18:33)
    at Module._compile (internal/modules/cjs/loader.js:776:30)
    at Object.Module._extensions..js (internal/modules/cjs/loader.js:787:10)
    at Module.load (internal/modules/cjs/loader.js:653:32)
    at tryModuleLoad (internal/modules/cjs/loader.js:593:12)
    at Function.Module._load (internal/modules/cjs/loader.js:585:3)
    at Module.require (internal/modules/cjs/loader.js:690:17)
    at require (internal/modules/cjs/helpers.js:25:18)
    at Object.<anonymous> (C:\Users\*****\AppData\Roaming\npm\node_modules\doxdox\bin\doxdox:9:16)
npm ERR! code ELIFECYCLE
npm ERR! errno 1

multi release

Hi, I've seen the doc of doxdox has show entry of each releases version. How can I generate docs like that. Thanks.

v4.0.0-preview

This repository is undergoing a massive rewrite. Things will be missing, broken, or incomplete as development continues.

doxdox throws warnings in Node.js 6

Steps to recreate:

Switch to Node.js 6

$ nvm use 6

Preform a clean install of doxdox

$ npm uninstall doxdox -g
$ npm install doxdox -g

Output doxdox version

$ doxdox --version

Results:

(node) v8::ObjectTemplate::Set() with non-primitive values is deprecated
(node) and will stop working in the next major release.

==== JS stack trace =========================================

Security context: 0x1bda5aec9fa9 <JS Object>#0#
    1: .node [module.js:568] [pc=0x3642a782e2a4] (this=0x3389cd712a39 <an Object with map 0x29472ff3e5f1>#1#,module=0x350d7f0f0259 <a Module with map 0x29472ff181b9>#2#,filename=0x350d7f0f0231 <String[105]: /usr/local/lib/node_modules/doxdox/node_modules/sqlite3/lib/binding/node-v48-darwin-x64/node_sqlite3.node>)
    2: load [module.js:456] [pc=0x3642a7638e72] (this=0x350d7f0f0259 <a Module with map 0x29472ff181b9>#2#,filename=0x350d7f0f0231 <String[105]: /usr/local/lib/node_modules/doxdox/node_modules/sqlite3/lib/binding/node-v48-darwin-x64/node_sqlite3.node>)
    3: tryModuleLoad(aka tryModuleLoad) [module.js:415] [pc=0x3642a763899d] (this=0x1bda5ae04189 <undefined>,module=0x350d7f0f0259 <a Module with map 0x29472ff181b9>#2#,filename=0x350d7f0f0231 <String[105]: /usr/local/lib/node_modules/doxdox/node_modules/sqlite3/lib/binding/node-v48-darwin-x64/node_sqlite3.node>)
    4: _load [module.j 1: v8::Template::Set(v8::Local<v8::Name>, v8::Local<v8::Data>, v8::PropertyAttribute)
 2: node_sqlite3::Database::Init(v8::Local<v8::Object>)
 3: (anonymous namespace)::RegisterModule(v8::Local<v8::Object>)
 4: node::DLOpen(v8::FunctionCallbackInfo<v8::Value> const&)
 5: v8::internal::FunctionCallbackArguments::Call(void (*)(v8::FunctionCallbackInfo<v8::Value> const&))
 6: v8::internal::MaybeHandle<v8::internal::Object> v8::internal::(anonymous namespace)::HandleApiCallHelper<false>(v8::internal::Isolate*, v8::internal::(anonymous namespace)::BuiltinArguments<(v8::internal::BuiltinExtraArguments)1>)
 7: v8::internal::Builtin_HandleApiCall(int, v8::internal::Object**, v8::internal::Isolate*)
 8: 0x3642a750961b
(node) v8::ObjectTemplate::Set() with non-primitive values is deprecated
(node) and will stop working in the next major release.

==== JS stack trace =========================================

Security context: 0x1bda5aec9fa9 <JS Object>#0#
    1: .node [module.js:568] [pc=0x3642a782e2a4] (this=0x3389cd712a39 <an Object with map 0x29472ff3e5f1>#1#,module=0x350d7f0f0259 <a Module with map 0x29472ff181b9>#2#,filename=0x350d7f0f0231 <String[105]: /usr/local/lib/node_modules/doxdox/node_modules/sqlite3/lib/binding/node-v48-darwin-x64/node_sqlite3.node>)
    2: load [module.js:456] [pc=0x3642a7638e72] (this=0x350d7f0f0259 <a Module with map 0x29472ff181b9>#2#,filename=0x350d7f0f0231 <String[105]: /usr/local/lib/node_modules/doxdox/node_modules/sqlite3/lib/binding/node-v48-darwin-x64/node_sqlite3.node>)
    3: tryModuleLoad(aka tryModuleLoad) [module.js:415] [pc=0x3642a763899d] (this=0x1bda5ae04189 <undefined>,module=0x350d7f0f0259 <a Module with map 0x29472ff181b9>#2#,filename=0x350d7f0f0231 <String[105]: /usr/local/lib/node_modules/doxdox/node_modules/sqlite3/lib/binding/node-v48-darwin-x64/node_sqlite3.node>)
    4: _load [module.j
==== C stack trace ===============================

 1: v8::Template::Set(v8::Local<v8::Name>, v8::Local<v8::Data>, v8::PropertyAttribute)
 2: node_sqlite3::Database::Init(v8::Local<v8::Object>)
 3: (anonymous namespace)::RegisterModule(v8::Local<v8::Object>)
 4: node::DLOpen(v8::FunctionCallbackInfo<v8::Value> const&)
 5: v8::internal::FunctionCallbackArguments::Call(void (*)(v8::FunctionCallbackInfo<v8::Value> const&))
 6: v8::internal::MaybeHandle<v8::internal::Object> v8::internal::(anonymous namespace)::HandleApiCallHelper<false>(v8::internal::Isolate*, v8::internal::(anonymous namespace)::BuiltinArguments<(v8::internal::BuiltinExtraArguments)1>)
 7: v8::internal::Builtin_HandleApiCall(int, v8::internal::Object**, v8::internal::Isolate*)
 8: 0x3642a750961b
(node) v8::ObjectTemplate::Set() with non-primitive values is deprecated
(node) and will stop working in the next major release.

==== JS stack trace =========================================

Security context: 0x1bda5aec9fa9 <JS Object>#0#
    1: .node [module.js:568] [pc=0x3642a782e2a4] (this=0x3389cd712a39 <an Object with map 0x29472ff3e5f1>#1#,module=0x350d7f0f0259 <a Module with map 0x29472ff181b9>#2#,filename=0x350d7f0f0231 <String[105]: /usr/local/lib/node_modules/doxdox/node_modules/sqlite3/lib/binding/node-v48-darwin-x64/node_sqlite3.node>)
    2: load [module.js:456] [pc=0x3642a7638e72] (this=0x350d7f0f0259 <a Module with map 0x29472ff181b9>#2#,filename=0x350d7f0f0231 <String[105]: /usr/local/lib/node_modules/doxdox/node_modules/sqlite3/lib/binding/node-v48-darwin-x64/node_sqlite3.node>)
    3: tryModuleLoad(aka tryModuleLoad) [module.js:415] [pc=0x3642a763899d] (this=0x1bda5ae04189 <undefined>,module=0x350d7f0f0259 <a Module with map 0x29472ff181b9>#2#,filename=0x350d7f0f0231 <String[105]: /usr/local/lib/node_modules/doxdox/node_modules/sqlite3/lib/binding/node-v48-darwin-x64/node_sqlite3.node>)
    4: _load [module.j 1: v8::Template::Set(v8::Local<v8::Name>, v8::Local<v8::Data>, v8::PropertyAttribute)
 2: node_sqlite3::Database::Init(v8::Local<v8::Object>)
 3: (anonymous namespace)::RegisterModule(v8::Local<v8::Object>)
 4: node::DLOpen(v8::FunctionCallbackInfo<v8::Value> const&)
 5: v8::internal::FunctionCallbackArguments::Call(void (*)(v8::FunctionCallbackInfo<v8::Value> const&))
 6: v8::internal::MaybeHandle<v8::internal::Object> v8::internal::(anonymous namespace)::HandleApiCallHelper<false>(v8::internal::Isolate*, v8::internal::(anonymous namespace)::BuiltinArguments<(v8::internal::BuiltinExtraArguments)1>)
 7: v8::internal::Builtin_HandleApiCall(int, v8::internal::Object**, v8::internal::Isolate*)
 8: 0x3642a750961b
(node) v8::ObjectTemplate::Set() with non-primitive values is deprecated
(node) and will stop working in the next major release.

==== JS stack trace =========================================

Security context: 0x1bda5aec9fa9 <JS Object>#0#
    1: .node [module.js:568] [pc=0x3642a782e2a4] (this=0x3389cd712a39 <an Object with map 0x29472ff3e5f1>#1#,module=0x350d7f0f0259 <a Module with map 0x29472ff181b9>#2#,filename=0x350d7f0f0231 <String[105]: /usr/local/lib/node_modules/doxdox/node_modules/sqlite3/lib/binding/node-v48-darwin-x64/node_sqlite3.node>)
    2: load [module.js:456] [pc=0x3642a7638e72] (this=0x350d7f0f0259 <a Module with map 0x29472ff181b9>#2#,filename=0x350d7f0f0231 <String[105]: /usr/local/lib/node_modules/doxdox/node_modules/sqlite3/lib/binding/node-v48-darwin-x64/node_sqlite3.node>)
    3: tryModuleLoad(aka tryModuleLoad) [module.js:415] [pc=0x3642a763899d] (this=0x1bda5ae04189 <undefined>,module=0x350d7f0f0259 <a Module with map 0x29472ff181b9>#2#,filename=0x350d7f0f0231 <String[105]: /usr/local/lib/node_modules/doxdox/node_modules/sqlite3/lib/binding/node-v48-darwin-x64/node_sqlite3.node>)
    4: _load [module.j
==== C stack trace ===============================

 1: v8::Template::Set(v8::Local<v8::Name>, v8::Local<v8::Data>, v8::PropertyAttribute)
 2: node_sqlite3::Database::Init(v8::Local<v8::Object>)
 3: (anonymous namespace)::RegisterModule(v8::Local<v8::Object>)
 4: node::DLOpen(v8::FunctionCallbackInfo<v8::Value> const&)
 5: v8::internal::FunctionCallbackArguments::Call(void (*)(v8::FunctionCallbackInfo<v8::Value> const&))
 6: v8::internal::MaybeHandle<v8::internal::Object> v8::internal::(anonymous namespace)::HandleApiCallHelper<false>(v8::internal::Isolate*, v8::internal::(anonymous namespace)::BuiltinArguments<(v8::internal::BuiltinExtraArguments)1>)
 7: v8::internal::Builtin_HandleApiCall(int, v8::internal::Object**, v8::internal::Isolate*)
 8: 0x3642a750961b
(node) v8::ObjectTemplate::Set() with non-primitive values is deprecated
(node) and will stop working in the next major release.

==== JS stack trace =========================================

Security context: 0x1bda5aec9fa9 <JS Object>#0#
    1: .node [module.js:568] [pc=0x3642a782e2a4] (this=0x3389cd712a39 <an Object with map 0x29472ff3e5f1>#1#,module=0x350d7f0f0259 <a Module with map 0x29472ff181b9>#2#,filename=0x350d7f0f0231 <String[105]: /usr/local/lib/node_modules/doxdox/node_modules/sqlite3/lib/binding/node-v48-darwin-x64/node_sqlite3.node>)
    2: load [module.js:456] [pc=0x3642a7638e72] (this=0x350d7f0f0259 <a Module with map 0x29472ff181b9>#2#,filename=0x350d7f0f0231 <String[105]: /usr/local/lib/node_modules/doxdox/node_modules/sqlite3/lib/binding/node-v48-darwin-x64/node_sqlite3.node>)
    3: tryModuleLoad(aka tryModuleLoad) [module.js:415] [pc=0x3642a763899d] (this=0x1bda5ae04189 <undefined>,module=0x350d7f0f0259 <a Module with map 0x29472ff181b9>#2#,filename=0x350d7f0f0231 <String[105]: /usr/local/lib/node_modules/doxdox/node_modules/sqlite3/lib/binding/node-v48-darwin-x64/node_sqlite3.node>)
    4: _load [module.j
==== C stack trace ===============================

 1: v8::Template::Set(v8::Local<v8::Name>, v8::Local<v8::Data>, v8::PropertyAttribute)
 2: node_sqlite3::Database::Init(v8::Local<v8::Object>)
 3: (anonymous namespace)::RegisterModule(v8::Local<v8::Object>)
 4: node::DLOpen(v8::FunctionCallbackInfo<v8::Value> const&)
 5: v8::internal::FunctionCallbackArguments::Call(void (*)(v8::FunctionCallbackInfo<v8::Value> const&))
 6: v8::internal::MaybeHandle<v8::internal::Object> v8::internal::(anonymous namespace)::HandleApiCallHelper<false>(v8::internal::Isolate*, v8::internal::(anonymous namespace)::BuiltinArguments<(v8::internal::BuiltinExtraArguments)1>)
 7: v8::internal::Builtin_HandleApiCall(int, v8::internal::Object**, v8::internal::Isolate*)
 8: 0x3642a750961b
(node) v8::ObjectTemplate::Set() with non-primitive values is deprecated
(node) and will stop working in the next major release.

==== JS stack trace =========================================

Security context: 0x1bda5aec9fa9 <JS Object>#0#
    1: .node [module.js:568] [pc=0x3642a782e2a4] (this=0x3389cd712a39 <an Object with map 0x29472ff3e5f1>#1#,module=0x350d7f0f0259 <a Module with map 0x29472ff181b9>#2#,filename=0x350d7f0f0231 <String[105]: /usr/local/lib/node_modules/doxdox/node_modules/sqlite3/lib/binding/node-v48-darwin-x64/node_sqlite3.node>)
    2: load [module.js:456] [pc=0x3642a7638e72] (this=0x350d7f0f0259 <a Module with map 0x29472ff181b9>#2#,filename=0x350d7f0f0231 <String[105]: /usr/local/lib/node_modules/doxdox/node_modules/sqlite3/lib/binding/node-v48-darwin-x64/node_sqlite3.node>)
    3: tryModuleLoad(aka tryModuleLoad) [module.js:415] [pc=0x3642a763899d] (this=0x1bda5ae04189 <undefined>,module=0x350d7f0f0259 <a Module with map 0x29472ff181b9>#2#,filename=0x350d7f0f0231 <String[105]: /usr/local/lib/node_modules/doxdox/node_modules/sqlite3/lib/binding/node-v48-darwin-x64/node_sqlite3.node>)
    4: _load [module.j
==== C stack trace ===============================

 1: v8::Template::Set(v8::Local<v8::Name>, v8::Local<v8::Data>, v8::PropertyAttribute)
 2: node_sqlite3::Database::Init(v8::Local<v8::Object>)
 3: (anonymous namespace)::RegisterModule(v8::Local<v8::Object>)
 4: node::DLOpen(v8::FunctionCallbackInfo<v8::Value> const&)
 5: v8::internal::FunctionCallbackArguments::Call(void (*)(v8::FunctionCallbackInfo<v8::Value> const&))
 6: v8::internal::MaybeHandle<v8::internal::Object> v8::internal::(anonymous namespace)::HandleApiCallHelper<false>(v8::internal::Isolate*, v8::internal::(anonymous namespace)::BuiltinArguments<(v8::internal::BuiltinExtraArguments)1>)
 7: v8::internal::Builtin_HandleApiCall(int, v8::internal::Object**, v8::internal::Isolate*)
 8: 0x3642a750961b
(node) v8::ObjectTemplate::Set() with non-primitive values is deprecated
(node) and will stop working in the next major release.

==== JS stack trace =========================================

Security context: 0x1bda5aec9fa9 <JS Object>#0#
    1: .node [module.js:568] [pc=0x3642a782e2a4] (this=0x3389cd712a39 <an Object with map 0x29472ff3e5f1>#1#,module=0x350d7f0f0259 <a Module with map 0x29472ff181b9>#2#,filename=0x350d7f0f0231 <String[105]: /usr/local/lib/node_modules/doxdox/node_modules/sqlite3/lib/binding/node-v48-darwin-x64/node_sqlite3.node>)
    2: load [module.js:456] [pc=0x3642a7638e72] (this=0x350d7f0f0259 <a Module with map 0x29472ff181b9>#2#,filename=0x350d7f0f0231 <String[105]: /usr/local/lib/node_modules/doxdox/node_modules/sqlite3/lib/binding/node-v48-darwin-x64/node_sqlite3.node>)
    3: tryModuleLoad(aka tryModuleLoad) [module.js:415] [pc=0x3642a763899d] (this=0x1bda5ae04189 <undefined>,module=0x350d7f0f0259 <a Module with map 0x29472ff181b9>#2#,filename=0x350d7f0f0231 <String[105]: /usr/local/lib/node_modules/doxdox/node_modules/sqlite3/lib/binding/node-v48-darwin-x64/node_sqlite3.node>)
    4: _load [module.j
==== C stack trace ===============================

 1: v8::Template::Set(v8::Local<v8::Name>, v8::Local<v8::Data>, v8::PropertyAttribute)
 2: node_sqlite3::Database::Init(v8::Local<v8::Object>)
 3: (anonymous namespace)::RegisterModule(v8::Local<v8::Object>)
 4: node::DLOpen(v8::FunctionCallbackInfo<v8::Value> const&)
 5: v8::internal::FunctionCallbackArguments::Call(void (*)(v8::FunctionCallbackInfo<v8::Value> const&))
 6: v8::internal::MaybeHandle<v8::internal::Object> v8::internal::(anonymous namespace)::HandleApiCallHelper<false>(v8::internal::Isolate*, v8::internal::(anonymous namespace)::BuiltinArguments<(v8::internal::BuiltinExtraArguments)1>)
 7: v8::internal::Builtin_HandleApiCall(int, v8::internal::Object**, v8::internal::Isolate*)
 8: 0x3642a750961b
(node) v8::ObjectTemplate::Set() with non-primitive values is deprecated
(node) and will stop working in the next major release.

==== JS stack trace =========================================

Security context: 0x1bda5aec9fa9 <JS Object>#0#
    1: .node [module.js:568] [pc=0x3642a782e2a4] (this=0x3389cd712a39 <an Object with map 0x29472ff3e5f1>#1#,module=0x350d7f0f0259 <a Module with map 0x29472ff181b9>#2#,filename=0x350d7f0f0231 <String[105]: /usr/local/lib/node_modules/doxdox/node_modules/sqlite3/lib/binding/node-v48-darwin-x64/node_sqlite3.node>)
    2: load [module.js:456] [pc=0x3642a7638e72] (this=0x350d7f0f0259 <a Module with map 0x29472ff181b9>#2#,filename=0x350d7f0f0231 <String[105]: /usr/local/lib/node_modules/doxdox/node_modules/sqlite3/lib/binding/node-v48-darwin-x64/node_sqlite3.node>)
    3: tryModuleLoad(aka tryModuleLoad) [module.js:415] [pc=0x3642a763899d] (this=0x1bda5ae04189 <undefined>,module=0x350d7f0f0259 <a Module with map 0x29472ff181b9>#2#,filename=0x350d7f0f0231 <String[105]: /usr/local/lib/node_modules/doxdox/node_modules/sqlite3/lib/binding/node-v48-darwin-x64/node_sqlite3.node>)
    4: _load [module.j
==== C stack trace ===============================

 1: v8::Template::Set(v8::Local<v8::Name>, v8::Local<v8::Data>, v8::PropertyAttribute)
 2: node_sqlite3::Statement::Init(v8::Local<v8::Object>)
 3: (anonymous namespace)::RegisterModule(v8::Local<v8::Object>)
 4: node::DLOpen(v8::FunctionCallbackInfo<v8::Value> const&)
 5: v8::internal::FunctionCallbackArguments::Call(void (*)(v8::FunctionCallbackInfo<v8::Value> const&))
 6: v8::internal::MaybeHandle<v8::internal::Object> v8::internal::(anonymous namespace)::HandleApiCallHelper<false>(v8::internal::Isolate*, v8::internal::(anonymous namespace)::BuiltinArguments<(v8::internal::BuiltinExtraArguments)1>)
 7: v8::internal::Builtin_HandleApiCall(int, v8::internal::Object**, v8::internal::Isolate*)
 8: 0x3642a750961b
(node) v8::ObjectTemplate::Set() with non-primitive values is deprecated
(node) and will stop working in the next major release.

==== JS stack trace =========================================

Security context: 0x1bda5aec9fa9 <JS Object>#0#
    1: .node [module.js:568] [pc=0x3642a782e2a4] (this=0x3389cd712a39 <an Object with map 0x29472ff3e5f1>#1#,module=0x350d7f0f0259 <a Module with map 0x29472ff181b9>#2#,filename=0x350d7f0f0231 <String[105]: /usr/local/lib/node_modules/doxdox/node_modules/sqlite3/lib/binding/node-v48-darwin-x64/node_sqlite3.node>)
    2: load [module.js:456] [pc=0x3642a7638e72] (this=0x350d7f0f0259 <a Module with map 0x29472ff181b9>#2#,filename=0x350d7f0f0231 <String[105]: /usr/local/lib/node_modules/doxdox/node_modules/sqlite3/lib/binding/node-v48-darwin-x64/node_sqlite3.node>)
    3: tryModuleLoad(aka tryModuleLoad) [module.js:415] [pc=0x3642a763899d] (this=0x1bda5ae04189 <undefined>,module=0x350d7f0f0259 <a Module with map 0x29472ff181b9>#2#,filename=0x350d7f0f0231 <String[105]: /usr/local/lib/node_modules/doxdox/node_modules/sqlite3/lib/binding/node-v48-darwin-x64/node_sqlite3.node>)
    4: _load [module.j
==== C stack trace ===============================

 1: v8::Template::Set(v8::Local<v8::Name>, v8::Local<v8::Data>, v8::PropertyAttribute)
 2: node_sqlite3::Statement::Init(v8::Local<v8::Object>)
 3: (anonymous namespace)::RegisterModule(v8::Local<v8::Object>)
 4: node::DLOpen(v8::FunctionCallbackInfo<v8::Value> const&)
 5: v8::internal::FunctionCallbackArguments::Call(void (*)(v8::FunctionCallbackInfo<v8::Value> const&))
 6: v8::internal::MaybeHandle<v8::internal::Object> v8::internal::(anonymous namespace)::HandleApiCallHelper<false>(v8::internal::Isolate*, v8::internal::(anonymous namespace)::BuiltinArguments<(v8::internal::BuiltinExtraArguments)1>)
 7: v8::internal::Builtin_HandleApiCall(int, v8::internal::Object**, v8::internal::Isolate*)
 8: 0x3642a750961b
(node) v8::ObjectTemplate::Set() with non-primitive values is deprecated
(node) and will stop working in the next major release.

==== JS stack trace =========================================

Security context: 0x1bda5aec9fa9 <JS Object>#0#
    1: .node [module.js:568] [pc=0x3642a782e2a4] (this=0x3389cd712a39 <an Object with map 0x29472ff3e5f1>#1#,module=0x350d7f0f0259 <a Module with map 0x29472ff181b9>#2#,filename=0x350d7f0f0231 <String[105]: /usr/local/lib/node_modules/doxdox/node_modules/sqlite3/lib/binding/node-v48-darwin-x64/node_sqlite3.node>)
    2: load [module.js:456] [pc=0x3642a7638e72] (this=0x350d7f0f0259 <a Module with map 0x29472ff181b9>#2#,filename=0x350d7f0f0231 <String[105]: /usr/local/lib/node_modules/doxdox/node_modules/sqlite3/lib/binding/node-v48-darwin-x64/node_sqlite3.node>)
    3: tryModuleLoad(aka tryModuleLoad) [module.js:415] [pc=0x3642a763899d] (this=0x1bda5ae04189 <undefined>,module=0x350d7f0f0259 <a Module with map 0x29472ff181b9>#2#,filename=0x350d7f0f0231 <String[105]: /usr/local/lib/node_modules/doxdox/node_modules/sqlite3/lib/binding/node-v48-darwin-x64/node_sqlite3.node>)
    4: _load [module.j 1: v8::Template::Set(v8::Local<v8::Name>, v8::Local<v8::Data>, v8::PropertyAttribute)
 2: node_sqlite3::Statement::Init(v8::Local<v8::Object>)
 3: (anonymous namespace)::RegisterModule(v8::Local<v8::Object>)
 4: node::DLOpen(v8::FunctionCallbackInfo<v8::Value> const&)
 5: v8::internal::FunctionCallbackArguments::Call(void (*)(v8::FunctionCallbackInfo<v8::Value> const&))
 6: v8::internal::MaybeHandle<v8::internal::Object> v8::internal::(anonymous namespace)::HandleApiCallHelper<false>(v8::internal::Isolate*, v8::internal::(anonymous namespace)::BuiltinArguments<(v8::internal::BuiltinExtraArguments)1>)
 7: v8::internal::Builtin_HandleApiCall(int, v8::internal::Object**, v8::internal::Isolate*)
 8: 0x3642a750961b
(node) v8::ObjectTemplate::Set() with non-primitive values is deprecated
(node) and will stop working in the next major release.

==== JS stack trace =========================================

Security context: 0x1bda5aec9fa9 <JS Object>#0#
    1: .node [module.js:568] [pc=0x3642a782e2a4] (this=0x3389cd712a39 <an Object with map 0x29472ff3e5f1>#1#,module=0x350d7f0f0259 <a Module with map 0x29472ff181b9>#2#,filename=0x350d7f0f0231 <String[105]: /usr/local/lib/node_modules/doxdox/node_modules/sqlite3/lib/binding/node-v48-darwin-x64/node_sqlite3.node>)
    2: load [module.js:456] [pc=0x3642a7638e72] (this=0x350d7f0f0259 <a Module with map 0x29472ff181b9>#2#,filename=0x350d7f0f0231 <String[105]: /usr/local/lib/node_modules/doxdox/node_modules/sqlite3/lib/binding/node-v48-darwin-x64/node_sqlite3.node>)
    3: tryModuleLoad(aka tryModuleLoad) [module.js:415] [pc=0x3642a763899d] (this=0x1bda5ae04189 <undefined>,module=0x350d7f0f0259 <a Module with map 0x29472ff181b9>#2#,filename=0x350d7f0f0231 <String[105]: /usr/local/lib/node_modules/doxdox/node_modules/sqlite3/lib/binding/node-v48-darwin-x64/node_sqlite3.node>)
    4: _load [module.j 1: v8::Template::Set(v8::Local<v8::Name>, v8::Local<v8::Data>, v8::PropertyAttribute)
 2: node_sqlite3::Statement::Init(v8::Local<v8::Object>)
 3: (anonymous namespace)::RegisterModule(v8::Local<v8::Object>)
 4: node::DLOpen(v8::FunctionCallbackInfo<v8::Value> const&)
 5: v8::internal::FunctionCallbackArguments::Call(void (*)(v8::FunctionCallbackInfo<v8::Value> const&))
 6: v8::internal::MaybeHandle<v8::internal::Object> v8::internal::(anonymous namespace)::HandleApiCallHelper<false>(v8::internal::Isolate*, v8::internal::(anonymous namespace)::BuiltinArguments<(v8::internal::BuiltinExtraArguments)1>)
 7: v8::internal::Builtin_HandleApiCall(int, v8::internal::Object**, v8::internal::Isolate*)
 8: 0x3642a750961b
(node) v8::ObjectTemplate::Set() with non-primitive values is deprecated
(node) and will stop working in the next major release.

==== JS stack trace =========================================

Security context: 0x1bda5aec9fa9 <JS Object>#0#
    1: .node [module.js:568] [pc=0x3642a782e2a4] (this=0x3389cd712a39 <an Object with map 0x29472ff3e5f1>#1#,module=0x350d7f0f0259 <a Module with map 0x29472ff181b9>#2#,filename=0x350d7f0f0231 <String[105]: /usr/local/lib/node_modules/doxdox/node_modules/sqlite3/lib/binding/node-v48-darwin-x64/node_sqlite3.node>)
    2: load [module.js:456] [pc=0x3642a7638e72] (this=0x350d7f0f0259 <a Module with map 0x29472ff181b9>#2#,filename=0x350d7f0f0231 <String[105]: /usr/local/lib/node_modules/doxdox/node_modules/sqlite3/lib/binding/node-v48-darwin-x64/node_sqlite3.node>)
    3: tryModuleLoad(aka tryModuleLoad) [module.js:415] [pc=0x3642a763899d] (this=0x1bda5ae04189 <undefined>,module=0x350d7f0f0259 <a Module with map 0x29472ff181b9>#2#,filename=0x350d7f0f0231 <String[105]: /usr/local/lib/node_modules/doxdox/node_modules/sqlite3/lib/binding/node-v48-darwin-x64/node_sqlite3.node>)
    4: _load [module.j
==== C stack trace ===============================

 1: v8::Template::Set(v8::Local<v8::Name>, v8::Local<v8::Data>, v8::PropertyAttribute)
 2: node_sqlite3::Statement::Init(v8::Local<v8::Object>)
 3: (anonymous namespace)::RegisterModule(v8::Local<v8::Object>)
 4: node::DLOpen(v8::FunctionCallbackInfo<v8::Value> const&)
 5: v8::internal::FunctionCallbackArguments::Call(void (*)(v8::FunctionCallbackInfo<v8::Value> const&))
 6: v8::internal::MaybeHandle<v8::internal::Object> v8::internal::(anonymous namespace)::HandleApiCallHelper<false>(v8::internal::Isolate*, v8::internal::(anonymous namespace)::BuiltinArguments<(v8::internal::BuiltinExtraArguments)1>)
 7: v8::internal::Builtin_HandleApiCall(int, v8::internal::Object**, v8::internal::Isolate*)
 8: 0x3642a750961b
(node) v8::ObjectTemplate::Set() with non-primitive values is deprecated
(node) and will stop working in the next major release.

==== JS stack trace =========================================

Security context: 0x1bda5aec9fa9 <JS Object>#0#
    1: .node [module.js:568] [pc=0x3642a782e2a4] (this=0x3389cd712a39 <an Object with map 0x29472ff3e5f1>#1#,module=0x350d7f0f0259 <a Module with map 0x29472ff181b9>#2#,filename=0x350d7f0f0231 <String[105]: /usr/local/lib/node_modules/doxdox/node_modules/sqlite3/lib/binding/node-v48-darwin-x64/node_sqlite3.node>)
    2: load [module.js:456] [pc=0x3642a7638e72] (this=0x350d7f0f0259 <a Module with map 0x29472ff181b9>#2#,filename=0x350d7f0f0231 <String[105]: /usr/local/lib/node_modules/doxdox/node_modules/sqlite3/lib/binding/node-v48-darwin-x64/node_sqlite3.node>)
    3: tryModuleLoad(aka tryModuleLoad) [module.js:415] [pc=0x3642a763899d] (this=0x1bda5ae04189 <undefined>,module=0x350d7f0f0259 <a Module with map 0x29472ff181b9>#2#,filename=0x350d7f0f0231 <String[105]: /usr/local/lib/node_modules/doxdox/node_modules/sqlite3/lib/binding/node-v48-darwin-x64/node_sqlite3.node>)
    4: _load [module.j
==== C stack trace ===============================

 1: v8::Template::Set(v8::Local<v8::Name>, v8::Local<v8::Data>, v8::PropertyAttribute)
 2: node_sqlite3::Statement::Init(v8::Local<v8::Object>)
 3: (anonymous namespace)::RegisterModule(v8::Local<v8::Object>)
 4: node::DLOpen(v8::FunctionCallbackInfo<v8::Value> const&)
 5: v8::internal::FunctionCallbackArguments::Call(void (*)(v8::FunctionCallbackInfo<v8::Value> const&))
 6: v8::internal::MaybeHandle<v8::internal::Object> v8::internal::(anonymous namespace)::HandleApiCallHelper<false>(v8::internal::Isolate*, v8::internal::(anonymous namespace)::BuiltinArguments<(v8::internal::BuiltinExtraArguments)1>)
 7: v8::internal::Builtin_HandleApiCall(int, v8::internal::Object**, v8::internal::Isolate*)
 8: 0x3642a750961b
(node) v8::ObjectTemplate::Set() with non-primitive values is deprecated
(node) and will stop working in the next major release.

==== JS stack trace =========================================

Security context: 0x1bda5aec9fa9 <JS Object>#0#
    1: .node [module.js:568] [pc=0x3642a782e2a4] (this=0x3389cd712a39 <an Object with map 0x29472ff3e5f1>#1#,module=0x350d7f0f0259 <a Module with map 0x29472ff181b9>#2#,filename=0x350d7f0f0231 <String[105]: /usr/local/lib/node_modules/doxdox/node_modules/sqlite3/lib/binding/node-v48-darwin-x64/node_sqlite3.node>)
    2: load [module.js:456] [pc=0x3642a7638e72] (this=0x350d7f0f0259 <a Module with map 0x29472ff181b9>#2#,filename=0x350d7f0f0231 <String[105]: /usr/local/lib/node_modules/doxdox/node_modules/sqlite3/lib/binding/node-v48-darwin-x64/node_sqlite3.node>)
    3: tryModuleLoad(aka tryModuleLoad) [module.js:415] [pc=0x3642a763899d] (this=0x1bda5ae04189 <undefined>,module=0x350d7f0f0259 <a Module with map 0x29472ff181b9>#2#,filename=0x350d7f0f0231 <String[105]: /usr/local/lib/node_modules/doxdox/node_modules/sqlite3/lib/binding/node-v48-darwin-x64/node_sqlite3.node>)
    4: _load [module.j
==== C stack trace ===============================

 1: v8::Template::Set(v8::Local<v8::Name>, v8::Local<v8::Data>, v8::PropertyAttribute)
 2: node_sqlite3::Statement::Init(v8::Local<v8::Object>)
 3: (anonymous namespace)::RegisterModule(v8::Local<v8::Object>)
 4: node::DLOpen(v8::FunctionCallbackInfo<v8::Value> const&)
 5: v8::internal::FunctionCallbackArguments::Call(void (*)(v8::FunctionCallbackInfo<v8::Value> const&))
 6: v8::internal::MaybeHandle<v8::internal::Object> v8::internal::(anonymous namespace)::HandleApiCallHelper<false>(v8::internal::Isolate*, v8::internal::(anonymous namespace)::BuiltinArguments<(v8::internal::BuiltinExtraArguments)1>)
 7: v8::internal::Builtin_HandleApiCall(int, v8::internal::Object**, v8::internal::Isolate*)
 8: 0x3642a750961b

Multiple input don't work with CLI (v4.0.0-preview.1)

This used to work per #9

$ doxdox file1.js file2.js

List of ignored folders should be configurable

Hi there,

I was trying to compile documentation for our internal test-writing API, but doxdox would silently fail because, unsurprisingly, part of the path contained the word test. Would be nice if the list of ignored folders was configurable/overridable.

Btw, I really like the direction of doxdox — I spent several days looking into currently available solutions for converting JSDoc into something human readable, and yours is the most promising. Keep it up!

Add missing search input back into Bootstrap output (v4.0.0-preview.1)

Related #7

"example" and "returns" tags doesn't show up

Hey, I really appreciate what you're doing here! I'm using this as the documentation generator for my project Preston. These tags aren't being displayed in the generated documentation. I'm not sure if this is a problem with dox or your generator, but I'd really like to have these tags. Thanks.

Use new ignoreFiles option in globby

Ref: sindresorhus/globby#228

Many comments are not supported

Hi @neogeek , Jsdoc3's some comments are not supported in the doxdox，For example:

/**
 *  @constant
 *  @default
 */
const RED = 0xff0000;

doxdox only render Methods, but Members is not render !

ignore comment types

it picks up non-doc blocks which can ruin the documentation when there are a lot of them

examples:
istanbul ignore next: dev
prettier-ignore

Remove rm and cp commands from npm targets for Windows dev support

Replace with https://www.npmjs.com/package/rimraf and https://www.npmjs.com/package/copyfiles

Create option to not show private methods

Right now private methods are generated. It's necessary to add an option to not show those private methods.

This is the line that would need changing (I think):

From ->

.filter(method => !method.ignore && method.ctx)

To ->

.filter(method => !method.ignore &&  !method.isPrivate && method.ctx)

Add yarn support

Vulnerabilities in dependencies

Both npm audit in projects using doxdox and the Snyk badge in it's readme show that this modules uses vulnerable versions of lodash and handlebars via its own dependencies:

My questions are:

is this project still maintained?
is someone aware of that and going to update dependencies?
or if not, are you willing to accept PRs by someonbe who does?

@neogeek I see that you've done some updates to avoid snyk alerts last year but the HEAD of master shows "All checks have failed" on GitHub so I don't know if the master in a working state and I'm not sure that the latest changes are published to npm.

An in-range update of mocha is breaking the build 🚨

Version 3.4.2 of mocha just got published.

Branch	Build failing 🚨
Dependency	mocha
Current Version	3.4.1
Type	devDependency

This version is covered by your current version range and after updating it in your project the build failed.

As mocha is “only” a devDependency of this project it might not break production or downstream projects, but “only” your build or test tools – preventing new deploys or publishes.

I recommend you give this issue a high priority. I’m sure you can resolve this 💪

Status Details

❌ continuous-integration/travis-ci/push The Travis CI build is in progress Details
❌ continuous-integration/appveyor/branch AppVeyor build failed Details

Release Notes

fake-success

3.4.2 / 2017-05-24

🐛 Fixes

#2802: Remove call to deprecated os.tmpDir (@makepanic)
#2820: Eagerly set process.exitCode (@chrisleck)

🔩 Other

#2778: Move linting into an npm script (@Munter)

Commits

The new version differs by 7 commits.

a15b20a :ship: Release v3.4.2
fc802a9 :memo: Add Changelog for v3.4.2
10ff0ec Eagerly set process.exitCode (#2820)
fc35691 Merge pull request #2818 from makepanic/issue/2802
3e7152f Remove call to deprecated os.tmpDir (#2802)
e249434 Merge pull request #2807 from mochajs/npm-script-lint
17a1770 Move linting into an npm script. Relates to #2805

See the full diff

Not sure how things should work exactly?

There is a collection of frequently asked questions and of course you may always ask my humans.

Your Greenkeeper Bot 🌴

Why include parameters in Dash docset index?

Is this needed? Do you usually search using a parameter name? Just including the methods should be fine as far as I can tell. I don't use node though so I have no idea.

You could include them in the in-page anchors only and not inside the main search index.

support annotations from closure compiler (that jsdoc does not have)

I found there are some properties I'd like to document that jsdoc does not have built in

esdoc/esdoc#347
http://stackoverflow.com/questions/25314979/documenting-side-effects-of-javascript-methods
https://github.com/google/closure-compiler/wiki/Annotating-JavaScript-for-the-Closure-Compiler#nosideeffects-modifies-thisarguments

--output docset

How do you use doxdox with --layout Dash? If I give it a file using --output, it seems to try to save a directory structure into it.

why is it generating extra column in markdown tables?

I see extra column being generated in markdown tables filled with |   |. What is the reasoning behind this and can this be disabled?

An in-range update of mocha is breaking the build 🚨

Version 5.2.0 of mocha was just published.

Branch	Build failing 🚨
Dependency	`mocha`
Current Version	5.1.1
Type	devDependency

This version is covered by your current version range and after updating it in your project the build failed.

mocha is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Status Details

❌ continuous-integration/travis-ci/push The Travis CI build could not complete due to an error Details
❌ continuous-integration/appveyor/branch AppVeyor build failed Details

Release Notes

v5.2.0

5.2.0 / 2018-05-18

🎉 Enhancements

#3375: Add support for comments in mocha.opts (@plroebuck)

🐛 Fixes

#3346: Exit correctly from before hooks when using --bail (@outsideris)

📖 Documentation

#3328: Mocha-flavored API docs! (@Munter)

🔩 Other

#3330: Use Buffer.from() (@harrysarson)
#3295: Remove redundant folder (@DavNej)
#3356: Refactoring (@plroebuck)

Commits

The new version differs by 30 commits.

5bd33a0 Release v5.2.0
0a5604f reformat missed files
7c8f551 ensure scripts/*.js gets prettiered
d8ea2ba update CHANGELOG.md for v5.2.0 [ci skip]
7203ed7 update all dependencies
fb5393b migrate Mocha's tests to Unexpected assertion library (#3343)
fae9af2 docs(docs/index.md): Update "mocha.opts" documentation
9d9e6c6 feat(bin/options.js): Add support for comment lines in "mocha.opts"
e0306ff fix busted lint-staged config
f2be6d4 Annotate when exceptions are caught but ignored; closes #3354 (#3356)
889e681 remove dead code in bin/_mocha
8712b95 fix(ocd): re-order Node.js tests in .travis.yml (descending)
3ab0e7e fix to exit correctly when using bail flag
d87b12e add Node.js v10 to build; fix win32 issues (#3350)
b392af5 update package-lock.json for npm@6 [ci skip]

There are 30 commits in total.

See the full diff

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.

Your Greenkeeper Bot 🌴

async function support

currently, async functions inside of classes seem to be ignored, while literal async functions get parsed correctly.

Test case: JS and package.json Gist
output: Markdown Gist

@Returns doesn't display in template

See: https://github.com/neogeek/doxdox/blob/master/templates/markdown.hbs#L53

Windows Execution Policies

If you are having issues running doxdox on Windows due to permissions, see the following link for more information.

https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_execution_policies?view=powershell-7.2

To get doxdox working, run the following command from Windows PowerShell.

$ Set-ExecutionPolicy RemoteSigned -Scope CurrentUser

static getters are ignored

/**
 * MyTestClass
 */
module.exports = class MyTestClass {

  /**
   * This method will be ignored
   */
  static get staticGetter() {
  }
}

Possibly related to #63 ?

Add Search Field

It would be nice to be able to search generated documentation easily. At the very least, provide the ability to search the set of exported functions.

Invalid layout specified when running packaged app

Using :

doxdox v2.0.3 via node js v8.9.4
windows cmd
Win10

and the following code:

doxdox.parseInputs([folder], {'parser': 'dox','layout': 'bootstrap'}).then(content => { /***/}

When running the script directly from nodejs everything works with no issue.
Running the app packaged with nexe gives me the following error:

Error: Invalid layout specified. at findPackagePath.then.plugin (C:\agv\DevWMS\Test\doc-gen.exe:699:28) at <anonymous>

Maybe related to:

Error: Invalid layout specified. #49

but the cause seems to be different

Error: Invalid layout specified.

win10
git-bash
yarn

Installed it. Launched example from your docs.
Result - "Error: Invalid layout specified.".

Package name and description are undefined

Regression in latest release v4.0.0-preview.3

An in-range update of codecov is breaking the build 🚨

Version 3.0.1 of codecov was just published.

Branch	Build failing 🚨
Dependency	codecov
Current Version	3.0.0
Type	devDependency

This version is covered by your current version range and after updating it in your project the build failed.

codecov is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Status Details

❌ continuous-integration/travis-ci/push The Travis CI build could not complete due to an error Details
❌ continuous-integration/appveyor/branch AppVeyor build failed Details

Release Notes

v3.0.1

Fixing security vulnerability

Commits

The new version differs by 6 commits.

3f18ff7 Fix tests
b055ca1 v3.0.1
75cc0dd package: unpin request so i stop getting these vulnerability reports (#91)
4a7561e add -X s3 to disable uploading to s3 (#84)
19facba Replace the cd command with the pwd option. (#85)
b03a202 update to use upload/v4 endpoint

See the full diff

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.

Your Greenkeeper Bot 🌴

Allow multiple inputs

Example:

$ doxdox src/controllers/user.js src/controllers/auth.js --layout markdown --output docs/README.md

Reference: cloudfour/drizzle-builder#7

How to document curried functions?

How do I document curried functions like this?

const map = func => iterable => {}

Version 10 of node.js has been released

Version 10 of Node.js (code name Dubnium) has been released! 🎊

To see what happens to your code in Node.js 10, Greenkeeper has created a branch with the following changes:

Added the new Node.js version to your .travis.yml
The new Node.js version is in-range for the engines in 1 of your package.json files, so that was left alone

If you’re interested in upgrading this repo to Node.js 10, you can open a PR with these changes. Please note that this issue is just intended as a friendly reminder and the PR as a possible starting point for getting your code running on Node.js 10.

More information on this issue

Greenkeeper has checked the engines key in any package.json file, the .nvmrc file, and the .travis.yml file, if present.

engines was only updated if it defined a single version, not a range.
.nvmrc was updated to Node.js 10
.travis.yml was only changed if there was a root-level node_js that didn’t already include Node.js 10, such as node or lts/*. In this case, the new version was appended to the list. We didn’t touch job or matrix configurations because these tend to be quite specific and complex, and it’s difficult to infer what the intentions were.

For many simpler .travis.yml configurations, this PR should suffice as-is, but depending on what you’re doing it may require additional work or may not be applicable at all. We’re also aware that you may have good reasons to not update to Node.js 10, which is why this was sent as an issue and not a pull request. Feel free to delete it without comment, I’m a humble robot and won’t feel rejected 🤖

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.

Your Greenkeeper Bot 🌴

doxdox.org is down

There is a JSON parse error (500)

Best regards

[feature] Windows support

problem
windows can't handle the path regExp

command
$ npx doxdox './src/**/*.js' --layout markdown --output testDOCU.md

result
Invalid regular expression: /^(C:\xampp\htdocs\projects\viewar\viewar-docu/|./)/: Invalid escape

Switch from a user defined temp directory to using the os temp directory

"Example

Website is down

I wanted to view the api reference for GPU.js which is hosted on your website, but it appears to be down. I see this:

Code highlight doesn't work in Bootstrap or Dash output (v4.0.0-preview.1)

Not supported enumeration (type union)

I have function like this:
myfile.js

  /**
   * Some description
   * @param {('SUCCESS'|'ERROR')} result
   */
  export function methodName(result) {
    // some code
  }

When I run doxdox 'myfile.js' --output output.md it is crashed with error:

TypeLexerSyntaxError: Expected "!", "(", "*", "...", "=", "?", "function", "module", "{", [ \t\r\n ] or [a-zA-Z_$] but "'" found.:
('SUCCESS'|'ERROR')

type union in JSDoc supported from 2004

Support new lines (hard wraps) in params?

In the sample input below, the param declarations are hard wrapped. However, the generated markdown is also hard wrapped, leading to an incorrect visual representation (since markdown tables don't support new lines in cells).

Input

/**
 * Sagas are primarily used for handling ajax workflows.
 *
 * @param {String} channel - the name of the saga collection
 * @param {Map<String,*>} ActionTypes - the names of the action types (aka side effects) these sagas handle
 * @param {Map<ActionType,Function>} SagaActionFunctions - (optional) map of action functions indexed by
 * ActionType. Like a store's action functions, these functions can be used to initiate a saga. Note
 * that if you include one action function, then every ActionType must have a corresponding action function.
 * @param {Function} SagaHandlersFn - higher order function with signature `({sagas})=>SagaHandlers` that
 * accepts the `sagas` interface object and returns the SagaHandlers. The SagaHandlers are a map of
 * functions indexed by ActionType i.e, Map<ActionType,Function>.
 * @return {Saga} higher order function that creates the saga.
 */
export default function createSagas({channel, ActionTypes, SagaActionFunctions = {}, SagaHandlersFn}) {
//...
}

Markdown output:

### src/stores/createSagas.js


#### createSagas(channel, ActionTypes, SagaActionFunctions, SagaHandlersFn) 

Sagas are primarily used for handling ajax workflows.




##### Parameters

| Name | Type | Description |  |
| ---- | ---- | ----------- | -------- |
| channel | `String`  | - the name of the saga collection | &nbsp; |
| ActionTypes | `Map.&lt;String, *&gt;`  | - the names of the action types (aka side effects) these sagas handle | &nbsp; |
| SagaActionFunctions | `Map.&lt;ActionType, Function&gt;`  | - (optional) map of action functions indexed by ActionType. Like a store's action functions, these functions can be used to initiate a saga. Note
that if you include one action function, then every ActionType must have a corresponding action function. | &nbsp; |
| SagaHandlersFn | `Function`  | - higher order function with signature `({sagas})=>SagaHandlers` that accepts the `sagas` interface object and returns the SagaHandlers. The SagaHandlers are a map of
functions indexed by ActionType i.e, Map<ActionType,Function>. | &nbsp; |

docsbydoxdox / doxdox Goto Github PK

doxdox's Introduction

Example

In

Out

Install

Globally

Locally

Usage

CLI

Custom Meta Information

Name

Description

Ignore

Output

File

Stdout

Renderers

Markdown

Bootstrap

JSON

Help

NPM Run Scripts

JavaScript

Next.js

Custom Renderer

Plugins

Parsers

Default Parsers

Optional Parsers

Renderers

Default Renderers

Optional Renderers

Questions

Contributing

License

doxdox's People

Contributors

Stargazers

Watchers

Forkers

doxdox's Issues

Version 3.4.2 of mocha just got published.

3.4.2 / 2017-05-24

🐛 Fixes

🔩 Other

Version 5.2.0 of mocha was just published.

5.2.0 / 2018-05-18

🎉 Enhancements

🐛 Fixes

📖 Documentation

🔩 Other

Version 3.0.1 of codecov was just published.

Version 10 of Node.js (code name Dubnium) has been released! 🎊

Recommend Projects

Recommend Topics

Recommend Org