@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.
- package/LICENSE +1 -1
- package/build/lib/builder/deploy.d.ts.map +1 -1
- package/build/lib/builder/deploy.js +6 -2
- package/build/lib/builder/deploy.js.map +1 -1
- package/build/lib/builder/index.d.ts +4 -0
- package/build/lib/builder/index.d.ts.map +1 -1
- package/build/lib/builder/index.js +4 -0
- package/build/lib/builder/index.js.map +1 -1
- package/build/lib/builder/nav.d.ts +1 -1
- package/build/lib/builder/nav.d.ts.map +1 -1
- package/build/lib/builder/nav.js +3 -3
- package/build/lib/builder/nav.js.map +1 -1
- package/build/lib/builder/reference.d.ts.map +1 -1
- package/build/lib/builder/reference.js +1 -19
- package/build/lib/builder/reference.js.map +1 -1
- package/build/lib/builder/site.d.ts.map +1 -1
- package/build/lib/builder/site.js +4 -3
- package/build/lib/builder/site.js.map +1 -1
- package/build/lib/cli/check.d.ts +19 -0
- package/build/lib/cli/check.d.ts.map +1 -0
- package/build/lib/cli/check.js +58 -0
- package/build/lib/cli/check.js.map +1 -0
- package/build/lib/cli/command/build.d.ts +189 -174
- package/build/lib/cli/command/build.d.ts.map +1 -1
- package/build/lib/cli/command/build.js +56 -38
- package/build/lib/cli/command/build.js.map +1 -1
- package/build/lib/cli/command/index.d.ts +4 -0
- package/build/lib/cli/command/index.d.ts.map +1 -1
- package/build/lib/cli/command/index.js +4 -0
- package/build/lib/cli/command/index.js.map +1 -1
- package/build/lib/cli/command/init.d.ts +156 -139
- package/build/lib/cli/command/init.d.ts.map +1 -1
- package/build/lib/cli/command/init.js +52 -27
- package/build/lib/cli/command/init.js.map +1 -1
- package/build/lib/cli/command/validate.d.ts +71 -63
- package/build/lib/cli/command/validate.d.ts.map +1 -1
- package/build/lib/cli/command/validate.js +31 -20
- package/build/lib/cli/command/validate.js.map +1 -1
- package/build/lib/cli/index.d.ts.map +1 -1
- package/build/lib/cli/index.js +29 -12
- package/build/lib/cli/index.js.map +1 -1
- package/build/lib/constants.d.ts +4 -0
- package/build/lib/constants.d.ts.map +1 -1
- package/build/lib/constants.js +5 -1
- package/build/lib/constants.js.map +1 -1
- package/build/lib/error.d.ts +5 -0
- package/build/lib/error.d.ts.map +1 -1
- package/build/lib/error.js +5 -0
- package/build/lib/error.js.map +1 -1
- package/build/lib/fs.d.ts +1 -1
- package/build/lib/fs.d.ts.map +1 -1
- package/build/lib/fs.js +2 -2
- package/build/lib/fs.js.map +1 -1
- package/build/lib/index.d.ts +4 -0
- package/build/lib/index.d.ts.map +1 -1
- package/build/lib/index.js +4 -0
- package/build/lib/index.js.map +1 -1
- package/build/lib/init.d.ts +12 -5
- package/build/lib/init.d.ts.map +1 -1
- package/build/lib/init.js +12 -7
- package/build/lib/init.js.map +1 -1
- package/build/lib/mike.d.ts.map +1 -1
- package/build/lib/mike.js +4 -0
- package/build/lib/mike.js.map +1 -1
- package/build/lib/util.d.ts +4 -1
- package/build/lib/util.d.ts.map +1 -1
- package/build/lib/util.js.map +1 -1
- package/build/lib/validate.d.ts +4 -1
- package/build/lib/validate.d.ts.map +1 -1
- package/build/lib/validate.js +9 -7
- package/build/lib/validate.js.map +1 -1
- package/lib/builder/deploy.ts +9 -3
- package/lib/builder/index.ts +5 -0
- package/lib/builder/nav.ts +2 -3
- package/lib/builder/reference.ts +2 -22
- package/lib/builder/site.ts +6 -5
- package/lib/cli/check.ts +87 -0
- package/lib/cli/command/build.ts +61 -43
- package/lib/cli/command/index.ts +5 -0
- package/lib/cli/command/init.ts +54 -29
- package/lib/cli/command/validate.ts +33 -25
- package/lib/cli/index.ts +23 -4
- package/lib/constants.ts +5 -0
- package/lib/error.ts +6 -0
- package/lib/fs.ts +6 -3
- package/lib/index.ts +5 -0
- package/lib/init.ts +23 -6
- package/lib/mike.js +5 -0
- package/lib/util.ts +4 -1
- package/lib/validate.ts +10 -9
- package/package.json +8 -10
- package/requirements.txt +1 -1
|
@@ -1,176 +1,191 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
describe:
|
|
78
|
-
group:
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
implies:
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
};
|
|
149
|
-
|
|
150
|
-
describe:
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
implies:
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
};
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
1
|
+
/**
|
|
2
|
+
* Yargs command module for the `build` command.
|
|
3
|
+
* @module
|
|
4
|
+
*/
|
|
5
|
+
import type { CommandModule, InferredOptionTypes } from 'yargs';
|
|
6
|
+
declare enum BuildCommandGroup {
|
|
7
|
+
Build = "Build Config:",
|
|
8
|
+
Deploy = "Deployment Config:",
|
|
9
|
+
Serve = "Dev Server Config:",
|
|
10
|
+
BuildPaths = "Custom Paths:"
|
|
11
|
+
}
|
|
12
|
+
declare const _default: CommandModule<object, InferredOptionTypes<{
|
|
13
|
+
readonly reference: {
|
|
14
|
+
readonly describe: "Run TypeDoc command API reference build (Markdown)";
|
|
15
|
+
readonly group: BuildCommandGroup.Build;
|
|
16
|
+
readonly type: "boolean";
|
|
17
|
+
readonly default: true;
|
|
18
|
+
};
|
|
19
|
+
readonly site: {
|
|
20
|
+
readonly describe: "Run MkDocs build (HTML)";
|
|
21
|
+
readonly group: BuildCommandGroup.Build;
|
|
22
|
+
readonly type: "boolean";
|
|
23
|
+
readonly default: true;
|
|
24
|
+
};
|
|
25
|
+
readonly 'site-dir': {
|
|
26
|
+
readonly alias: "d";
|
|
27
|
+
readonly describe: "HTML output directory";
|
|
28
|
+
readonly group: BuildCommandGroup.Build;
|
|
29
|
+
readonly nargs: 1;
|
|
30
|
+
readonly requiresArg: true;
|
|
31
|
+
readonly type: "string";
|
|
32
|
+
readonly normalize: true;
|
|
33
|
+
readonly coerce: (...paths: string[]) => string;
|
|
34
|
+
readonly implies: "site";
|
|
35
|
+
readonly defaultDescription: "(from mkdocs.yml)";
|
|
36
|
+
};
|
|
37
|
+
readonly 'package-json': {
|
|
38
|
+
readonly defaultDescription: "./package.json";
|
|
39
|
+
readonly describe: "Path to package.json";
|
|
40
|
+
readonly group: BuildCommandGroup.BuildPaths;
|
|
41
|
+
readonly nargs: 1;
|
|
42
|
+
readonly normalize: true;
|
|
43
|
+
readonly coerce: (...paths: string[]) => string;
|
|
44
|
+
readonly requiresArg: true;
|
|
45
|
+
readonly type: "string";
|
|
46
|
+
};
|
|
47
|
+
readonly title: {
|
|
48
|
+
readonly defaultDescription: "(extension package name)";
|
|
49
|
+
readonly describe: "Title of the API reference";
|
|
50
|
+
readonly group: BuildCommandGroup.Build;
|
|
51
|
+
readonly nargs: 1;
|
|
52
|
+
readonly requiresArg: true;
|
|
53
|
+
readonly type: "string";
|
|
54
|
+
};
|
|
55
|
+
readonly 'tsconfig-json': {
|
|
56
|
+
readonly defaultDescription: "./tsconfig.json";
|
|
57
|
+
readonly describe: "Path to tsconfig.json";
|
|
58
|
+
readonly group: BuildCommandGroup.BuildPaths;
|
|
59
|
+
readonly nargs: 1;
|
|
60
|
+
readonly normalize: true;
|
|
61
|
+
readonly requiresArg: true;
|
|
62
|
+
readonly coerce: (...paths: string[]) => string;
|
|
63
|
+
readonly type: "string";
|
|
64
|
+
};
|
|
65
|
+
readonly 'mkdocs-yml': {
|
|
66
|
+
readonly defaultDescription: "./mkdocs.yml";
|
|
67
|
+
readonly description: "Path to mkdocs.yml";
|
|
68
|
+
readonly group: BuildCommandGroup.BuildPaths;
|
|
69
|
+
readonly nargs: 1;
|
|
70
|
+
readonly normalize: true;
|
|
71
|
+
readonly requiresArg: true;
|
|
72
|
+
readonly coerce: (...paths: string[]) => string;
|
|
73
|
+
readonly type: "string";
|
|
74
|
+
};
|
|
75
|
+
readonly 'typedoc-json': {
|
|
76
|
+
readonly defaultDescription: "./typedoc.json";
|
|
77
|
+
readonly describe: "Path to typedoc.json";
|
|
78
|
+
readonly group: BuildCommandGroup.BuildPaths;
|
|
79
|
+
readonly nargs: 1;
|
|
80
|
+
readonly normalize: true;
|
|
81
|
+
readonly requiresArg: true;
|
|
82
|
+
readonly coerce: (...paths: string[]) => string;
|
|
83
|
+
readonly type: "string";
|
|
84
|
+
};
|
|
85
|
+
readonly all: {
|
|
86
|
+
readonly describe: "Output all reference docs (not just Appium comands)";
|
|
87
|
+
readonly group: BuildCommandGroup.Build;
|
|
88
|
+
readonly implies: "site";
|
|
89
|
+
readonly type: "boolean";
|
|
90
|
+
};
|
|
91
|
+
readonly deploy: {
|
|
92
|
+
readonly describe: "Commit HTML output to a branch using mike";
|
|
93
|
+
readonly group: BuildCommandGroup.Deploy;
|
|
94
|
+
readonly type: "boolean";
|
|
95
|
+
readonly implies: "site";
|
|
96
|
+
};
|
|
97
|
+
readonly push: {
|
|
98
|
+
readonly describe: "Push after deploy";
|
|
99
|
+
readonly group: BuildCommandGroup.Deploy;
|
|
100
|
+
readonly type: "boolean";
|
|
101
|
+
readonly implies: "deploy";
|
|
102
|
+
};
|
|
103
|
+
readonly branch: {
|
|
104
|
+
readonly alias: "b";
|
|
105
|
+
readonly describe: "Branch to commit to";
|
|
106
|
+
readonly implies: "deploy";
|
|
107
|
+
readonly group: BuildCommandGroup.Deploy;
|
|
108
|
+
readonly type: "string";
|
|
109
|
+
readonly requiresArg: true;
|
|
110
|
+
readonly nargs: 1;
|
|
111
|
+
readonly defaultDescription: "gh-pages";
|
|
112
|
+
};
|
|
113
|
+
readonly remote: {
|
|
114
|
+
readonly alias: "r";
|
|
115
|
+
readonly describe: "Remote to push to";
|
|
116
|
+
readonly implies: readonly ["deploy", "push"];
|
|
117
|
+
readonly group: BuildCommandGroup.Deploy;
|
|
118
|
+
readonly type: "string";
|
|
119
|
+
readonly requiresArg: true;
|
|
120
|
+
readonly nargs: 1;
|
|
121
|
+
readonly defaultDescription: "origin";
|
|
122
|
+
};
|
|
123
|
+
readonly prefix: {
|
|
124
|
+
readonly describe: "Subdirectory within <branch> to commit to";
|
|
125
|
+
readonly implies: readonly ["deploy", "branch"];
|
|
126
|
+
readonly group: BuildCommandGroup.Deploy;
|
|
127
|
+
readonly type: "string";
|
|
128
|
+
readonly nargs: 1;
|
|
129
|
+
readonly requiresArg: true;
|
|
130
|
+
};
|
|
131
|
+
readonly message: {
|
|
132
|
+
readonly alias: "m";
|
|
133
|
+
readonly describe: "Commit message. Use \"%s\" for version placeholder";
|
|
134
|
+
readonly implies: "deploy";
|
|
135
|
+
readonly group: BuildCommandGroup.Deploy;
|
|
136
|
+
readonly type: "string";
|
|
137
|
+
readonly nargs: 1;
|
|
138
|
+
readonly requiresArg: true;
|
|
139
|
+
};
|
|
140
|
+
readonly 'deploy-version': {
|
|
141
|
+
readonly describe: "Version (directory) to deploy build to";
|
|
142
|
+
readonly implies: "deploy";
|
|
143
|
+
readonly group: BuildCommandGroup.Deploy;
|
|
144
|
+
readonly type: "string";
|
|
145
|
+
readonly nargs: 1;
|
|
146
|
+
readonly requiresArg: true;
|
|
147
|
+
readonly defaultDescription: "(derived from package.json)";
|
|
148
|
+
};
|
|
149
|
+
readonly alias: {
|
|
150
|
+
readonly describe: "Alias for the build (e.g., \"latest\"); triggers alias update";
|
|
151
|
+
readonly implies: "deploy";
|
|
152
|
+
readonly group: BuildCommandGroup.Deploy;
|
|
153
|
+
readonly type: "string";
|
|
154
|
+
readonly nargs: 1;
|
|
155
|
+
readonly requiresArg: true;
|
|
156
|
+
readonly defaultDescription: "latest";
|
|
157
|
+
};
|
|
158
|
+
readonly rebase: {
|
|
159
|
+
readonly describe: "Rebase <branch> with remote before deploy";
|
|
160
|
+
readonly implies: readonly ["deploy", "branch", "remote"];
|
|
161
|
+
readonly group: BuildCommandGroup.Deploy;
|
|
162
|
+
readonly type: "boolean";
|
|
163
|
+
};
|
|
164
|
+
readonly serve: {
|
|
165
|
+
readonly describe: "Start development server";
|
|
166
|
+
readonly group: BuildCommandGroup.Serve;
|
|
167
|
+
readonly type: "boolean";
|
|
168
|
+
};
|
|
169
|
+
readonly port: {
|
|
170
|
+
readonly alias: "p";
|
|
171
|
+
readonly describe: "Development server port";
|
|
172
|
+
readonly group: BuildCommandGroup.Serve;
|
|
173
|
+
readonly type: "number";
|
|
174
|
+
readonly defaultDescription: "8000";
|
|
175
|
+
readonly implies: "serve";
|
|
176
|
+
readonly nargs: 1;
|
|
177
|
+
readonly requiresArg: true;
|
|
178
|
+
};
|
|
179
|
+
readonly host: {
|
|
180
|
+
readonly alias: "h";
|
|
181
|
+
readonly describe: "Development server host";
|
|
182
|
+
readonly group: BuildCommandGroup.Serve;
|
|
183
|
+
readonly type: "string";
|
|
184
|
+
readonly nargs: 1;
|
|
185
|
+
readonly requiresArg: true;
|
|
186
|
+
readonly implies: "serve";
|
|
187
|
+
readonly defaultDescription: "localhost";
|
|
188
|
+
};
|
|
189
|
+
}>>;
|
|
175
190
|
export default _default;
|
|
176
191
|
//# sourceMappingURL=build.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"build.d.ts","sourceRoot":"","sources":["../../../../lib/cli/command/build.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,aAAa,EAAE,mBAAmB,EAAU,MAAM,OAAO,CAAC
|
|
1
|
+
{"version":3,"file":"build.d.ts","sourceRoot":"","sources":["../../../../lib/cli/command/build.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,KAAK,EAAC,aAAa,EAAE,mBAAmB,EAAU,MAAM,OAAO,CAAC;AASvE,aAAK,iBAAiB;IACpB,KAAK,kBAAkB;IACvB,MAAM,uBAAuB;IAC7B,KAAK,uBAAuB;IAC5B,UAAU,kBAAkB;CAC7B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAuLD,wBAwCyC"}
|
|
@@ -1,54 +1,65 @@
|
|
|
1
1
|
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* Yargs command module for the `build` command.
|
|
4
|
+
* @module
|
|
5
|
+
*/
|
|
2
6
|
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
7
|
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
8
|
};
|
|
5
9
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
10
|
+
const node_path_1 = __importDefault(require("node:path"));
|
|
6
11
|
const builder_1 = require("../../builder");
|
|
7
12
|
const constants_1 = require("../../constants");
|
|
8
13
|
const logger_1 = __importDefault(require("../../logger"));
|
|
9
14
|
const util_1 = require("../../util");
|
|
15
|
+
const check_1 = require("../check");
|
|
10
16
|
const log = logger_1.default.withTag('build');
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
17
|
+
var BuildCommandGroup;
|
|
18
|
+
(function (BuildCommandGroup) {
|
|
19
|
+
BuildCommandGroup["Build"] = "Build Config:";
|
|
20
|
+
BuildCommandGroup["Deploy"] = "Deployment Config:";
|
|
21
|
+
BuildCommandGroup["Serve"] = "Dev Server Config:";
|
|
22
|
+
BuildCommandGroup["BuildPaths"] = "Custom Paths:";
|
|
23
|
+
})(BuildCommandGroup || (BuildCommandGroup = {}));
|
|
24
|
+
const opts = {
|
|
16
25
|
reference: {
|
|
17
26
|
describe: 'Run TypeDoc command API reference build (Markdown)',
|
|
18
|
-
group:
|
|
27
|
+
group: BuildCommandGroup.Build,
|
|
19
28
|
type: 'boolean',
|
|
20
29
|
default: true,
|
|
21
30
|
},
|
|
22
31
|
site: {
|
|
23
32
|
describe: 'Run MkDocs build (HTML)',
|
|
24
|
-
group:
|
|
33
|
+
group: BuildCommandGroup.Build,
|
|
25
34
|
type: 'boolean',
|
|
26
35
|
default: true,
|
|
27
36
|
},
|
|
28
37
|
'site-dir': {
|
|
29
38
|
alias: 'd',
|
|
30
39
|
describe: 'HTML output directory',
|
|
31
|
-
group:
|
|
40
|
+
group: BuildCommandGroup.Build,
|
|
32
41
|
nargs: 1,
|
|
33
42
|
requiresArg: true,
|
|
34
43
|
type: 'string',
|
|
35
44
|
normalize: true,
|
|
45
|
+
coerce: node_path_1.default.resolve,
|
|
36
46
|
implies: 'site',
|
|
37
47
|
defaultDescription: '(from mkdocs.yml)',
|
|
38
48
|
},
|
|
39
49
|
'package-json': {
|
|
40
50
|
defaultDescription: './package.json',
|
|
41
51
|
describe: 'Path to package.json',
|
|
42
|
-
group:
|
|
52
|
+
group: BuildCommandGroup.BuildPaths,
|
|
43
53
|
nargs: 1,
|
|
44
54
|
normalize: true,
|
|
55
|
+
coerce: node_path_1.default.resolve,
|
|
45
56
|
requiresArg: true,
|
|
46
57
|
type: 'string',
|
|
47
58
|
},
|
|
48
59
|
title: {
|
|
49
60
|
defaultDescription: '(extension package name)',
|
|
50
61
|
describe: 'Title of the API reference',
|
|
51
|
-
group:
|
|
62
|
+
group: BuildCommandGroup.Build,
|
|
52
63
|
nargs: 1,
|
|
53
64
|
requiresArg: true,
|
|
54
65
|
type: 'string',
|
|
@@ -56,45 +67,48 @@ const opts = Object.freeze({
|
|
|
56
67
|
'tsconfig-json': {
|
|
57
68
|
defaultDescription: './tsconfig.json',
|
|
58
69
|
describe: 'Path to tsconfig.json',
|
|
59
|
-
group:
|
|
70
|
+
group: BuildCommandGroup.BuildPaths,
|
|
60
71
|
nargs: 1,
|
|
61
72
|
normalize: true,
|
|
62
73
|
requiresArg: true,
|
|
74
|
+
coerce: node_path_1.default.resolve,
|
|
63
75
|
type: 'string',
|
|
64
76
|
},
|
|
65
77
|
'mkdocs-yml': {
|
|
66
78
|
defaultDescription: './mkdocs.yml',
|
|
67
79
|
description: 'Path to mkdocs.yml',
|
|
68
|
-
group:
|
|
80
|
+
group: BuildCommandGroup.BuildPaths,
|
|
69
81
|
nargs: 1,
|
|
70
82
|
normalize: true,
|
|
71
83
|
requiresArg: true,
|
|
84
|
+
coerce: node_path_1.default.resolve,
|
|
72
85
|
type: 'string',
|
|
73
86
|
},
|
|
74
87
|
'typedoc-json': {
|
|
75
88
|
defaultDescription: './typedoc.json',
|
|
76
89
|
describe: 'Path to typedoc.json',
|
|
77
|
-
group:
|
|
90
|
+
group: BuildCommandGroup.BuildPaths,
|
|
78
91
|
nargs: 1,
|
|
79
92
|
normalize: true,
|
|
80
93
|
requiresArg: true,
|
|
94
|
+
coerce: node_path_1.default.resolve,
|
|
81
95
|
type: 'string',
|
|
82
96
|
},
|
|
83
97
|
all: {
|
|
84
98
|
describe: 'Output all reference docs (not just Appium comands)',
|
|
85
|
-
group:
|
|
99
|
+
group: BuildCommandGroup.Build,
|
|
86
100
|
implies: 'site',
|
|
87
101
|
type: 'boolean',
|
|
88
102
|
},
|
|
89
103
|
deploy: {
|
|
90
|
-
describe: 'Commit HTML output',
|
|
91
|
-
group:
|
|
104
|
+
describe: 'Commit HTML output to a branch using mike',
|
|
105
|
+
group: BuildCommandGroup.Deploy,
|
|
92
106
|
type: 'boolean',
|
|
93
107
|
implies: 'site',
|
|
94
108
|
},
|
|
95
109
|
push: {
|
|
96
110
|
describe: 'Push after deploy',
|
|
97
|
-
group:
|
|
111
|
+
group: BuildCommandGroup.Deploy,
|
|
98
112
|
type: 'boolean',
|
|
99
113
|
implies: 'deploy',
|
|
100
114
|
},
|
|
@@ -102,7 +116,7 @@ const opts = Object.freeze({
|
|
|
102
116
|
alias: 'b',
|
|
103
117
|
describe: 'Branch to commit to',
|
|
104
118
|
implies: 'deploy',
|
|
105
|
-
group:
|
|
119
|
+
group: BuildCommandGroup.Deploy,
|
|
106
120
|
type: 'string',
|
|
107
121
|
requiresArg: true,
|
|
108
122
|
nargs: 1,
|
|
@@ -112,7 +126,7 @@ const opts = Object.freeze({
|
|
|
112
126
|
alias: 'r',
|
|
113
127
|
describe: 'Remote to push to',
|
|
114
128
|
implies: ['deploy', 'push'],
|
|
115
|
-
group:
|
|
129
|
+
group: BuildCommandGroup.Deploy,
|
|
116
130
|
type: 'string',
|
|
117
131
|
requiresArg: true,
|
|
118
132
|
nargs: 1,
|
|
@@ -121,16 +135,16 @@ const opts = Object.freeze({
|
|
|
121
135
|
prefix: {
|
|
122
136
|
describe: 'Subdirectory within <branch> to commit to',
|
|
123
137
|
implies: ['deploy', 'branch'],
|
|
124
|
-
group:
|
|
138
|
+
group: BuildCommandGroup.Deploy,
|
|
125
139
|
type: 'string',
|
|
126
140
|
nargs: 1,
|
|
127
141
|
requiresArg: true,
|
|
128
142
|
},
|
|
129
143
|
message: {
|
|
130
144
|
alias: 'm',
|
|
131
|
-
describe: 'Commit message',
|
|
145
|
+
describe: 'Commit message. Use "%s" for version placeholder',
|
|
132
146
|
implies: 'deploy',
|
|
133
|
-
group:
|
|
147
|
+
group: BuildCommandGroup.Deploy,
|
|
134
148
|
type: 'string',
|
|
135
149
|
nargs: 1,
|
|
136
150
|
requiresArg: true,
|
|
@@ -138,7 +152,7 @@ const opts = Object.freeze({
|
|
|
138
152
|
'deploy-version': {
|
|
139
153
|
describe: 'Version (directory) to deploy build to',
|
|
140
154
|
implies: 'deploy',
|
|
141
|
-
group:
|
|
155
|
+
group: BuildCommandGroup.Deploy,
|
|
142
156
|
type: 'string',
|
|
143
157
|
nargs: 1,
|
|
144
158
|
requiresArg: true,
|
|
@@ -147,7 +161,7 @@ const opts = Object.freeze({
|
|
|
147
161
|
alias: {
|
|
148
162
|
describe: 'Alias for the build (e.g., "latest"); triggers alias update',
|
|
149
163
|
implies: 'deploy',
|
|
150
|
-
group:
|
|
164
|
+
group: BuildCommandGroup.Deploy,
|
|
151
165
|
type: 'string',
|
|
152
166
|
nargs: 1,
|
|
153
167
|
requiresArg: true,
|
|
@@ -156,18 +170,18 @@ const opts = Object.freeze({
|
|
|
156
170
|
rebase: {
|
|
157
171
|
describe: 'Rebase <branch> with remote before deploy',
|
|
158
172
|
implies: ['deploy', 'branch', 'remote'],
|
|
159
|
-
group:
|
|
173
|
+
group: BuildCommandGroup.Deploy,
|
|
160
174
|
type: 'boolean',
|
|
161
175
|
},
|
|
162
176
|
serve: {
|
|
163
177
|
describe: 'Start development server',
|
|
164
|
-
group:
|
|
178
|
+
group: BuildCommandGroup.Serve,
|
|
165
179
|
type: 'boolean',
|
|
166
180
|
},
|
|
167
181
|
port: {
|
|
168
182
|
alias: 'p',
|
|
169
183
|
describe: 'Development server port',
|
|
170
|
-
group:
|
|
184
|
+
group: BuildCommandGroup.Serve,
|
|
171
185
|
type: 'number',
|
|
172
186
|
defaultDescription: '8000',
|
|
173
187
|
implies: 'serve',
|
|
@@ -177,25 +191,29 @@ const opts = Object.freeze({
|
|
|
177
191
|
host: {
|
|
178
192
|
alias: 'h',
|
|
179
193
|
describe: 'Development server host',
|
|
180
|
-
group:
|
|
194
|
+
group: BuildCommandGroup.Serve,
|
|
181
195
|
type: 'string',
|
|
182
196
|
nargs: 1,
|
|
183
197
|
requiresArg: true,
|
|
184
198
|
implies: 'serve',
|
|
185
199
|
defaultDescription: 'localhost',
|
|
186
200
|
},
|
|
187
|
-
}
|
|
201
|
+
};
|
|
188
202
|
exports.default = {
|
|
189
203
|
command: 'build',
|
|
190
|
-
describe: 'Build Appium extension documentation',
|
|
191
|
-
builder
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
204
|
+
describe: 'Build Appium extension documentation using TypeDoc & MkDocs',
|
|
205
|
+
builder(yargs) {
|
|
206
|
+
return yargs
|
|
207
|
+
.options(opts)
|
|
208
|
+
.check(async (argv) => {
|
|
209
|
+
// either this method doesn't provide camel-cased props, or the types are wrong.
|
|
210
|
+
if (argv.deploy === true && argv['site-dir']) {
|
|
211
|
+
return `--site-dir is unsupported when running "${constants_1.NAME_BIN} deploy"; use --prefix if needed, but remember that the default behavior is to deploy to the root of the branch (${argv.branch}) instead of a subdirectory`;
|
|
212
|
+
}
|
|
213
|
+
return await (0, check_1.checkMissingPaths)(opts, BuildCommandGroup.BuildPaths, argv);
|
|
214
|
+
})
|
|
215
|
+
.epilog('For help with further configuration, see:\n - MkDocs: https://www.mkdocs.org\n - TypeDoc: https://typedoc.org\n - Mike: https://github.com/jimporter/mike');
|
|
216
|
+
},
|
|
199
217
|
async handler(args) {
|
|
200
218
|
const stop = (0, util_1.stopwatch)('build');
|
|
201
219
|
log.debug('Build command called with args: %O', args);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"build.js","sourceRoot":"","sources":["../../../../lib/cli/command/build.ts"],"names":[],"mappings":";;;;;
|
|
1
|
+
{"version":3,"file":"build.js","sourceRoot":"","sources":["../../../../lib/cli/command/build.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;AAEH,0DAA6B;AAE7B,2CAA+E;AAC/E,+CAAyC;AACzC,0DAAkC;AAClC,qCAAqC;AACrC,oCAA2C;AAE3C,MAAM,GAAG,GAAG,gBAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;AAEpC,IAAK,iBAKJ;AALD,WAAK,iBAAiB;IACpB,4CAAuB,CAAA;IACvB,kDAA6B,CAAA;IAC7B,iDAA4B,CAAA;IAC5B,iDAA4B,CAAA;AAC9B,CAAC,EALI,iBAAiB,KAAjB,iBAAiB,QAKrB;AAED,MAAM,IAAI,GAAG;IACX,SAAS,EAAE;QACT,QAAQ,EAAE,oDAAoD;QAC9D,KAAK,EAAE,iBAAiB,CAAC,KAAK;QAC9B,IAAI,EAAE,SAAS;QACf,OAAO,EAAE,IAAI;KACd;IACD,IAAI,EAAE;QACJ,QAAQ,EAAE,yBAAyB;QACnC,KAAK,EAAE,iBAAiB,CAAC,KAAK;QAC9B,IAAI,EAAE,SAAS;QACf,OAAO,EAAE,IAAI;KACd;IACD,UAAU,EAAE;QACV,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,uBAAuB;QACjC,KAAK,EAAE,iBAAiB,CAAC,KAAK;QAC9B,KAAK,EAAE,CAAC;QACR,WAAW,EAAE,IAAI;QACjB,IAAI,EAAE,QAAQ;QACd,SAAS,EAAE,IAAI;QACf,MAAM,EAAE,mBAAI,CAAC,OAAO;QACpB,OAAO,EAAE,MAAM;QACf,kBAAkB,EAAE,mBAAmB;KACxC;IACD,cAAc,EAAE;QACd,kBAAkB,EAAE,gBAAgB;QACpC,QAAQ,EAAE,sBAAsB;QAChC,KAAK,EAAE,iBAAiB,CAAC,UAAU;QACnC,KAAK,EAAE,CAAC;QACR,SAAS,EAAE,IAAI;QACf,MAAM,EAAE,mBAAI,CAAC,OAAO;QACpB,WAAW,EAAE,IAAI;QACjB,IAAI,EAAE,QAAQ;KACf;IACD,KAAK,EAAE;QACL,kBAAkB,EAAE,0BAA0B;QAC9C,QAAQ,EAAE,4BAA4B;QACtC,KAAK,EAAE,iBAAiB,CAAC,KAAK;QAC9B,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,iBAAiB,CAAC,UAAU;QACnC,KAAK,EAAE,CAAC;QACR,SAAS,EAAE,IAAI;QACf,WAAW,EAAE,IAAI;QACjB,MAAM,EAAE,mBAAI,CAAC,OAAO;QACpB,IAAI,EAAE,QAAQ;KACf;IACD,YAAY,EAAE;QACZ,kBAAkB,EAAE,cAAc;QAClC,WAAW,EAAE,oBAAoB;QACjC,KAAK,EAAE,iBAAiB,CAAC,UAAU;QACnC,KAAK,EAAE,CAAC;QACR,SAAS,EAAE,IAAI;QACf,WAAW,EAAE,IAAI;QACjB,MAAM,EAAE,mBAAI,CAAC,OAAO;QACpB,IAAI,EAAE,QAAQ;KACf;IACD,cAAc,EAAE;QACd,kBAAkB,EAAE,gBAAgB;QACpC,QAAQ,EAAE,sBAAsB;QAChC,KAAK,EAAE,iBAAiB,CAAC,UAAU;QACnC,KAAK,EAAE,CAAC;QACR,SAAS,EAAE,IAAI;QACf,WAAW,EAAE,IAAI;QACjB,MAAM,EAAE,mBAAI,CAAC,OAAO;QACpB,IAAI,EAAE,QAAQ;KACf;IACD,GAAG,EAAE;QACH,QAAQ,EAAE,qDAAqD;QAC/D,KAAK,EAAE,iBAAiB,CAAC,KAAK;QAC9B,OAAO,EAAE,MAAM;QACf,IAAI,EAAE,SAAS;KAChB;IACD,MAAM,EAAE;QACN,QAAQ,EAAE,2CAA2C;QACrD,KAAK,EAAE,iBAAiB,CAAC,MAAM;QAC/B,IAAI,EAAE,SAAS;QACf,OAAO,EAAE,MAAM;KAChB;IACD,IAAI,EAAE;QACJ,QAAQ,EAAE,mBAAmB;QAC7B,KAAK,EAAE,iBAAiB,CAAC,MAAM;QAC/B,IAAI,EAAE,SAAS;QACf,OAAO,EAAE,QAAQ;KAClB;IACD,MAAM,EAAE;QACN,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,qBAAqB;QAC/B,OAAO,EAAE,QAAQ;QACjB,KAAK,EAAE,iBAAiB,CAAC,MAAM;QAC/B,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,IAAI;QACjB,KAAK,EAAE,CAAC;QACR,kBAAkB,EAAE,UAAU;KAC/B;IACD,MAAM,EAAE;QACN,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,mBAAmB;QAC7B,OAAO,EAAE,CAAC,QAAQ,EAAE,MAAM,CAAC;QAC3B,KAAK,EAAE,iBAAiB,CAAC,MAAM;QAC/B,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,IAAI;QACjB,KAAK,EAAE,CAAC;QACR,kBAAkB,EAAE,QAAQ;KAC7B;IACD,MAAM,EAAE;QACN,QAAQ,EAAE,2CAA2C;QACrD,OAAO,EAAE,CAAC,QAAQ,EAAE,QAAQ,CAAC;QAC7B,KAAK,EAAE,iBAAiB,CAAC,MAAM;QAC/B,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,CAAC;QACR,WAAW,EAAE,IAAI;KAClB;IACD,OAAO,EAAE;QACP,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,kDAAkD;QAC5D,OAAO,EAAE,QAAQ;QACjB,KAAK,EAAE,iBAAiB,CAAC,MAAM;QAC/B,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,CAAC;QACR,WAAW,EAAE,IAAI;KAClB;IACD,gBAAgB,EAAE;QAChB,QAAQ,EAAE,wCAAwC;QAClD,OAAO,EAAE,QAAQ;QACjB,KAAK,EAAE,iBAAiB,CAAC,MAAM;QAC/B,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,CAAC;QACR,WAAW,EAAE,IAAI;QACjB,kBAAkB,EAAE,6BAA6B;KAClD;IACD,KAAK,EAAE;QACL,QAAQ,EAAE,6DAA6D;QACvE,OAAO,EAAE,QAAQ;QACjB,KAAK,EAAE,iBAAiB,CAAC,MAAM;QAC/B,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,CAAC;QACR,WAAW,EAAE,IAAI;QACjB,kBAAkB,EAAE,QAAQ;KAC7B;IACD,MAAM,EAAE;QACN,QAAQ,EAAE,2CAA2C;QACrD,OAAO,EAAE,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC;QACvC,KAAK,EAAE,iBAAiB,CAAC,MAAM;QAC/B,IAAI,EAAE,SAAS;KAChB;IACD,KAAK,EAAE;QACL,QAAQ,EAAE,0BAA0B;QACpC,KAAK,EAAE,iBAAiB,CAAC,KAAK;QAC9B,IAAI,EAAE,SAAS;KAChB;IACD,IAAI,EAAE;QACJ,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,yBAAyB;QACnC,KAAK,EAAE,iBAAiB,CAAC,KAAK;QAC9B,IAAI,EAAE,QAAQ;QACd,kBAAkB,EAAE,MAAM;QAC1B,OAAO,EAAE,OAAO;QAChB,KAAK,EAAE,CAAC;QACR,WAAW,EAAE,IAAI;KAClB;IACD,IAAI,EAAE;QACJ,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,yBAAyB;QACnC,KAAK,EAAE,iBAAiB,CAAC,KAAK;QAC9B,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,CAAC;QACR,WAAW,EAAE,IAAI;QACjB,OAAO,EAAE,OAAO;QAChB,kBAAkB,EAAE,WAAW;KAChC;CACyC,CAAC;AAI7C,kBAAe;IACb,OAAO,EAAE,OAAO;IAChB,QAAQ,EAAE,6DAA6D;IACvE,OAAO,CAAC,KAAK;QACX,OAAO,KAAK;aACT,OAAO,CAAC,IAAI,CAAC;aACb,KAAK,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE;YACpB,gFAAgF;YAChF,IAAI,IAAI,CAAC,MAAM,KAAK,IAAI,IAAI,IAAI,CAAC,UAAU,CAAC,EAAE;gBAC5C,OAAO,2CAA2C,oBAAQ,oHAAoH,IAAI,CAAC,MAAM,6BAA6B,CAAC;aACxN;YAED,OAAO,MAAM,IAAA,yBAAiB,EAAC,IAAI,EAAE,iBAAiB,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;QAC3E,CAAC,CAAC;aACD,MAAM,CACL,8JAA8J,CAC/J,CAAC;IACN,CAAC;IACD,KAAK,CAAC,OAAO,CAAC,IAAI;QAChB,MAAM,IAAI,GAAG,IAAA,gBAAS,EAAC,OAAO,CAAC,CAAC;QAChC,GAAG,CAAC,KAAK,CAAC,oCAAoC,EAAE,IAAI,CAAC,CAAC;QACtD,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;YACjC,oCAAoC;YACpC,MAAM,IAAI,KAAK,CACb,iFAAiF,CAClF,CAAC;SACH;QACD,IAAI,IAAI,CAAC,SAAS,EAAE;YAClB,MAAM,IAAA,4BAAkB,EAAC,IAAI,CAAC,CAAC;SAChC;QACD,IAAI,IAAI,CAAC,IAAI,EAAE;YACb,MAAM,IAAA,mBAAS,EAAC,IAAI,CAAC,CAAC;YACtB,IAAI,IAAI,CAAC,MAAM,EAAE;gBACf,MAAM,IAAA,gBAAM,EAAC,IAAI,CAAC,CAAC;aACpB;iBAAM;gBACL,MAAM,IAAA,mBAAS,EAAC,IAAI,CAAC,CAAC;aACvB;SACF;QACD,GAAG,CAAC,OAAO,CAAC,qBAAqB,EAAE,IAAI,EAAE,CAAC,CAAC;IAC7C,CAAC;CACqC,CAAC"}
|