@appium/docutils 0.2.0 → 0.2.2
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/build/lib/builder/deploy.d.ts +2 -2
- package/build/lib/builder/deploy.d.ts.map +1 -1
- package/build/lib/builder/deploy.js +6 -3
- package/build/lib/builder/deploy.js.map +1 -1
- package/build/lib/builder/nav.d.ts.map +1 -1
- package/build/lib/builder/nav.js +27 -19
- package/build/lib/builder/nav.js.map +1 -1
- package/build/lib/builder/reference.d.ts +1 -1
- package/build/lib/builder/reference.d.ts.map +1 -1
- package/build/lib/cli/command/build.d.ts +174 -176
- package/build/lib/cli/command/build.d.ts.map +1 -1
- package/build/lib/cli/command/build.js +3 -5
- package/build/lib/cli/command/build.js.map +1 -1
- package/build/lib/cli/command/init.d.ts +139 -141
- package/build/lib/cli/command/init.d.ts.map +1 -1
- package/build/lib/cli/command/init.js +3 -5
- package/build/lib/cli/command/init.js.map +1 -1
- package/build/lib/cli/command/validate.d.ts +63 -65
- package/build/lib/cli/command/validate.d.ts.map +1 -1
- package/build/lib/cli/command/validate.js +3 -5
- package/build/lib/cli/command/validate.js.map +1 -1
- package/build/lib/cli/config.js +1 -1
- package/build/lib/cli/config.js.map +1 -1
- package/build/lib/init.d.ts +13 -22
- package/build/lib/init.d.ts.map +1 -1
- package/build/lib/logger.js +0 -4
- package/build/lib/logger.js.map +1 -1
- package/build/lib/model.d.ts +6 -10
- package/build/lib/model.d.ts.map +1 -1
- package/build/lib/scaffold.d.ts +5 -5
- package/build/lib/scaffold.d.ts.map +1 -1
- package/build/lib/util.d.ts +2 -2
- package/build/lib/util.d.ts.map +1 -1
- package/build/lib/validate.d.ts +1 -1
- package/build/lib/validate.d.ts.map +1 -1
- package/lib/builder/deploy.ts +10 -4
- package/lib/builder/nav.ts +28 -22
- package/lib/cli/command/build.ts +4 -7
- package/lib/cli/command/init.ts +4 -7
- package/lib/cli/command/validate.ts +6 -7
- package/lib/logger.ts +6 -11
- package/lib/model.ts +3 -9
- package/package.json +8 -8
- package/requirements.txt +1 -1
- package/build/lib/build/mkdocs.d.ts +0 -58
- package/build/lib/build/mkdocs.d.ts.map +0 -1
- package/build/lib/build/mkdocs.js +0 -80
- package/build/lib/build/mkdocs.js.map +0 -1
- package/build/lib/build/typedoc.d.ts +0 -55
- package/build/lib/build/typedoc.d.ts.map +0 -1
- package/build/lib/build/typedoc.js +0 -120
- package/build/lib/build/typedoc.js.map +0 -1
- package/build/lib/build-api.d.ts +0 -18
- package/build/lib/build-api.d.ts.map +0 -1
- package/build/lib/build-api.js +0 -75
- package/build/lib/build-api.js.map +0 -1
- package/build/lib/build.d.ts +0 -21
- package/build/lib/build.d.ts.map +0 -1
- package/build/lib/build.js +0 -71
- package/build/lib/build.js.map +0 -1
- package/build/lib/cli/command/deploy.d.ts +0 -1
- package/build/lib/cli/command/deploy.d.ts.map +0 -1
- package/build/lib/cli/command/deploy.js +0 -2
- package/build/lib/cli/command/deploy.js.map +0 -1
- package/build/lib/cli/command-init.d.ts +0 -143
- package/build/lib/cli/command-init.d.ts.map +0 -1
- package/build/lib/cli/command-init.js +0 -164
- package/build/lib/cli/command-init.js.map +0 -1
- package/build/lib/cli/command-validate.d.ts +0 -52
- package/build/lib/cli/command-validate.d.ts.map +0 -1
- package/build/lib/cli/command-validate.js +0 -66
- package/build/lib/cli/command-validate.js.map +0 -1
- package/build/lib/cli/init.d.ts +0 -143
- package/build/lib/cli/init.d.ts.map +0 -1
- package/build/lib/cli/init.js +0 -164
- package/build/lib/cli/init.js.map +0 -1
- package/build/lib/cli/options.d.ts +0 -1
- package/build/lib/cli/options.d.ts.map +0 -1
- package/build/lib/cli/options.js +0 -2
- package/build/lib/cli/options.js.map +0 -1
- package/build/lib/cli/validate.d.ts +0 -1
- package/build/lib/cli/validate.d.ts.map +0 -1
- package/build/lib/cli/validate.js +0 -2
- package/build/lib/cli/validate.js.map +0 -1
- package/build/lib/cli.d.ts +0 -10
- package/build/lib/cli.d.ts.map +0 -1
- package/build/lib/cli.js +0 -328
- package/build/lib/cli.js.map +0 -1
- package/build/lib/init-task.d.ts +0 -49
- package/build/lib/init-task.d.ts.map +0 -1
- package/build/lib/init-task.js +0 -95
- package/build/lib/init-task.js.map +0 -1
- package/build/lib/io.d.ts +0 -1
- package/build/lib/io.d.ts.map +0 -1
- package/build/lib/io.js +0 -2
- package/build/lib/io.js.map +0 -1
- package/build/lib/mkdocs.d.ts +0 -58
- package/build/lib/mkdocs.d.ts.map +0 -1
- package/build/lib/mkdocs.js +0 -77
- package/build/lib/mkdocs.js.map +0 -1
- package/build/lib/nav.d.ts +0 -47
- package/build/lib/nav.d.ts.map +0 -1
- package/build/lib/nav.js +0 -132
- package/build/lib/nav.js.map +0 -1
- package/build/lib/test.d.ts +0 -9
- package/build/lib/test.d.ts.map +0 -1
- package/build/lib/test.js +0 -2
- package/build/lib/test.js.map +0 -1
- package/build/lib/typedoc.d.ts +0 -55
- package/build/lib/typedoc.d.ts.map +0 -1
- package/build/lib/typedoc.js +0 -122
- package/build/lib/typedoc.js.map +0 -1
- package/build/lib/types.d.ts +0 -52
- package/build/lib/types.d.ts.map +0 -1
- package/build/lib/types.js +0 -7
- package/build/lib/types.js.map +0 -1
- package/build/lib/validation/base-validator.d.ts +0 -218
- package/build/lib/validation/base-validator.d.ts.map +0 -1
- package/build/lib/validation/base-validator.js +0 -453
- package/build/lib/validation/base-validator.js.map +0 -1
- package/build/lib/validation/mkdocs-validator.d.ts +0 -5
- package/build/lib/validation/mkdocs-validator.d.ts.map +0 -1
- package/build/lib/validation/mkdocs-validator.js +0 -54
- package/build/lib/validation/mkdocs-validator.js.map +0 -1
- package/build/lib/validation/python-validator.d.ts +0 -1
- package/build/lib/validation/python-validator.d.ts.map +0 -1
- package/build/lib/validation/python-validator.js +0 -2
- package/build/lib/validation/python-validator.js.map +0 -1
- package/build/lib/validation/python.d.ts +0 -1
- package/build/lib/validation/python.d.ts.map +0 -1
- package/build/lib/validation/python.js +0 -2
- package/build/lib/validation/python.js.map +0 -1
- package/build/lib/validation/validate.d.ts +0 -221
- package/build/lib/validation/validate.d.ts.map +0 -1
- package/build/lib/validation/validate.js +0 -508
- package/build/lib/validation/validate.js.map +0 -1
- package/build/lib/validation/validator.d.ts +0 -220
- package/build/lib/validation/validator.d.ts.map +0 -1
- package/build/lib/validation/validator.js +0 -470
- package/build/lib/validation/validator.js.map +0 -1
- package/build/test/unit/mike.spec.js +0 -17
- package/build/test/unit/mike.spec.js.map +0 -1
package/build/lib/cli/init.js
DELETED
|
@@ -1,164 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
|
-
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
|
-
};
|
|
5
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
-
const lodash_1 = __importDefault(require("lodash"));
|
|
7
|
-
const init_1 = require("../init");
|
|
8
|
-
const logger_1 = __importDefault(require("../logger"));
|
|
9
|
-
const util_1 = require("../util");
|
|
10
|
-
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 = {
|
|
15
|
-
copyright: {
|
|
16
|
-
description: 'Copyright notice',
|
|
17
|
-
group: NAME_GROUP_INIT_MKDOCS,
|
|
18
|
-
nargs: 1,
|
|
19
|
-
requiresArg: true,
|
|
20
|
-
type: 'string',
|
|
21
|
-
},
|
|
22
|
-
dir: {
|
|
23
|
-
default: '.',
|
|
24
|
-
defaultDescription: '(current directory)',
|
|
25
|
-
description: 'Directory of package',
|
|
26
|
-
group: NAME_GROUP_INIT_PATHS,
|
|
27
|
-
normalize: true,
|
|
28
|
-
type: 'string',
|
|
29
|
-
},
|
|
30
|
-
'dry-run': {
|
|
31
|
-
describe: 'Do not write any files; show what would be done',
|
|
32
|
-
group: NAME_GROUP_INIT_BEHAVIOR,
|
|
33
|
-
type: 'boolean',
|
|
34
|
-
},
|
|
35
|
-
force: {
|
|
36
|
-
alias: 'f',
|
|
37
|
-
describe: 'Overwrite existing configurations',
|
|
38
|
-
group: NAME_GROUP_INIT_BEHAVIOR,
|
|
39
|
-
type: 'boolean',
|
|
40
|
-
},
|
|
41
|
-
include: {
|
|
42
|
-
alias: 'i',
|
|
43
|
-
array: true,
|
|
44
|
-
coerce: (value) => lodash_1.default.castArray(value),
|
|
45
|
-
description: 'Files to include in compilation (globs OK)',
|
|
46
|
-
nargs: 1,
|
|
47
|
-
requiresArg: true,
|
|
48
|
-
type: 'string',
|
|
49
|
-
},
|
|
50
|
-
mkdocs: {
|
|
51
|
-
default: true,
|
|
52
|
-
description: 'Create mkdocs.yml if needed',
|
|
53
|
-
group: NAME_GROUP_INIT_BEHAVIOR,
|
|
54
|
-
type: 'boolean',
|
|
55
|
-
},
|
|
56
|
-
'mkdocs-yml': {
|
|
57
|
-
defaultDescription: './mkdocs.yml',
|
|
58
|
-
description: 'Path to mkdocs.yml',
|
|
59
|
-
group: NAME_GROUP_INIT_PATHS,
|
|
60
|
-
nargs: 1,
|
|
61
|
-
normalize: true,
|
|
62
|
-
requiresArg: true,
|
|
63
|
-
type: 'string',
|
|
64
|
-
},
|
|
65
|
-
'package-json': {
|
|
66
|
-
defaultDescription: './package.json',
|
|
67
|
-
describe: 'Path to package.json',
|
|
68
|
-
group: NAME_GROUP_INIT_PATHS,
|
|
69
|
-
nargs: 1,
|
|
70
|
-
normalize: true,
|
|
71
|
-
requiresArg: true,
|
|
72
|
-
type: 'string',
|
|
73
|
-
},
|
|
74
|
-
python: {
|
|
75
|
-
default: true,
|
|
76
|
-
description: 'Install Python dependencies if needed',
|
|
77
|
-
group: NAME_GROUP_INIT_BEHAVIOR,
|
|
78
|
-
type: 'boolean',
|
|
79
|
-
},
|
|
80
|
-
'python-path': {
|
|
81
|
-
defaultDescription: '(derived from shell)',
|
|
82
|
-
description: 'Path to python 3 executable',
|
|
83
|
-
group: NAME_GROUP_INIT_PATHS,
|
|
84
|
-
nargs: 1,
|
|
85
|
-
normalize: true,
|
|
86
|
-
requiresArg: true,
|
|
87
|
-
type: 'string',
|
|
88
|
-
},
|
|
89
|
-
'repo-name': {
|
|
90
|
-
defaultDescription: '(derived from --repo-url)',
|
|
91
|
-
description: 'Name of extension repository',
|
|
92
|
-
group: NAME_GROUP_INIT_MKDOCS,
|
|
93
|
-
nargs: 1,
|
|
94
|
-
requiresArg: true,
|
|
95
|
-
type: 'string',
|
|
96
|
-
},
|
|
97
|
-
'repo-url': {
|
|
98
|
-
defaultDescription: '(from package.json)',
|
|
99
|
-
description: 'URL of extension repository',
|
|
100
|
-
group: NAME_GROUP_INIT_MKDOCS,
|
|
101
|
-
nargs: 1,
|
|
102
|
-
requiresArg: true,
|
|
103
|
-
type: 'string',
|
|
104
|
-
},
|
|
105
|
-
'site-description': {
|
|
106
|
-
defaultDescription: '(from package.json)',
|
|
107
|
-
description: 'Site description',
|
|
108
|
-
group: NAME_GROUP_INIT_MKDOCS,
|
|
109
|
-
nargs: 1,
|
|
110
|
-
requiresArg: true,
|
|
111
|
-
type: 'string',
|
|
112
|
-
},
|
|
113
|
-
'site-name': {
|
|
114
|
-
defaultDescription: '(extension package name)',
|
|
115
|
-
description: 'Name of site',
|
|
116
|
-
group: NAME_GROUP_INIT_MKDOCS,
|
|
117
|
-
nargs: 1,
|
|
118
|
-
requiresArg: true,
|
|
119
|
-
type: 'string',
|
|
120
|
-
},
|
|
121
|
-
'tsconfig-json': {
|
|
122
|
-
defaultDescription: './tsconfig.json',
|
|
123
|
-
describe: 'Path to tsconfig.json',
|
|
124
|
-
group: NAME_GROUP_INIT_PATHS,
|
|
125
|
-
nargs: 1,
|
|
126
|
-
normalize: true,
|
|
127
|
-
requiresArg: true,
|
|
128
|
-
type: 'string',
|
|
129
|
-
},
|
|
130
|
-
typedoc: {
|
|
131
|
-
default: true,
|
|
132
|
-
description: 'Create typedoc.json if needed',
|
|
133
|
-
group: NAME_GROUP_INIT_BEHAVIOR,
|
|
134
|
-
type: 'boolean',
|
|
135
|
-
},
|
|
136
|
-
'typedoc-json': {
|
|
137
|
-
defaultDescription: './typedoc.json',
|
|
138
|
-
describe: 'Path to typedoc.json',
|
|
139
|
-
group: NAME_GROUP_INIT_PATHS,
|
|
140
|
-
nargs: 1,
|
|
141
|
-
normalize: true,
|
|
142
|
-
requiresArg: true,
|
|
143
|
-
type: 'string',
|
|
144
|
-
},
|
|
145
|
-
typescript: {
|
|
146
|
-
default: true,
|
|
147
|
-
description: 'Create tsconfig.json if needed',
|
|
148
|
-
group: NAME_GROUP_INIT_BEHAVIOR,
|
|
149
|
-
type: 'boolean',
|
|
150
|
-
},
|
|
151
|
-
};
|
|
152
|
-
opts; // type check
|
|
153
|
-
const initCommand = {
|
|
154
|
-
command: 'init',
|
|
155
|
-
describe: 'Initialize package for doc generation',
|
|
156
|
-
builder: opts,
|
|
157
|
-
async handler(args) {
|
|
158
|
-
const done = (0, util_1.stopwatch)('init');
|
|
159
|
-
await (0, init_1.init)({ ...args, overwrite: args.force, cwd: args.dir });
|
|
160
|
-
log.success('Done (%dms)', done());
|
|
161
|
-
},
|
|
162
|
-
};
|
|
163
|
-
exports.default = initCommand;
|
|
164
|
-
//# sourceMappingURL=init.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"init.js","sourceRoot":"","sources":["../../../lib/cli/init.ts"],"names":[],"mappings":";;;;;AAAA,oDAAuB;AAEvB,kCAA6B;AAC7B,uDAA+B;AAC/B,kCAAkC;AAElC,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;IACX,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;CACO,CAAC;AACX,IAA+B,CAAC,CAAC,aAAa;AAI9C,MAAM,WAAW,GAAmC;IAClD,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;CACF,CAAC;AAEF,kBAAe,WAAW,CAAC"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
//# sourceMappingURL=options.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"options.d.ts","sourceRoot":"","sources":["../../../lib/cli/options.ts"],"names":[],"mappings":""}
|
package/build/lib/cli/options.js
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"options.js","sourceRoot":"","sources":["../../../lib/cli/options.ts"],"names":[],"mappings":""}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
//# sourceMappingURL=validate.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"validate.d.ts","sourceRoot":"","sources":["../../../lib/cli/validate.ts"],"names":[],"mappings":""}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"validate.js","sourceRoot":"","sources":["../../../lib/cli/validate.ts"],"names":[],"mappings":""}
|
package/build/lib/cli.d.ts
DELETED
|
@@ -1,10 +0,0 @@
|
|
|
1
|
-
#!/usr/bin/env node
|
|
2
|
-
export declare function main(argv?: string[]): Promise<{
|
|
3
|
-
[x: string]: unknown;
|
|
4
|
-
verbose: boolean | undefined;
|
|
5
|
-
"log-level": "error" | "debug" | "info" | "warn" | "silent";
|
|
6
|
-
logLevel: "error" | "debug" | "info" | "warn" | "silent";
|
|
7
|
-
_: (string | number)[];
|
|
8
|
-
$0: string;
|
|
9
|
-
}>;
|
|
10
|
-
//# sourceMappingURL=cli.d.ts.map
|
package/build/lib/cli.d.ts.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../../lib/cli.ts"],"names":[],"mappings":";AA2BA,wBAAsB,IAAI,CAAC,IAAI,WAAwB;;;;;;;GA6TtD"}
|
package/build/lib/cli.js
DELETED
|
@@ -1,328 +0,0 @@
|
|
|
1
|
-
#!/usr/bin/env node
|
|
2
|
-
"use strict";
|
|
3
|
-
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
4
|
-
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
5
|
-
};
|
|
6
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
7
|
-
exports.main = void 0;
|
|
8
|
-
const lodash_1 = __importDefault(require("lodash"));
|
|
9
|
-
const yargs_1 = __importDefault(require("yargs/yargs"));
|
|
10
|
-
const helpers_1 = require("yargs/helpers");
|
|
11
|
-
const init_1 = require("./init");
|
|
12
|
-
const logger_1 = __importDefault(require("./logger"));
|
|
13
|
-
const error_1 = require("./error");
|
|
14
|
-
const consola_1 = require("consola");
|
|
15
|
-
const util_1 = require("./util");
|
|
16
|
-
const build_1 = require("./build");
|
|
17
|
-
const validate_1 = require("./validate");
|
|
18
|
-
const NAME_GROUP_INIT_BEHAVIOR = 'Initialization Behavior:';
|
|
19
|
-
const NAME_GROUP_INIT_MKDOCS = 'MkDocs Config:';
|
|
20
|
-
const NAME_GROUP_BUILD_REFERENCE = 'Build API:';
|
|
21
|
-
const NAME_GROUP_INIT_PATHS = 'Paths:';
|
|
22
|
-
const NAME_GROUP_VALIDATE = 'Validation:';
|
|
23
|
-
const LogLevelName = {
|
|
24
|
-
silent: consola_1.LogLevel.Silent,
|
|
25
|
-
error: consola_1.LogLevel.Error,
|
|
26
|
-
warn: consola_1.LogLevel.Warn,
|
|
27
|
-
info: consola_1.LogLevel.Info,
|
|
28
|
-
debug: consola_1.LogLevel.Debug,
|
|
29
|
-
};
|
|
30
|
-
async function main(argv = (0, helpers_1.hideBin)(process.argv)) {
|
|
31
|
-
const done = (0, util_1.stopwatch)('main');
|
|
32
|
-
const y = (0, yargs_1.default)(argv);
|
|
33
|
-
return await y
|
|
34
|
-
.scriptName('appium-docs')
|
|
35
|
-
.command('build', 'Build docs', (yargs) => {
|
|
36
|
-
return yargs.options({
|
|
37
|
-
'mkdocs-path': {
|
|
38
|
-
describe: 'Path to mkdocs.yml',
|
|
39
|
-
normalize: true,
|
|
40
|
-
type: 'string',
|
|
41
|
-
nargs: 1,
|
|
42
|
-
array: false,
|
|
43
|
-
},
|
|
44
|
-
});
|
|
45
|
-
}, async () => { })
|
|
46
|
-
.command('validate', 'Validate Environment', (yargs) => yargs.options({
|
|
47
|
-
python: {
|
|
48
|
-
default: true,
|
|
49
|
-
description: 'Validate Python 3 environment',
|
|
50
|
-
group: NAME_GROUP_VALIDATE,
|
|
51
|
-
type: 'boolean',
|
|
52
|
-
},
|
|
53
|
-
'python-path': {
|
|
54
|
-
defaultDescription: '(derived from shell)',
|
|
55
|
-
description: 'Path to python 3 executable',
|
|
56
|
-
group: NAME_GROUP_VALIDATE,
|
|
57
|
-
nargs: 1,
|
|
58
|
-
normalize: true,
|
|
59
|
-
requiresArg: true,
|
|
60
|
-
type: 'string',
|
|
61
|
-
},
|
|
62
|
-
'tsconfig-json': {
|
|
63
|
-
defaultDescription: './tsconfig.json',
|
|
64
|
-
describe: 'Path to tsconfig.json',
|
|
65
|
-
group: NAME_GROUP_VALIDATE,
|
|
66
|
-
nargs: 1,
|
|
67
|
-
normalize: true,
|
|
68
|
-
requiresArg: true,
|
|
69
|
-
type: 'string',
|
|
70
|
-
},
|
|
71
|
-
typedoc: {
|
|
72
|
-
default: true,
|
|
73
|
-
description: 'Validate TypoDoc config',
|
|
74
|
-
group: NAME_GROUP_VALIDATE,
|
|
75
|
-
type: 'boolean',
|
|
76
|
-
},
|
|
77
|
-
'typedoc-json': {
|
|
78
|
-
defaultDescription: './typedoc.json',
|
|
79
|
-
describe: 'Path to typedoc.json',
|
|
80
|
-
group: NAME_GROUP_VALIDATE,
|
|
81
|
-
nargs: 1,
|
|
82
|
-
normalize: true,
|
|
83
|
-
requiresArg: true,
|
|
84
|
-
type: 'string',
|
|
85
|
-
},
|
|
86
|
-
typescript: {
|
|
87
|
-
default: true,
|
|
88
|
-
description: 'Validate TypeScript config',
|
|
89
|
-
group: NAME_GROUP_VALIDATE,
|
|
90
|
-
type: 'boolean',
|
|
91
|
-
},
|
|
92
|
-
}), async (argv) => {
|
|
93
|
-
if (!argv.python && !argv.typedoc && !argv.typescript) {
|
|
94
|
-
throw new Error('No validation targets specified; one or more of --python, --typescript or --typedoc must be provided');
|
|
95
|
-
}
|
|
96
|
-
await (0, validate_1.validate)(argv);
|
|
97
|
-
})
|
|
98
|
-
.command('build-reference', 'Build API reference docs', (yargs) => yargs.options({
|
|
99
|
-
'package-json': {
|
|
100
|
-
defaultDescription: './package.json',
|
|
101
|
-
describe: 'Path to package.json',
|
|
102
|
-
group: NAME_GROUP_BUILD_REFERENCE,
|
|
103
|
-
nargs: 1,
|
|
104
|
-
normalize: true,
|
|
105
|
-
requiresArg: true,
|
|
106
|
-
type: 'string',
|
|
107
|
-
},
|
|
108
|
-
title: {
|
|
109
|
-
defaultDescription: '(extension package name)',
|
|
110
|
-
describe: 'Title of the API reference',
|
|
111
|
-
group: NAME_GROUP_BUILD_REFERENCE,
|
|
112
|
-
nargs: 1,
|
|
113
|
-
requiresArg: true,
|
|
114
|
-
type: 'string',
|
|
115
|
-
},
|
|
116
|
-
'tsconfig-json': {
|
|
117
|
-
defaultDescription: './tsconfig.json',
|
|
118
|
-
describe: 'Path to tsconfig.json',
|
|
119
|
-
group: NAME_GROUP_BUILD_REFERENCE,
|
|
120
|
-
nargs: 1,
|
|
121
|
-
normalize: true,
|
|
122
|
-
requiresArg: true,
|
|
123
|
-
type: 'string',
|
|
124
|
-
},
|
|
125
|
-
'typedoc-json': {
|
|
126
|
-
defaultDescription: './typedoc.json',
|
|
127
|
-
describe: 'Path to typedoc.json',
|
|
128
|
-
group: NAME_GROUP_BUILD_REFERENCE,
|
|
129
|
-
nargs: 1,
|
|
130
|
-
normalize: true,
|
|
131
|
-
requiresArg: true,
|
|
132
|
-
type: 'string',
|
|
133
|
-
},
|
|
134
|
-
}), async (argv) => {
|
|
135
|
-
await (0, build_1.buildReference)(argv);
|
|
136
|
-
})
|
|
137
|
-
.command('init', 'Initialize package for docs', (yargs) => yargs.options({
|
|
138
|
-
copyright: {
|
|
139
|
-
descripiton: 'Copyright notice',
|
|
140
|
-
group: NAME_GROUP_INIT_MKDOCS,
|
|
141
|
-
nargs: 1,
|
|
142
|
-
requiresArg: true,
|
|
143
|
-
type: 'string',
|
|
144
|
-
},
|
|
145
|
-
dir: {
|
|
146
|
-
default: '.',
|
|
147
|
-
defaultDescription: '(current directory)',
|
|
148
|
-
description: 'Directory of package',
|
|
149
|
-
group: NAME_GROUP_INIT_PATHS,
|
|
150
|
-
normalize: true,
|
|
151
|
-
type: 'string',
|
|
152
|
-
},
|
|
153
|
-
'dry-run': {
|
|
154
|
-
describe: 'Do not write any files; show what would be done',
|
|
155
|
-
group: NAME_GROUP_INIT_BEHAVIOR,
|
|
156
|
-
type: 'boolean',
|
|
157
|
-
},
|
|
158
|
-
force: {
|
|
159
|
-
alias: 'f',
|
|
160
|
-
describe: 'Overwrite existing configurations',
|
|
161
|
-
group: NAME_GROUP_INIT_BEHAVIOR,
|
|
162
|
-
type: 'boolean',
|
|
163
|
-
},
|
|
164
|
-
include: {
|
|
165
|
-
alias: 'i',
|
|
166
|
-
array: true,
|
|
167
|
-
coerce: (value) => lodash_1.default.castArray(value),
|
|
168
|
-
description: 'Files to include in compilation (globs OK)',
|
|
169
|
-
nargs: 1,
|
|
170
|
-
requiresArg: true,
|
|
171
|
-
type: 'string',
|
|
172
|
-
},
|
|
173
|
-
mkdocs: {
|
|
174
|
-
default: true,
|
|
175
|
-
description: 'Create mkdocs.yml if needed',
|
|
176
|
-
group: NAME_GROUP_INIT_BEHAVIOR,
|
|
177
|
-
type: 'boolean',
|
|
178
|
-
},
|
|
179
|
-
'mkdocs-yml': {
|
|
180
|
-
defaultDescription: './mkdocs.yml',
|
|
181
|
-
description: 'Path to mkdocs.yml',
|
|
182
|
-
group: NAME_GROUP_INIT_PATHS,
|
|
183
|
-
nargs: 1,
|
|
184
|
-
normalize: true,
|
|
185
|
-
requiresArg: true,
|
|
186
|
-
type: 'string',
|
|
187
|
-
},
|
|
188
|
-
'package-json': {
|
|
189
|
-
defaultDescription: './package.json',
|
|
190
|
-
describe: 'Path to package.json',
|
|
191
|
-
group: NAME_GROUP_INIT_PATHS,
|
|
192
|
-
nargs: 1,
|
|
193
|
-
normalize: true,
|
|
194
|
-
requiresArg: true,
|
|
195
|
-
type: 'string',
|
|
196
|
-
},
|
|
197
|
-
python: {
|
|
198
|
-
default: true,
|
|
199
|
-
description: 'Install Python dependencies if needed',
|
|
200
|
-
group: NAME_GROUP_INIT_BEHAVIOR,
|
|
201
|
-
type: 'boolean',
|
|
202
|
-
},
|
|
203
|
-
'python-path': {
|
|
204
|
-
defaultDescription: '(derived from shell)',
|
|
205
|
-
description: 'Path to python 3 executable',
|
|
206
|
-
group: NAME_GROUP_INIT_PATHS,
|
|
207
|
-
nargs: 1,
|
|
208
|
-
normalize: true,
|
|
209
|
-
requiresArg: true,
|
|
210
|
-
type: 'string',
|
|
211
|
-
},
|
|
212
|
-
'repo-name': {
|
|
213
|
-
defaultDescription: '(derived from --repo-url)',
|
|
214
|
-
description: 'Name of extension repository',
|
|
215
|
-
group: NAME_GROUP_INIT_MKDOCS,
|
|
216
|
-
nargs: 1,
|
|
217
|
-
requiresArg: true,
|
|
218
|
-
type: 'string',
|
|
219
|
-
},
|
|
220
|
-
'repo-url': {
|
|
221
|
-
defaultDescription: '(from package.json)',
|
|
222
|
-
description: 'URL of extension repository',
|
|
223
|
-
group: NAME_GROUP_INIT_MKDOCS,
|
|
224
|
-
nargs: 1,
|
|
225
|
-
requiresArg: true,
|
|
226
|
-
type: 'string',
|
|
227
|
-
},
|
|
228
|
-
'site-description': {
|
|
229
|
-
defaultDescription: '(from package.json)',
|
|
230
|
-
description: 'Site description',
|
|
231
|
-
group: NAME_GROUP_INIT_MKDOCS,
|
|
232
|
-
nargs: 1,
|
|
233
|
-
requiresArg: true,
|
|
234
|
-
type: 'string',
|
|
235
|
-
},
|
|
236
|
-
'site-name': {
|
|
237
|
-
defaultDescription: '(extension package name)',
|
|
238
|
-
description: 'Name of site',
|
|
239
|
-
group: NAME_GROUP_INIT_MKDOCS,
|
|
240
|
-
nargs: 1,
|
|
241
|
-
requiresArg: true,
|
|
242
|
-
type: 'string',
|
|
243
|
-
},
|
|
244
|
-
'tsconfig-json': {
|
|
245
|
-
defaultDescription: './tsconfig.json',
|
|
246
|
-
describe: 'Path to tsconfig.json',
|
|
247
|
-
group: NAME_GROUP_INIT_PATHS,
|
|
248
|
-
nargs: 1,
|
|
249
|
-
normalize: true,
|
|
250
|
-
requiresArg: true,
|
|
251
|
-
type: 'string',
|
|
252
|
-
},
|
|
253
|
-
typedoc: {
|
|
254
|
-
default: true,
|
|
255
|
-
description: 'Create typedoc.json if needed',
|
|
256
|
-
group: NAME_GROUP_INIT_BEHAVIOR,
|
|
257
|
-
type: 'boolean',
|
|
258
|
-
},
|
|
259
|
-
'typedoc-json': {
|
|
260
|
-
defaultDescription: './typedoc.json',
|
|
261
|
-
describe: 'Path to typedoc.json',
|
|
262
|
-
group: NAME_GROUP_INIT_PATHS,
|
|
263
|
-
nargs: 1,
|
|
264
|
-
normalize: true,
|
|
265
|
-
requiresArg: true,
|
|
266
|
-
type: 'string',
|
|
267
|
-
},
|
|
268
|
-
typescript: {
|
|
269
|
-
default: true,
|
|
270
|
-
description: 'Create tsconfig.json if needed',
|
|
271
|
-
group: NAME_GROUP_INIT_BEHAVIOR,
|
|
272
|
-
type: 'boolean',
|
|
273
|
-
},
|
|
274
|
-
}), async (argv) => {
|
|
275
|
-
await (0, init_1.init)({ ...argv, overwrite: argv.force, cwd: argv.dir });
|
|
276
|
-
logger_1.default.success('Done (%dms)', done());
|
|
277
|
-
})
|
|
278
|
-
.options({
|
|
279
|
-
verbose: {
|
|
280
|
-
alias: 'V',
|
|
281
|
-
type: 'boolean',
|
|
282
|
-
describe: 'Alias for --log-level=debug',
|
|
283
|
-
},
|
|
284
|
-
'log-level': {
|
|
285
|
-
alias: 'L',
|
|
286
|
-
choices: ['debug', 'info', 'warn', 'error', 'silent'],
|
|
287
|
-
default: 'info',
|
|
288
|
-
describe: 'Sets the log level',
|
|
289
|
-
coerce: lodash_1.default.identity,
|
|
290
|
-
},
|
|
291
|
-
})
|
|
292
|
-
.middleware(
|
|
293
|
-
/**
|
|
294
|
-
* Configures logging; `--verbose` implies `--log-level=debug`
|
|
295
|
-
*/
|
|
296
|
-
(argv) => {
|
|
297
|
-
const { logLevel, verbose } = argv;
|
|
298
|
-
logger_1.default.level = verbose ? LogLevelName.debug : LogLevelName[logLevel];
|
|
299
|
-
})
|
|
300
|
-
.fail(
|
|
301
|
-
/**
|
|
302
|
-
* Custom failure handler so we can log nicely.
|
|
303
|
-
*/
|
|
304
|
-
(msg, error) => {
|
|
305
|
-
// if it is a DocutilsError, it has nothing to do with the CLI
|
|
306
|
-
if (error instanceof error_1.DocutilsError) {
|
|
307
|
-
logger_1.default.error(error.message);
|
|
308
|
-
}
|
|
309
|
-
else {
|
|
310
|
-
y.showHelp();
|
|
311
|
-
logger_1.default.error(msg ?? error.message);
|
|
312
|
-
}
|
|
313
|
-
y.exit(1, error);
|
|
314
|
-
})
|
|
315
|
-
// at least one command is required (but not for --version or --help)
|
|
316
|
-
.demandCommand(1)
|
|
317
|
-
// fail if unknown option or command is provided
|
|
318
|
-
.strict()
|
|
319
|
-
.parseAsync();
|
|
320
|
-
}
|
|
321
|
-
exports.main = main;
|
|
322
|
-
if (require.main === module) {
|
|
323
|
-
// eslint-disable-next-line promise/prefer-await-to-then
|
|
324
|
-
main().catch((err) => {
|
|
325
|
-
logger_1.default.error('Caught otherwise-unhandled rejection (this is probably a bug):', err);
|
|
326
|
-
});
|
|
327
|
-
}
|
|
328
|
-
//# sourceMappingURL=cli.js.map
|
package/build/lib/cli.js.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"cli.js","sourceRoot":"","sources":["../../lib/cli.ts"],"names":[],"mappings":";;;;;;;AAEA,oDAAuB;AACvB,wDAAgC;AAChC,2CAAsC;AACtC,iCAA4B;AAC5B,sDAA2B;AAC3B,mCAAsC;AACtC,qCAAiC;AACjC,iCAAiC;AACjC,mCAAuC;AACvC,yCAAoC;AAEpC,MAAM,wBAAwB,GAAG,0BAA0B,CAAC;AAC5D,MAAM,sBAAsB,GAAG,gBAAgB,CAAC;AAChD,MAAM,0BAA0B,GAAG,YAAY,CAAC;AAChD,MAAM,qBAAqB,GAAG,QAAQ,CAAC;AACvC,MAAM,mBAAmB,GAAG,aAAa,CAAC;AAE1C,MAAM,YAAY,GAAG;IACnB,MAAM,EAAE,kBAAQ,CAAC,MAAM;IACvB,KAAK,EAAE,kBAAQ,CAAC,KAAK;IACrB,IAAI,EAAE,kBAAQ,CAAC,IAAI;IACnB,IAAI,EAAE,kBAAQ,CAAC,IAAI;IACnB,KAAK,EAAE,kBAAQ,CAAC,KAAK;CACb,CAAC;AAEJ,KAAK,UAAU,IAAI,CAAC,IAAI,GAAG,IAAA,iBAAO,EAAC,OAAO,CAAC,IAAI,CAAC;IACrD,MAAM,IAAI,GAAG,IAAA,gBAAS,EAAC,MAAM,CAAC,CAAC;IAC/B,MAAM,CAAC,GAAG,IAAA,eAAK,EAAC,IAAI,CAAC,CAAC;IACtB,OAAO,MAAM,CAAC;SACX,UAAU,CAAC,aAAa,CAAC;SACzB,OAAO,CACN,OAAO,EACP,YAAY,EACZ,CAAC,KAAK,EAAE,EAAE;QACR,OAAO,KAAK,CAAC,OAAO,CAAC;YACnB,aAAa,EAAE;gBACb,QAAQ,EAAE,oBAAoB;gBAC9B,SAAS,EAAE,IAAI;gBACf,IAAI,EAAE,QAAQ;gBACd,KAAK,EAAE,CAAC;gBACR,KAAK,EAAE,KAAK;aACb;SACF,CAAC,CAAC;IACL,CAAC,EACD,KAAK,IAAI,EAAE,GAAE,CAAC,CACf;SACA,OAAO,CACN,UAAU,EACV,sBAAsB,EACtB,CAAC,KAAK,EAAE,EAAE,CACR,KAAK,CAAC,OAAO,CAAC;QACZ,MAAM,EAAE;YACN,OAAO,EAAE,IAAI;YACb,WAAW,EAAE,+BAA+B;YAC5C,KAAK,EAAE,mBAAmB;YAC1B,IAAI,EAAE,SAAS;SAChB;QACD,aAAa,EAAE;YACb,kBAAkB,EAAE,sBAAsB;YAC1C,WAAW,EAAE,6BAA6B;YAC1C,KAAK,EAAE,mBAAmB;YAC1B,KAAK,EAAE,CAAC;YACR,SAAS,EAAE,IAAI;YACf,WAAW,EAAE,IAAI;YACjB,IAAI,EAAE,QAAQ;SACf;QACD,eAAe,EAAE;YACf,kBAAkB,EAAE,iBAAiB;YACrC,QAAQ,EAAE,uBAAuB;YACjC,KAAK,EAAE,mBAAmB;YAC1B,KAAK,EAAE,CAAC;YACR,SAAS,EAAE,IAAI;YACf,WAAW,EAAE,IAAI;YACjB,IAAI,EAAE,QAAQ;SACf;QACD,OAAO,EAAE;YACP,OAAO,EAAE,IAAI;YACb,WAAW,EAAE,yBAAyB;YACtC,KAAK,EAAE,mBAAmB;YAC1B,IAAI,EAAE,SAAS;SAChB;QACD,cAAc,EAAE;YACd,kBAAkB,EAAE,gBAAgB;YACpC,QAAQ,EAAE,sBAAsB;YAChC,KAAK,EAAE,mBAAmB;YAC1B,KAAK,EAAE,CAAC;YACR,SAAS,EAAE,IAAI;YACf,WAAW,EAAE,IAAI;YACjB,IAAI,EAAE,QAAQ;SACf;QACD,UAAU,EAAE;YACV,OAAO,EAAE,IAAI;YACb,WAAW,EAAE,4BAA4B;YACzC,KAAK,EAAE,mBAAmB;YAC1B,IAAI,EAAE,SAAS;SAChB;KACF,CAAC,EACJ,KAAK,EAAE,IAAI,EAAE,EAAE;QACb,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE;YACrD,MAAM,IAAI,KAAK,CACb,sGAAsG,CACvG,CAAC;SACH;QACD,MAAM,IAAA,mBAAQ,EAAC,IAAI,CAAC,CAAC;IACvB,CAAC,CACF;SACA,OAAO,CACN,iBAAiB,EACjB,0BAA0B,EAC1B,CAAC,KAAK,EAAE,EAAE,CACR,KAAK,CAAC,OAAO,CAAC;QACZ,cAAc,EAAE;YACd,kBAAkB,EAAE,gBAAgB;YACpC,QAAQ,EAAE,sBAAsB;YAChC,KAAK,EAAE,0BAA0B;YACjC,KAAK,EAAE,CAAC;YACR,SAAS,EAAE,IAAI;YACf,WAAW,EAAE,IAAI;YACjB,IAAI,EAAE,QAAQ;SACf;QACD,KAAK,EAAE;YACL,kBAAkB,EAAE,0BAA0B;YAC9C,QAAQ,EAAE,4BAA4B;YACtC,KAAK,EAAE,0BAA0B;YACjC,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,IAAI;YACjB,IAAI,EAAE,QAAQ;SACf;QACD,eAAe,EAAE;YACf,kBAAkB,EAAE,iBAAiB;YACrC,QAAQ,EAAE,uBAAuB;YACjC,KAAK,EAAE,0BAA0B;YACjC,KAAK,EAAE,CAAC;YACR,SAAS,EAAE,IAAI;YACf,WAAW,EAAE,IAAI;YACjB,IAAI,EAAE,QAAQ;SACf;QACD,cAAc,EAAE;YACd,kBAAkB,EAAE,gBAAgB;YACpC,QAAQ,EAAE,sBAAsB;YAChC,KAAK,EAAE,0BAA0B;YACjC,KAAK,EAAE,CAAC;YACR,SAAS,EAAE,IAAI;YACf,WAAW,EAAE,IAAI;YACjB,IAAI,EAAE,QAAQ;SACf;KACF,CAAC,EACJ,KAAK,EAAE,IAAI,EAAE,EAAE;QACb,MAAM,IAAA,sBAAc,EAAC,IAAI,CAAC,CAAC;IAC7B,CAAC,CACF;SACA,OAAO,CACN,MAAM,EACN,6BAA6B,EAC7B,CAAC,KAAK,EAAE,EAAE,CACR,KAAK,CAAC,OAAO,CAAC;QACZ,SAAS,EAAE;YACT,WAAW,EAAE,kBAAkB;YAC/B,KAAK,EAAE,sBAAsB;YAC7B,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,IAAI;YACjB,IAAI,EAAE,QAAQ;SACf;QACD,GAAG,EAAE;YACH,OAAO,EAAE,GAAG;YACZ,kBAAkB,EAAE,qBAAqB;YACzC,WAAW,EAAE,sBAAsB;YACnC,KAAK,EAAE,qBAAqB;YAC5B,SAAS,EAAE,IAAI;YACf,IAAI,EAAE,QAAQ;SACf;QACD,SAAS,EAAE;YACT,QAAQ,EAAE,iDAAiD;YAC3D,KAAK,EAAE,wBAAwB;YAC/B,IAAI,EAAE,SAAS;SAChB;QACD,KAAK,EAAE;YACL,KAAK,EAAE,GAAG;YACV,QAAQ,EAAE,mCAAmC;YAC7C,KAAK,EAAE,wBAAwB;YAC/B,IAAI,EAAE,SAAS;SAChB;QACD,OAAO,EAAE;YACP,KAAK,EAAE,GAAG;YACV,KAAK,EAAE,IAAI;YACX,MAAM,EAAE,CAAC,KAAwB,EAAE,EAAE,CAAC,gBAAC,CAAC,SAAS,CAAC,KAAK,CAAC;YACxD,WAAW,EAAE,4CAA4C;YACzD,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,IAAI;YACjB,IAAI,EAAE,QAAQ;SACf;QACD,MAAM,EAAE;YACN,OAAO,EAAE,IAAI;YACb,WAAW,EAAE,6BAA6B;YAC1C,KAAK,EAAE,wBAAwB;YAC/B,IAAI,EAAE,SAAS;SAChB;QACD,YAAY,EAAE;YACZ,kBAAkB,EAAE,cAAc;YAClC,WAAW,EAAE,oBAAoB;YACjC,KAAK,EAAE,qBAAqB;YAC5B,KAAK,EAAE,CAAC;YACR,SAAS,EAAE,IAAI;YACf,WAAW,EAAE,IAAI;YACjB,IAAI,EAAE,QAAQ;SACf;QACD,cAAc,EAAE;YACd,kBAAkB,EAAE,gBAAgB;YACpC,QAAQ,EAAE,sBAAsB;YAChC,KAAK,EAAE,qBAAqB;YAC5B,KAAK,EAAE,CAAC;YACR,SAAS,EAAE,IAAI;YACf,WAAW,EAAE,IAAI;YACjB,IAAI,EAAE,QAAQ;SACf;QACD,MAAM,EAAE;YACN,OAAO,EAAE,IAAI;YACb,WAAW,EAAE,uCAAuC;YACpD,KAAK,EAAE,wBAAwB;YAC/B,IAAI,EAAE,SAAS;SAChB;QACD,aAAa,EAAE;YACb,kBAAkB,EAAE,sBAAsB;YAC1C,WAAW,EAAE,6BAA6B;YAC1C,KAAK,EAAE,qBAAqB;YAC5B,KAAK,EAAE,CAAC;YACR,SAAS,EAAE,IAAI;YACf,WAAW,EAAE,IAAI;YACjB,IAAI,EAAE,QAAQ;SACf;QACD,WAAW,EAAE;YACX,kBAAkB,EAAE,2BAA2B;YAC/C,WAAW,EAAE,8BAA8B;YAC3C,KAAK,EAAE,sBAAsB;YAC7B,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,IAAI;YACjB,IAAI,EAAE,QAAQ;SACf;QACD,UAAU,EAAE;YACV,kBAAkB,EAAE,qBAAqB;YACzC,WAAW,EAAE,6BAA6B;YAC1C,KAAK,EAAE,sBAAsB;YAC7B,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,IAAI;YACjB,IAAI,EAAE,QAAQ;SACf;QACD,kBAAkB,EAAE;YAClB,kBAAkB,EAAE,qBAAqB;YACzC,WAAW,EAAE,kBAAkB;YAC/B,KAAK,EAAE,sBAAsB;YAC7B,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,IAAI;YACjB,IAAI,EAAE,QAAQ;SACf;QACD,WAAW,EAAE;YACX,kBAAkB,EAAE,0BAA0B;YAC9C,WAAW,EAAE,cAAc;YAC3B,KAAK,EAAE,sBAAsB;YAC7B,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,IAAI;YACjB,IAAI,EAAE,QAAQ;SACf;QACD,eAAe,EAAE;YACf,kBAAkB,EAAE,iBAAiB;YACrC,QAAQ,EAAE,uBAAuB;YACjC,KAAK,EAAE,qBAAqB;YAC5B,KAAK,EAAE,CAAC;YACR,SAAS,EAAE,IAAI;YACf,WAAW,EAAE,IAAI;YACjB,IAAI,EAAE,QAAQ;SACf;QACD,OAAO,EAAE;YACP,OAAO,EAAE,IAAI;YACb,WAAW,EAAE,+BAA+B;YAC5C,KAAK,EAAE,wBAAwB;YAC/B,IAAI,EAAE,SAAS;SAChB;QACD,cAAc,EAAE;YACd,kBAAkB,EAAE,gBAAgB;YACpC,QAAQ,EAAE,sBAAsB;YAChC,KAAK,EAAE,qBAAqB;YAC5B,KAAK,EAAE,CAAC;YACR,SAAS,EAAE,IAAI;YACf,WAAW,EAAE,IAAI;YACjB,IAAI,EAAE,QAAQ;SACf;QACD,UAAU,EAAE;YACV,OAAO,EAAE,IAAI;YACb,WAAW,EAAE,gCAAgC;YAC7C,KAAK,EAAE,wBAAwB;YAC/B,IAAI,EAAE,SAAS;SAChB;KACF,CAAC,EACJ,KAAK,EAAE,IAAI,EAAE,EAAE;QACb,MAAM,IAAA,WAAI,EAAC,EAAC,GAAG,IAAI,EAAE,SAAS,EAAE,IAAI,CAAC,KAAK,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,EAAC,CAAC,CAAC;QAC5D,gBAAG,CAAC,OAAO,CAAC,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;IACrC,CAAC,CACF;SACA,OAAO,CAAC;QACP,OAAO,EAAE;YACP,KAAK,EAAE,GAAG;YACV,IAAI,EAAE,SAAS;YACf,QAAQ,EAAE,6BAA6B;SACxC;QACD,WAAW,EAAE;YACX,KAAK,EAAE,GAAG;YACV,OAAO,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,CAAC;YACrD,OAAO,EAAE,MAAM;YACf,QAAQ,EAAE,oBAAoB;YAC9B,MAAM,EAAE,gBAAC,CAAC,QAAoD;SAC/D;KACF,CAAC;SACD,UAAU;IACT;;OAEG;IACH,CAAC,IAAI,EAAE,EAAE;QACP,MAAM,EAAC,QAAQ,EAAE,OAAO,EAAC,GAAG,IAAI,CAAC;QACjC,gBAAG,CAAC,KAAK,GAAG,OAAO,CAAC,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;IACpE,CAAC,CACF;SAEA,IAAI;IACH;;OAEG;IACH,CAAC,GAAkB,EAAE,KAAK,EAAE,EAAE;QAC5B,8DAA8D;QAC9D,IAAI,KAAK,YAAY,qBAAa,EAAE;YAClC,gBAAG,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;SAC1B;aAAM;YACL,CAAC,CAAC,QAAQ,EAAE,CAAC;YACb,gBAAG,CAAC,KAAK,CAAC,GAAG,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC;SACjC;QACD,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IACnB,CAAC,CACF;QACD,qEAAqE;SACpE,aAAa,CAAC,CAAC,CAAC;QACjB,gDAAgD;SAC/C,MAAM,EAAE;SACR,UAAU,EAAE,CAAC;AAClB,CAAC;AA7TD,oBA6TC;AAED,IAAI,OAAO,CAAC,IAAI,KAAK,MAAM,EAAE;IAC3B,wDAAwD;IACxD,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;QACnB,gBAAG,CAAC,KAAK,CAAC,gEAAgE,EAAE,GAAG,CAAC,CAAC;IACnF,CAAC,CAAC,CAAC;CACJ"}
|
package/build/lib/init-task.d.ts
DELETED
|
@@ -1,49 +0,0 @@
|
|
|
1
|
-
import { NormalizedPackageJson } from 'read-pkg';
|
|
2
|
-
import { JsonValue, JsonObject } from 'type-fest';
|
|
3
|
-
export declare type TaskSpecificOpts<Opts extends ScaffoldTaskOptions> = Omit<Opts, 'overwrite' | 'cwd' | 'packageJson' | 'dest' | 'dryRun'>;
|
|
4
|
-
export declare type ScaffoldTask<Opts extends ScaffoldTaskOptions, T extends JsonObject> = (opts: Opts) => Promise<ScaffoldTaskResult<T>>;
|
|
5
|
-
/**
|
|
6
|
-
* Factory for a {@linkcode ScaffoldTask}.
|
|
7
|
-
*
|
|
8
|
-
* @param defaultFilename Default file to create
|
|
9
|
-
* @param defaultContent Default content to use
|
|
10
|
-
* @param description Description of task
|
|
11
|
-
* @param opts Options
|
|
12
|
-
* @returns A scaffold task
|
|
13
|
-
*/
|
|
14
|
-
export declare function createScaffoldTask<Opts extends ScaffoldTaskOptions, T extends JsonObject>(defaultFilename: string, defaultContent: T, description: string, { transform, deserialize, serialize, }?: CreateScaffoldTaskOptions<Opts, T>): ScaffoldTask<Opts, T>;
|
|
15
|
-
export declare type ScaffoldTaskTransformer<Opts extends ScaffoldTaskOptions, T extends JsonValue> = (content: Readonly<T>, opts: TaskSpecificOpts<Opts>, pkg: NormalizedPackageJson) => T;
|
|
16
|
-
export declare type ScaffoldTaskDeserializer<T extends JsonValue> = (content: string) => T;
|
|
17
|
-
export declare type ScaffoldTaskSerializer<T extends JsonValue> = (content: T) => string;
|
|
18
|
-
export interface CreateScaffoldTaskOptions<Opts extends ScaffoldTaskOptions, T extends JsonValue> {
|
|
19
|
-
transform?: ScaffoldTaskTransformer<Opts, T>;
|
|
20
|
-
deserialize?: ScaffoldTaskDeserializer<T>;
|
|
21
|
-
serialize?: ScaffoldTaskSerializer<T>;
|
|
22
|
-
}
|
|
23
|
-
export interface ScaffoldTaskOptions {
|
|
24
|
-
/**
|
|
25
|
-
* Current working directory
|
|
26
|
-
*/
|
|
27
|
-
cwd?: string;
|
|
28
|
-
/**
|
|
29
|
-
* Destination file
|
|
30
|
-
*/
|
|
31
|
-
dest?: string;
|
|
32
|
-
/**
|
|
33
|
-
* If `true` will not write files
|
|
34
|
-
*/
|
|
35
|
-
dryRun?: boolean;
|
|
36
|
-
/**
|
|
37
|
-
* If `true` will overwrite fields in `typedoc.json`
|
|
38
|
-
*/
|
|
39
|
-
overwrite?: boolean;
|
|
40
|
-
/**
|
|
41
|
-
* Path to `package.json`
|
|
42
|
-
*/
|
|
43
|
-
packageJson?: string;
|
|
44
|
-
}
|
|
45
|
-
export interface ScaffoldTaskResult<T> {
|
|
46
|
-
content: T;
|
|
47
|
-
path: string;
|
|
48
|
-
}
|
|
49
|
-
//# sourceMappingURL=init-task.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"init-task.d.ts","sourceRoot":"","sources":["../../lib/init-task.ts"],"names":[],"mappings":"AAIA,OAAO,EAAC,qBAAqB,EAAC,MAAM,UAAU,CAAC;AAC/C,OAAO,EAAC,SAAS,EAAE,UAAU,EAAC,MAAM,WAAW,CAAC;AAiChD,oBAAY,gBAAgB,CAAC,IAAI,SAAS,mBAAmB,IAAI,IAAI,CACnE,IAAI,EACJ,WAAW,GAAG,KAAK,GAAG,aAAa,GAAG,MAAM,GAAG,QAAQ,CACxD,CAAC;AAEF,oBAAY,YAAY,CAAC,IAAI,SAAS,mBAAmB,EAAE,CAAC,SAAS,UAAU,IAAI,CACjF,IAAI,EAAE,IAAI,KACP,OAAO,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,CAAC;AAEpC;;;;;;;;GAQG;AACH,wBAAgB,kBAAkB,CAAC,IAAI,SAAS,mBAAmB,EAAE,CAAC,SAAS,UAAU,EACvF,eAAe,EAAE,MAAM,EACvB,cAAc,EAAE,CAAC,EACjB,WAAW,EAAE,MAAM,EACnB,EACE,SAAsB,EACtB,WAAwB,EACxB,SAAyB,GAC1B,GAAE,yBAAyB,CAAC,IAAI,EAAE,CAAC,CAAM,GACzC,YAAY,CAAC,IAAI,EAAE,CAAC,CAAC,CAqEvB;AAED,oBAAY,uBAAuB,CAAC,IAAI,SAAS,mBAAmB,EAAE,CAAC,SAAS,SAAS,IAAI,CAC3F,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC,EACpB,IAAI,EAAE,gBAAgB,CAAC,IAAI,CAAC,EAC5B,GAAG,EAAE,qBAAqB,KACvB,CAAC,CAAC;AAEP,oBAAY,wBAAwB,CAAC,CAAC,SAAS,SAAS,IAAI,CAAC,OAAO,EAAE,MAAM,KAAK,CAAC,CAAC;AAEnF,oBAAY,sBAAsB,CAAC,CAAC,SAAS,SAAS,IAAI,CAAC,OAAO,EAAE,CAAC,KAAK,MAAM,CAAC;AAEjF,MAAM,WAAW,yBAAyB,CAAC,IAAI,SAAS,mBAAmB,EAAE,CAAC,SAAS,SAAS;IAC9F,SAAS,CAAC,EAAE,uBAAuB,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;IAC7C,WAAW,CAAC,EAAE,wBAAwB,CAAC,CAAC,CAAC,CAAC;IAC1C,SAAS,CAAC,EAAE,sBAAsB,CAAC,CAAC,CAAC,CAAC;CACvC;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,kBAAkB,CAAC,CAAC;IACnC,OAAO,EAAE,CAAC,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;CACd"}
|