@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/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"}
|
package/build/lib/nav.d.ts
DELETED
|
@@ -1,47 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Handles updating/adding the `nav` property of `mkdocs.yml`, based on the output of `typedoc`;
|
|
3
|
-
* specifically, the command documentation generated by `@appium/typedoc-plugin-appium`.
|
|
4
|
-
*
|
|
5
|
-
* @module
|
|
6
|
-
*/
|
|
7
|
-
/**
|
|
8
|
-
* Update the `nav` property of `mkdocs.yml` with a list of "command" files generated by TypeDoc via `@appium/typedoc-plugin-appium`
|
|
9
|
-
* @param opts - Options
|
|
10
|
-
* @todo implement `dryRun` option
|
|
11
|
-
*/
|
|
12
|
-
export declare function updateNav<S extends string>({ cwd, mkdocsYml: mkDocsYmlPath, referenceHeader, noReferenceHeader, typedocJson: typeDocJsonPath, dryRun, }?: UpdateNavOpts<S>): Promise<void>;
|
|
13
|
-
/**
|
|
14
|
-
* Options for {@linkcode updateNav}
|
|
15
|
-
*/
|
|
16
|
-
export interface UpdateNavOpts<S extends string> {
|
|
17
|
-
/**
|
|
18
|
-
* Current working directory
|
|
19
|
-
*/
|
|
20
|
-
cwd?: string;
|
|
21
|
-
/**
|
|
22
|
-
* Path to `mkdocs.yml`
|
|
23
|
-
*/
|
|
24
|
-
mkdocsYml?: string;
|
|
25
|
-
/**
|
|
26
|
-
* Path to `package.json`
|
|
27
|
-
*/
|
|
28
|
-
packageJson?: string;
|
|
29
|
-
/**
|
|
30
|
-
* The name of the header in `nav` to use for reference docs.
|
|
31
|
-
*/
|
|
32
|
-
referenceHeader?: S;
|
|
33
|
-
/**
|
|
34
|
-
* If `true`, do not add a reference header to `nav` if one does not exist
|
|
35
|
-
*/
|
|
36
|
-
noReferenceHeader?: boolean;
|
|
37
|
-
/**
|
|
38
|
-
* Path to `typedoc.json`
|
|
39
|
-
*/
|
|
40
|
-
typedocJson?: string;
|
|
41
|
-
/**
|
|
42
|
-
* If `true`, do not write any files
|
|
43
|
-
* @remarks Not yet implemented
|
|
44
|
-
*/
|
|
45
|
-
dryRun?: boolean;
|
|
46
|
-
}
|
|
47
|
-
//# sourceMappingURL=nav.d.ts.map
|
package/build/lib/nav.d.ts.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"nav.d.ts","sourceRoot":"","sources":["../../lib/nav.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AA4BH;;;;GAIG;AACH,wBAAsB,SAAS,CAAC,CAAC,SAAS,MAAM,EAAE,EAChD,GAAmB,EACnB,SAAS,EAAE,aAAa,EACxB,eAA6C,EAC7C,iBAAyB,EACzB,WAAW,EAAE,eAAe,EAC5B,MAAc,GACf,GAAE,aAAa,CAAC,CAAC,CAAM,iBA2HvB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa,CAAC,CAAC,SAAS,MAAM;IAC7C;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,eAAe,CAAC,EAAE,CAAC,CAAC;IACpB;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB"}
|
package/build/lib/nav.js
DELETED
|
@@ -1,132 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
/**
|
|
3
|
-
* Handles updating/adding the `nav` property of `mkdocs.yml`, based on the output of `typedoc`;
|
|
4
|
-
* specifically, the command documentation generated by `@appium/typedoc-plugin-appium`.
|
|
5
|
-
*
|
|
6
|
-
* @module
|
|
7
|
-
*/
|
|
8
|
-
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
9
|
-
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
10
|
-
};
|
|
11
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
12
|
-
exports.updateNav = void 0;
|
|
13
|
-
const support_1 = require("@appium/support");
|
|
14
|
-
const lodash_1 = __importDefault(require("lodash"));
|
|
15
|
-
const node_path_1 = __importDefault(require("node:path"));
|
|
16
|
-
const constants_1 = require("./constants");
|
|
17
|
-
const error_1 = require("./error");
|
|
18
|
-
const fs_1 = require("./fs");
|
|
19
|
-
const logger_1 = __importDefault(require("./logger"));
|
|
20
|
-
const util_1 = require("./util");
|
|
21
|
-
const DEFAULT_REFERENCE_HEADER = 'Reference';
|
|
22
|
-
const log = logger_1.default.withTag('mkdocs-nav');
|
|
23
|
-
/**
|
|
24
|
-
* Update the `nav` property of `mkdocs.yml` with a list of "command" files generated by TypeDoc via `@appium/typedoc-plugin-appium`
|
|
25
|
-
* @param opts - Options
|
|
26
|
-
* @todo implement `dryRun` option
|
|
27
|
-
*/
|
|
28
|
-
async function updateNav({ cwd = process.cwd(), mkdocsYml: mkDocsYmlPath, referenceHeader = DEFAULT_REFERENCE_HEADER, noReferenceHeader = false, typedocJson: typeDocJsonPath, dryRun = false, } = {}) {
|
|
29
|
-
[mkDocsYmlPath, typeDocJsonPath] = await Promise.all([
|
|
30
|
-
mkDocsYmlPath ?? (0, fs_1.findMkDocsYml)(cwd),
|
|
31
|
-
typeDocJsonPath ?? (0, fs_1.findTypeDocJsonPath)(cwd),
|
|
32
|
-
]);
|
|
33
|
-
if (!mkDocsYmlPath) {
|
|
34
|
-
throw new error_1.DocutilsError(`Could not find ${constants_1.NAME_MKDOCS_YML} from ${cwd}; run "${constants_1.NAME_BIN} init" to create it`);
|
|
35
|
-
}
|
|
36
|
-
if (!typeDocJsonPath) {
|
|
37
|
-
throw new error_1.DocutilsError(`Could not find ${constants_1.NAME_TYPEDOC_JSON} from ${cwd}; run "${constants_1.NAME_BIN} init" to create it`);
|
|
38
|
-
}
|
|
39
|
-
const relativePath = (0, util_1.relative)(cwd);
|
|
40
|
-
const relMkDocsYmlPath = relativePath(mkDocsYmlPath);
|
|
41
|
-
const typeDocJson = (0, fs_1.readTypedocJson)(typeDocJsonPath);
|
|
42
|
-
const mkDocsYml = (await (0, fs_1.readYaml)(mkDocsYmlPath));
|
|
43
|
-
const findRefDictIndex = lodash_1.default.partial(lodash_1.default.findIndex, lodash_1.default, lodash_1.default.overEvery([lodash_1.default.isObject, lodash_1.default.partial(lodash_1.default.has, lodash_1.default, referenceHeader)]));
|
|
44
|
-
/**
|
|
45
|
-
* Absolute path to `typedoc.json`
|
|
46
|
-
*/
|
|
47
|
-
const absTypeDocJsonPath = node_path_1.default.isAbsolute(typeDocJsonPath)
|
|
48
|
-
? typeDocJsonPath
|
|
49
|
-
: node_path_1.default.resolve(cwd, typeDocJsonPath);
|
|
50
|
-
/**
|
|
51
|
-
* Absolute path to TypeDoc's output directory (`out`)
|
|
52
|
-
*/
|
|
53
|
-
const typeDocOutDir = node_path_1.default.resolve(node_path_1.default.dirname(absTypeDocJsonPath), typeDocJson.out ? typeDocJson.out : constants_1.DEFAULT_REL_TYPEDOC_OUT_PATH);
|
|
54
|
-
/**
|
|
55
|
-
* Absolute path to `mkdocs.yml`
|
|
56
|
-
*/
|
|
57
|
-
const absMkdocsYmlPath = node_path_1.default.isAbsolute(mkDocsYmlPath)
|
|
58
|
-
? mkDocsYmlPath
|
|
59
|
-
: node_path_1.default.resolve(cwd, mkDocsYmlPath);
|
|
60
|
-
const { docs_dir: docsDir, nav = [] } = mkDocsYml;
|
|
61
|
-
/**
|
|
62
|
-
* Absolute path to the directory containing MkDocs input docs
|
|
63
|
-
*/
|
|
64
|
-
const mkDocsDocsDir = node_path_1.default.resolve(node_path_1.default.dirname(absMkdocsYmlPath), docsDir ?? 'docs');
|
|
65
|
-
/**
|
|
66
|
-
* The dir we need to prepend to all entries within `nav`
|
|
67
|
-
*/
|
|
68
|
-
const relReferenceDir = node_path_1.default.relative(mkDocsDocsDir, typeDocOutDir);
|
|
69
|
-
const partitionRefArray = lodash_1.default.partialRight(lodash_1.default.partition, lodash_1.default.partialRight(lodash_1.default.startsWith, `${relReferenceDir}/`));
|
|
70
|
-
const newRefFilepaths = [];
|
|
71
|
-
// TODO: this doesn't respect the 'commandsDir' option for typedoc-plugin-appium. in fact,
|
|
72
|
-
// typeDocJson does not even include it, because it's unknown. I suppose that will mean we need
|
|
73
|
-
// to load plugins, but that means bootstrapping TypeDoc entirely just to read a `typedoc.json`
|
|
74
|
-
// file, which is slow.
|
|
75
|
-
const commandDir = node_path_1.default.join(typeDocOutDir, 'commands');
|
|
76
|
-
const relCommandDir = node_path_1.default.relative(mkDocsDocsDir, commandDir);
|
|
77
|
-
const commandDocFileEnts = await support_1.fs.readdir(commandDir, { withFileTypes: true });
|
|
78
|
-
if (!commandDocFileEnts.length) {
|
|
79
|
-
log.warn('No reference API docs were found in %s; skipping navigation update', commandDir);
|
|
80
|
-
return;
|
|
81
|
-
}
|
|
82
|
-
for (const ent of commandDocFileEnts) {
|
|
83
|
-
if (ent.isFile() && ent.name.endsWith('.md')) {
|
|
84
|
-
newRefFilepaths.push(node_path_1.default.join(relCommandDir, ent.name));
|
|
85
|
-
}
|
|
86
|
-
}
|
|
87
|
-
log.debug('New reference filepaths: %O', newRefFilepaths);
|
|
88
|
-
const navUsesHeaders = noReferenceHeader || !(0, util_1.isStringArray)(nav);
|
|
89
|
-
let shouldWriteMkDocsYml = false;
|
|
90
|
-
let refFilepaths;
|
|
91
|
-
let nonRefFilepaths;
|
|
92
|
-
const refDictIdx = findRefDictIndex(nav);
|
|
93
|
-
if (refDictIdx >= 0) {
|
|
94
|
-
const refDict = nav[refDictIdx];
|
|
95
|
-
const refArray = refDict[referenceHeader];
|
|
96
|
-
[refFilepaths, nonRefFilepaths] = partitionRefArray(refArray);
|
|
97
|
-
}
|
|
98
|
-
else {
|
|
99
|
-
[refFilepaths, nonRefFilepaths] = partitionRefArray(nav);
|
|
100
|
-
}
|
|
101
|
-
const symmetricDiff = lodash_1.default.xor(newRefFilepaths, refFilepaths);
|
|
102
|
-
if (symmetricDiff.length) {
|
|
103
|
-
log.debug('Difference in old nav vs new: %O', symmetricDiff);
|
|
104
|
-
shouldWriteMkDocsYml = true;
|
|
105
|
-
if (navUsesHeaders) {
|
|
106
|
-
if (refDictIdx >= 0) {
|
|
107
|
-
const res = [...nonRefFilepaths, ...newRefFilepaths];
|
|
108
|
-
mkDocsYml.nav[refDictIdx][referenceHeader] = res;
|
|
109
|
-
log.debug('Replaced "%s" section with %O', referenceHeader, res);
|
|
110
|
-
}
|
|
111
|
-
else {
|
|
112
|
-
mkDocsYml.nav = [...nonRefFilepaths, { [referenceHeader]: newRefFilepaths }];
|
|
113
|
-
log.debug('Added "%s" section with %O', referenceHeader, newRefFilepaths);
|
|
114
|
-
}
|
|
115
|
-
}
|
|
116
|
-
else {
|
|
117
|
-
mkDocsYml.nav = [...nonRefFilepaths, ...newRefFilepaths];
|
|
118
|
-
log.debug('Replaced nav with %O', mkDocsYml.nav);
|
|
119
|
-
}
|
|
120
|
-
}
|
|
121
|
-
if (shouldWriteMkDocsYml) {
|
|
122
|
-
const yaml = (0, fs_1.stringifyYaml)(mkDocsYml);
|
|
123
|
-
log.debug(yaml);
|
|
124
|
-
await (0, fs_1.safeWriteFile)(mkDocsYmlPath, yaml, true);
|
|
125
|
-
log.success('Updated navigation for reference documents in %s', relMkDocsYmlPath);
|
|
126
|
-
}
|
|
127
|
-
else {
|
|
128
|
-
log.info('No changes to navigation for reference documents in %s', relMkDocsYmlPath);
|
|
129
|
-
}
|
|
130
|
-
}
|
|
131
|
-
exports.updateNav = updateNav;
|
|
132
|
-
//# sourceMappingURL=nav.js.map
|
package/build/lib/nav.js.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"nav.js","sourceRoot":"","sources":["../../lib/nav.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;;;AAEH,6CAAmC;AACnC,oDAAuB;AACvB,0DAA6B;AAC7B,2CAKqB;AACrB,mCAAsC;AACtC,6BAOc;AACd,sDAA8B;AAE9B,iCAA+C;AAE/C,MAAM,wBAAwB,GAAG,WAAW,CAAC;AAE7C,MAAM,GAAG,GAAG,gBAAM,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;AAEzC;;;;GAIG;AACI,KAAK,UAAU,SAAS,CAAmB,EAChD,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE,EACnB,SAAS,EAAE,aAAa,EACxB,eAAe,GAAM,wBAAwB,EAC7C,iBAAiB,GAAG,KAAK,EACzB,WAAW,EAAE,eAAe,EAC5B,MAAM,GAAG,KAAK,MACM,EAAE;IACtB,CAAC,aAAa,EAAE,eAAe,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;QACnD,aAAa,IAAI,IAAA,kBAAa,EAAC,GAAG,CAAC;QACnC,eAAe,IAAI,IAAA,wBAAmB,EAAC,GAAG,CAAC;KAC5C,CAAC,CAAC;IACH,IAAI,CAAC,aAAa,EAAE;QAClB,MAAM,IAAI,qBAAa,CACrB,kBAAkB,2BAAe,SAAS,GAAG,WAAW,oBAAQ,qBAAqB,CACtF,CAAC;KACH;IACD,IAAI,CAAC,eAAe,EAAE;QACpB,MAAM,IAAI,qBAAa,CACrB,kBAAkB,6BAAiB,SAAS,GAAG,WAAW,oBAAQ,qBAAqB,CACxF,CAAC;KACH;IACD,MAAM,YAAY,GAAG,IAAA,eAAQ,EAAC,GAAG,CAAC,CAAC;IACnC,MAAM,gBAAgB,GAAG,YAAY,CAAC,aAAa,CAAC,CAAC;IACrD,MAAM,WAAW,GAAG,IAAA,oBAAe,EAAC,eAAe,CAAC,CAAC;IACrD,MAAM,SAAS,GAAG,CAAC,MAAM,IAAA,aAAQ,EAAC,aAAa,CAAC,CAAc,CAAC;IAC/D,MAAM,gBAAgB,GAAsC,gBAAC,CAAC,OAAO,CACnE,gBAAC,CAAC,SAAS,EACX,gBAAC,EACD,gBAAC,CAAC,SAAS,CAAC,CAAC,gBAAC,CAAC,QAAQ,EAAE,gBAAC,CAAC,OAAO,CAAC,gBAAC,CAAC,GAAG,EAAE,gBAAC,EAAE,eAAe,CAAC,CAAC,CAAC,CAChE,CAAC;IAEF;;OAEG;IACH,MAAM,kBAAkB,GAAG,mBAAI,CAAC,UAAU,CAAC,eAAe,CAAC;QACzD,CAAC,CAAC,eAAe;QACjB,CAAC,CAAC,mBAAI,CAAC,OAAO,CAAC,GAAG,EAAE,eAAe,CAAC,CAAC;IAEvC;;OAEG;IACH,MAAM,aAAa,GAAG,mBAAI,CAAC,OAAO,CAChC,mBAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC,EAChC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,wCAA4B,CACjE,CAAC;IAEF;;OAEG;IACH,MAAM,gBAAgB,GAAG,mBAAI,CAAC,UAAU,CAAC,aAAa,CAAC;QACrD,CAAC,CAAC,aAAa;QACf,CAAC,CAAC,mBAAI,CAAC,OAAO,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;IAErC,MAAM,EAAC,QAAQ,EAAE,OAAO,EAAE,GAAG,GAAG,EAAE,EAAC,GAAG,SAAS,CAAC;IAChD;;OAEG;IACH,MAAM,aAAa,GAAG,mBAAI,CAAC,OAAO,CAAC,mBAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,EAAE,OAAO,IAAI,MAAM,CAAC,CAAC;IAEtF;;OAEG;IACH,MAAM,eAAe,GAAG,mBAAI,CAAC,QAAQ,CAAC,aAAa,EAAE,aAAa,CAAC,CAAC;IAEpE,MAAM,iBAAiB,GACrB,gBAAC,CAAC,YAAY,CAAC,gBAAC,CAAC,SAAS,EAAE,gBAAC,CAAC,YAAY,CAAC,gBAAC,CAAC,UAAU,EAAE,GAAG,eAAe,GAAG,CAAC,CAAC,CAAC;IAEnF,MAAM,eAAe,GAAa,EAAE,CAAC;IAErC,2FAA2F;IAC3F,gGAAgG;IAChG,+FAA+F;IAC/F,uBAAuB;IACvB,MAAM,UAAU,GAAG,mBAAI,CAAC,IAAI,CAAC,aAAa,EAAE,UAAU,CAAC,CAAC;IACxD,MAAM,aAAa,GAAG,mBAAI,CAAC,QAAQ,CAAC,aAAa,EAAE,UAAU,CAAC,CAAC;IAC/D,MAAM,kBAAkB,GAAG,MAAM,YAAE,CAAC,OAAO,CAAC,UAAU,EAAE,EAAC,aAAa,EAAE,IAAI,EAAC,CAAC,CAAC;IAC/E,IAAI,CAAC,kBAAkB,CAAC,MAAM,EAAE;QAC9B,GAAG,CAAC,IAAI,CAAC,oEAAoE,EAAE,UAAU,CAAC,CAAC;QAC3F,OAAO;KACR;IACD,KAAK,MAAM,GAAG,IAAI,kBAAkB,EAAE;QACpC,IAAI,GAAG,CAAC,MAAM,EAAE,IAAI,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE;YAC5C,eAAe,CAAC,IAAI,CAAC,mBAAI,CAAC,IAAI,CAAC,aAAa,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;SAC1D;KACF;IAED,GAAG,CAAC,KAAK,CAAC,6BAA6B,EAAE,eAAe,CAAC,CAAC;IAE1D,MAAM,cAAc,GAAG,iBAAiB,IAAI,CAAC,IAAA,oBAAa,EAAC,GAAG,CAAC,CAAC;IAChE,IAAI,oBAAoB,GAAG,KAAK,CAAC;IACjC,IAAI,YAAsB,CAAC;IAC3B,IAAI,eAAyB,CAAC;IAE9B,MAAM,UAAU,GAAG,gBAAgB,CAAC,GAAG,CAAC,CAAC;IACzC,IAAI,UAAU,IAAI,CAAC,EAAE;QACnB,MAAM,OAAO,GAAG,GAAG,CAAC,UAAU,CAAwB,CAAC;QACvD,MAAM,QAAQ,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;QAC1C,CAAC,YAAY,EAAE,eAAe,CAAC,GAAG,iBAAiB,CAAC,QAAQ,CAAC,CAAC;KAC/D;SAAM;QACL,CAAC,YAAY,EAAE,eAAe,CAAC,GAAG,iBAAiB,CAAW,GAAG,CAAC,CAAC;KACpE;IAED,MAAM,aAAa,GAAG,gBAAC,CAAC,GAAG,CAAC,eAAe,EAAE,YAAY,CAAC,CAAC;IAC3D,IAAI,aAAa,CAAC,MAAM,EAAE;QACxB,GAAG,CAAC,KAAK,CAAC,kCAAkC,EAAE,aAAa,CAAC,CAAC;QAC7D,oBAAoB,GAAG,IAAI,CAAC;QAC5B,IAAI,cAAc,EAAE;YAClB,IAAI,UAAU,IAAI,CAAC,EAAE;gBACnB,MAAM,GAAG,GAAG,CAAC,GAAG,eAAe,EAAE,GAAG,eAAe,CAAC,CAAC;gBACpD,SAAS,CAAC,GAAI,CAAC,UAAU,CAAyB,CAAC,eAAe,CAAC,GAAG,GAAG,CAAC;gBAC3E,GAAG,CAAC,KAAK,CAAC,+BAA+B,EAAE,eAAe,EAAE,GAAG,CAAC,CAAC;aAClE;iBAAM;gBACL,SAAS,CAAC,GAAG,GAAG,CAAC,GAAG,eAAe,EAAE,EAAC,CAAC,eAAe,CAAC,EAAE,eAAe,EAAC,CAAC,CAAC;gBAC3E,GAAG,CAAC,KAAK,CAAC,4BAA4B,EAAE,eAAe,EAAE,eAAe,CAAC,CAAC;aAC3E;SACF;aAAM;YACL,SAAS,CAAC,GAAG,GAAG,CAAC,GAAG,eAAe,EAAE,GAAG,eAAe,CAAC,CAAC;YACzD,GAAG,CAAC,KAAK,CAAC,sBAAsB,EAAE,SAAS,CAAC,GAAG,CAAC,CAAC;SAClD;KACF;IAED,IAAI,oBAAoB,EAAE;QACxB,MAAM,IAAI,GAAG,IAAA,kBAAa,EAAC,SAAS,CAAC,CAAC;QACtC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAChB,MAAM,IAAA,kBAAa,EAAC,aAAa,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;QAC/C,GAAG,CAAC,OAAO,CAAC,kDAAkD,EAAE,gBAAgB,CAAC,CAAC;KACnF;SAAM;QACL,GAAG,CAAC,IAAI,CAAC,wDAAwD,EAAE,gBAAgB,CAAC,CAAC;KACtF;AACH,CAAC;AAlID,8BAkIC"}
|
package/build/lib/test.d.ts
DELETED
package/build/lib/test.d.ts.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"test.d.ts","sourceRoot":"","sources":["../../lib/test.ts"],"names":[],"mappings":"AAAA,kBAAU,IAAI,CAAC;IACb,UAAiB,QAAQ;QACvB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,UAAU,EAAE,MAAM,CAAC;KACpB;CACF"}
|
package/build/lib/test.js
DELETED
package/build/lib/test.js.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"test.js","sourceRoot":"","sources":["../../lib/test.ts"],"names":[],"mappings":""}
|
package/build/lib/typedoc.d.ts
DELETED
|
@@ -1,55 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Runs TypeDoc
|
|
3
|
-
*
|
|
4
|
-
* @module
|
|
5
|
-
*/
|
|
6
|
-
/**
|
|
7
|
-
* Executes TypeDoc _in the current process_
|
|
8
|
-
*
|
|
9
|
-
* Monkeypatches TypeDoc's homebrew "glob" implementation because it is broken
|
|
10
|
-
* @param pkgRoot - Package root path
|
|
11
|
-
* @param opts - TypeDoc options
|
|
12
|
-
*/
|
|
13
|
-
export declare function runTypedoc(pkgRoot: string, opts: Record<string, string>): Promise<void>;
|
|
14
|
-
/**
|
|
15
|
-
* Options for {@linkcode buildReference}
|
|
16
|
-
*/
|
|
17
|
-
export interface BuildReferenceOptions {
|
|
18
|
-
/**
|
|
19
|
-
* Path to `typedoc.json`
|
|
20
|
-
*/
|
|
21
|
-
typedocJson?: string;
|
|
22
|
-
/**
|
|
23
|
-
* Current working directory
|
|
24
|
-
*/
|
|
25
|
-
cwd?: string;
|
|
26
|
-
/**
|
|
27
|
-
* Path to `package.json`
|
|
28
|
-
*/
|
|
29
|
-
packageJson?: string;
|
|
30
|
-
/**
|
|
31
|
-
* Path to `tsconfig.json`
|
|
32
|
-
*/
|
|
33
|
-
tsconfigJson?: string;
|
|
34
|
-
/**
|
|
35
|
-
* "Title" for generated docs; this corresponds to {@linkcode typedoc.TypeDocOptionMap.name}
|
|
36
|
-
*/
|
|
37
|
-
title?: string;
|
|
38
|
-
/**
|
|
39
|
-
* This is here because we pass it thru to TypeDoc
|
|
40
|
-
*/
|
|
41
|
-
logLevel?: LogLevelName;
|
|
42
|
-
}
|
|
43
|
-
/**
|
|
44
|
-
* Log level names as supported by this package
|
|
45
|
-
*
|
|
46
|
-
* Used to convert our log level to TypeDoc's
|
|
47
|
-
*/
|
|
48
|
-
declare type LogLevelName = 'debug' | 'info' | 'error' | 'warn';
|
|
49
|
-
/**
|
|
50
|
-
* Build reference documentation via TypeDoc
|
|
51
|
-
* @param opts - Options
|
|
52
|
-
*/
|
|
53
|
-
export declare function buildReference({ typedocJson: typeDocJsonPath, cwd, tsconfigJson: tsconfig, logLevel, title, }?: BuildReferenceOptions): Promise<void>;
|
|
54
|
-
export {};
|
|
55
|
-
//# sourceMappingURL=typedoc.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"typedoc.d.ts","sourceRoot":"","sources":["../../lib/typedoc.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AA+CH;;;;;;GAMG;AACH,wBAAsB,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,iBAkB7E;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,QAAQ,CAAC,EAAE,YAAY,CAAC;CACzB;AAED;;;;GAIG;AACH,aAAK,YAAY,GAAG,OAAO,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,CAAC;AAexD;;;GAGG;AACH,wBAAsB,cAAc,CAAC,EACnC,WAAW,EAAE,eAAe,EAC5B,GAAmB,EACnB,YAAY,EAAE,QAAQ,EACtB,QAA4B,EAC5B,KAAK,GACN,GAAE,qBAA0B,iBAwD5B"}
|