@appium/docutils 0.2.1 → 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 +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 +42 -29
- package/build/lib/cli/command/build.d.ts.map +1 -1
- package/build/lib/cli/command/build.js +55 -39
- 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 +42 -27
- package/build/lib/cli/command/init.d.ts.map +1 -1
- package/build/lib/cli/command/init.js +51 -28
- package/build/lib/cli/command/init.js.map +1 -1
- package/build/lib/cli/command/validate.d.ts +21 -15
- package/build/lib/cli/command/validate.d.ts.map +1 -1
- package/build/lib/cli/command/validate.js +30 -21
- 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/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 +24 -26
- 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/logger.js +0 -4
- package/build/lib/logger.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/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 +6 -3
- package/build/lib/util.d.ts.map +1 -1
- package/build/lib/util.js.map +1 -1
- package/build/lib/validate.d.ts +5 -2
- 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 -46
- package/lib/cli/command/index.ts +5 -0
- package/lib/cli/command/init.ts +54 -32
- package/lib/cli/command/validate.ts +35 -28
- 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/logger.ts +6 -11
- package/lib/mike.js +5 -0
- package/lib/model.ts +3 -9
- package/lib/util.ts +4 -1
- package/lib/validate.ts +10 -9
- package/package.json +10 -12
- 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.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"}
|
package/build/lib/init-task.js
DELETED
|
@@ -1,95 +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
|
-
exports.createScaffoldTask = void 0;
|
|
7
|
-
const support_1 = require("@appium/support");
|
|
8
|
-
const logger_1 = __importDefault(require("./logger"));
|
|
9
|
-
const node_path_1 = __importDefault(require("node:path"));
|
|
10
|
-
const diff_1 = require("diff");
|
|
11
|
-
const error_1 = require("./error");
|
|
12
|
-
const util_1 = require("./util");
|
|
13
|
-
const lodash_1 = __importDefault(require("lodash"));
|
|
14
|
-
const NAME_ERR_ENOENT = 'ENOENT';
|
|
15
|
-
const NAME_ERR_EEXIST = 'EEXIST';
|
|
16
|
-
const log = logger_1.default.withTag('init');
|
|
17
|
-
const dryRunLog = logger_1.default.withTag('dry-run');
|
|
18
|
-
const jsonStringify = lodash_1.default.partial(JSON.stringify, lodash_1.default, undefined, 2);
|
|
19
|
-
/**
|
|
20
|
-
* Creates a unified patch for display in "dry run" mode
|
|
21
|
-
* @param filename - File name to use
|
|
22
|
-
* @param oldData - Old data
|
|
23
|
-
* @param newData - New Data
|
|
24
|
-
* @returns Patch string
|
|
25
|
-
*/
|
|
26
|
-
function makePatch(filename, oldData, newData, serializer = jsonStringify) {
|
|
27
|
-
return (0, diff_1.createPatch)(filename, lodash_1.default.isString(oldData) ? oldData : serializer(oldData), lodash_1.default.isString(newData) ? newData : serializer(newData));
|
|
28
|
-
}
|
|
29
|
-
/**
|
|
30
|
-
* Factory for a {@linkcode ScaffoldTask}.
|
|
31
|
-
*
|
|
32
|
-
* @param defaultFilename Default file to create
|
|
33
|
-
* @param defaultContent Default content to use
|
|
34
|
-
* @param description Description of task
|
|
35
|
-
* @param opts Options
|
|
36
|
-
* @returns A scaffold task
|
|
37
|
-
*/
|
|
38
|
-
function createScaffoldTask(defaultFilename, defaultContent, description, { transform = lodash_1.default.identity, deserialize = JSON.parse, serialize = jsonStringify, } = {}) {
|
|
39
|
-
return async ({ overwrite = false, cwd = process.cwd(), packageJson: packageJsonPath, dest, dryRun = false, ...opts }) => {
|
|
40
|
-
const relativePath = (0, util_1.relative)(cwd);
|
|
41
|
-
const { pkgPath, pkg } = await (0, util_1.readPackageJson)(packageJsonPath ? node_path_1.default.dirname(packageJsonPath) : cwd, true);
|
|
42
|
-
const pkgDir = node_path_1.default.dirname(pkgPath);
|
|
43
|
-
dest = dest ?? node_path_1.default.join(pkgDir, defaultFilename);
|
|
44
|
-
const relativeDest = relativePath(dest);
|
|
45
|
-
log.debug('Initializing %s', relativeDest);
|
|
46
|
-
let shouldWriteDest = false;
|
|
47
|
-
let destContent;
|
|
48
|
-
let result;
|
|
49
|
-
try {
|
|
50
|
-
destContent = deserialize(await support_1.fs.readFile(dest, 'utf8'));
|
|
51
|
-
log.debug('Found existing file %s', relativeDest);
|
|
52
|
-
}
|
|
53
|
-
catch (e) {
|
|
54
|
-
const err = e;
|
|
55
|
-
if (err.code !== NAME_ERR_ENOENT) {
|
|
56
|
-
throw err;
|
|
57
|
-
}
|
|
58
|
-
shouldWriteDest = true;
|
|
59
|
-
log.debug('Creating new file %s', relativeDest);
|
|
60
|
-
destContent = {};
|
|
61
|
-
}
|
|
62
|
-
const defaults = transform(defaultContent, opts, pkg);
|
|
63
|
-
const finalDestContent = lodash_1.default.defaultsDeep({}, destContent, defaults);
|
|
64
|
-
shouldWriteDest = shouldWriteDest || !lodash_1.default.isEqual(destContent, finalDestContent);
|
|
65
|
-
if (shouldWriteDest) {
|
|
66
|
-
log.info('Changes needed to %s', relativeDest);
|
|
67
|
-
log.debug('Original %s: %O', relativeDest, destContent);
|
|
68
|
-
log.debug('Final %s: %O', relativeDest, finalDestContent);
|
|
69
|
-
const patch = makePatch(dest, destContent, finalDestContent, serialize);
|
|
70
|
-
if (dryRun) {
|
|
71
|
-
dryRunLog.info('Would apply the following patch: \n\n%s', patch);
|
|
72
|
-
result = { path: dest, content: finalDestContent };
|
|
73
|
-
return result;
|
|
74
|
-
}
|
|
75
|
-
try {
|
|
76
|
-
await (0, util_1.safeWriteFile)(dest, finalDestContent, overwrite);
|
|
77
|
-
}
|
|
78
|
-
catch (e) {
|
|
79
|
-
const err = e;
|
|
80
|
-
// this should only be thrown if `force` is false
|
|
81
|
-
if (err.code === NAME_ERR_EEXIST) {
|
|
82
|
-
throw new error_1.DocutilsError(`${relativeDest} already exists. To overwrite, use --force. Wanted to apply patch:\n\n${patch}`);
|
|
83
|
-
}
|
|
84
|
-
throw new error_1.DocutilsError(`Could not write to ${relativeDest}. Reason: ${err.message}`);
|
|
85
|
-
}
|
|
86
|
-
}
|
|
87
|
-
else {
|
|
88
|
-
log.info('No changes to %s', relativeDest);
|
|
89
|
-
}
|
|
90
|
-
log.success('Initialized %s', description);
|
|
91
|
-
return { path: dest, content: finalDestContent };
|
|
92
|
-
};
|
|
93
|
-
}
|
|
94
|
-
exports.createScaffoldTask = createScaffoldTask;
|
|
95
|
-
//# sourceMappingURL=init-task.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"init-task.js","sourceRoot":"","sources":["../../lib/init-task.ts"],"names":[],"mappings":";;;;;;AAAA,6CAAmC;AACnC,sDAA8B;AAC9B,0DAA6B;AAC7B,+BAAiC;AAGjC,mCAAsC;AACtC,iCAAgE;AAChE,oDAAuB;AAEvB,MAAM,eAAe,GAAG,QAAQ,CAAC;AACjC,MAAM,eAAe,GAAG,QAAQ,CAAC;AAEjC,MAAM,GAAG,GAAG,gBAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;AACnC,MAAM,SAAS,GAAG,gBAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;AAE5C,MAAM,aAAa,GAAG,gBAAC,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,gBAAC,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC;AAEjE;;;;;;GAMG;AACH,SAAS,SAAS,CAChB,QAAgB,EAChB,OAA2B,EAC3B,OAA2B,EAC3B,UAAU,GAAG,aAAa;IAE1B,OAAO,IAAA,kBAAW,EAChB,QAAQ,EACR,gBAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC,EACnD,gBAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC,CACpD,CAAC;AACJ,CAAC;AAWD;;;;;;;;GAQG;AACH,SAAgB,kBAAkB,CAChC,eAAuB,EACvB,cAAiB,EACjB,WAAmB,EACnB,EACE,SAAS,GAAG,gBAAC,CAAC,QAAQ,EACtB,WAAW,GAAG,IAAI,CAAC,KAAK,EACxB,SAAS,GAAG,aAAa,MACa,EAAE;IAE1C,OAAO,KAAK,EAAE,EACZ,SAAS,GAAG,KAAK,EACjB,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE,EACnB,WAAW,EAAE,eAAe,EAC5B,IAAI,EACJ,MAAM,GAAG,KAAK,EACd,GAAG,IAAI,EACF,EAAkC,EAAE;QACzC,MAAM,YAAY,GAAG,IAAA,eAAQ,EAAC,GAAG,CAAC,CAAC;QACnC,MAAM,EAAC,OAAO,EAAE,GAAG,EAAC,GAAG,MAAM,IAAA,sBAAe,EAC1C,eAAe,CAAC,CAAC,CAAC,mBAAI,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,GAAG,EACrD,IAAI,CACL,CAAC;QACF,MAAM,MAAM,GAAG,mBAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACrC,IAAI,GAAG,IAAI,IAAI,mBAAI,CAAC,IAAI,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;QAClD,MAAM,YAAY,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;QACxC,GAAG,CAAC,KAAK,CAAC,iBAAiB,EAAE,YAAY,CAAC,CAAC;QAC3C,IAAI,eAAe,GAAG,KAAK,CAAC;QAC5B,IAAI,WAAc,CAAC;QACnB,IAAI,MAA6B,CAAC;QAClC,IAAI;YACF,WAAW,GAAG,WAAW,CAAC,MAAM,YAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;YAC3D,GAAG,CAAC,KAAK,CAAC,wBAAwB,EAAE,YAAY,CAAC,CAAC;SACnD;QAAC,OAAO,CAAC,EAAE;YACV,MAAM,GAAG,GAAG,CAA0B,CAAC;YACvC,IAAI,GAAG,CAAC,IAAI,KAAK,eAAe,EAAE;gBAChC,MAAM,GAAG,CAAC;aACX;YACD,eAAe,GAAG,IAAI,CAAC;YACvB,GAAG,CAAC,KAAK,CAAC,sBAAsB,EAAE,YAAY,CAAC,CAAC;YAChD,WAAW,GAAG,EAAO,CAAC;SACvB;QAED,MAAM,QAAQ,GAAM,SAAS,CAAC,cAAc,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;QACzD,MAAM,gBAAgB,GAAM,gBAAC,CAAC,YAAY,CAAC,EAAE,EAAE,WAAW,EAAE,QAAQ,CAAC,CAAC;QAEtE,eAAe,GAAG,eAAe,IAAI,CAAC,gBAAC,CAAC,OAAO,CAAC,WAAW,EAAE,gBAAgB,CAAC,CAAC;QAE/E,IAAI,eAAe,EAAE;YACnB,GAAG,CAAC,IAAI,CAAC,sBAAsB,EAAE,YAAY,CAAC,CAAC;YAC/C,GAAG,CAAC,KAAK,CAAC,iBAAiB,EAAE,YAAY,EAAE,WAAW,CAAC,CAAC;YACxD,GAAG,CAAC,KAAK,CAAC,cAAc,EAAE,YAAY,EAAE,gBAAgB,CAAC,CAAC;YAC1D,MAAM,KAAK,GAAG,SAAS,CAAC,IAAI,EAAE,WAAW,EAAE,gBAAgB,EAAE,SAAS,CAAC,CAAC;YAExE,IAAI,MAAM,EAAE;gBACV,SAAS,CAAC,IAAI,CAAC,yCAAyC,EAAE,KAAK,CAAC,CAAC;gBACjE,MAAM,GAAG,EAAC,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,gBAAgB,EAAC,CAAC;gBACjD,OAAO,MAAM,CAAC;aACf;YAED,IAAI;gBACF,MAAM,IAAA,oBAAa,EAAC,IAAI,EAAE,gBAAgB,EAAE,SAAS,CAAC,CAAC;aACxD;YAAC,OAAO,CAAC,EAAE;gBACV,MAAM,GAAG,GAAG,CAA0B,CAAC;gBACvC,iDAAiD;gBACjD,IAAI,GAAG,CAAC,IAAI,KAAK,eAAe,EAAE;oBAChC,MAAM,IAAI,qBAAa,CACrB,GAAG,YAAY,yEAAyE,KAAK,EAAE,CAChG,CAAC;iBACH;gBACD,MAAM,IAAI,qBAAa,CAAC,sBAAsB,YAAY,aAAa,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC;aACvF;SACF;aAAM;YACL,GAAG,CAAC,IAAI,CAAC,kBAAkB,EAAE,YAAY,CAAC,CAAC;SAC5C;QACD,GAAG,CAAC,OAAO,CAAC,gBAAgB,EAAE,WAAW,CAAC,CAAC;QAC3C,OAAO,EAAC,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,gBAAgB,EAAC,CAAC;IACjD,CAAC,CAAC;AACJ,CAAC;AA9ED,gDA8EC"}
|
package/build/lib/io.d.ts
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
//# sourceMappingURL=io.d.ts.map
|
package/build/lib/io.d.ts.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"io.d.ts","sourceRoot":"","sources":["../../lib/io.ts"],"names":[],"mappings":""}
|
package/build/lib/io.js
DELETED
package/build/lib/io.js.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"io.js","sourceRoot":"","sources":["../../lib/io.ts"],"names":[],"mappings":""}
|
package/build/lib/mkdocs.d.ts
DELETED
|
@@ -1,58 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Functions for running `mkdocs`
|
|
3
|
-
*
|
|
4
|
-
* @module
|
|
5
|
-
*/
|
|
6
|
-
import { SubProcess, TeenProcessExecOptions } from 'teen_process';
|
|
7
|
-
import { TupleToObject } from './util';
|
|
8
|
-
/**
|
|
9
|
-
* Runs `mkdocs build` or `mkdocs serve`
|
|
10
|
-
* @param opts
|
|
11
|
-
*/
|
|
12
|
-
export declare function buildMkDocs({ mkdocsYml: mkdocsYmlPath, siteDir, theme, cwd, serve, serveOpts, execOpts, }?: BuildMkDocsOpts): Promise<void>;
|
|
13
|
-
/**
|
|
14
|
-
* Options for {@linkcode buildMkDocs}.
|
|
15
|
-
*/
|
|
16
|
-
export interface BuildMkDocsOpts {
|
|
17
|
-
/**
|
|
18
|
-
* Path to `mkdocs.yml`
|
|
19
|
-
*/
|
|
20
|
-
mkdocsYml?: string;
|
|
21
|
-
/**
|
|
22
|
-
* Path to output directory
|
|
23
|
-
*/
|
|
24
|
-
siteDir?: string;
|
|
25
|
-
/**
|
|
26
|
-
* MkDocs theme to use
|
|
27
|
-
* @defaultValue 'mkdocs'
|
|
28
|
-
*/
|
|
29
|
-
theme?: string;
|
|
30
|
-
/**
|
|
31
|
-
* Current working directory
|
|
32
|
-
* @defaultValue `process.cwd()`
|
|
33
|
-
*/
|
|
34
|
-
cwd?: string;
|
|
35
|
-
/**
|
|
36
|
-
* Path to `package.json`
|
|
37
|
-
*
|
|
38
|
-
* Used to find `mkdocs.yml` if unspecified.
|
|
39
|
-
*/
|
|
40
|
-
packageJson?: string;
|
|
41
|
-
/**
|
|
42
|
-
* If `true`, run `mkdocs serve` instead of `mkdocs build`
|
|
43
|
-
*/
|
|
44
|
-
serve?: boolean;
|
|
45
|
-
/**
|
|
46
|
-
* Extra options for {@linkcode teen_process.exec}
|
|
47
|
-
*/
|
|
48
|
-
execOpts?: TeenProcessExecOptions;
|
|
49
|
-
/**
|
|
50
|
-
* Extra options for {@linkcode teen_process.Subprocess.start}
|
|
51
|
-
*/
|
|
52
|
-
serveOpts?: TeenProcessSubprocessStartOpts;
|
|
53
|
-
}
|
|
54
|
-
/**
|
|
55
|
-
* Conversion of the parameters of {@linkcode Subprocess.start} to an object.
|
|
56
|
-
*/
|
|
57
|
-
export declare type TeenProcessSubprocessStartOpts = Partial<TupleToObject<Parameters<SubProcess['start']>, ['startDetector', 'detach', 'timeoutMs']>>;
|
|
58
|
-
//# sourceMappingURL=mkdocs.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"mkdocs.d.ts","sourceRoot":"","sources":["../../lib/mkdocs.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAO,UAAU,EAAE,sBAAsB,EAAC,MAAM,cAAc,CAAC;AAItE,OAAO,EAAsB,aAAa,EAAC,MAAM,QAAQ,CAAC;AAyC1D;;;GAGG;AACH,wBAAsB,WAAW,CAAC,EAChC,SAAS,EAAE,aAAa,EACxB,OAAO,EACP,KAAmB,EACnB,GAAmB,EACnB,KAAa,EACb,SAAS,EACT,QAAQ,GACT,GAAE,eAAoB,iBA2BtB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,QAAQ,CAAC,EAAE,sBAAsB,CAAC;IAElC;;OAEG;IACH,SAAS,CAAC,EAAE,8BAA8B,CAAC;CAC5C;AAED;;GAEG;AACH,oBAAY,8BAA8B,GAAG,OAAO,CAClD,aAAa,CAAC,UAAU,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,eAAe,EAAE,QAAQ,EAAE,WAAW,CAAC,CAAC,CACzF,CAAC"}
|
package/build/lib/mkdocs.js
DELETED
|
@@ -1,77 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
/**
|
|
3
|
-
* Functions for running `mkdocs`
|
|
4
|
-
*
|
|
5
|
-
* @module
|
|
6
|
-
*/
|
|
7
|
-
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
8
|
-
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
9
|
-
};
|
|
10
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
11
|
-
exports.buildMkDocs = void 0;
|
|
12
|
-
const teen_process_1 = require("teen_process");
|
|
13
|
-
const constants_1 = require("./constants");
|
|
14
|
-
const fs_1 = require("./fs");
|
|
15
|
-
const logger_1 = __importDefault(require("./logger"));
|
|
16
|
-
const util_1 = require("./util");
|
|
17
|
-
const error_1 = require("./error");
|
|
18
|
-
const log = logger_1.default.withTag('mkdocs');
|
|
19
|
-
/**
|
|
20
|
-
* Runs `mkdocs serve`
|
|
21
|
-
* @param args Extra args to `mkdocs build`
|
|
22
|
-
* @param opts Extra options for `teen_process.Subprocess.start`
|
|
23
|
-
* @param mkDocsPath Path to `mkdocs` executable
|
|
24
|
-
*/
|
|
25
|
-
async function doServe(args = [], { startDetector, detach, timeoutMs } = {}, mkDocsPath) {
|
|
26
|
-
mkDocsPath = mkDocsPath ?? (await (0, fs_1.whichMkDocs)());
|
|
27
|
-
const finalArgs = ['serve', ...args];
|
|
28
|
-
log.debug('Launching %s with args: %O', mkDocsPath, finalArgs);
|
|
29
|
-
const proc = new teen_process_1.SubProcess(mkDocsPath, finalArgs);
|
|
30
|
-
return await proc.start(startDetector, detach, timeoutMs);
|
|
31
|
-
}
|
|
32
|
-
/**
|
|
33
|
-
* Runs `mkdocs build`
|
|
34
|
-
* @param args Extra args to `mkdocs build`
|
|
35
|
-
* @param opts Extra options to `teen_process.exec`
|
|
36
|
-
* @param mkDocsPath Path to `mkdocs` executable
|
|
37
|
-
*/
|
|
38
|
-
async function doBuild(args = [], opts = {}, mkDocsPath) {
|
|
39
|
-
mkDocsPath = mkDocsPath ?? (await (0, fs_1.whichMkDocs)());
|
|
40
|
-
const finalArgs = ['build', ...args];
|
|
41
|
-
log.debug('Launching %s with args: %O', mkDocsPath, finalArgs);
|
|
42
|
-
return await (0, teen_process_1.exec)(mkDocsPath, finalArgs, opts);
|
|
43
|
-
}
|
|
44
|
-
/**
|
|
45
|
-
* Runs `mkdocs build` or `mkdocs serve`
|
|
46
|
-
* @param opts
|
|
47
|
-
*/
|
|
48
|
-
async function buildMkDocs({ mkdocsYml: mkdocsYmlPath, siteDir, theme = constants_1.NAME_MKDOCS, cwd = process.cwd(), serve = false, serveOpts, execOpts, } = {}) {
|
|
49
|
-
const stop = (0, util_1.stopwatch)('build-mkdocs');
|
|
50
|
-
mkdocsYmlPath = mkdocsYmlPath ?? (await (0, fs_1.findMkDocsYml)(cwd));
|
|
51
|
-
if (!mkdocsYmlPath) {
|
|
52
|
-
throw new error_1.DocutilsError(`Could not find ${constants_1.NAME_MKDOCS_YML} from ${cwd}; run "${constants_1.NAME_BIN} init" to create it`);
|
|
53
|
-
}
|
|
54
|
-
const relativePath = (0, util_1.relative)(cwd);
|
|
55
|
-
const mkdocsArgs = ['-f', mkdocsYmlPath, '-t', theme];
|
|
56
|
-
if (siteDir) {
|
|
57
|
-
mkdocsArgs.push('-d', siteDir);
|
|
58
|
-
}
|
|
59
|
-
if (serve) {
|
|
60
|
-
// unsure about how SIGHUP is handled here
|
|
61
|
-
await doServe(mkdocsArgs, serveOpts);
|
|
62
|
-
}
|
|
63
|
-
else {
|
|
64
|
-
await doBuild(mkdocsArgs, execOpts);
|
|
65
|
-
let relSiteDir;
|
|
66
|
-
if (siteDir) {
|
|
67
|
-
relSiteDir = relativePath(siteDir);
|
|
68
|
-
}
|
|
69
|
-
else {
|
|
70
|
-
({ site_dir: siteDir } = await (0, fs_1.readYaml)(mkdocsYmlPath));
|
|
71
|
-
relSiteDir = relativePath(siteDir);
|
|
72
|
-
}
|
|
73
|
-
log.success('MkDocs finished building into %s (%dms)', relSiteDir, stop());
|
|
74
|
-
}
|
|
75
|
-
}
|
|
76
|
-
exports.buildMkDocs = buildMkDocs;
|
|
77
|
-
//# sourceMappingURL=mkdocs.js.map
|
package/build/lib/mkdocs.js.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"mkdocs.js","sourceRoot":"","sources":["../../lib/mkdocs.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;;;;;AAEH,+CAAsE;AACtE,2CAAmE;AACnE,6BAA0D;AAC1D,sDAA8B;AAC9B,iCAA0D;AAE1D,mCAAsC;AAEtC,MAAM,GAAG,GAAG,gBAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;AAErC;;;;;GAKG;AACH,KAAK,UAAU,OAAO,CACpB,OAAiB,EAAE,EACnB,EAAC,aAAa,EAAE,MAAM,EAAE,SAAS,KAAoC,EAAE,EACvE,UAAmB;IAEnB,UAAU,GAAG,UAAU,IAAI,CAAC,MAAM,IAAA,gBAAW,GAAE,CAAC,CAAC;IACjD,MAAM,SAAS,GAAG,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC;IACrC,GAAG,CAAC,KAAK,CAAC,4BAA4B,EAAE,UAAU,EAAE,SAAS,CAAC,CAAC;IAC/D,MAAM,IAAI,GAAG,IAAI,yBAAU,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;IACnD,OAAO,MAAM,IAAI,CAAC,KAAK,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC;AAC5D,CAAC;AAED;;;;;GAKG;AACH,KAAK,UAAU,OAAO,CACpB,OAAiB,EAAE,EACnB,OAA+B,EAAE,EACjC,UAAmB;IAEnB,UAAU,GAAG,UAAU,IAAI,CAAC,MAAM,IAAA,gBAAW,GAAE,CAAC,CAAC;IACjD,MAAM,SAAS,GAAG,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC;IACrC,GAAG,CAAC,KAAK,CAAC,4BAA4B,EAAE,UAAU,EAAE,SAAS,CAAC,CAAC;IAC/D,OAAO,MAAM,IAAA,mBAAI,EAAC,UAAU,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;AACjD,CAAC;AAED;;;GAGG;AACI,KAAK,UAAU,WAAW,CAAC,EAChC,SAAS,EAAE,aAAa,EACxB,OAAO,EACP,KAAK,GAAG,uBAAW,EACnB,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE,EACnB,KAAK,GAAG,KAAK,EACb,SAAS,EACT,QAAQ,MACW,EAAE;IACrB,MAAM,IAAI,GAAG,IAAA,gBAAS,EAAC,cAAc,CAAC,CAAC;IACvC,aAAa,GAAG,aAAa,IAAI,CAAC,MAAM,IAAA,kBAAa,EAAC,GAAG,CAAC,CAAC,CAAC;IAC5D,IAAI,CAAC,aAAa,EAAE;QAClB,MAAM,IAAI,qBAAa,CACrB,kBAAkB,2BAAe,SAAS,GAAG,UAAU,oBAAQ,qBAAqB,CACrF,CAAC;KACH;IACD,MAAM,YAAY,GAAG,IAAA,eAAQ,EAAC,GAAG,CAAC,CAAC;IACnC,MAAM,UAAU,GAAG,CAAC,IAAI,EAAE,aAAa,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;IACtD,IAAI,OAAO,EAAE;QACX,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;KAChC;IACD,IAAI,KAAK,EAAE;QACT,0CAA0C;QAC1C,MAAM,OAAO,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;KACtC;SAAM;QACL,MAAM,OAAO,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;QACpC,IAAI,UAAU,CAAC;QACf,IAAI,OAAO,EAAE;YACX,UAAU,GAAG,YAAY,CAAC,OAAO,CAAC,CAAC;SACpC;aAAM;YACL,CAAC,EAAC,QAAQ,EAAE,OAAO,EAAC,GAAG,MAAM,IAAA,aAAQ,EAAC,aAAa,CAAC,CAAC,CAAC;YACtD,UAAU,GAAG,YAAY,CAAC,OAAQ,CAAC,CAAC;SACrC;QACD,GAAG,CAAC,OAAO,CAAC,yCAAyC,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,CAAC;KAC5E;AACH,CAAC;AAnCD,kCAmCC"}
|