@appium/docutils 0.2.2 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (92) hide show
  1. package/LICENSE +1 -1
  2. package/build/lib/builder/deploy.d.ts.map +1 -1
  3. package/build/lib/builder/deploy.js +6 -2
  4. package/build/lib/builder/deploy.js.map +1 -1
  5. package/build/lib/builder/index.d.ts +4 -0
  6. package/build/lib/builder/index.d.ts.map +1 -1
  7. package/build/lib/builder/index.js +4 -0
  8. package/build/lib/builder/index.js.map +1 -1
  9. package/build/lib/builder/nav.d.ts +1 -1
  10. package/build/lib/builder/nav.d.ts.map +1 -1
  11. package/build/lib/builder/nav.js +3 -3
  12. package/build/lib/builder/nav.js.map +1 -1
  13. package/build/lib/builder/reference.d.ts.map +1 -1
  14. package/build/lib/builder/reference.js +1 -19
  15. package/build/lib/builder/reference.js.map +1 -1
  16. package/build/lib/builder/site.d.ts.map +1 -1
  17. package/build/lib/builder/site.js +4 -3
  18. package/build/lib/builder/site.js.map +1 -1
  19. package/build/lib/cli/check.d.ts +19 -0
  20. package/build/lib/cli/check.d.ts.map +1 -0
  21. package/build/lib/cli/check.js +58 -0
  22. package/build/lib/cli/check.js.map +1 -0
  23. package/build/lib/cli/command/build.d.ts +189 -174
  24. package/build/lib/cli/command/build.d.ts.map +1 -1
  25. package/build/lib/cli/command/build.js +56 -38
  26. package/build/lib/cli/command/build.js.map +1 -1
  27. package/build/lib/cli/command/index.d.ts +4 -0
  28. package/build/lib/cli/command/index.d.ts.map +1 -1
  29. package/build/lib/cli/command/index.js +4 -0
  30. package/build/lib/cli/command/index.js.map +1 -1
  31. package/build/lib/cli/command/init.d.ts +156 -139
  32. package/build/lib/cli/command/init.d.ts.map +1 -1
  33. package/build/lib/cli/command/init.js +52 -27
  34. package/build/lib/cli/command/init.js.map +1 -1
  35. package/build/lib/cli/command/validate.d.ts +71 -63
  36. package/build/lib/cli/command/validate.d.ts.map +1 -1
  37. package/build/lib/cli/command/validate.js +31 -20
  38. package/build/lib/cli/command/validate.js.map +1 -1
  39. package/build/lib/cli/index.d.ts.map +1 -1
  40. package/build/lib/cli/index.js +29 -12
  41. package/build/lib/cli/index.js.map +1 -1
  42. package/build/lib/constants.d.ts +4 -0
  43. package/build/lib/constants.d.ts.map +1 -1
  44. package/build/lib/constants.js +5 -1
  45. package/build/lib/constants.js.map +1 -1
  46. package/build/lib/error.d.ts +5 -0
  47. package/build/lib/error.d.ts.map +1 -1
  48. package/build/lib/error.js +5 -0
  49. package/build/lib/error.js.map +1 -1
  50. package/build/lib/fs.d.ts +1 -1
  51. package/build/lib/fs.d.ts.map +1 -1
  52. package/build/lib/fs.js +2 -2
  53. package/build/lib/fs.js.map +1 -1
  54. package/build/lib/index.d.ts +4 -0
  55. package/build/lib/index.d.ts.map +1 -1
  56. package/build/lib/index.js +4 -0
  57. package/build/lib/index.js.map +1 -1
  58. package/build/lib/init.d.ts +12 -5
  59. package/build/lib/init.d.ts.map +1 -1
  60. package/build/lib/init.js +12 -7
  61. package/build/lib/init.js.map +1 -1
  62. package/build/lib/mike.d.ts.map +1 -1
  63. package/build/lib/mike.js +4 -0
  64. package/build/lib/mike.js.map +1 -1
  65. package/build/lib/util.d.ts +4 -1
  66. package/build/lib/util.d.ts.map +1 -1
  67. package/build/lib/util.js.map +1 -1
  68. package/build/lib/validate.d.ts +4 -1
  69. package/build/lib/validate.d.ts.map +1 -1
  70. package/build/lib/validate.js +9 -7
  71. package/build/lib/validate.js.map +1 -1
  72. package/lib/builder/deploy.ts +9 -3
  73. package/lib/builder/index.ts +5 -0
  74. package/lib/builder/nav.ts +2 -3
  75. package/lib/builder/reference.ts +2 -22
  76. package/lib/builder/site.ts +6 -5
  77. package/lib/cli/check.ts +87 -0
  78. package/lib/cli/command/build.ts +61 -43
  79. package/lib/cli/command/index.ts +5 -0
  80. package/lib/cli/command/init.ts +54 -29
  81. package/lib/cli/command/validate.ts +33 -25
  82. package/lib/cli/index.ts +23 -4
  83. package/lib/constants.ts +5 -0
  84. package/lib/error.ts +6 -0
  85. package/lib/fs.ts +6 -3
  86. package/lib/index.ts +5 -0
  87. package/lib/init.ts +23 -6
  88. package/lib/mike.js +5 -0
  89. package/lib/util.ts +4 -1
  90. package/lib/validate.ts +10 -9
  91. package/package.json +8 -10
  92. package/requirements.txt +1 -1
@@ -1,3 +1,7 @@
1
+ /**
2
+ * Exports all command modules
3
+ * @module
4
+ */
1
5
  export { default as init } from './init';
2
6
  export { default as validate } from './validate';
3
7
  export { default as build } from './build';
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../lib/cli/command/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,OAAO,IAAI,IAAI,EAAC,MAAM,QAAQ,CAAC;AACvC,OAAO,EAAC,OAAO,IAAI,QAAQ,EAAC,MAAM,YAAY,CAAC;AAC/C,OAAO,EAAC,OAAO,IAAI,KAAK,EAAC,MAAM,SAAS,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../lib/cli/command/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAC,OAAO,IAAI,IAAI,EAAC,MAAM,QAAQ,CAAC;AACvC,OAAO,EAAC,OAAO,IAAI,QAAQ,EAAC,MAAM,YAAY,CAAC;AAC/C,OAAO,EAAC,OAAO,IAAI,KAAK,EAAC,MAAM,SAAS,CAAC"}
@@ -1,4 +1,8 @@
1
1
  "use strict";
2
+ /**
3
+ * Exports all command modules
4
+ * @module
5
+ */
2
6
  var __importDefault = (this && this.__importDefault) || function (mod) {
3
7
  return (mod && mod.__esModule) ? mod : { "default": mod };
4
8
  };
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../lib/cli/command/index.ts"],"names":[],"mappings":";;;;;;AAAA,+BAAuC;AAA/B,6GAAA,OAAO,OAAQ;AACvB,uCAA+C;AAAvC,qHAAA,OAAO,OAAY;AAC3B,iCAAyC;AAAjC,+GAAA,OAAO,OAAS"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../lib/cli/command/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;AAEH,+BAAuC;AAA/B,6GAAA,OAAO,OAAQ;AACvB,uCAA+C;AAAvC,qHAAA,OAAO,OAAY;AAC3B,iCAAyC;AAAjC,+GAAA,OAAO,OAAS"}
@@ -1,141 +1,158 @@
1
- import { CommandModule, InferredOptionTypes } from 'yargs';
2
- declare const _default: CommandModule<{}, InferredOptionTypes<Readonly<{
3
- copyright: {
4
- description: string;
5
- group: string;
6
- nargs: number;
7
- requiresArg: true;
8
- type: "string";
9
- };
10
- dir: {
11
- default: string;
12
- defaultDescription: string;
13
- description: string;
14
- group: string;
15
- normalize: true;
16
- type: "string";
17
- };
18
- 'dry-run': {
19
- describe: string;
20
- group: string;
21
- type: "boolean";
22
- };
23
- force: {
24
- alias: string;
25
- describe: string;
26
- group: string;
27
- type: "boolean";
28
- };
29
- include: {
30
- alias: string;
31
- array: true;
32
- coerce: (value: string | string[]) => string[];
33
- description: string;
34
- nargs: number;
35
- requiresArg: true;
36
- type: "string";
37
- };
38
- mkdocs: {
39
- default: boolean;
40
- description: string;
41
- group: string;
42
- type: "boolean";
43
- };
44
- 'mkdocs-yml': {
45
- defaultDescription: string;
46
- description: string;
47
- group: string;
48
- nargs: number;
49
- normalize: true;
50
- requiresArg: true;
51
- type: "string";
52
- };
53
- 'package-json': {
54
- defaultDescription: string;
55
- describe: string;
56
- group: string;
57
- nargs: number;
58
- normalize: true;
59
- requiresArg: true;
60
- type: "string";
61
- };
62
- python: {
63
- default: boolean;
64
- description: string;
65
- group: string;
66
- type: "boolean";
67
- };
68
- 'python-path': {
69
- defaultDescription: string;
70
- description: string;
71
- group: string;
72
- nargs: number;
73
- normalize: true;
74
- requiresArg: true;
75
- type: "string";
76
- };
77
- 'repo-name': {
78
- defaultDescription: string;
79
- description: string;
80
- group: string;
81
- nargs: number;
82
- requiresArg: true;
83
- type: "string";
84
- };
85
- 'repo-url': {
86
- defaultDescription: string;
87
- description: string;
88
- group: string;
89
- nargs: number;
90
- requiresArg: true;
91
- type: "string";
92
- };
93
- 'site-description': {
94
- defaultDescription: string;
95
- description: string;
96
- group: string;
97
- nargs: number;
98
- requiresArg: true;
99
- type: "string";
100
- };
101
- 'site-name': {
102
- defaultDescription: string;
103
- description: string;
104
- group: string;
105
- nargs: number;
106
- requiresArg: true;
107
- type: "string";
108
- };
109
- 'tsconfig-json': {
110
- defaultDescription: string;
111
- describe: string;
112
- group: string;
113
- nargs: number;
114
- normalize: true;
115
- requiresArg: true;
116
- type: "string";
117
- };
118
- typedoc: {
119
- default: boolean;
120
- description: string;
121
- group: string;
122
- type: "boolean";
123
- };
124
- 'typedoc-json': {
125
- defaultDescription: string;
126
- describe: string;
127
- group: string;
128
- nargs: number;
129
- normalize: true;
130
- requiresArg: true;
131
- type: "string";
132
- };
133
- typescript: {
134
- default: boolean;
135
- description: string;
136
- group: string;
137
- type: "boolean";
138
- };
139
- }>>>;
1
+ /**
2
+ * Yargs command module for the `init` command.
3
+ * @module
4
+ */
5
+ import type { CommandModule, InferredOptionTypes } from 'yargs';
6
+ declare enum InitCommandGroup {
7
+ MkDocs = "MkDocs Config:",
8
+ Paths = "Custom Paths:",
9
+ Behavior = "Initialization Behavior:"
10
+ }
11
+ declare const _default: CommandModule<object, InferredOptionTypes<{
12
+ readonly copyright: {
13
+ readonly description: "Copyright notice";
14
+ readonly group: InitCommandGroup.MkDocs;
15
+ readonly nargs: 1;
16
+ readonly requiresArg: true;
17
+ readonly type: "string";
18
+ };
19
+ readonly dir: {
20
+ readonly default: ".";
21
+ readonly defaultDescription: "(current directory)";
22
+ readonly description: "Directory of package";
23
+ readonly group: InitCommandGroup.Paths;
24
+ readonly normalize: true;
25
+ readonly type: "string";
26
+ };
27
+ readonly 'dry-run': {
28
+ readonly describe: "Do not write any files; show what would be done";
29
+ readonly group: InitCommandGroup.Behavior;
30
+ readonly type: "boolean";
31
+ };
32
+ readonly force: {
33
+ readonly alias: "f";
34
+ readonly describe: "Overwrite existing configurations";
35
+ readonly group: InitCommandGroup.Behavior;
36
+ readonly type: "boolean";
37
+ };
38
+ readonly include: {
39
+ readonly alias: "i";
40
+ readonly array: true;
41
+ readonly coerce: (value: string | string[]) => string[];
42
+ readonly description: "Files to include in compilation (globs OK)";
43
+ readonly nargs: 1;
44
+ readonly group: InitCommandGroup.MkDocs;
45
+ readonly requiresArg: true;
46
+ readonly type: "string";
47
+ };
48
+ readonly mkdocs: {
49
+ readonly default: true;
50
+ readonly description: "Create mkdocs.yml if needed";
51
+ readonly group: InitCommandGroup.Behavior;
52
+ readonly type: "boolean";
53
+ };
54
+ readonly 'mkdocs-yml': {
55
+ readonly defaultDescription: "./mkdocs.yml";
56
+ readonly description: "Path to new or existing mkdocs.yml";
57
+ readonly group: InitCommandGroup.MkDocs;
58
+ readonly nargs: 1;
59
+ readonly normalize: true;
60
+ readonly requiresArg: true;
61
+ readonly type: "string";
62
+ };
63
+ readonly 'package-json': {
64
+ readonly defaultDescription: "./package.json";
65
+ readonly describe: "Path to existing package.json";
66
+ readonly group: InitCommandGroup.Paths;
67
+ readonly nargs: 1;
68
+ readonly normalize: true;
69
+ readonly requiresArg: true;
70
+ readonly type: "string";
71
+ };
72
+ readonly python: {
73
+ readonly default: true;
74
+ readonly description: "Install Python dependencies if needed";
75
+ readonly group: InitCommandGroup.Behavior;
76
+ readonly type: "boolean";
77
+ };
78
+ readonly 'python-path': {
79
+ readonly defaultDescription: "(derived from shell)";
80
+ readonly description: "Path to python 3 executable";
81
+ readonly group: InitCommandGroup.Paths;
82
+ readonly nargs: 1;
83
+ readonly normalize: true;
84
+ readonly requiresArg: true;
85
+ readonly type: "string";
86
+ };
87
+ readonly 'repo-name': {
88
+ readonly defaultDescription: "(derived from --repo-url)";
89
+ readonly description: "Name of extension repository";
90
+ readonly group: InitCommandGroup.MkDocs;
91
+ readonly nargs: 1;
92
+ readonly requiresArg: true;
93
+ readonly type: "string";
94
+ };
95
+ readonly 'repo-url': {
96
+ readonly defaultDescription: "(from package.json)";
97
+ readonly description: "URL of extension repository";
98
+ readonly group: InitCommandGroup.MkDocs;
99
+ readonly nargs: 1;
100
+ readonly requiresArg: true;
101
+ readonly type: "string";
102
+ };
103
+ readonly 'site-description': {
104
+ readonly defaultDescription: "(from package.json)";
105
+ readonly description: "Site description";
106
+ readonly group: InitCommandGroup.MkDocs;
107
+ readonly nargs: 1;
108
+ readonly requiresArg: true;
109
+ readonly type: "string";
110
+ };
111
+ readonly 'site-name': {
112
+ readonly defaultDescription: "(extension package name)";
113
+ readonly description: "Name of site";
114
+ readonly group: InitCommandGroup.MkDocs;
115
+ readonly nargs: 1;
116
+ readonly requiresArg: true;
117
+ readonly type: "string";
118
+ };
119
+ readonly 'tsconfig-json': {
120
+ readonly defaultDescription: "./tsconfig.json";
121
+ readonly describe: "Path to new or existing tsconfig.json";
122
+ readonly group: InitCommandGroup.Behavior;
123
+ readonly nargs: 1;
124
+ readonly normalize: true;
125
+ readonly requiresArg: true;
126
+ readonly type: "string";
127
+ };
128
+ readonly typedoc: {
129
+ readonly default: true;
130
+ readonly description: "Create typedoc.json if needed";
131
+ readonly group: InitCommandGroup.Behavior;
132
+ readonly type: "boolean";
133
+ };
134
+ readonly 'typedoc-json': {
135
+ readonly defaultDescription: "./typedoc.json";
136
+ readonly describe: "Path to new or existing typedoc.json";
137
+ readonly group: InitCommandGroup.Behavior;
138
+ readonly nargs: 1;
139
+ readonly normalize: true;
140
+ readonly requiresArg: true;
141
+ readonly type: "string";
142
+ };
143
+ readonly typescript: {
144
+ readonly default: true;
145
+ readonly description: "Create tsconfig.json if needed";
146
+ readonly group: InitCommandGroup.Behavior;
147
+ readonly type: "boolean";
148
+ };
149
+ readonly upgrade: {
150
+ readonly alias: "up";
151
+ readonly describe: "Only upgrade Python dependencies if out-of-date";
152
+ readonly group: InitCommandGroup.Behavior;
153
+ readonly type: "boolean";
154
+ readonly conflicts: "force";
155
+ };
156
+ }>>;
140
157
  export default _default;
141
158
  //# sourceMappingURL=init.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"init.d.ts","sourceRoot":"","sources":["../../../../lib/cli/command/init.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,aAAa,EAAE,mBAAmB,EAAU,MAAM,OAAO,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAwJlE,wBASoC"}
1
+ {"version":3,"file":"init.d.ts","sourceRoot":"","sources":["../../../../lib/cli/command/init.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,KAAK,EAAC,aAAa,EAAE,mBAAmB,EAAU,MAAM,OAAO,CAAC;AAQvE,aAAK,gBAAgB;IACnB,MAAM,mBAAmB;IACzB,KAAK,kBAAkB;IACvB,QAAQ,6BAA6B;CACtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4JD,wBAawC"}
@@ -1,4 +1,8 @@
1
1
  "use strict";
2
+ /**
3
+ * Yargs command module for the `init` command.
4
+ * @module
5
+ */
2
6
  var __importDefault = (this && this.__importDefault) || function (mod) {
3
7
  return (mod && mod.__esModule) ? mod : { "default": mod };
4
8
  };
@@ -7,14 +11,23 @@ const lodash_1 = __importDefault(require("lodash"));
7
11
  const init_1 = require("../../init");
8
12
  const logger_1 = __importDefault(require("../../logger"));
9
13
  const util_1 = require("../../util");
14
+ const check_1 = require("../check");
10
15
  const log = logger_1.default.withTag('init');
11
- const NAME_GROUP_INIT_MKDOCS = 'MkDocs Config:';
12
- const NAME_GROUP_INIT_PATHS = 'Paths:';
13
- const NAME_GROUP_INIT_BEHAVIOR = 'Initialization Behavior:';
14
- const opts = Object.freeze({
16
+ var InitCommandGroup;
17
+ (function (InitCommandGroup) {
18
+ InitCommandGroup["MkDocs"] = "MkDocs Config:";
19
+ InitCommandGroup["Paths"] = "Custom Paths:";
20
+ InitCommandGroup["Behavior"] = "Initialization Behavior:";
21
+ })(InitCommandGroup || (InitCommandGroup = {}));
22
+ /**
23
+ * Note the groups here; _some_ opts are paths and would usually be checked via
24
+ * {@linkcode checkMissingPaths}, but in this case we do not care if the path exists or not, because
25
+ * we may create it.
26
+ */
27
+ const opts = {
15
28
  copyright: {
16
29
  description: 'Copyright notice',
17
- group: NAME_GROUP_INIT_MKDOCS,
30
+ group: InitCommandGroup.MkDocs,
18
31
  nargs: 1,
19
32
  requiresArg: true,
20
33
  type: 'string',
@@ -23,19 +36,19 @@ const opts = Object.freeze({
23
36
  default: '.',
24
37
  defaultDescription: '(current directory)',
25
38
  description: 'Directory of package',
26
- group: NAME_GROUP_INIT_PATHS,
39
+ group: InitCommandGroup.Paths,
27
40
  normalize: true,
28
41
  type: 'string',
29
42
  },
30
43
  'dry-run': {
31
44
  describe: 'Do not write any files; show what would be done',
32
- group: NAME_GROUP_INIT_BEHAVIOR,
45
+ group: InitCommandGroup.Behavior,
33
46
  type: 'boolean',
34
47
  },
35
48
  force: {
36
49
  alias: 'f',
37
50
  describe: 'Overwrite existing configurations',
38
- group: NAME_GROUP_INIT_BEHAVIOR,
51
+ group: InitCommandGroup.Behavior,
39
52
  type: 'boolean',
40
53
  },
41
54
  include: {
@@ -44,19 +57,20 @@ const opts = Object.freeze({
44
57
  coerce: (value) => lodash_1.default.castArray(value),
45
58
  description: 'Files to include in compilation (globs OK)',
46
59
  nargs: 1,
60
+ group: InitCommandGroup.MkDocs,
47
61
  requiresArg: true,
48
62
  type: 'string',
49
63
  },
50
64
  mkdocs: {
51
65
  default: true,
52
66
  description: 'Create mkdocs.yml if needed',
53
- group: NAME_GROUP_INIT_BEHAVIOR,
67
+ group: InitCommandGroup.Behavior,
54
68
  type: 'boolean',
55
69
  },
56
70
  'mkdocs-yml': {
57
71
  defaultDescription: './mkdocs.yml',
58
- description: 'Path to mkdocs.yml',
59
- group: NAME_GROUP_INIT_PATHS,
72
+ description: 'Path to new or existing mkdocs.yml',
73
+ group: InitCommandGroup.MkDocs,
60
74
  nargs: 1,
61
75
  normalize: true,
62
76
  requiresArg: true,
@@ -64,8 +78,8 @@ const opts = Object.freeze({
64
78
  },
65
79
  'package-json': {
66
80
  defaultDescription: './package.json',
67
- describe: 'Path to package.json',
68
- group: NAME_GROUP_INIT_PATHS,
81
+ describe: 'Path to existing package.json',
82
+ group: InitCommandGroup.Paths,
69
83
  nargs: 1,
70
84
  normalize: true,
71
85
  requiresArg: true,
@@ -74,13 +88,13 @@ const opts = Object.freeze({
74
88
  python: {
75
89
  default: true,
76
90
  description: 'Install Python dependencies if needed',
77
- group: NAME_GROUP_INIT_BEHAVIOR,
91
+ group: InitCommandGroup.Behavior,
78
92
  type: 'boolean',
79
93
  },
80
94
  'python-path': {
81
95
  defaultDescription: '(derived from shell)',
82
96
  description: 'Path to python 3 executable',
83
- group: NAME_GROUP_INIT_PATHS,
97
+ group: InitCommandGroup.Paths,
84
98
  nargs: 1,
85
99
  normalize: true,
86
100
  requiresArg: true,
@@ -89,7 +103,7 @@ const opts = Object.freeze({
89
103
  'repo-name': {
90
104
  defaultDescription: '(derived from --repo-url)',
91
105
  description: 'Name of extension repository',
92
- group: NAME_GROUP_INIT_MKDOCS,
106
+ group: InitCommandGroup.MkDocs,
93
107
  nargs: 1,
94
108
  requiresArg: true,
95
109
  type: 'string',
@@ -97,7 +111,7 @@ const opts = Object.freeze({
97
111
  'repo-url': {
98
112
  defaultDescription: '(from package.json)',
99
113
  description: 'URL of extension repository',
100
- group: NAME_GROUP_INIT_MKDOCS,
114
+ group: InitCommandGroup.MkDocs,
101
115
  nargs: 1,
102
116
  requiresArg: true,
103
117
  type: 'string',
@@ -105,7 +119,7 @@ const opts = Object.freeze({
105
119
  'site-description': {
106
120
  defaultDescription: '(from package.json)',
107
121
  description: 'Site description',
108
- group: NAME_GROUP_INIT_MKDOCS,
122
+ group: InitCommandGroup.MkDocs,
109
123
  nargs: 1,
110
124
  requiresArg: true,
111
125
  type: 'string',
@@ -113,15 +127,15 @@ const opts = Object.freeze({
113
127
  'site-name': {
114
128
  defaultDescription: '(extension package name)',
115
129
  description: 'Name of site',
116
- group: NAME_GROUP_INIT_MKDOCS,
130
+ group: InitCommandGroup.MkDocs,
117
131
  nargs: 1,
118
132
  requiresArg: true,
119
133
  type: 'string',
120
134
  },
121
135
  'tsconfig-json': {
122
136
  defaultDescription: './tsconfig.json',
123
- describe: 'Path to tsconfig.json',
124
- group: NAME_GROUP_INIT_PATHS,
137
+ describe: 'Path to new or existing tsconfig.json',
138
+ group: InitCommandGroup.Behavior,
125
139
  nargs: 1,
126
140
  normalize: true,
127
141
  requiresArg: true,
@@ -130,13 +144,13 @@ const opts = Object.freeze({
130
144
  typedoc: {
131
145
  default: true,
132
146
  description: 'Create typedoc.json if needed',
133
- group: NAME_GROUP_INIT_BEHAVIOR,
147
+ group: InitCommandGroup.Behavior,
134
148
  type: 'boolean',
135
149
  },
136
150
  'typedoc-json': {
137
151
  defaultDescription: './typedoc.json',
138
- describe: 'Path to typedoc.json',
139
- group: NAME_GROUP_INIT_PATHS,
152
+ describe: 'Path to new or existing typedoc.json',
153
+ group: InitCommandGroup.Behavior,
140
154
  nargs: 1,
141
155
  normalize: true,
142
156
  requiresArg: true,
@@ -145,14 +159,25 @@ const opts = Object.freeze({
145
159
  typescript: {
146
160
  default: true,
147
161
  description: 'Create tsconfig.json if needed',
148
- group: NAME_GROUP_INIT_BEHAVIOR,
162
+ group: InitCommandGroup.Behavior,
149
163
  type: 'boolean',
150
164
  },
151
- });
165
+ upgrade: {
166
+ alias: 'up',
167
+ describe: 'Only upgrade Python dependencies if out-of-date',
168
+ group: InitCommandGroup.Behavior,
169
+ type: 'boolean',
170
+ conflicts: 'force',
171
+ },
172
+ };
152
173
  exports.default = {
153
174
  command: 'init',
154
175
  describe: 'Initialize package for doc generation',
155
- builder: opts,
176
+ builder(yargs) {
177
+ return yargs
178
+ .options(opts)
179
+ .check(async (argv) => (0, check_1.checkMissingPaths)(opts, InitCommandGroup.Paths, argv));
180
+ },
156
181
  async handler(args) {
157
182
  const done = (0, util_1.stopwatch)('init');
158
183
  await (0, init_1.init)({ ...args, overwrite: args.force, cwd: args.dir });
@@ -1 +1 @@
1
- {"version":3,"file":"init.js","sourceRoot":"","sources":["../../../../lib/cli/command/init.ts"],"names":[],"mappings":";;;;;AAAA,oDAAuB;AAEvB,qCAAgC;AAChC,0DAAkC;AAClC,qCAAqC;AAErC,MAAM,GAAG,GAAG,gBAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;AAEnC,MAAM,sBAAsB,GAAG,gBAAgB,CAAC;AAChD,MAAM,qBAAqB,GAAG,QAAQ,CAAC;AACvC,MAAM,wBAAwB,GAAG,0BAA0B,CAAC;AAE5D,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC;IACzB,SAAS,EAAE;QACT,WAAW,EAAE,kBAAkB;QAC/B,KAAK,EAAE,sBAAsB;QAC7B,KAAK,EAAE,CAAC;QACR,WAAW,EAAE,IAAI;QACjB,IAAI,EAAE,QAAQ;KACf;IACD,GAAG,EAAE;QACH,OAAO,EAAE,GAAG;QACZ,kBAAkB,EAAE,qBAAqB;QACzC,WAAW,EAAE,sBAAsB;QACnC,KAAK,EAAE,qBAAqB;QAC5B,SAAS,EAAE,IAAI;QACf,IAAI,EAAE,QAAQ;KACf;IACD,SAAS,EAAE;QACT,QAAQ,EAAE,iDAAiD;QAC3D,KAAK,EAAE,wBAAwB;QAC/B,IAAI,EAAE,SAAS;KAChB;IACD,KAAK,EAAE;QACL,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,mCAAmC;QAC7C,KAAK,EAAE,wBAAwB;QAC/B,IAAI,EAAE,SAAS;KAChB;IACD,OAAO,EAAE;QACP,KAAK,EAAE,GAAG;QACV,KAAK,EAAE,IAAI;QACX,MAAM,EAAE,CAAC,KAAwB,EAAE,EAAE,CAAC,gBAAC,CAAC,SAAS,CAAC,KAAK,CAAC;QACxD,WAAW,EAAE,4CAA4C;QACzD,KAAK,EAAE,CAAC;QACR,WAAW,EAAE,IAAI;QACjB,IAAI,EAAE,QAAQ;KACf;IACD,MAAM,EAAE;QACN,OAAO,EAAE,IAAI;QACb,WAAW,EAAE,6BAA6B;QAC1C,KAAK,EAAE,wBAAwB;QAC/B,IAAI,EAAE,SAAS;KAChB;IACD,YAAY,EAAE;QACZ,kBAAkB,EAAE,cAAc;QAClC,WAAW,EAAE,oBAAoB;QACjC,KAAK,EAAE,qBAAqB;QAC5B,KAAK,EAAE,CAAC;QACR,SAAS,EAAE,IAAI;QACf,WAAW,EAAE,IAAI;QACjB,IAAI,EAAE,QAAQ;KACf;IACD,cAAc,EAAE;QACd,kBAAkB,EAAE,gBAAgB;QACpC,QAAQ,EAAE,sBAAsB;QAChC,KAAK,EAAE,qBAAqB;QAC5B,KAAK,EAAE,CAAC;QACR,SAAS,EAAE,IAAI;QACf,WAAW,EAAE,IAAI;QACjB,IAAI,EAAE,QAAQ;KACf;IACD,MAAM,EAAE;QACN,OAAO,EAAE,IAAI;QACb,WAAW,EAAE,uCAAuC;QACpD,KAAK,EAAE,wBAAwB;QAC/B,IAAI,EAAE,SAAS;KAChB;IACD,aAAa,EAAE;QACb,kBAAkB,EAAE,sBAAsB;QAC1C,WAAW,EAAE,6BAA6B;QAC1C,KAAK,EAAE,qBAAqB;QAC5B,KAAK,EAAE,CAAC;QACR,SAAS,EAAE,IAAI;QACf,WAAW,EAAE,IAAI;QACjB,IAAI,EAAE,QAAQ;KACf;IACD,WAAW,EAAE;QACX,kBAAkB,EAAE,2BAA2B;QAC/C,WAAW,EAAE,8BAA8B;QAC3C,KAAK,EAAE,sBAAsB;QAC7B,KAAK,EAAE,CAAC;QACR,WAAW,EAAE,IAAI;QACjB,IAAI,EAAE,QAAQ;KACf;IACD,UAAU,EAAE;QACV,kBAAkB,EAAE,qBAAqB;QACzC,WAAW,EAAE,6BAA6B;QAC1C,KAAK,EAAE,sBAAsB;QAC7B,KAAK,EAAE,CAAC;QACR,WAAW,EAAE,IAAI;QACjB,IAAI,EAAE,QAAQ;KACf;IACD,kBAAkB,EAAE;QAClB,kBAAkB,EAAE,qBAAqB;QACzC,WAAW,EAAE,kBAAkB;QAC/B,KAAK,EAAE,sBAAsB;QAC7B,KAAK,EAAE,CAAC;QACR,WAAW,EAAE,IAAI;QACjB,IAAI,EAAE,QAAQ;KACf;IACD,WAAW,EAAE;QACX,kBAAkB,EAAE,0BAA0B;QAC9C,WAAW,EAAE,cAAc;QAC3B,KAAK,EAAE,sBAAsB;QAC7B,KAAK,EAAE,CAAC;QACR,WAAW,EAAE,IAAI;QACjB,IAAI,EAAE,QAAQ;KACf;IACD,eAAe,EAAE;QACf,kBAAkB,EAAE,iBAAiB;QACrC,QAAQ,EAAE,uBAAuB;QACjC,KAAK,EAAE,qBAAqB;QAC5B,KAAK,EAAE,CAAC;QACR,SAAS,EAAE,IAAI;QACf,WAAW,EAAE,IAAI;QACjB,IAAI,EAAE,QAAQ;KACf;IACD,OAAO,EAAE;QACP,OAAO,EAAE,IAAI;QACb,WAAW,EAAE,+BAA+B;QAC5C,KAAK,EAAE,wBAAwB;QAC/B,IAAI,EAAE,SAAS;KAChB;IACD,cAAc,EAAE;QACd,kBAAkB,EAAE,gBAAgB;QACpC,QAAQ,EAAE,sBAAsB;QAChC,KAAK,EAAE,qBAAqB;QAC5B,KAAK,EAAE,CAAC;QACR,SAAS,EAAE,IAAI;QACf,WAAW,EAAE,IAAI;QACjB,IAAI,EAAE,QAAQ;KACf;IACD,UAAU,EAAE;QACV,OAAO,EAAE,IAAI;QACb,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,wBAAwB;QAC/B,IAAI,EAAE,SAAS;KAChB;CACF,CAAmC,CAAC;AAIrC,kBAAe;IACb,OAAO,EAAE,MAAM;IACf,QAAQ,EAAE,uCAAuC;IACjD,OAAO,EAAE,IAAI;IACb,KAAK,CAAC,OAAO,CAAC,IAAI;QAChB,MAAM,IAAI,GAAG,IAAA,gBAAS,EAAC,MAAM,CAAC,CAAC;QAC/B,MAAM,IAAA,WAAI,EAAC,EAAC,GAAG,IAAI,EAAE,SAAS,EAAE,IAAI,CAAC,KAAK,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,EAAC,CAAC,CAAC;QAC5D,GAAG,CAAC,OAAO,CAAC,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;IACrC,CAAC;CACgC,CAAC"}
1
+ {"version":3,"file":"init.js","sourceRoot":"","sources":["../../../../lib/cli/command/init.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;AAEH,oDAAuB;AAEvB,qCAAgC;AAChC,0DAAkC;AAClC,qCAAqC;AACrC,oCAA2C;AAE3C,MAAM,GAAG,GAAG,gBAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;AAEnC,IAAK,gBAIJ;AAJD,WAAK,gBAAgB;IACnB,6CAAyB,CAAA;IACzB,2CAAuB,CAAA;IACvB,yDAAqC,CAAA;AACvC,CAAC,EAJI,gBAAgB,KAAhB,gBAAgB,QAIpB;AAED;;;;GAIG;AACH,MAAM,IAAI,GAAG;IACX,SAAS,EAAE;QACT,WAAW,EAAE,kBAAkB;QAC/B,KAAK,EAAE,gBAAgB,CAAC,MAAM;QAC9B,KAAK,EAAE,CAAC;QACR,WAAW,EAAE,IAAI;QACjB,IAAI,EAAE,QAAQ;KACf;IACD,GAAG,EAAE;QACH,OAAO,EAAE,GAAG;QACZ,kBAAkB,EAAE,qBAAqB;QACzC,WAAW,EAAE,sBAAsB;QACnC,KAAK,EAAE,gBAAgB,CAAC,KAAK;QAC7B,SAAS,EAAE,IAAI;QACf,IAAI,EAAE,QAAQ;KACf;IACD,SAAS,EAAE;QACT,QAAQ,EAAE,iDAAiD;QAC3D,KAAK,EAAE,gBAAgB,CAAC,QAAQ;QAChC,IAAI,EAAE,SAAS;KAChB;IACD,KAAK,EAAE;QACL,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,mCAAmC;QAC7C,KAAK,EAAE,gBAAgB,CAAC,QAAQ;QAChC,IAAI,EAAE,SAAS;KAChB;IACD,OAAO,EAAE;QACP,KAAK,EAAE,GAAG;QACV,KAAK,EAAE,IAAI;QACX,MAAM,EAAE,CAAC,KAAwB,EAAE,EAAE,CAAC,gBAAC,CAAC,SAAS,CAAC,KAAK,CAAC;QACxD,WAAW,EAAE,4CAA4C;QACzD,KAAK,EAAE,CAAC;QACR,KAAK,EAAE,gBAAgB,CAAC,MAAM;QAC9B,WAAW,EAAE,IAAI;QACjB,IAAI,EAAE,QAAQ;KACf;IACD,MAAM,EAAE;QACN,OAAO,EAAE,IAAI;QACb,WAAW,EAAE,6BAA6B;QAC1C,KAAK,EAAE,gBAAgB,CAAC,QAAQ;QAChC,IAAI,EAAE,SAAS;KAChB;IACD,YAAY,EAAE;QACZ,kBAAkB,EAAE,cAAc;QAClC,WAAW,EAAE,oCAAoC;QACjD,KAAK,EAAE,gBAAgB,CAAC,MAAM;QAC9B,KAAK,EAAE,CAAC;QACR,SAAS,EAAE,IAAI;QACf,WAAW,EAAE,IAAI;QACjB,IAAI,EAAE,QAAQ;KACf;IACD,cAAc,EAAE;QACd,kBAAkB,EAAE,gBAAgB;QACpC,QAAQ,EAAE,+BAA+B;QACzC,KAAK,EAAE,gBAAgB,CAAC,KAAK;QAC7B,KAAK,EAAE,CAAC;QACR,SAAS,EAAE,IAAI;QACf,WAAW,EAAE,IAAI;QACjB,IAAI,EAAE,QAAQ;KACf;IACD,MAAM,EAAE;QACN,OAAO,EAAE,IAAI;QACb,WAAW,EAAE,uCAAuC;QACpD,KAAK,EAAE,gBAAgB,CAAC,QAAQ;QAChC,IAAI,EAAE,SAAS;KAChB;IACD,aAAa,EAAE;QACb,kBAAkB,EAAE,sBAAsB;QAC1C,WAAW,EAAE,6BAA6B;QAC1C,KAAK,EAAE,gBAAgB,CAAC,KAAK;QAC7B,KAAK,EAAE,CAAC;QACR,SAAS,EAAE,IAAI;QACf,WAAW,EAAE,IAAI;QACjB,IAAI,EAAE,QAAQ;KACf;IACD,WAAW,EAAE;QACX,kBAAkB,EAAE,2BAA2B;QAC/C,WAAW,EAAE,8BAA8B;QAC3C,KAAK,EAAE,gBAAgB,CAAC,MAAM;QAC9B,KAAK,EAAE,CAAC;QACR,WAAW,EAAE,IAAI;QACjB,IAAI,EAAE,QAAQ;KACf;IACD,UAAU,EAAE;QACV,kBAAkB,EAAE,qBAAqB;QACzC,WAAW,EAAE,6BAA6B;QAC1C,KAAK,EAAE,gBAAgB,CAAC,MAAM;QAC9B,KAAK,EAAE,CAAC;QACR,WAAW,EAAE,IAAI;QACjB,IAAI,EAAE,QAAQ;KACf;IACD,kBAAkB,EAAE;QAClB,kBAAkB,EAAE,qBAAqB;QACzC,WAAW,EAAE,kBAAkB;QAC/B,KAAK,EAAE,gBAAgB,CAAC,MAAM;QAC9B,KAAK,EAAE,CAAC;QACR,WAAW,EAAE,IAAI;QACjB,IAAI,EAAE,QAAQ;KACf;IACD,WAAW,EAAE;QACX,kBAAkB,EAAE,0BAA0B;QAC9C,WAAW,EAAE,cAAc;QAC3B,KAAK,EAAE,gBAAgB,CAAC,MAAM;QAC9B,KAAK,EAAE,CAAC;QACR,WAAW,EAAE,IAAI;QACjB,IAAI,EAAE,QAAQ;KACf;IACD,eAAe,EAAE;QACf,kBAAkB,EAAE,iBAAiB;QACrC,QAAQ,EAAE,uCAAuC;QACjD,KAAK,EAAE,gBAAgB,CAAC,QAAQ;QAChC,KAAK,EAAE,CAAC;QACR,SAAS,EAAE,IAAI;QACf,WAAW,EAAE,IAAI;QACjB,IAAI,EAAE,QAAQ;KACf;IACD,OAAO,EAAE;QACP,OAAO,EAAE,IAAI;QACb,WAAW,EAAE,+BAA+B;QAC5C,KAAK,EAAE,gBAAgB,CAAC,QAAQ;QAChC,IAAI,EAAE,SAAS;KAChB;IACD,cAAc,EAAE;QACd,kBAAkB,EAAE,gBAAgB;QACpC,QAAQ,EAAE,sCAAsC;QAChD,KAAK,EAAE,gBAAgB,CAAC,QAAQ;QAChC,KAAK,EAAE,CAAC;QACR,SAAS,EAAE,IAAI;QACf,WAAW,EAAE,IAAI;QACjB,IAAI,EAAE,QAAQ;KACf;IACD,UAAU,EAAE;QACV,OAAO,EAAE,IAAI;QACb,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,gBAAgB,CAAC,QAAQ;QAChC,IAAI,EAAE,SAAS;KAChB;IACD,OAAO,EAAE;QACP,KAAK,EAAE,IAAI;QACX,QAAQ,EAAE,iDAAiD;QAC3D,KAAK,EAAE,gBAAgB,CAAC,QAAQ;QAChC,IAAI,EAAE,SAAS;QACf,SAAS,EAAE,OAAO;KACnB;CACyC,CAAC;AAI7C,kBAAe;IACb,OAAO,EAAE,MAAM;IACf,QAAQ,EAAE,uCAAuC;IACjD,OAAO,CAAC,KAAK;QACX,OAAO,KAAK;aACT,OAAO,CAAC,IAAI,CAAC;aACb,KAAK,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE,CAAC,IAAA,yBAAiB,EAAC,IAAI,EAAE,gBAAgB,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC;IAClF,CAAC;IACD,KAAK,CAAC,OAAO,CAAC,IAAI;QAChB,MAAM,IAAI,GAAG,IAAA,gBAAS,EAAC,MAAM,CAAC,CAAC;QAC/B,MAAM,IAAA,WAAI,EAAC,EAAC,GAAG,IAAI,EAAE,SAAS,EAAE,IAAI,CAAC,KAAK,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,EAAC,CAAC,CAAC;QAC5D,GAAG,CAAC,OAAO,CAAC,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;IACrC,CAAC;CACoC,CAAC"}