Skip to content

Commit 84809d4

Browse files
committed
Added ignore paths flag.
1 parent 1b79de5 commit 84809d4

File tree

2 files changed

+3
-0
lines changed

2 files changed

+3
-0
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,7 @@ Options:
7878
-h, --help Display this help message.
7979
-v, --version Display the current installed version.
8080
-d, --description Sets description.
81+
-i, --ignore Comma separated list of paths to ignore.
8182
-l, --layout Template to render the documentation with.
8283
-o, --output File to save documentation to. Defaults to stdout.
8384
-p, --package Sets location of package.json file.

bin/doxdox

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ ${chalk.blue(' Usage:')} doxdox <path> [options]
2929
${chalk.yellow(' -h, --help')} Display this help message.
3030
${chalk.yellow(' -v, --version')} Display the current installed version.
3131
${chalk.yellow(' -d, --description')} Sets description.
32+
${chalk.yellow(' -i, --ignore')} Comma separated list of paths to ignore.
3233
${chalk.yellow(' -l, --layout')} Template to render the documentation with.
3334
${chalk.yellow(' -o, --output')} File to save documentation to. Defaults to stdout.
3435
${chalk.yellow(' -p, --package')} Sets location of package.json file.
@@ -59,6 +60,7 @@ ${chalk.yellow(' -t, --title')} Sets title.
5960

6061
const config = {
6162
'description': args.flags['--description'] || args.flags['-d'] || pkg.description || '',
63+
'ignore': (args.flags['--ignore'] || args.flags['-i'] || '').split(/\s*,\s*/),
6264
'layout': (args.flags['--layout'] || args.flags['-l'] || 'markdown').toLowerCase(),
6365
'parser': (args.flags['--parser'] || args.flags['-r'] || 'dox').toLowerCase(),
6466
'title': args.flags['--title'] || args.flags['-t'] || pkg.name || 'Untitled Project'

0 commit comments

Comments
 (0)