4
4
* Adds shared options to any command that runs documentation
5
5
*/
6
6
module . exports . sharedInputOptions = {
7
- strict : true ,
8
7
shallow : {
9
8
describe :
10
9
'shallow mode turns off dependency resolution, ' +
11
- 'only processing the specified files (or the main script specified in package.json)' ,
10
+ 'only processing the specified files (or the main script specified in package.json)' ,
12
11
default : false ,
13
12
type : 'boolean'
14
13
} ,
@@ -27,13 +26,13 @@ module.exports.sharedInputOptions = {
27
26
external : {
28
27
describe :
29
28
'a string / glob match pattern that defines which external ' +
30
- 'modules will be whitelisted and included in the generated documentation.' ,
29
+ 'modules will be whitelisted and included in the generated documentation.' ,
31
30
default : null
32
31
} ,
33
32
'require-extension' : {
34
33
describe :
35
34
"additional extensions to include in require() and import's search algorithm." +
36
- 'For instance, adding .es5 would allow require("adder") to find "adder.es5"' ,
35
+ 'For instance, adding .es5 would allow require("adder") to find "adder.es5"' ,
37
36
// Ensure that the value is an array
38
37
coerce : ( value : string | Array < string > ) => [ ] . concat ( value ) ,
39
38
alias : 're'
@@ -53,8 +52,8 @@ module.exports.sharedInputOptions = {
53
52
access : {
54
53
describe :
55
54
'Include only comments with a given access level, out of private, ' +
56
- 'protected, public, undefined. By default, public, protected, and undefined access ' +
57
- 'levels are included' ,
55
+ 'protected, public, undefined. By default, public, protected, and undefined access ' +
56
+ 'levels are included' ,
58
57
choices : [ 'public' , 'private' , 'protected' , 'undefined' ] ,
59
58
array : true ,
60
59
alias : 'a'
@@ -68,13 +67,13 @@ module.exports.sharedInputOptions = {
68
67
type : 'string' ,
69
68
describe :
70
69
'Infer private access based on the name. This is a regular expression that ' +
71
- 'is used to match the name'
70
+ 'is used to match the name'
72
71
} ,
73
72
'document-exported' : {
74
73
type : 'boolean' ,
75
74
describe :
76
75
'Generate documentation for all exported bindings and members ' +
77
- 'even if there is no JSDoc for them' ,
76
+ 'even if there is no JSDoc for them' ,
78
77
default : false
79
78
} ,
80
79
'sort-order' : {
0 commit comments