mirror of
https://github.com/jsdoc/jsdoc.git
synced 2025-12-08 19:46:11 +00:00
6a5b88cb5a
Glob expressions are easier than regexes to write correctly; they're often easier to read as well. We support all of the syntax in https://github.com/mrmlnc/fast-glob#pattern-syntax, which should provide more than enough flexibility for JSDoc users. Related change: If a `package.json` or `README.md` file gets picked up as one of your source files, we no longer assume that it should be incorporated into the generated docs. Instead, you must specify the file explicitly with the `-P` flag (for `package.json`) or the `-R` flag (for `README.md`).
118 lines
3.1 KiB
JavaScript
118 lines
3.1 KiB
JavaScript
/*
|
|
Copyright 2019 the JSDoc Authors.
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
https://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
*/
|
|
const { cast } = require('@jsdoc/util');
|
|
const querystring = require('querystring');
|
|
|
|
// TODO: Document the format of this object, then update the docs for `Engine`.
|
|
/**
|
|
* Command-line flags recognized by JSDoc.
|
|
*
|
|
* @alias module:@jsdoc/cli/lib/flags
|
|
*/
|
|
module.exports = {
|
|
access: {
|
|
alias: 'a',
|
|
array: true,
|
|
choices: ['all', 'package', 'private', 'protected', 'public', 'undefined'],
|
|
defaultDescription: 'All except `private`',
|
|
description: 'Document only symbols with the specified access level.',
|
|
requiresArg: true,
|
|
},
|
|
configure: {
|
|
alias: 'c',
|
|
description: 'The configuration file to use.',
|
|
normalize: true,
|
|
requiresArg: true,
|
|
},
|
|
debug: {
|
|
boolean: true,
|
|
description: 'Log information to help with debugging.',
|
|
},
|
|
destination: {
|
|
alias: 'd',
|
|
default: './out',
|
|
description: 'The output directory.',
|
|
normalize: true,
|
|
requiresArg: true,
|
|
},
|
|
encoding: {
|
|
alias: 'e',
|
|
default: 'utf8',
|
|
description: 'The encoding to assume when reading source files.',
|
|
requiresArg: true,
|
|
},
|
|
explain: {
|
|
alias: 'X',
|
|
boolean: true,
|
|
description: 'Print the parse results to the console and exit.',
|
|
},
|
|
help: {
|
|
alias: 'h',
|
|
boolean: true,
|
|
description: 'Print help information and exit.',
|
|
},
|
|
match: {
|
|
description: 'Run only tests whose names contain this value.',
|
|
requiresArg: true,
|
|
},
|
|
package: {
|
|
alias: 'P',
|
|
description: 'The path to the `package.json` file to use.',
|
|
normalize: true,
|
|
requiresArg: true,
|
|
},
|
|
pedantic: {
|
|
boolean: true,
|
|
description: 'Treat errors as fatal errors, and treat warnings as errors.',
|
|
},
|
|
private: {
|
|
alias: 'p',
|
|
boolean: true,
|
|
description: 'Document private symbols (equivalent to `--access all`).',
|
|
},
|
|
query: {
|
|
alias: 'q',
|
|
coerce: (str) => cast(querystring.parse(str)),
|
|
description: 'A query string to parse and store (for example, `foo=bar&baz=true`).',
|
|
requiresArg: true,
|
|
},
|
|
readme: {
|
|
alias: 'R',
|
|
description: 'The `README` file to include in the documentation.',
|
|
normalize: true,
|
|
requiresArg: true,
|
|
},
|
|
template: {
|
|
alias: 't',
|
|
description: 'The template package to use.',
|
|
requiresArg: true,
|
|
},
|
|
test: {
|
|
alias: 'T',
|
|
boolean: true,
|
|
description: 'Run all tests and exit.',
|
|
},
|
|
verbose: {
|
|
boolean: true,
|
|
description: 'Log detailed information to the console.',
|
|
},
|
|
version: {
|
|
alias: 'v',
|
|
boolean: true,
|
|
description: 'Display the version number and exit.',
|
|
},
|
|
};
|