@appium/docutils 2.1.1 → 2.2.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/base-mkdocs.yml +3 -0
- package/build/lib/cli/config.js +35 -2
- package/build/lib/cli/config.js.map +1 -1
- package/build/lib/fs.js +36 -3
- package/build/lib/fs.js.map +1 -1
- package/build/lib/init.js +35 -5
- package/build/lib/init.js.map +1 -1
- package/build/test/e2e/build.e2e.spec.d.ts +6 -0
- package/build/test/e2e/build.e2e.spec.d.ts.map +1 -0
- package/build/test/e2e/build.e2e.spec.js +313 -0
- package/build/test/e2e/build.e2e.spec.js.map +1 -0
- package/build/test/unit/util.spec.d.ts +2 -0
- package/build/test/unit/util.spec.d.ts.map +1 -0
- package/build/test/unit/util.spec.js +79 -0
- package/build/test/unit/util.spec.js.map +1 -0
- package/lib/cli/config.ts +1 -1
- package/lib/fs.ts +1 -1
- package/lib/init.ts +1 -1
- package/package.json +8 -8
- package/requirements.txt +2 -2
- package/tsconfig.json +2 -1
package/base-mkdocs.yml
CHANGED
|
@@ -75,8 +75,11 @@ theme:
|
|
|
75
75
|
- content.action.edit
|
|
76
76
|
- content.code.annotate
|
|
77
77
|
- content.code.copy
|
|
78
|
+
- content.footnote.tooltips
|
|
78
79
|
- content.tabs.link
|
|
80
|
+
- content.tooltips
|
|
79
81
|
- navigation.indexes
|
|
82
|
+
- navigation.path
|
|
80
83
|
- navigation.sections
|
|
81
84
|
- navigation.tabs
|
|
82
85
|
- navigation.top
|
package/build/lib/cli/config.js
CHANGED
|
@@ -3,6 +3,39 @@
|
|
|
3
3
|
* Handles reading of a config file for docutils
|
|
4
4
|
* @module
|
|
5
5
|
*/
|
|
6
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
7
|
+
if (k2 === undefined) k2 = k;
|
|
8
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
9
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
10
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
11
|
+
}
|
|
12
|
+
Object.defineProperty(o, k2, desc);
|
|
13
|
+
}) : (function(o, m, k, k2) {
|
|
14
|
+
if (k2 === undefined) k2 = k;
|
|
15
|
+
o[k2] = m[k];
|
|
16
|
+
}));
|
|
17
|
+
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
18
|
+
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
19
|
+
}) : function(o, v) {
|
|
20
|
+
o["default"] = v;
|
|
21
|
+
});
|
|
22
|
+
var __importStar = (this && this.__importStar) || (function () {
|
|
23
|
+
var ownKeys = function(o) {
|
|
24
|
+
ownKeys = Object.getOwnPropertyNames || function (o) {
|
|
25
|
+
var ar = [];
|
|
26
|
+
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
|
|
27
|
+
return ar;
|
|
28
|
+
};
|
|
29
|
+
return ownKeys(o);
|
|
30
|
+
};
|
|
31
|
+
return function (mod) {
|
|
32
|
+
if (mod && mod.__esModule) return mod;
|
|
33
|
+
var result = {};
|
|
34
|
+
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
|
|
35
|
+
__setModuleDefault(result, mod);
|
|
36
|
+
return result;
|
|
37
|
+
};
|
|
38
|
+
})();
|
|
6
39
|
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
7
40
|
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
8
41
|
};
|
|
@@ -12,7 +45,7 @@ exports.loadConfig = loadConfig;
|
|
|
12
45
|
const lilconfig_1 = require("lilconfig");
|
|
13
46
|
const lodash_1 = __importDefault(require("lodash"));
|
|
14
47
|
const node_path_1 = __importDefault(require("node:path"));
|
|
15
|
-
const
|
|
48
|
+
const YAML = __importStar(require("yaml"));
|
|
16
49
|
const yargs_parser_1 = __importDefault(require("yargs-parser"));
|
|
17
50
|
const helpers_1 = require("yargs/helpers");
|
|
18
51
|
const constants_1 = require("../constants");
|
|
@@ -22,7 +55,7 @@ const log = (0, logger_1.getLogger)('config');
|
|
|
22
55
|
/**
|
|
23
56
|
* `lilconfig` loader for YAML
|
|
24
57
|
*/
|
|
25
|
-
const loadYaml = lodash_1.default.rearg(
|
|
58
|
+
const loadYaml = lodash_1.default.rearg(YAML.parse, [2, 0, 1]);
|
|
26
59
|
/**
|
|
27
60
|
* Controls how we load/find a config file.
|
|
28
61
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"config.js","sourceRoot":"","sources":["../../../lib/cli/config.ts"],"names":[],"mappings":";AAAA;;;GAGG
|
|
1
|
+
{"version":3,"file":"config.js","sourceRoot":"","sources":["../../../lib/cli/config.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkCH,gCAqBC;AAQD,gCAwBC;AArFD,yCAA4C;AAC5C,oDAAuB;AACvB,0DAA6B;AAC7B,2CAA6B;AAC7B,gEAAkC;AAClC,2CAAsC;AACtC,4CAAsE;AACtE,sCAAkE;AAClE,kCAAiC;AAEjC,MAAM,GAAG,GAAG,IAAA,kBAAS,EAAC,QAAQ,CAAC,CAAC;AAEhC;;GAEG;AACH,MAAM,QAAQ,GAAW,gBAAC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AAExD;;;;;;;;;;;;;;GAcG;AACI,KAAK,UAAU,UAAU,CAAC,OAAiB,IAAA,iBAAO,EAAC,OAAO,CAAC,IAAI,CAAC;IACrE,MAAM,OAAO,GAAG,IAAA,sBAAM,EAAC,IAAI,CAAC,CAAC;IAE7B,oDAAoD;IACpD,4CAA4C;IAC5C,IAAI,QAAkC,CAAC;IACvC,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;QACpB,QAAQ,GAAG,OAAO,CAAC;IACrB,CAAC;SAAM,CAAC;QACN,8DAA8D;QAC9D,QAAQ,GAAG,IAAA,yBAAgB,EAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,6BAAiB,CAAC;IACvF,CAAC;IACD,IAAA,mBAAU,EAAC,QAAQ,CAAC,CAAC;IAErB,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;QACrB,GAAG,CAAC,KAAK,CAAC,qDAAqD,CAAC,CAAC;IACnE,CAAC;IAED,OAAO,OAAO,CAAC,QAAQ,IAAI,OAAO,CAAC,IAAI,IAAI,OAAO,CAAC,OAAO;QACxD,CAAC,CAAC,EAAE;QACJ,CAAC,CAAC,MAAM,UAAU,CAAC,OAAO,CAAC,MAA4B,CAAC,CAAC;AAC7D,CAAC;AAED;;;;;GAKG;AACI,KAAK,UAAU,UAAU,CAAC,QAAiB,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE;IACrE,MAAM,YAAY,GAAG,IAAA,eAAQ,EAAC,GAAG,CAAC,CAAC;IACnC,MAAM,QAAQ,GAAG,IAAA,qBAAS,EAAC,oBAAQ,EAAE;QACnC,OAAO,EAAE;YACP,OAAO,EAAE,QAAQ;YACjB,MAAM,EAAE,QAAQ;SACjB;KACF,CAAC,CAAC;IAEH,MAAM,MAAM,GAAG,QAAQ;QACrB,CAAC,CAAC,MAAM,QAAQ,CAAC,IAAI,CAAC,mBAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;QAC/C,CAAC,CAAC,MAAM,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IAC/B,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;QACpB,GAAG,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;QAC7B,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;QACnB,GAAG,CAAC,KAAK,CAAC,sCAAsC,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC;QACnE,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,MAAM,WAAW,GAAG,YAAY,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAClD,GAAG,CAAC,OAAO,CAAC,uBAAuB,EAAE,WAAW,CAAC,CAAC;IAClD,GAAG,CAAC,KAAK,CAAC,qBAAqB,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;IAChD,OAAO,MAAM,CAAC,MAAM,CAAC;AACvB,CAAC"}
|
package/build/lib/fs.js
CHANGED
|
@@ -3,6 +3,39 @@
|
|
|
3
3
|
* Functions which touch the filesystem
|
|
4
4
|
* @module
|
|
5
5
|
*/
|
|
6
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
7
|
+
if (k2 === undefined) k2 = k;
|
|
8
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
9
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
10
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
11
|
+
}
|
|
12
|
+
Object.defineProperty(o, k2, desc);
|
|
13
|
+
}) : (function(o, m, k, k2) {
|
|
14
|
+
if (k2 === undefined) k2 = k;
|
|
15
|
+
o[k2] = m[k];
|
|
16
|
+
}));
|
|
17
|
+
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
18
|
+
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
19
|
+
}) : function(o, v) {
|
|
20
|
+
o["default"] = v;
|
|
21
|
+
});
|
|
22
|
+
var __importStar = (this && this.__importStar) || (function () {
|
|
23
|
+
var ownKeys = function(o) {
|
|
24
|
+
ownKeys = Object.getOwnPropertyNames || function (o) {
|
|
25
|
+
var ar = [];
|
|
26
|
+
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
|
|
27
|
+
return ar;
|
|
28
|
+
};
|
|
29
|
+
return ownKeys(o);
|
|
30
|
+
};
|
|
31
|
+
return function (mod) {
|
|
32
|
+
if (mod && mod.__esModule) return mod;
|
|
33
|
+
var result = {};
|
|
34
|
+
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
|
|
35
|
+
__setModuleDefault(result, mod);
|
|
36
|
+
return result;
|
|
37
|
+
};
|
|
38
|
+
})();
|
|
6
39
|
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
7
40
|
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
8
41
|
};
|
|
@@ -16,7 +49,7 @@ const lodash_1 = __importDefault(require("lodash"));
|
|
|
16
49
|
const node_path_1 = __importDefault(require("node:path"));
|
|
17
50
|
const pkg_dir_1 = __importDefault(require("pkg-dir"));
|
|
18
51
|
const read_pkg_1 = __importDefault(require("read-pkg"));
|
|
19
|
-
const
|
|
52
|
+
const YAML = __importStar(require("yaml"));
|
|
20
53
|
const constants_1 = require("./constants");
|
|
21
54
|
const error_1 = require("./error");
|
|
22
55
|
const logger_1 = require("./logger");
|
|
@@ -33,7 +66,7 @@ const findPkgDir = lodash_1.default.memoize(pkg_dir_1.default);
|
|
|
33
66
|
* @param value Something to yamlify
|
|
34
67
|
* @returns Some nice YAML 4 u
|
|
35
68
|
*/
|
|
36
|
-
exports.stringifyYaml = lodash_1.default.partialRight(
|
|
69
|
+
exports.stringifyYaml = lodash_1.default.partialRight(YAML.stringify, { indent: 2 }, undefined);
|
|
37
70
|
/**
|
|
38
71
|
* Pretty-stringifies a JSON value
|
|
39
72
|
* @param value Something to stringify
|
|
@@ -43,7 +76,7 @@ exports.stringifyJson = lodash_1.default.partialRight(JSON.stringify, 2, undefin
|
|
|
43
76
|
/**
|
|
44
77
|
* Reads a YAML file, parses it and caches the result
|
|
45
78
|
*/
|
|
46
|
-
const readYaml = lodash_1.default.memoize(async (filepath) =>
|
|
79
|
+
const readYaml = lodash_1.default.memoize(async (filepath) => YAML.parse(await support_1.fs.readFile(filepath, 'utf8'), {
|
|
47
80
|
prettyErrors: false,
|
|
48
81
|
logLevel: 'silent',
|
|
49
82
|
}));
|
package/build/lib/fs.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"fs.js","sourceRoot":"","sources":["../../lib/fs.ts"],"names":[],"mappings":";AAAA;;;GAGG
|
|
1
|
+
{"version":3,"file":"fs.js","sourceRoot":"","sources":["../../lib/fs.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAsEH,oCASC;AAgED,0CAKC;AAgFD,sCAMC;AAxOD,6CAAmC;AACnC,oDAAuB;AACvB,0DAA6B;AAC7B,sDAA8B;AAC9B,wDAAqE;AAErE,2CAA6B;AAC7B,2CAOqB;AACrB,mCAAsC;AACtC,qCAAmC;AAEnC,+CAAkC;AAElC,MAAM,GAAG,GAAG,IAAA,kBAAS,EAAC,IAAI,CAAC,CAAC;AAE5B;;;;GAIG;AACH,MAAM,UAAU,GAAG,gBAAC,CAAC,OAAO,CAAC,iBAAO,CAAC,CAAC;AAEtC;;;;GAIG;AACU,QAAA,aAAa,GAAiC,gBAAC,CAAC,YAAY,CACvE,IAAI,CAAC,SAAS,EACd,EAAC,MAAM,EAAE,CAAC,EAAC,EACX,SAAS,CACV,CAAC;AAEF;;;;GAIG;AACU,QAAA,aAAa,GAAiC,gBAAC,CAAC,YAAY,CACvE,IAAI,CAAC,SAAS,EACd,CAAC,EACD,SAAS,CACV,CAAC;AAEF;;GAEG;AACH,MAAM,QAAQ,GAAG,gBAAC,CAAC,OAAO,CAAC,KAAK,EAAE,QAAgB,EAAE,EAAE,CACpD,IAAI,CAAC,KAAK,CAAC,MAAM,YAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,EAAE;IAC9C,YAAY,EAAE,KAAK;IACnB,QAAQ,EAAE,QAAQ;CACnB,CAAC,CACH,CAAC;AAEF;;;;;;GAMG;AACI,KAAK,UAAU,YAAY,CAChC,QAAgB,EAChB,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE;IAEnB,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,GAAG,CAAC,CAAC;IACrC,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO;IACT,CAAC;IACD,OAAO,mBAAI,CAAC,IAAI,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;AACrC,CAAC;AAED;;;;;;GAMG;AACU,QAAA,aAAa,GAAG,gBAAC,CAAC,OAAO,CAAC,gBAAC,CAAC,OAAO,CAAC,YAAY,EAAE,2BAAe,CAAC,CAAC,CAAC;AAgBjF,KAAK,UAAU,YAAY,CACzB,GAAW,EACX,SAAmB;IAEnB,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,GAAG,CAAC,CAAC;IACrC,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,IAAI,qBAAa,CACrB,oBAAoB,6BAAiB,SAAS,GAAG,8CAA8C,CAChG,CAAC;IACJ,CAAC;IACD,MAAM,OAAO,GAAG,mBAAI,CAAC,IAAI,CAAC,MAAM,EAAE,6BAAiB,CAAC,CAAC;IACrD,GAAG,CAAC,KAAK,CAAC,4BAA4B,EAAE,OAAO,CAAC,CAAC;IACjD,IAAI,SAAS,EAAE,CAAC;QACd,MAAM,GAAG,GAAG,MAAM,IAAA,kBAAO,EAAC,EAAC,GAAG,EAAE,MAAM,EAAE,SAAS,EAAC,CAAC,CAAC;QACpD,OAAO,EAAC,GAAG,EAAE,OAAO,EAAC,CAAC;IACxB,CAAC;SAAM,CAAC;QACN,MAAM,GAAG,GAAG,MAAM,IAAA,kBAAO,EAAC,EAAC,GAAG,EAAE,MAAM,EAAC,CAAC,CAAC;QACzC,OAAO,EAAC,GAAG,EAAE,OAAO,EAAC,CAAC;IACxB,CAAC;AACH,CAAC;AAED;;GAEG;AACU,QAAA,eAAe,GAAG,gBAAC,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;AAEvD;;GAEG;AACU,QAAA,QAAQ,GAAG,gBAAC,CAAC,OAAO,CAC/B,KAAK,EAAuB,QAAgB,EAAc,EAAE,CAC1D,IAAI,CAAC,KAAK,CAAC,MAAM,YAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,CAClD,CAAC;AAEF;;;;GAIG;AACH,SAAgB,eAAe,CAAC,QAAgB,EAAE,OAAkB;IAClE,MAAM,IAAI,GAAW,gBAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC;IAC3F,OAAO,YAAE,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,EAAE;QAClC,QAAQ,EAAE,MAAM;KACjB,CAAC,CAAC;AACL,CAAC;AAID;;GAEG;AACH,MAAM,WAAW,GAAG,gBAAC,CAAC,OAAO,CAAC,YAAE,CAAC,KAAsB,CAAC,CAAC;AAEzD;;GAEG;AACH,MAAM,WAAW,GAAG,gBAAC,CAAC,OAAO,CAAC,WAAW,EAAE,uBAAW,EAAE,EAAC,OAAO,EAAE,IAAI,EAAC,CAAC,CAAC;AAEzE;;GAEG;AACH,MAAM,YAAY,GAAG,gBAAC,CAAC,OAAO,CAAC,WAAW,EAAE,GAAG,uBAAW,GAAG,EAAE,EAAC,OAAO,EAAE,IAAI,EAAC,CAAC,CAAC;AAEhF;;GAEG;AACU,QAAA,iBAAiB,GAAG,gBAAC,CAAC,OAAO,CAAC,KAAK,IAAsB,EAAE;IACtE,sBAAsB;IACtB,MAAM,UAAU,GAAG,MAAM,WAAW,CAAC,uBAAW,EAAE,EAAC,OAAO,EAAE,IAAI,EAAC,CAAC,CAAC;IACnE,IAAI,UAAU,EAAE,CAAC;QACf,OAAO,IAAI,CAAC;IACd,CAAC;IACD,sDAAsD;IACtD,MAAM,UAAU,GAAG,MAAM,IAAA,kBAAU,GAAE,CAAC;IACtC,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,OAAO,KAAK,CAAC;IACf,CAAC;IACD,IAAI,CAAC;QACH,MAAM,IAAA,mBAAI,EAAC,UAAU,EAAE,CAAC,IAAI,EAAE,uBAAW,CAAC,CAAC,CAAC;QAC5C,OAAO,IAAI,CAAC;IACd,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC,CAAC,CAAC;AAEH;;GAEG;AACU,QAAA,QAAQ,GAAG,gBAAC,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE;IAC3C,sBAAsB;IACtB,IAAI,QAAQ,GAAG,MAAM,WAAW,CAAC,qBAAS,EAAE,EAAC,OAAO,EAAE,IAAI,EAAC,CAAC,CAAC;IAC7D,IAAI,QAAQ,EAAE,CAAC;QACb,OAAO,QAAQ,CAAC;IAClB,CAAC;IACD,uCAAuC;IACvC,MAAM,UAAU,GAAG,MAAM,IAAA,kBAAU,GAAE,CAAC;IACtC,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,OAAO;IACT,CAAC;IACD,IAAI,CAAC;QACH,sCAAsC;QACtC,uCAAuC;QACvC,MAAM,EAAC,MAAM,EAAC,GAAG,MAAM,IAAA,mBAAI,EAAC,UAAU,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,aAAa,CAAC,CAAC,CAAC;QACvE,IAAI,MAAM,EAAE,CAAC;YACX,QAAQ,GAAG,mBAAI,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;YACnD,IAAI,MAAM,YAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE,CAAC;gBACpC,OAAO,QAAQ,CAAC;YAClB,CAAC;QACH,CAAC;IACH,CAAC;IAAC,MAAM,CAAC,CAAA,CAAC;AACZ,CAAC,CAAC,CAAC;AAEH;;;;GAIG;AACU,QAAA,UAAU,GAAG,gBAAC,CAAC,OAAO,CACjC,KAAK,IAA4B,EAAE,CAAC,CAAC,MAAM,YAAY,EAAE,CAAC,IAAI,CAAC,MAAM,WAAW,EAAE,CAAC,CACpF,CAAC;AAEF;;GAEG;AACI,KAAK,UAAU,aAAa,CAAC,UAAmB;IACrD,MAAM,eAAe,GAAG,UAAU,IAAI,CAAC,MAAM,IAAA,kBAAU,GAAE,CAAC,CAAC;IAC3D,IAAI,CAAC,eAAe,EAAE,CAAC;QACrB,MAAM,IAAI,qBAAa,CAAC,kCAAsB,CAAC,CAAC;IAClD,CAAC;IACD,OAAO,eAAe,CAAC;AACzB,CAAC;AAED;;;;;;;GAOG;AACU,QAAA,aAAa,GAAG,gBAAC,CAAC,OAAO,CACpC,KAAK,EAAE,QAAgB,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE,EAAsB,EAAE;IAClE,IAAI,SAAS,GAAG,CAAC,MAAM,QAAQ,CAAC,QAAQ,CAAC,CAAc,CAAC;IACxD,IAAI,SAAS,CAAC,QAAQ,EAAE,CAAC;QACvB,SAAS,CAAC,QAAQ,GAAG,mBAAI,CAAC,OAAO,CAAC,GAAG,EAAE,mBAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,SAAS,CAAC,QAAQ,CAAC,CAAC;IACrF,CAAC;IACD,IAAI,SAAS,CAAC,OAAO,EAAE,CAAC;QACtB,IAAI,WAAW,GAAuB,mBAAI,CAAC,OAAO,CAAC,mBAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,SAAS,CAAC,OAAO,CAAC,CAAC;QAC9F,OAAO,WAAW,EAAE,CAAC;YACnB,MAAM,UAAU,GAAG,CAAC,MAAM,QAAQ,CAAC,WAAW,CAAC,CAAc,CAAC;YAC9D,IAAI,UAAU,CAAC,QAAQ,EAAE,CAAC;gBACxB,UAAU,CAAC,QAAQ,GAAG,mBAAI,CAAC,OAAO,CAAC,mBAAI,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,UAAU,CAAC,QAAQ,CAAC,CAAC;gBACnF,GAAG,CAAC,KAAK,CAAC,yBAAyB,EAAE,UAAU,CAAC,QAAQ,CAAC,CAAC;YAC5D,CAAC;YACD,IAAI,UAAU,CAAC,QAAQ,EAAE,CAAC;gBACxB,UAAU,CAAC,QAAQ,GAAG,mBAAI,CAAC,OAAO,CAAC,mBAAI,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,UAAU,CAAC,QAAQ,CAAC,CAAC;gBACnF,GAAG,CAAC,KAAK,CAAC,yBAAyB,EAAE,UAAU,CAAC,QAAQ,CAAC,CAAC;YAC5D,CAAC;YACD,SAAS,GAAG,gBAAC,CAAC,YAAY,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;YAClD,WAAW,GAAG,UAAU,CAAC,OAAO;gBAC9B,CAAC,CAAC,mBAAI,CAAC,OAAO,CAAC,mBAAI,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,UAAU,CAAC,OAAO,CAAC;gBAC7D,CAAC,CAAC,SAAS,CAAC;QAChB,CAAC;IACH,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC,CACF,CAAC"}
|
package/build/lib/init.js
CHANGED
|
@@ -4,15 +4,45 @@
|
|
|
4
4
|
*
|
|
5
5
|
* @module
|
|
6
6
|
*/
|
|
7
|
-
var
|
|
8
|
-
|
|
9
|
-
|
|
7
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
8
|
+
if (k2 === undefined) k2 = k;
|
|
9
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
10
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
11
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
12
|
+
}
|
|
13
|
+
Object.defineProperty(o, k2, desc);
|
|
14
|
+
}) : (function(o, m, k, k2) {
|
|
15
|
+
if (k2 === undefined) k2 = k;
|
|
16
|
+
o[k2] = m[k];
|
|
17
|
+
}));
|
|
18
|
+
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
19
|
+
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
20
|
+
}) : function(o, v) {
|
|
21
|
+
o["default"] = v;
|
|
22
|
+
});
|
|
23
|
+
var __importStar = (this && this.__importStar) || (function () {
|
|
24
|
+
var ownKeys = function(o) {
|
|
25
|
+
ownKeys = Object.getOwnPropertyNames || function (o) {
|
|
26
|
+
var ar = [];
|
|
27
|
+
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
|
|
28
|
+
return ar;
|
|
29
|
+
};
|
|
30
|
+
return ownKeys(o);
|
|
31
|
+
};
|
|
32
|
+
return function (mod) {
|
|
33
|
+
if (mod && mod.__esModule) return mod;
|
|
34
|
+
var result = {};
|
|
35
|
+
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
|
|
36
|
+
__setModuleDefault(result, mod);
|
|
37
|
+
return result;
|
|
38
|
+
};
|
|
39
|
+
})();
|
|
10
40
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
11
41
|
exports.initMkDocs = void 0;
|
|
12
42
|
exports.initPython = initPython;
|
|
13
43
|
exports.init = init;
|
|
14
44
|
const constants_1 = require("./constants");
|
|
15
|
-
const
|
|
45
|
+
const YAML = __importStar(require("yaml"));
|
|
16
46
|
const teen_process_1 = require("teen_process");
|
|
17
47
|
const error_1 = require("./error");
|
|
18
48
|
const scaffold_1 = require("./scaffold");
|
|
@@ -32,7 +62,7 @@ const dryRunLog = (0, logger_1.getLogger)('dry-run', log);
|
|
|
32
62
|
* Function which scaffolds an `mkdocs.yml` file
|
|
33
63
|
*/
|
|
34
64
|
exports.initMkDocs = (0, scaffold_1.createScaffoldTask)(constants_1.NAME_MKDOCS_YML, BASE_MKDOCS_YML, 'MkDocs configuration', {
|
|
35
|
-
deserialize:
|
|
65
|
+
deserialize: YAML.parse,
|
|
36
66
|
serialize: fs_1.stringifyYaml,
|
|
37
67
|
transform: (content, opts, pkg) => {
|
|
38
68
|
let siteName = opts.siteName ?? content.site_name;
|
package/build/lib/init.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"init.js","sourceRoot":"","sources":["../../lib/init.ts"],"names":[],"mappings":";AAAA;;;;GAIG
|
|
1
|
+
{"version":3,"file":"init.js","sourceRoot":"","sources":["../../lib/init.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAqFH,gCAsCC;AAmBD,oBAgCC;AA5KD,2CAAiF;AACjF,2CAA6B;AAC7B,+CAAkC;AAElC,mCAAsC;AACtC,yCAAmE;AAEnE,qCAAmC;AAEnC,6BAAkD;AAElD;;GAEG;AACH,MAAM,eAAe,GAAwB,MAAM,CAAC,MAAM,CAAC;IACzD,OAAO,EAAE,iDAAiD;IAC1D,QAAQ,EAAE,MAAM;IAChB,QAAQ,EAAE,MAAM;CACjB,CAAC,CAAC;AAEH,MAAM,GAAG,GAAG,IAAA,kBAAS,EAAC,MAAM,CAAC,CAAC;AAC9B,MAAM,SAAS,GAAG,IAAA,kBAAS,EAAC,SAAS,EAAE,GAAG,CAAC,CAAC;AAE5C;;GAEG;AACU,QAAA,UAAU,GAA+C,IAAA,6BAAkB,EACtF,2BAAe,EACf,eAAe,EACf,sBAAsB,EACtB;IACE,WAAW,EAAE,IAAI,CAAC,KAAK;IACvB,SAAS,EAAE,kBAAa;IACxB,SAAS,EAAE,CAAC,OAAO,EAAE,IAAI,EAAE,GAAG,EAAE,EAAE;QAChC,IAAI,QAAQ,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,CAAC,SAAS,CAAC;QAClD,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,QAAQ,GAAG,GAAG,CAAC,IAAI,IAAI,WAAW,CAAC;YACnC,IAAI,QAAQ,EAAE,CAAC;gBACb,GAAG,CAAC,IAAI,CAAC,uCAAuC,EAAE,QAAQ,CAAC,CAAC;YAC9D,CAAC;QACH,CAAC;QACD,IAAI,OAAO,GAAuB,IAAI,CAAC,OAAO,IAAI,OAAO,CAAC,QAAQ,CAAC;QACnE,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,OAAO,GAAG,GAAG,CAAC,UAAU,EAAE,GAAG,CAAC;YAC9B,IAAI,OAAO,EAAE,CAAC;gBACZ,GAAG,CAAC,IAAI,CAAC,sCAAsC,EAAE,OAAO,CAAC,CAAC;YAC5D,CAAC;QACH,CAAC;QACD,IAAI,QAAQ,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,CAAC,SAAS,CAAC;QAClD,IAAI,OAAO,IAAI,CAAC,QAAQ,EAAE,CAAC;YACzB,IAAI,EAAC,QAAQ,EAAC,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,CAAC;YAClC,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAC7B,MAAM,SAAS,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACtC,MAAM,KAAK,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;YAC3B,IAAI,IAAI,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;YACxB,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;YAClC,QAAQ,GAAG,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACnC,IAAI,QAAQ,EAAE,CAAC;gBACb,GAAG,CAAC,IAAI,CAAC,uCAAuC,EAAE,QAAQ,CAAC,CAAC;YAC9D,CAAC;QACH,CAAC;QACD,IAAI,eAAe,GAAG,IAAI,CAAC,eAAe,IAAI,OAAO,CAAC,gBAAgB,CAAC;QACvE,IAAI,CAAC,eAAe,EAAE,CAAC;YACrB,eAAe,GAAG,GAAG,CAAC,WAAW,CAAC;YAClC,IAAI,eAAe,EAAE,CAAC;gBACpB,GAAG,CAAC,IAAI,CAAC,kDAAkD,EAAE,eAAe,CAAC,CAAC;YAChF,CAAC;QACH,CAAC;QACD,OAAO;YACL,GAAG,OAAO;YACV,SAAS,EAAE,QAAQ;YACnB,QAAQ,EAAE,OAAO;YACjB,SAAS,EAAE,QAAQ;YACnB,gBAAgB,EAAE,eAAe;SAClC,CAAC;IACJ,CAAC;CACF,CACF,CAAC;AAEF;;;GAGG;AACI,KAAK,UAAU,UAAU,CAAC,EAC/B,UAAU,EACV,MAAM,GAAG,KAAK,EACd,OAAO,GAAG,KAAK,MACM,EAAE;IACvB,MAAM,eAAe,GAAG,MAAM,IAAA,kBAAa,EAAC,UAAU,CAAC,CAAC;IAExD,MAAM,IAAI,GAAG,CAAC,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,iCAAqB,CAAC,CAAC;IACnE,IAAI,OAAO,EAAE,CAAC;QACZ,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IACzB,CAAC;IACD,IAAI,MAAM,EAAE,CAAC;QACX,SAAS,CAAC,IAAI,CACZ,0DAA0D,EAC1D,eAAe,EACf,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EACd,wBAAY,CACb,CAAC;IACJ,CAAC;SAAM,CAAC;QACN,GAAG,CAAC,KAAK,CAAC,sDAAsD,EAC9D,eAAe,EACf,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EACd,wBAAY,CACb,CAAC;QACF,GAAG,CAAC,IAAI,CAAC,mCAAmC,CAAC,CAAC;QAC9C,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,IAAA,mBAAI,EAAC,eAAe,EAAE,IAAI,EAAE,EAAC,GAAG,EAAE,wBAAY,EAAE,KAAK,EAAE,IAAI,EAAC,CAAC,CAAC;YACnF,MAAM,EAAC,IAAI,EAAE,MAAM,EAAC,GAAG,MAAM,CAAC;YAC9B,IAAI,IAAI,KAAK,CAAC,EAAE,CAAC;gBACf,MAAM,IAAI,qBAAa,CAAC,kDAAkD,MAAM,EAAE,CAAC,CAAC;YACtF,CAAC;QACH,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,MAAM,IAAI,qBAAa,CACrB,kDAAmD,GAAa,CAAC,OAAO,EAAE,CAC3E,CAAC;QACJ,CAAC;IACH,CAAC;IACD,GAAG,CAAC,OAAO,CAAC,4CAA4C,CAAC,CAAC;AAC5D,CAAC;AAaD;;;;;GAKG;AACI,KAAK,UAAU,IAAI,CAAC,EACzB,MAAM,EACN,WAAW,EAAE,eAAe,EAC5B,SAAS,EACT,MAAM,EACN,SAAS,EAAE,aAAa,EACxB,QAAQ,EACR,QAAQ,EACR,OAAO,EACP,SAAS,EACT,MAAM,EACN,GAAG,EACH,UAAU,EACV,OAAO,MACQ,EAAE;IACjB,IAAI,MAAM,EAAE,CAAC;QACX,MAAM,UAAU,CAAC,EAAC,UAAU,EAAE,MAAM,EAAE,OAAO,EAAC,CAAC,CAAC;IAClD,CAAC;IAED,IAAI,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;QACvB,MAAM,IAAA,kBAAU,EAAC;YACf,IAAI,EAAE,aAAa;YACnB,GAAG;YACH,QAAQ;YACR,OAAO;YACP,QAAQ;YACR,SAAS;YACT,WAAW,EAAE,eAAe;YAC5B,SAAS;YACT,MAAM;SACP,CAAC,CAAC;IACL,CAAC;AACH,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"build.e2e.spec.d.ts","sourceRoot":"","sources":["../../../test/e2e/build.e2e.spec.ts"],"names":[],"mappings":"AAAA;;;GAGG"}
|
|
@@ -0,0 +1,313 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* E2E tests for the `appium-docs build` and `init` commands
|
|
4
|
+
* @module
|
|
5
|
+
*/
|
|
6
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
7
|
+
if (k2 === undefined) k2 = k;
|
|
8
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
9
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
10
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
11
|
+
}
|
|
12
|
+
Object.defineProperty(o, k2, desc);
|
|
13
|
+
}) : (function(o, m, k, k2) {
|
|
14
|
+
if (k2 === undefined) k2 = k;
|
|
15
|
+
o[k2] = m[k];
|
|
16
|
+
}));
|
|
17
|
+
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
18
|
+
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
19
|
+
}) : function(o, v) {
|
|
20
|
+
o["default"] = v;
|
|
21
|
+
});
|
|
22
|
+
var __importStar = (this && this.__importStar) || (function () {
|
|
23
|
+
var ownKeys = function(o) {
|
|
24
|
+
ownKeys = Object.getOwnPropertyNames || function (o) {
|
|
25
|
+
var ar = [];
|
|
26
|
+
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
|
|
27
|
+
return ar;
|
|
28
|
+
};
|
|
29
|
+
return ownKeys(o);
|
|
30
|
+
};
|
|
31
|
+
return function (mod) {
|
|
32
|
+
if (mod && mod.__esModule) return mod;
|
|
33
|
+
var result = {};
|
|
34
|
+
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
|
|
35
|
+
__setModuleDefault(result, mod);
|
|
36
|
+
return result;
|
|
37
|
+
};
|
|
38
|
+
})();
|
|
39
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
40
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
41
|
+
};
|
|
42
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
43
|
+
const node_path_1 = __importDefault(require("node:path"));
|
|
44
|
+
const chai = __importStar(require("chai"));
|
|
45
|
+
const chai_as_promised_1 = __importDefault(require("chai-as-promised"));
|
|
46
|
+
const YAML = __importStar(require("yaml"));
|
|
47
|
+
const yargs_1 = __importDefault(require("yargs/yargs"));
|
|
48
|
+
const support_1 = require("@appium/support");
|
|
49
|
+
const builder_1 = require("../../lib/builder");
|
|
50
|
+
const init_1 = require("../../lib/init");
|
|
51
|
+
const fs_1 = require("../../lib/fs");
|
|
52
|
+
const constants_1 = require("../../lib/constants");
|
|
53
|
+
const command_1 = require("../../lib/cli/command");
|
|
54
|
+
chai.use(chai_as_promised_1.default);
|
|
55
|
+
const { expect } = chai;
|
|
56
|
+
/**
|
|
57
|
+
* Helper function to create a project directory with package.json
|
|
58
|
+
*/
|
|
59
|
+
async function createProjectDir(testDir, subdir, packageJson) {
|
|
60
|
+
const projectDir = node_path_1.default.join(testDir, subdir);
|
|
61
|
+
await support_1.fs.mkdirp(projectDir);
|
|
62
|
+
await support_1.fs.writeFile(node_path_1.default.join(projectDir, constants_1.NAME_PACKAGE_JSON), JSON.stringify(packageJson, null, 2), 'utf8');
|
|
63
|
+
return projectDir;
|
|
64
|
+
}
|
|
65
|
+
/**
|
|
66
|
+
* Helper function to create a minimal mkdocs.yml file
|
|
67
|
+
*/
|
|
68
|
+
async function createMkdocsYml(projectDir, mkdocsYml) {
|
|
69
|
+
await support_1.fs.writeFile(node_path_1.default.join(projectDir, constants_1.NAME_MKDOCS_YML), (0, fs_1.stringifyYaml)(mkdocsYml), 'utf8');
|
|
70
|
+
}
|
|
71
|
+
/**
|
|
72
|
+
* Helper function to create a docs directory with a markdown file
|
|
73
|
+
*/
|
|
74
|
+
async function createDocsFile(projectDir, filename, content) {
|
|
75
|
+
const docsDir = node_path_1.default.join(projectDir, 'docs');
|
|
76
|
+
await support_1.fs.mkdirp(docsDir);
|
|
77
|
+
await support_1.fs.writeFile(node_path_1.default.join(docsDir, filename), content, 'utf8');
|
|
78
|
+
}
|
|
79
|
+
/**
|
|
80
|
+
* Helper function to ensure Python dependencies are installed
|
|
81
|
+
*/
|
|
82
|
+
async function ensurePythonDeps(projectDir, context) {
|
|
83
|
+
try {
|
|
84
|
+
await (0, init_1.initPython)({ cwd: projectDir });
|
|
85
|
+
}
|
|
86
|
+
catch {
|
|
87
|
+
context.skip();
|
|
88
|
+
}
|
|
89
|
+
}
|
|
90
|
+
/**
|
|
91
|
+
* Helper function to verify a site was built
|
|
92
|
+
*/
|
|
93
|
+
async function verifySiteBuilt(siteDir, expectedContent) {
|
|
94
|
+
const siteDirExists = await support_1.fs.exists(siteDir);
|
|
95
|
+
expect(siteDirExists).to.be.true;
|
|
96
|
+
const indexHtml = node_path_1.default.join(siteDir, 'index.html');
|
|
97
|
+
const indexHtmlExists = await support_1.fs.exists(indexHtml);
|
|
98
|
+
expect(indexHtmlExists).to.be.true;
|
|
99
|
+
const indexHtmlContent = await support_1.fs.readFile(indexHtml, 'utf8');
|
|
100
|
+
expect(indexHtmlContent).to.include(expectedContent);
|
|
101
|
+
}
|
|
102
|
+
/**
|
|
103
|
+
* Helper function to read and parse mkdocs.yml
|
|
104
|
+
*/
|
|
105
|
+
async function readMkdocsYml(projectDir) {
|
|
106
|
+
const mkdocsYmlPath = node_path_1.default.join(projectDir, constants_1.NAME_MKDOCS_YML);
|
|
107
|
+
const mkdocsYmlContent = await support_1.fs.readFile(mkdocsYmlPath, 'utf8');
|
|
108
|
+
return YAML.parse(mkdocsYmlContent);
|
|
109
|
+
}
|
|
110
|
+
describe('@appium/docutils build e2e', function () {
|
|
111
|
+
let testDir;
|
|
112
|
+
before(async function () {
|
|
113
|
+
// Create a temporary directory for the test
|
|
114
|
+
testDir = await support_1.tempDir.openDir();
|
|
115
|
+
});
|
|
116
|
+
after(async function () {
|
|
117
|
+
// Clean up the temporary directory
|
|
118
|
+
if (testDir) {
|
|
119
|
+
await support_1.fs.rimraf(testDir);
|
|
120
|
+
}
|
|
121
|
+
});
|
|
122
|
+
describe('buildSite', function () {
|
|
123
|
+
it('should build a site with mkdocs', async function () {
|
|
124
|
+
const projectDir = await createProjectDir(testDir, 'test1', {
|
|
125
|
+
name: 'test-docs',
|
|
126
|
+
version: '1.0.0',
|
|
127
|
+
description: 'Test documentation',
|
|
128
|
+
});
|
|
129
|
+
// Create a minimal mkdocs.yml
|
|
130
|
+
// For testing, we use a simple config without INHERIT to avoid path resolution issues
|
|
131
|
+
await createMkdocsYml(projectDir, {
|
|
132
|
+
site_name: 'Test Docs',
|
|
133
|
+
docs_dir: 'docs',
|
|
134
|
+
site_dir: constants_1.DEFAULT_SITE_DIR,
|
|
135
|
+
theme: {
|
|
136
|
+
name: 'material',
|
|
137
|
+
},
|
|
138
|
+
plugins: ['search'],
|
|
139
|
+
});
|
|
140
|
+
await createDocsFile(projectDir, 'index.md', '# Test Documentation\n\nThis is a test page.\n');
|
|
141
|
+
await ensurePythonDeps(projectDir, this);
|
|
142
|
+
// Build the site
|
|
143
|
+
await (0, builder_1.buildSite)({
|
|
144
|
+
mkdocsYml: node_path_1.default.join(projectDir, constants_1.NAME_MKDOCS_YML),
|
|
145
|
+
cwd: projectDir,
|
|
146
|
+
});
|
|
147
|
+
// Verify the site was built
|
|
148
|
+
await verifySiteBuilt(node_path_1.default.join(projectDir, constants_1.DEFAULT_SITE_DIR), 'Test Documentation');
|
|
149
|
+
});
|
|
150
|
+
it('should build a site with custom site-dir', async function () {
|
|
151
|
+
const customSiteDir = 'custom-site';
|
|
152
|
+
const projectDir = await createProjectDir(testDir, 'test2', {
|
|
153
|
+
name: 'test-docs-2',
|
|
154
|
+
version: '1.0.0',
|
|
155
|
+
description: 'Test documentation',
|
|
156
|
+
});
|
|
157
|
+
// Create a minimal mkdocs.yml
|
|
158
|
+
// For testing, we use a simple config without INHERIT to avoid path resolution issues
|
|
159
|
+
await createMkdocsYml(projectDir, {
|
|
160
|
+
site_name: 'Test Docs 2',
|
|
161
|
+
docs_dir: 'docs',
|
|
162
|
+
site_dir: customSiteDir,
|
|
163
|
+
theme: {
|
|
164
|
+
name: 'material',
|
|
165
|
+
},
|
|
166
|
+
plugins: ['search'],
|
|
167
|
+
});
|
|
168
|
+
await createDocsFile(projectDir, 'index.md', '# Test Documentation 2\n\nThis is another test page.\n');
|
|
169
|
+
await ensurePythonDeps(projectDir, this);
|
|
170
|
+
// Build the site with custom site-dir
|
|
171
|
+
const customSiteDirPath = node_path_1.default.join(projectDir, customSiteDir);
|
|
172
|
+
await (0, builder_1.buildSite)({
|
|
173
|
+
mkdocsYml: node_path_1.default.join(projectDir, constants_1.NAME_MKDOCS_YML),
|
|
174
|
+
siteDir: customSiteDirPath,
|
|
175
|
+
cwd: projectDir,
|
|
176
|
+
});
|
|
177
|
+
// Verify the site was built in the custom directory
|
|
178
|
+
await verifySiteBuilt(customSiteDirPath, 'Test Documentation 2');
|
|
179
|
+
});
|
|
180
|
+
});
|
|
181
|
+
describe('init', function () {
|
|
182
|
+
it('should scaffold mkdocs.yml file', async function () {
|
|
183
|
+
const projectDir = await createProjectDir(testDir, 'init-test', {
|
|
184
|
+
name: 'test-package',
|
|
185
|
+
version: '1.0.0',
|
|
186
|
+
description: 'Test package description',
|
|
187
|
+
repository: {
|
|
188
|
+
type: 'git',
|
|
189
|
+
url: 'https://github.com/testuser/test-package.git',
|
|
190
|
+
},
|
|
191
|
+
});
|
|
192
|
+
// Run init command (skip Python installation for faster test)
|
|
193
|
+
await (0, init_1.init)({
|
|
194
|
+
cwd: projectDir,
|
|
195
|
+
mkdocs: true,
|
|
196
|
+
python: false,
|
|
197
|
+
});
|
|
198
|
+
// Verify mkdocs.yml was created
|
|
199
|
+
const mkdocsYmlPath = node_path_1.default.join(projectDir, constants_1.NAME_MKDOCS_YML);
|
|
200
|
+
expect(await support_1.fs.exists(mkdocsYmlPath)).to.be.true;
|
|
201
|
+
// Read and verify the content of mkdocs.yml
|
|
202
|
+
const mkdocsYml = await readMkdocsYml(projectDir);
|
|
203
|
+
// Verify expected fields are present
|
|
204
|
+
expect(mkdocsYml.INHERIT).to.equal('./node_modules/@appium/docutils/base-mkdocs.yml');
|
|
205
|
+
expect(mkdocsYml.docs_dir).to.equal('docs');
|
|
206
|
+
expect(mkdocsYml.site_dir).to.equal('site');
|
|
207
|
+
expect(mkdocsYml.site_name).to.equal('test-package');
|
|
208
|
+
expect(mkdocsYml.site_description).to.equal('Test package description');
|
|
209
|
+
// Repository URL may be normalized with "git+" prefix by read-pkg
|
|
210
|
+
expect(mkdocsYml.repo_url).to.include('github.com/testuser/test-package');
|
|
211
|
+
expect(mkdocsYml.repo_name).to.equal('testuser/test-package');
|
|
212
|
+
});
|
|
213
|
+
it('should scaffold mkdocs.yml with custom options', async function () {
|
|
214
|
+
const projectDir = await createProjectDir(testDir, 'init-custom-test', {
|
|
215
|
+
name: 'custom-package',
|
|
216
|
+
version: '2.0.0',
|
|
217
|
+
description: 'Custom package',
|
|
218
|
+
});
|
|
219
|
+
// Run init command with custom options
|
|
220
|
+
await (0, init_1.init)({
|
|
221
|
+
cwd: projectDir,
|
|
222
|
+
mkdocs: true,
|
|
223
|
+
python: false,
|
|
224
|
+
siteName: 'Custom Site Name',
|
|
225
|
+
repoUrl: 'https://github.com/custom/repo',
|
|
226
|
+
repoName: 'custom/repo',
|
|
227
|
+
siteDescription: 'Custom description',
|
|
228
|
+
});
|
|
229
|
+
// Verify mkdocs.yml was created
|
|
230
|
+
const mkdocsYmlPath = node_path_1.default.join(projectDir, constants_1.NAME_MKDOCS_YML);
|
|
231
|
+
expect(await support_1.fs.exists(mkdocsYmlPath)).to.be.true;
|
|
232
|
+
// Read and verify the content
|
|
233
|
+
const mkdocsYml = await readMkdocsYml(projectDir);
|
|
234
|
+
// Verify custom values are used
|
|
235
|
+
expect(mkdocsYml.site_name).to.equal('Custom Site Name');
|
|
236
|
+
// Note: siteDescription from options should override package.json description
|
|
237
|
+
// If it doesn't work, it falls back to package description
|
|
238
|
+
expect(mkdocsYml.site_description).to.be.oneOf(['Custom description', 'Custom package']);
|
|
239
|
+
expect(mkdocsYml.repo_url).to.equal('https://github.com/custom/repo');
|
|
240
|
+
expect(mkdocsYml.repo_name).to.equal('custom/repo');
|
|
241
|
+
});
|
|
242
|
+
});
|
|
243
|
+
describe('CLI help', function () {
|
|
244
|
+
it('should print help when --help is passed', async function () {
|
|
245
|
+
let helpOutput = '';
|
|
246
|
+
// Create yargs instance similar to CLI
|
|
247
|
+
const y = (0, yargs_1.default)(['--help'])
|
|
248
|
+
.scriptName(constants_1.NAME_BIN)
|
|
249
|
+
.command(command_1.build)
|
|
250
|
+
.command(command_1.init)
|
|
251
|
+
.command(command_1.validate)
|
|
252
|
+
.options({
|
|
253
|
+
verbose: {
|
|
254
|
+
type: 'boolean',
|
|
255
|
+
describe: 'Alias for --log-level=debug',
|
|
256
|
+
},
|
|
257
|
+
'log-level': {
|
|
258
|
+
alias: 'L',
|
|
259
|
+
choices: ['debug', 'info', 'warn', 'error', 'silent'],
|
|
260
|
+
describe: 'Sets the log level',
|
|
261
|
+
default: 'info',
|
|
262
|
+
},
|
|
263
|
+
config: {
|
|
264
|
+
alias: 'c',
|
|
265
|
+
type: 'string',
|
|
266
|
+
describe: 'Path to config file',
|
|
267
|
+
normalize: true,
|
|
268
|
+
nargs: 1,
|
|
269
|
+
requiresArg: true,
|
|
270
|
+
defaultDescription: '(discovered automatically)',
|
|
271
|
+
},
|
|
272
|
+
'no-config': {
|
|
273
|
+
type: 'boolean',
|
|
274
|
+
describe: 'Disable config file discovery',
|
|
275
|
+
},
|
|
276
|
+
})
|
|
277
|
+
.demandCommand(1)
|
|
278
|
+
.strict();
|
|
279
|
+
// Try getHelp first (returns a string, no I/O needed)
|
|
280
|
+
try {
|
|
281
|
+
const helpText = await y.getHelp();
|
|
282
|
+
helpOutput = helpText;
|
|
283
|
+
}
|
|
284
|
+
catch {
|
|
285
|
+
// If getHelp doesn't work, use showHelp which writes to stderr by default
|
|
286
|
+
// Capture stderr since showHelp() writes to stderr by default
|
|
287
|
+
const originalStderrWrite = process.stderr.write.bind(process.stderr);
|
|
288
|
+
const mockStderrWrite = (chunk) => {
|
|
289
|
+
if (typeof chunk === 'string' || Buffer.isBuffer(chunk)) {
|
|
290
|
+
helpOutput += chunk.toString();
|
|
291
|
+
}
|
|
292
|
+
return true;
|
|
293
|
+
};
|
|
294
|
+
process.stderr.write = mockStderrWrite;
|
|
295
|
+
try {
|
|
296
|
+
y.showHelp();
|
|
297
|
+
}
|
|
298
|
+
finally {
|
|
299
|
+
process.stderr.write = originalStderrWrite;
|
|
300
|
+
}
|
|
301
|
+
}
|
|
302
|
+
// Verify help output contains expected content
|
|
303
|
+
expect(helpOutput).to.include(constants_1.NAME_BIN);
|
|
304
|
+
expect(helpOutput).to.include('Commands:');
|
|
305
|
+
expect(helpOutput).to.include('build');
|
|
306
|
+
expect(helpOutput).to.include('init');
|
|
307
|
+
expect(helpOutput).to.include('validate');
|
|
308
|
+
expect(helpOutput).to.include('Options:');
|
|
309
|
+
expect(helpOutput).to.include('--help');
|
|
310
|
+
});
|
|
311
|
+
});
|
|
312
|
+
});
|
|
313
|
+
//# sourceMappingURL=build.e2e.spec.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"build.e2e.spec.js","sourceRoot":"","sources":["../../../test/e2e/build.e2e.spec.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,0DAA6B;AAC7B,2CAA6B;AAC7B,wEAA8C;AAC9C,2CAA6B;AAC7B,wDAAgC;AAChC,6CAA4C;AAC5C,+CAA4C;AAC5C,yCAAgD;AAChD,qCAA2C;AAE3C,mDAAmG;AACnG,mDAA8G;AAE9G,IAAI,CAAC,GAAG,CAAC,0BAAc,CAAC,CAAC;AACzB,MAAM,EAAC,MAAM,EAAC,GAAG,IAAI,CAAC;AAEtB;;GAEG;AACH,KAAK,UAAU,gBAAgB,CAC7B,OAAe,EACf,MAAc,EACd,WAAgC;IAEhC,MAAM,UAAU,GAAG,mBAAI,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IAC9C,MAAM,YAAE,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;IAC5B,MAAM,YAAE,CAAC,SAAS,CAChB,mBAAI,CAAC,IAAI,CAAC,UAAU,EAAE,6BAAiB,CAAC,EACxC,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC,EACpC,MAAM,CACP,CAAC;IACF,OAAO,UAAU,CAAC;AACpB,CAAC;AAED;;GAEG;AACH,KAAK,UAAU,eAAe,CAAC,UAAkB,EAAE,SAAoB;IACrE,MAAM,YAAE,CAAC,SAAS,CAAC,mBAAI,CAAC,IAAI,CAAC,UAAU,EAAE,2BAAe,CAAC,EAAE,IAAA,kBAAa,EAAC,SAAS,CAAC,EAAE,MAAM,CAAC,CAAC;AAC/F,CAAC;AAED;;GAEG;AACH,KAAK,UAAU,cAAc,CAAC,UAAkB,EAAE,QAAgB,EAAE,OAAe;IACjF,MAAM,OAAO,GAAG,mBAAI,CAAC,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;IAC9C,MAAM,YAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IACzB,MAAM,YAAE,CAAC,SAAS,CAAC,mBAAI,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;AACpE,CAAC;AAED;;GAEG;AACH,KAAK,UAAU,gBAAgB,CAAC,UAAkB,EAAE,OAAsB;IACxE,IAAI,CAAC;QACH,MAAM,IAAA,iBAAU,EAAC,EAAC,GAAG,EAAE,UAAU,EAAC,CAAC,CAAC;IACtC,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,CAAC,IAAI,EAAE,CAAC;IACjB,CAAC;AACH,CAAC;AAED;;GAEG;AACH,KAAK,UAAU,eAAe,CAAC,OAAe,EAAE,eAAuB;IACrE,MAAM,aAAa,GAAG,MAAM,YAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAC/C,MAAM,CAAC,aAAa,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC;IAEjC,MAAM,SAAS,GAAG,mBAAI,CAAC,IAAI,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;IACnD,MAAM,eAAe,GAAG,MAAM,YAAE,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IACnD,MAAM,CAAC,eAAe,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC;IAEnC,MAAM,gBAAgB,GAAG,MAAM,YAAE,CAAC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;IAC9D,MAAM,CAAC,gBAAgB,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;AACvD,CAAC;AAED;;GAEG;AACH,KAAK,UAAU,aAAa,CAAC,UAAkB;IAC7C,MAAM,aAAa,GAAG,mBAAI,CAAC,IAAI,CAAC,UAAU,EAAE,2BAAe,CAAC,CAAC;IAC7D,MAAM,gBAAgB,GAAG,MAAM,YAAE,CAAC,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC,CAAC;IAClE,OAAO,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAc,CAAC;AACnD,CAAC;AAGD,QAAQ,CAAC,4BAA4B,EAAE;IACrC,IAAI,OAAe,CAAC;IAEpB,MAAM,CAAC,KAAK;QACV,4CAA4C;QAC5C,OAAO,GAAG,MAAM,iBAAO,CAAC,OAAO,EAAE,CAAC;IACpC,CAAC,CAAC,CAAC;IAEH,KAAK,CAAC,KAAK;QACT,mCAAmC;QACnC,IAAI,OAAO,EAAE,CAAC;YACZ,MAAM,YAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAC3B,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,WAAW,EAAE;QACpB,EAAE,CAAC,iCAAiC,EAAE,KAAK;YACzC,MAAM,UAAU,GAAG,MAAM,gBAAgB,CAAC,OAAO,EAAE,OAAO,EAAE;gBAC1D,IAAI,EAAE,WAAW;gBACjB,OAAO,EAAE,OAAO;gBAChB,WAAW,EAAE,oBAAoB;aAClC,CAAC,CAAC;YAEH,8BAA8B;YAC9B,sFAAsF;YACtF,MAAM,eAAe,CAAC,UAAU,EAAE;gBAChC,SAAS,EAAE,WAAW;gBACtB,QAAQ,EAAE,MAAM;gBAChB,QAAQ,EAAE,4BAAgB;gBAC1B,KAAK,EAAE;oBACL,IAAI,EAAE,UAAU;iBACjB;gBACD,OAAO,EAAE,CAAC,QAAQ,CAAC;aACpB,CAAC,CAAC;YAEH,MAAM,cAAc,CAAC,UAAU,EAAE,UAAU,EAAE,gDAAgD,CAAC,CAAC;YAC/F,MAAM,gBAAgB,CAAC,UAAU,EAAE,IAAqB,CAAC,CAAC;YAE1D,iBAAiB;YACjB,MAAM,IAAA,mBAAS,EAAC;gBACd,SAAS,EAAE,mBAAI,CAAC,IAAI,CAAC,UAAU,EAAE,2BAAe,CAAC;gBACjD,GAAG,EAAE,UAAU;aAChB,CAAC,CAAC;YAEH,4BAA4B;YAC5B,MAAM,eAAe,CAAC,mBAAI,CAAC,IAAI,CAAC,UAAU,EAAE,4BAAgB,CAAC,EAAE,oBAAoB,CAAC,CAAC;QACvF,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,0CAA0C,EAAE,KAAK;YAClD,MAAM,aAAa,GAAG,aAAa,CAAC;YACpC,MAAM,UAAU,GAAG,MAAM,gBAAgB,CAAC,OAAO,EAAE,OAAO,EAAE;gBAC1D,IAAI,EAAE,aAAa;gBACnB,OAAO,EAAE,OAAO;gBAChB,WAAW,EAAE,oBAAoB;aAClC,CAAC,CAAC;YAEH,8BAA8B;YAC9B,sFAAsF;YACtF,MAAM,eAAe,CAAC,UAAU,EAAE;gBAChC,SAAS,EAAE,aAAa;gBACxB,QAAQ,EAAE,MAAM;gBAChB,QAAQ,EAAE,aAAa;gBACvB,KAAK,EAAE;oBACL,IAAI,EAAE,UAAU;iBACjB;gBACD,OAAO,EAAE,CAAC,QAAQ,CAAC;aACpB,CAAC,CAAC;YAEH,MAAM,cAAc,CAAC,UAAU,EAAE,UAAU,EAAE,wDAAwD,CAAC,CAAC;YACvG,MAAM,gBAAgB,CAAC,UAAU,EAAE,IAAqB,CAAC,CAAC;YAE1D,sCAAsC;YACtC,MAAM,iBAAiB,GAAG,mBAAI,CAAC,IAAI,CAAC,UAAU,EAAE,aAAa,CAAC,CAAC;YAC/D,MAAM,IAAA,mBAAS,EAAC;gBACd,SAAS,EAAE,mBAAI,CAAC,IAAI,CAAC,UAAU,EAAE,2BAAe,CAAC;gBACjD,OAAO,EAAE,iBAAiB;gBAC1B,GAAG,EAAE,UAAU;aAChB,CAAC,CAAC;YAEH,oDAAoD;YACpD,MAAM,eAAe,CAAC,iBAAiB,EAAE,sBAAsB,CAAC,CAAC;QACnE,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,MAAM,EAAE;QACf,EAAE,CAAC,iCAAiC,EAAE,KAAK;YACzC,MAAM,UAAU,GAAG,MAAM,gBAAgB,CAAC,OAAO,EAAE,WAAW,EAAE;gBAC9D,IAAI,EAAE,cAAc;gBACpB,OAAO,EAAE,OAAO;gBAChB,WAAW,EAAE,0BAA0B;gBACvC,UAAU,EAAE;oBACV,IAAI,EAAE,KAAK;oBACX,GAAG,EAAE,8CAA8C;iBACpD;aACF,CAAC,CAAC;YAEH,8DAA8D;YAC9D,MAAM,IAAA,WAAI,EAAC;gBACT,GAAG,EAAE,UAAU;gBACf,MAAM,EAAE,IAAI;gBACZ,MAAM,EAAE,KAAK;aACd,CAAC,CAAC;YAEH,gCAAgC;YAChC,MAAM,aAAa,GAAG,mBAAI,CAAC,IAAI,CAAC,UAAU,EAAE,2BAAe,CAAC,CAAC;YAC7D,MAAM,CAAC,MAAM,YAAE,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC;YAElD,4CAA4C;YAC5C,MAAM,SAAS,GAAG,MAAM,aAAa,CAAC,UAAU,CAAC,CAAC;YAElD,qCAAqC;YACrC,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,iDAAiD,CAAC,CAAC;YACtF,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YAC5C,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YAC5C,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;YACrD,MAAM,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,0BAA0B,CAAC,CAAC;YACxE,kEAAkE;YAClE,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,kCAAkC,CAAC,CAAC;YAC1E,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,uBAAuB,CAAC,CAAC;QAChE,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,gDAAgD,EAAE,KAAK;YACxD,MAAM,UAAU,GAAG,MAAM,gBAAgB,CAAC,OAAO,EAAE,kBAAkB,EAAE;gBACrE,IAAI,EAAE,gBAAgB;gBACtB,OAAO,EAAE,OAAO;gBAChB,WAAW,EAAE,gBAAgB;aAC9B,CAAC,CAAC;YAEH,uCAAuC;YACvC,MAAM,IAAA,WAAI,EAAC;gBACT,GAAG,EAAE,UAAU;gBACf,MAAM,EAAE,IAAI;gBACZ,MAAM,EAAE,KAAK;gBACb,QAAQ,EAAE,kBAAkB;gBAC5B,OAAO,EAAE,gCAAgC;gBACzC,QAAQ,EAAE,aAAa;gBACvB,eAAe,EAAE,oBAAoB;aACtC,CAAC,CAAC;YAEH,gCAAgC;YAChC,MAAM,aAAa,GAAG,mBAAI,CAAC,IAAI,CAAC,UAAU,EAAE,2BAAe,CAAC,CAAC;YAC7D,MAAM,CAAC,MAAM,YAAE,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC;YAElD,8BAA8B;YAC9B,MAAM,SAAS,GAAG,MAAM,aAAa,CAAC,UAAU,CAAC,CAAC;YAElD,gCAAgC;YAChC,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC;YACzD,8EAA8E;YAC9E,2DAA2D;YAC3D,MAAM,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,oBAAoB,EAAE,gBAAgB,CAAC,CAAC,CAAC;YACzF,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,gCAAgC,CAAC,CAAC;YACtE,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;QACtD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,UAAU,EAAE;QACnB,EAAE,CAAC,yCAAyC,EAAE,KAAK;YACjD,IAAI,UAAU,GAAG,EAAE,CAAC;YAEpB,uCAAuC;YACvC,MAAM,CAAC,GAAG,IAAA,eAAK,EAAC,CAAC,QAAQ,CAAC,CAAC;iBACxB,UAAU,CAAC,oBAAQ,CAAC;iBACpB,OAAO,CAAC,eAAY,CAAC;iBACrB,OAAO,CAAC,cAAW,CAAC;iBACpB,OAAO,CAAC,kBAAe,CAAC;iBACxB,OAAO,CAAC;gBACP,OAAO,EAAE;oBACP,IAAI,EAAE,SAAS;oBACf,QAAQ,EAAE,6BAA6B;iBACxC;gBACD,WAAW,EAAE;oBACX,KAAK,EAAE,GAAG;oBACV,OAAO,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,CAAC;oBACrD,QAAQ,EAAE,oBAAoB;oBAC9B,OAAO,EAAE,MAAM;iBAChB;gBACD,MAAM,EAAE;oBACN,KAAK,EAAE,GAAG;oBACV,IAAI,EAAE,QAAQ;oBACd,QAAQ,EAAE,qBAAqB;oBAC/B,SAAS,EAAE,IAAI;oBACf,KAAK,EAAE,CAAC;oBACR,WAAW,EAAE,IAAI;oBACjB,kBAAkB,EAAE,4BAA4B;iBACjD;gBACD,WAAW,EAAE;oBACX,IAAI,EAAE,SAAS;oBACf,QAAQ,EAAE,+BAA+B;iBAC1C;aACF,CAAC;iBACD,aAAa,CAAC,CAAC,CAAC;iBAChB,MAAM,EAAE,CAAC;YAEZ,sDAAsD;YACtD,IAAI,CAAC;gBACH,MAAM,QAAQ,GAAG,MAAM,CAAC,CAAC,OAAO,EAAE,CAAC;gBACnC,UAAU,GAAG,QAAQ,CAAC;YACxB,CAAC;YAAC,MAAM,CAAC;gBACP,0EAA0E;gBAC1E,8DAA8D;gBAC9D,MAAM,mBAAmB,GAAG,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;gBACtE,MAAM,eAAe,GAAG,CAAC,KAAU,EAAE,EAAE;oBACrC,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;wBACxD,UAAU,IAAI,KAAK,CAAC,QAAQ,EAAE,CAAC;oBACjC,CAAC;oBACD,OAAO,IAAI,CAAC;gBACd,CAAC,CAAC;gBACF,OAAO,CAAC,MAAM,CAAC,KAAK,GAAG,eAA8C,CAAC;gBACtE,IAAI,CAAC;oBACH,CAAC,CAAC,QAAQ,EAAE,CAAC;gBACf,CAAC;wBAAS,CAAC;oBACT,OAAO,CAAC,MAAM,CAAC,KAAK,GAAG,mBAAmB,CAAC;gBAC7C,CAAC;YACH,CAAC;YAED,+CAA+C;YAC/C,MAAM,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,oBAAQ,CAAC,CAAC;YACxC,MAAM,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;YAC3C,MAAM,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YACvC,MAAM,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YACtC,MAAM,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;YAC1C,MAAM,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;YAC1C,MAAM,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAC1C,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"util.spec.d.ts","sourceRoot":"","sources":["../../../test/unit/util.spec.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
14
|
+
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
15
|
+
}) : function(o, v) {
|
|
16
|
+
o["default"] = v;
|
|
17
|
+
});
|
|
18
|
+
var __importStar = (this && this.__importStar) || (function () {
|
|
19
|
+
var ownKeys = function(o) {
|
|
20
|
+
ownKeys = Object.getOwnPropertyNames || function (o) {
|
|
21
|
+
var ar = [];
|
|
22
|
+
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
|
|
23
|
+
return ar;
|
|
24
|
+
};
|
|
25
|
+
return ownKeys(o);
|
|
26
|
+
};
|
|
27
|
+
return function (mod) {
|
|
28
|
+
if (mod && mod.__esModule) return mod;
|
|
29
|
+
var result = {};
|
|
30
|
+
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
|
|
31
|
+
__setModuleDefault(result, mod);
|
|
32
|
+
return result;
|
|
33
|
+
};
|
|
34
|
+
})();
|
|
35
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
36
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
37
|
+
};
|
|
38
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
39
|
+
const util_1 = require("../../lib/util");
|
|
40
|
+
const lodash_1 = __importDefault(require("lodash"));
|
|
41
|
+
const chai = __importStar(require("chai"));
|
|
42
|
+
const chai_as_promised_1 = __importDefault(require("chai-as-promised"));
|
|
43
|
+
chai.use(chai_as_promised_1.default);
|
|
44
|
+
const { expect } = chai;
|
|
45
|
+
describe('argify', function () {
|
|
46
|
+
it('should create args from params', function () {
|
|
47
|
+
// deploy example
|
|
48
|
+
const version = '2.0';
|
|
49
|
+
const mikeOpts = {
|
|
50
|
+
'config-file': '/path/to/yml',
|
|
51
|
+
push: true,
|
|
52
|
+
remote: 'origin',
|
|
53
|
+
branch: 'gh-pages',
|
|
54
|
+
'deploy-prefix': '2.0',
|
|
55
|
+
message: 'docs: a thing',
|
|
56
|
+
port: 8100,
|
|
57
|
+
host: 'localhost',
|
|
58
|
+
};
|
|
59
|
+
const mikeArgs = [
|
|
60
|
+
...(0, util_1.argify)(lodash_1.default.omitBy(mikeOpts, (value, key) => lodash_1.default.includes(['port', 'host'], key) || (!lodash_1.default.isNumber(value) && !value))),
|
|
61
|
+
version,
|
|
62
|
+
];
|
|
63
|
+
expect(mikeArgs).to.eql([
|
|
64
|
+
'--config-file',
|
|
65
|
+
'/path/to/yml',
|
|
66
|
+
'--push',
|
|
67
|
+
'--remote',
|
|
68
|
+
'origin',
|
|
69
|
+
'--branch',
|
|
70
|
+
'gh-pages',
|
|
71
|
+
'--deploy-prefix',
|
|
72
|
+
'2.0',
|
|
73
|
+
'--message',
|
|
74
|
+
'docs: a thing',
|
|
75
|
+
'2.0',
|
|
76
|
+
]);
|
|
77
|
+
});
|
|
78
|
+
});
|
|
79
|
+
//# sourceMappingURL=util.spec.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"util.spec.js","sourceRoot":"","sources":["../../../test/unit/util.spec.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,yCAAsC;AACtC,oDAAuB;AACvB,2CAA6B;AAC7B,wEAA8C;AAE9C,IAAI,CAAC,GAAG,CAAC,0BAAc,CAAC,CAAC;AACzB,MAAM,EAAC,MAAM,EAAC,GAAG,IAAI,CAAC;AAEtB,QAAQ,CAAC,QAAQ,EAAE;IACjB,EAAE,CAAC,gCAAgC,EAAE;QACnC,iBAAiB;QACjB,MAAM,OAAO,GAAG,KAAK,CAAC;QACtB,MAAM,QAAQ,GAAG;YACf,aAAa,EAAE,cAAc;YAC7B,IAAI,EAAE,IAAI;YACV,MAAM,EAAE,QAAQ;YAChB,MAAM,EAAE,UAAU;YAClB,eAAe,EAAE,KAAK;YACtB,OAAO,EAAE,eAAe;YACxB,IAAI,EAAE,IAAI;YACV,IAAI,EAAE,WAAW;SAClB,CAAC;QACF,MAAM,QAAQ,GAAG;YACf,GAAG,IAAA,aAAM,EACP,gBAAC,CAAC,MAAM,CACN,QAAQ,EACR,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC,gBAAC,CAAC,QAAQ,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC,gBAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CACpF,CACF;YACD,OAAO;SACR,CAAC;QACF,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC;YACtB,eAAe;YACf,cAAc;YACd,QAAQ;YACR,UAAU;YACV,QAAQ;YACR,UAAU;YACV,UAAU;YACV,iBAAiB;YACjB,KAAK;YACL,WAAW;YACX,eAAe;YACf,KAAK;SACN,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
|
package/lib/cli/config.ts
CHANGED
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
import {lilconfig, Loader} from 'lilconfig';
|
|
7
7
|
import _ from 'lodash';
|
|
8
8
|
import path from 'node:path';
|
|
9
|
-
import YAML from 'yaml';
|
|
9
|
+
import * as YAML from 'yaml';
|
|
10
10
|
import parser from 'yargs-parser';
|
|
11
11
|
import {hideBin} from 'yargs/helpers';
|
|
12
12
|
import {DEFAULT_LOG_LEVEL, LogLevelMap, NAME_BIN} from '../constants';
|
package/lib/fs.ts
CHANGED
|
@@ -9,7 +9,7 @@ import path from 'node:path';
|
|
|
9
9
|
import _pkgDir from 'pkg-dir';
|
|
10
10
|
import readPkg, {NormalizedPackageJson, PackageJson} from 'read-pkg';
|
|
11
11
|
import {JsonValue} from 'type-fest';
|
|
12
|
-
import YAML from 'yaml';
|
|
12
|
+
import * as YAML from 'yaml';
|
|
13
13
|
import {
|
|
14
14
|
MESSAGE_PYTHON_MISSING,
|
|
15
15
|
NAME_MIKE,
|
package/lib/init.ts
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
*/
|
|
6
6
|
|
|
7
7
|
import {NAME_MKDOCS_YML, PIP_ENV_VARS, REQUIREMENTS_TXT_PATH} from './constants';
|
|
8
|
-
import YAML from 'yaml';
|
|
8
|
+
import * as YAML from 'yaml';
|
|
9
9
|
import {exec} from 'teen_process';
|
|
10
10
|
import {Simplify} from 'type-fest';
|
|
11
11
|
import {DocutilsError} from './error';
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@appium/docutils",
|
|
3
|
-
"version": "2.
|
|
3
|
+
"version": "2.2.0",
|
|
4
4
|
"description": "Documentation generation utilities for Appium and related projects",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"automation",
|
|
@@ -42,13 +42,13 @@
|
|
|
42
42
|
],
|
|
43
43
|
"scripts": {
|
|
44
44
|
"test": "npm run test:unit",
|
|
45
|
-
"test:e2e": "
|
|
45
|
+
"test:e2e": "mocha --exit --timeout 60s --slow 30s \"./test/e2e/**/*.e2e.spec.ts\"",
|
|
46
46
|
"test:smoke": "node ./index.js",
|
|
47
|
-
"test:unit": "mocha \"./test/unit/**/*.spec.
|
|
47
|
+
"test:unit": "mocha \"./test/unit/**/*.spec.ts\"",
|
|
48
48
|
"start": "node ./build/lib/cli/index.js"
|
|
49
49
|
},
|
|
50
50
|
"dependencies": {
|
|
51
|
-
"@appium/support": "^7.0.
|
|
51
|
+
"@appium/support": "^7.0.4",
|
|
52
52
|
"chalk": "4.1.2",
|
|
53
53
|
"consola": "3.4.2",
|
|
54
54
|
"diff": "8.0.2",
|
|
@@ -57,9 +57,9 @@
|
|
|
57
57
|
"pkg-dir": "5.0.0",
|
|
58
58
|
"read-pkg": "5.2.0",
|
|
59
59
|
"source-map-support": "0.5.21",
|
|
60
|
-
"teen_process": "3.0.
|
|
61
|
-
"type-fest": "5.0
|
|
62
|
-
"yaml": "2.8.
|
|
60
|
+
"teen_process": "3.0.4",
|
|
61
|
+
"type-fest": "5.3.0",
|
|
62
|
+
"yaml": "2.8.2",
|
|
63
63
|
"yargs": "18.0.0",
|
|
64
64
|
"yargs-parser": "22.0.0"
|
|
65
65
|
},
|
|
@@ -70,5 +70,5 @@
|
|
|
70
70
|
"publishConfig": {
|
|
71
71
|
"access": "public"
|
|
72
72
|
},
|
|
73
|
-
"gitHead": "
|
|
73
|
+
"gitHead": "9004554879687ddad51d3afdf8c711b027efbd99"
|
|
74
74
|
}
|
package/requirements.txt
CHANGED
package/tsconfig.json
CHANGED
|
@@ -4,12 +4,13 @@
|
|
|
4
4
|
"rootDir": ".",
|
|
5
5
|
"outDir": "build",
|
|
6
6
|
"checkJs": true,
|
|
7
|
+
"types": ["node", "mocha", "chai", "chai-as-promised"],
|
|
7
8
|
"paths": {
|
|
8
9
|
"@appium/support": ["../support"],
|
|
9
10
|
"@appium/types": ["../types"]
|
|
10
11
|
},
|
|
11
12
|
"strict": true
|
|
12
13
|
},
|
|
13
|
-
"include": ["./lib/**/*"],
|
|
14
|
+
"include": ["./lib/**/*", "./test/**/*"],
|
|
14
15
|
"references": [{"path": "../types"}, {"path": "../support"}]
|
|
15
16
|
}
|