@appium/docutils 1.0.1 → 1.0.3

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/README.md CHANGED
@@ -2,21 +2,26 @@
2
2
 
3
3
  > Documentation-building utilities for Appium
4
4
 
5
- ## Prerequisites
5
+ [![NPM version](http://img.shields.io/npm/v/@appium/docutils.svg)](https://npmjs.org/package/@appium/docutils)
6
+ [![Downloads](http://img.shields.io/npm/dm/@appium/docutils.svg)](https://npmjs.org/package/@appium/docutils)
6
7
 
7
- - Node.js in the [semantic version range](https://semver.org) `^14.17.0 || ^16.13.0 || >=18.0.0`
8
- - Python v3+ if building HTML documentation
8
+ ## Setup for Main Appium Docs
9
9
 
10
- ## Running for Main Appium Docs
11
-
12
- This package does not need to be run directly. Instead, execute this command in the `packages/appium` folder of [this monorepo](https://github.com/appium/appium):
10
+ This package does not need to be run directly. Instead, execute this command in the
11
+ `packages/appium` directory:
13
12
 
14
13
  ```bash
15
14
  npm run dev:docs:en
16
- ````
15
+ ```
16
+
17
+ > [!NOTE]
18
+ > This will only build the English docs. See the `scripts` field of the `package.json` for
19
+ other languages.
20
+
21
+ ## Setup for Appium Drivers and Plugins
17
22
 
18
- See the `scripts` field of the `package.json` for other languages.
23
+ See the Appium docs on [Building Documentation](http://appium.io/docs/en/latest/developing/build-docs/).
19
24
 
20
- ## Using in Appium Extensions
25
+ ## License
21
26
 
22
- TODO: give an example of how this package is used in an extension outside the appium monorepo, for example when it's made a part of the XCUITest repo. Or link to the part of the Appium docs where this info will live.
27
+ Apache-2.0
@@ -1 +1 @@
1
- {"version":3,"file":"deploy.d.ts","sourceRoot":"","sources":["../../../lib/builder/deploy.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAIH,OAAO,EAAO,sBAAsB,EAAC,MAAM,cAAc,CAAC;AAe1D,OAAO,EAAiC,0BAA0B,EAAY,MAAM,SAAS,CAAC;AAsD9F;;;GAGG;AACH,wBAAsB,MAAM,CAAC,EAC3B,SAAS,EAAE,aAAa,EACxB,WAAW,EAAE,eAAe,EAC5B,aAAa,EAAE,OAAO,EACtB,GAAmB,EACnB,KAAa,EACb,IAAY,EACZ,MAA8B,EAC9B,MAA8B,EAC9B,YAAY,EACZ,OAAO,EACP,KAAK,EACL,SAAqC,EACrC,IAAyB,EACzB,IAAyB,EACzB,SAAS,EACT,QAAQ,GACT,GAAE,UAAe,iBAwEjB;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;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,IAAI,CAAC,EAAE,OAAO,CAAC;IACf;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,QAAQ,CAAC,EAAE,sBAAsB,CAAC;IAElC;;OAEG;IACH,SAAS,CAAC,EAAE,0BAA0B,CAAC;CACxC"}
1
+ {"version":3,"file":"deploy.d.ts","sourceRoot":"","sources":["../../../lib/builder/deploy.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAIH,OAAO,EAAO,sBAAsB,EAAC,MAAM,cAAc,CAAC;AAe1D,OAAO,EAAiC,0BAA0B,EAAY,MAAM,SAAS,CAAC;AAsD9F;;;GAGG;AACH,wBAAsB,MAAM,CAAC,EAC3B,SAAS,EAAE,aAAa,EACxB,WAAW,EAAE,eAAe,EAC5B,aAAa,EAAE,OAAO,EACtB,GAAmB,EACnB,KAAa,EACb,IAAY,EACZ,MAA8B,EAC9B,MAA8B,EAC9B,YAAY,EACZ,OAAO,EACP,KAAK,EACL,SAAqC,EACrC,IAAyB,EACzB,IAAyB,EACzB,SAAS,EACT,QAAQ,GACT,GAAE,UAAe,iBAkEjB;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;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,IAAI,CAAC,EAAE,OAAO,CAAC;IACf;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,QAAQ,CAAC,EAAE,sBAAsB,CAAC;IAElC;;OAEG;IACH,SAAS,CAAC,EAAE,0BAA0B,CAAC;CACxC"}
@@ -93,13 +93,6 @@ async function deploy({ mkdocsYml: mkDocsYmlPath, packageJson: packageJsonPath,
93
93
  const mikeArgs = [
94
94
  ...(0, util_1.argify)(lodash_1.default.pickBy(mikeOpts, (value) => lodash_1.default.isNumber(value) || Boolean(value))),
95
95
  ];
96
- if (alias) {
97
- mikeArgs.push('--update-aliases', version, alias);
98
- mikeArgs.push('--alias-type', aliasType);
99
- }
100
- else {
101
- mikeArgs.push(version);
102
- }
103
96
  stop(); // discard
104
97
  // unsure about how SIGHUP is handled here
105
98
  await doServe(mikePath, mikeArgs, serveOpts);
@@ -110,8 +103,8 @@ async function deploy({ mkdocsYml: mkDocsYmlPath, packageJson: packageJsonPath,
110
103
  ...(0, util_1.argify)(lodash_1.default.omitBy(mikeOpts, (value, key) => lodash_1.default.includes(['port', 'host'], key) || (!lodash_1.default.isNumber(value) && !value))),
111
104
  ];
112
105
  if (alias) {
113
- mikeArgs.push('--update-aliases', version, alias);
114
- mikeArgs.push('--alias-type', aliasType);
106
+ mikeArgs.push('--update-aliases', '--alias-type', aliasType);
107
+ mikeArgs.push(version, alias);
115
108
  }
116
109
  else {
117
110
  mikeArgs.push(version);
@@ -1 +1 @@
1
- {"version":3,"file":"deploy.js","sourceRoot":"","sources":["../../../lib/builder/deploy.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;;;;;AAEH,oDAAuB;AACvB,0DAA6B;AAC7B,+CAA0D;AAC1D,4CAUsB;AACtB,oCAAuC;AACvC,8BAA2E;AAC3E,sCAAoC;AACpC,kCAA8F;AAE9F,MAAM,GAAG,GAAG,IAAA,kBAAS,EAAC,gBAAgB,CAAC,CAAC;AAExC;;;;;GAKG;AACH,KAAK,UAAU,OAAO,CACpB,QAAgB,EAChB,OAAiB,EAAE,EACnB,OAAmC,EAAE;IAErC,MAAM,SAAS,GAAG,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC;IACrC,OAAO,IAAA,6BAAsB,EAAC,QAAQ,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;AAC3D,CAAC;AAED;;;;;GAKG;AACH,KAAK,UAAU,QAAQ,CAAC,QAAgB,EAAE,OAAiB,EAAE,EAAE,OAA+B,EAAE;IAC9F,MAAM,SAAS,GAAG,CAAC,QAAQ,EAAE,GAAG,IAAI,CAAC,CAAC;IACtC,GAAG,CAAC,KAAK,CAAC,yBAAyB,EAAE,qBAAS,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC;IACrE,OAAO,MAAM,IAAA,mBAAI,EAAC,QAAQ,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;AAC/C,CAAC;AAED;;;;GAIG;AACH,KAAK,UAAU,iBAAiB,CAAC,eAAwB,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE;IAC5E,MAAM,EAAC,GAAG,EAAC,GAAG,MAAM,IAAA,oBAAe,EAAC,eAAe,CAAC,CAAC,CAAC,mBAAI,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IACjG,MAAM,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC;IAC5B,IAAI,CAAC,OAAO,EAAE;QACZ,MAAM,IAAI,qBAAa,CACrB,yFAAyF,CAC1F,CAAC;KACH;IAED,6FAA6F;IAC7F,gCAAgC;IAChC,MAAM,YAAY,GAAG,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACxC,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE;QAC7B,OAAO,OAAO,CAAC;KAChB;IACD,OAAO,GAAG,YAAY,CAAC,CAAC,CAAC,IAAI,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC;AACjD,CAAC;AAED;;;GAGG;AACI,KAAK,UAAU,MAAM,CAAC,EAC3B,SAAS,EAAE,aAAa,EACxB,WAAW,EAAE,eAAe,EAC5B,aAAa,EAAE,OAAO,EACtB,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE,EACnB,KAAK,GAAG,KAAK,EACb,IAAI,GAAG,KAAK,EACZ,MAAM,GAAG,iCAAqB,EAC9B,MAAM,GAAG,iCAAqB,EAC9B,YAAY,EACZ,OAAO,EACP,KAAK,EACL,SAAS,GAAG,qCAAyB,EACrC,IAAI,GAAG,8BAAkB,EACzB,IAAI,GAAG,8BAAkB,EACzB,SAAS,EACT,QAAQ,MACM,EAAE;IAChB,MAAM,IAAI,GAAG,IAAA,gBAAS,EAAC,QAAQ,CAAC,CAAC;IAEjC,MAAM,UAAU,GAAG,MAAM,IAAA,eAAU,GAAE,CAAC;IAEtC,IAAI,CAAC,UAAU,EAAE;QACf,MAAM,IAAI,qBAAa,CACrB,kBAAkB,uBAAW,KAAK,uBAAW,+CAA+C,CAC7F,CAAC;KACH;IAED,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,OAAO,GAAG,OAAO,IAAI,CAAC,MAAM,iBAAiB,CAAC,eAAe,EAAE,GAAG,CAAC,CAAC,CAAC;IAErE,wCAAwC;IACxC,OAAO,GAAG,OAAO,EAAE,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAE1C,MAAM,QAAQ,GAAG;QACf,aAAa,EAAE,aAAa;QAC5B,IAAI;QACJ,MAAM;QACN,MAAM;QACN,eAAe,EAAE,YAAY;QAC7B,OAAO;QACP,IAAI;QACJ,IAAI;KACL,CAAC;IAEF,MAAM,QAAQ,GAAG,MAAM,IAAA,aAAQ,GAAE,CAAC;IAClC,IAAI,CAAC,QAAQ,EAAE;QACb,MAAM,IAAI,qBAAa,CACrB,kBAAkB,qBAAS,4BAA4B,oBAAQ,QAAQ,CACxE,CAAC;KACH;IACD,IAAI,KAAK,EAAE;QACT,MAAM,QAAQ,GAAG;YACf,GAAG,IAAA,aAAM,EAAC,gBAAC,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,gBAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;SAC9E,CAAC;QACF,IAAI,KAAK,EAAE;YACT,QAAQ,CAAC,IAAI,CAAC,kBAAkB,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;YAClD,QAAQ,CAAC,IAAI,CAAC,cAAc,EAAE,SAAS,CAAC,CAAC;SAC1C;aAAM;YACL,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;SACxB;QACD,IAAI,EAAE,CAAC,CAAC,UAAU;QAClB,0CAA0C;QAC1C,MAAM,OAAO,CAAC,QAAQ,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC;KAC9C;SAAM;QACL,GAAG,CAAC,IAAI,CAAC,0BAA0B,EAAE,MAAM,CAAC,CAAC;QAC7C,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;SACF,CAAC;QACF,IAAI,KAAK,EAAE;YACT,QAAQ,CAAC,IAAI,CAAC,kBAAkB,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;YAClD,QAAQ,CAAC,IAAI,CAAC,cAAc,EAAE,SAAS,CAAC,CAAC;SAC1C;aAAM;YACL,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;SACxB;QACD,MAAM,QAAQ,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;QAE7C,GAAG,CAAC,OAAO,CAAC,2CAA2C,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;KAC1E;AACH,CAAC;AAzFD,wBAyFC"}
1
+ {"version":3,"file":"deploy.js","sourceRoot":"","sources":["../../../lib/builder/deploy.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;;;;;AAEH,oDAAuB;AACvB,0DAA6B;AAC7B,+CAA0D;AAC1D,4CAUsB;AACtB,oCAAuC;AACvC,8BAA2E;AAC3E,sCAAoC;AACpC,kCAA8F;AAE9F,MAAM,GAAG,GAAG,IAAA,kBAAS,EAAC,gBAAgB,CAAC,CAAC;AAExC;;;;;GAKG;AACH,KAAK,UAAU,OAAO,CACpB,QAAgB,EAChB,OAAiB,EAAE,EACnB,OAAmC,EAAE;IAErC,MAAM,SAAS,GAAG,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC;IACrC,OAAO,IAAA,6BAAsB,EAAC,QAAQ,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;AAC3D,CAAC;AAED;;;;;GAKG;AACH,KAAK,UAAU,QAAQ,CAAC,QAAgB,EAAE,OAAiB,EAAE,EAAE,OAA+B,EAAE;IAC9F,MAAM,SAAS,GAAG,CAAC,QAAQ,EAAE,GAAG,IAAI,CAAC,CAAC;IACtC,GAAG,CAAC,KAAK,CAAC,yBAAyB,EAAE,qBAAS,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC;IACrE,OAAO,MAAM,IAAA,mBAAI,EAAC,QAAQ,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;AAC/C,CAAC;AAED;;;;GAIG;AACH,KAAK,UAAU,iBAAiB,CAAC,eAAwB,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE;IAC5E,MAAM,EAAC,GAAG,EAAC,GAAG,MAAM,IAAA,oBAAe,EAAC,eAAe,CAAC,CAAC,CAAC,mBAAI,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IACjG,MAAM,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC;IAC5B,IAAI,CAAC,OAAO,EAAE;QACZ,MAAM,IAAI,qBAAa,CACrB,yFAAyF,CAC1F,CAAC;KACH;IAED,6FAA6F;IAC7F,gCAAgC;IAChC,MAAM,YAAY,GAAG,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACxC,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE;QAC7B,OAAO,OAAO,CAAC;KAChB;IACD,OAAO,GAAG,YAAY,CAAC,CAAC,CAAC,IAAI,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC;AACjD,CAAC;AAED;;;GAGG;AACI,KAAK,UAAU,MAAM,CAAC,EAC3B,SAAS,EAAE,aAAa,EACxB,WAAW,EAAE,eAAe,EAC5B,aAAa,EAAE,OAAO,EACtB,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE,EACnB,KAAK,GAAG,KAAK,EACb,IAAI,GAAG,KAAK,EACZ,MAAM,GAAG,iCAAqB,EAC9B,MAAM,GAAG,iCAAqB,EAC9B,YAAY,EACZ,OAAO,EACP,KAAK,EACL,SAAS,GAAG,qCAAyB,EACrC,IAAI,GAAG,8BAAkB,EACzB,IAAI,GAAG,8BAAkB,EACzB,SAAS,EACT,QAAQ,MACM,EAAE;IAChB,MAAM,IAAI,GAAG,IAAA,gBAAS,EAAC,QAAQ,CAAC,CAAC;IAEjC,MAAM,UAAU,GAAG,MAAM,IAAA,eAAU,GAAE,CAAC;IAEtC,IAAI,CAAC,UAAU,EAAE;QACf,MAAM,IAAI,qBAAa,CACrB,kBAAkB,uBAAW,KAAK,uBAAW,+CAA+C,CAC7F,CAAC;KACH;IAED,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,OAAO,GAAG,OAAO,IAAI,CAAC,MAAM,iBAAiB,CAAC,eAAe,EAAE,GAAG,CAAC,CAAC,CAAC;IAErE,wCAAwC;IACxC,OAAO,GAAG,OAAO,EAAE,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAE1C,MAAM,QAAQ,GAAG;QACf,aAAa,EAAE,aAAa;QAC5B,IAAI;QACJ,MAAM;QACN,MAAM;QACN,eAAe,EAAE,YAAY;QAC7B,OAAO;QACP,IAAI;QACJ,IAAI;KACL,CAAC;IAEF,MAAM,QAAQ,GAAG,MAAM,IAAA,aAAQ,GAAE,CAAC;IAClC,IAAI,CAAC,QAAQ,EAAE;QACb,MAAM,IAAI,qBAAa,CACrB,kBAAkB,qBAAS,4BAA4B,oBAAQ,QAAQ,CACxE,CAAC;KACH;IACD,IAAI,KAAK,EAAE;QACT,MAAM,QAAQ,GAAG;YACf,GAAG,IAAA,aAAM,EAAC,gBAAC,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,gBAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;SAC9E,CAAC;QACF,IAAI,EAAE,CAAC,CAAC,UAAU;QAClB,0CAA0C;QAC1C,MAAM,OAAO,CAAC,QAAQ,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC;KAC9C;SAAM;QACL,GAAG,CAAC,IAAI,CAAC,0BAA0B,EAAE,MAAM,CAAC,CAAC;QAC7C,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;SACF,CAAC;QACF,IAAI,KAAK,EAAE;YACT,QAAQ,CAAC,IAAI,CAAC,kBAAkB,EAAE,cAAc,EAAE,SAAS,CAAC,CAAC;YAC7D,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;SAC/B;aAAM;YACL,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;SACxB;QACD,MAAM,QAAQ,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;QAE7C,GAAG,CAAC,OAAO,CAAC,2CAA2C,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;KAC1E;AACH,CAAC;AAnFD,wBAmFC"}
@@ -1 +1 @@
1
- {"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../../lib/cli/config.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAyBH;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,UAAU,CAAC,IAAI,GAAE,MAAM,EAA0B,gBAqBtE;AAED;;;;;GAKG;AACH,wBAAsB,UAAU,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,GAAG,SAAgB,GAAG,OAAO,CAAC,GAAG,CAAC,CA4BrF"}
1
+ {"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../../lib/cli/config.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAwBH;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,UAAU,CAAC,IAAI,GAAE,MAAM,EAA0B,gBAqBtE;AAED;;;;;GAKG;AACH,wBAAsB,UAAU,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,GAAG,SAAgB,GAAG,OAAO,CAAC,GAAG,CAAC,CA4BrF"}
@@ -9,7 +9,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
9
9
  Object.defineProperty(exports, "__esModule", { value: true });
10
10
  exports.loadConfig = exports.findConfig = void 0;
11
11
  const lilconfig_ts_loader_1 = __importDefault(require("@sliphua/lilconfig-ts-loader"));
12
- const consola_1 = require("consola");
13
12
  const lilconfig_1 = require("lilconfig");
14
13
  const lodash_1 = __importDefault(require("lodash"));
15
14
  const node_path_1 = __importDefault(require("node:path"));
@@ -49,7 +48,7 @@ async function findConfig(argv = (0, helpers_1.hideBin)(process.argv)) {
49
48
  // otherwise use --log-level or the default.
50
49
  let logLevel;
51
50
  if (preArgs.verbose) {
52
- logLevel = consola_1.LogLevel.Debug;
51
+ logLevel = 'debug';
53
52
  }
54
53
  else {
55
54
  // if the loglevel is valid, use it, otherwise use the default
@@ -1 +1 @@
1
- {"version":3,"file":"config.js","sourceRoot":"","sources":["../../../lib/cli/config.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;AAEH,uFAAkD;AAClD,qCAAiC;AACjC,yCAA4C;AAC5C,oDAAuB;AACvB,0DAA6B;AAC7B,gDAAwB;AACxB,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,cAAI,CAAC,KAAK,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AACxD;;GAEG;AACH,MAAM,OAAO,GAAW,CAAC,QAAgB,EAAE,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;AAE/D;;;;;;;;;;;;;;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,QAA6C,CAAC;IAClD,IAAI,OAAO,CAAC,OAAO,EAAE;QACnB,QAAQ,GAAG,kBAAQ,CAAC,KAAK,CAAC;KAC3B;SAAM;QACL,8DAA8D;QAC9D,QAAQ,GAAG,IAAA,yBAAgB,EAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,6BAAiB,CAAC;KACtF;IACD,IAAA,mBAAU,EAAC,QAAQ,CAAC,CAAC;IAErB,IAAI,OAAO,CAAC,QAAQ,EAAE;QACpB,GAAG,CAAC,KAAK,CAAC,qDAAqD,CAAC,CAAC;KAClE;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;AArBD,gCAqBC;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;YAChB,KAAK,EAAE,6BAAM;YACb,KAAK,EAAE,OAAO;YACd,MAAM,EAAE,OAAO;YACf,MAAM,EAAE,OAAO;SAChB;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;QACnB,GAAG,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;QAC7B,OAAO,EAAE,CAAC;KACX;IACD,IAAI,MAAM,CAAC,OAAO,EAAE;QAClB,GAAG,CAAC,KAAK,CAAC,sCAAsC,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC;QACnE,OAAO,EAAE,CAAC;KACX;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;AA5BD,gCA4BC"}
1
+ {"version":3,"file":"config.js","sourceRoot":"","sources":["../../../lib/cli/config.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;AAEH,uFAAkD;AAClD,yCAA4C;AAC5C,oDAAuB;AACvB,0DAA6B;AAC7B,gDAAwB;AACxB,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,cAAI,CAAC,KAAK,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AACxD;;GAEG;AACH,MAAM,OAAO,GAAW,CAAC,QAAgB,EAAE,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;AAE/D;;;;;;;;;;;;;;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;QACnB,QAAQ,GAAG,OAAO,CAAC;KACpB;SAAM;QACL,8DAA8D;QAC9D,QAAQ,GAAG,IAAA,yBAAgB,EAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,6BAAiB,CAAC;KACtF;IACD,IAAA,mBAAU,EAAC,QAAQ,CAAC,CAAC;IAErB,IAAI,OAAO,CAAC,QAAQ,EAAE;QACpB,GAAG,CAAC,KAAK,CAAC,qDAAqD,CAAC,CAAC;KAClE;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;AArBD,gCAqBC;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;YAChB,KAAK,EAAE,6BAAM;YACb,KAAK,EAAE,OAAO;YACd,MAAM,EAAE,OAAO;YACf,MAAM,EAAE,OAAO;SAChB;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;QACnB,GAAG,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;QAC7B,OAAO,EAAE,CAAC;KACX;IACD,IAAI,MAAM,CAAC,OAAO,EAAE;QAClB,GAAG,CAAC,KAAK,CAAC,sCAAsC,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC;QACnE,OAAO,EAAE,CAAC;KACX;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;AA5BD,gCA4BC"}
@@ -1,8 +1,3 @@
1
- /**
2
- * Constants used across various modules in this package
3
- * @module
4
- */
5
- import { LogLevel } from 'consola';
6
1
  import { PackageJson } from 'type-fest';
7
2
  /**
8
3
  * CLI executable name
@@ -88,7 +83,7 @@ export declare const REQUIREMENTS_TXT_PATH: string;
88
83
  * The default alias creation strategy to pass to `mike` when deploying
89
84
  * (`symlink`, `redirect` or `copy`)
90
85
  */
91
- export declare const DEFAULT_DEPLOY_ALIAS_TYPE = "redirect";
86
+ export declare const DEFAULT_DEPLOY_ALIAS_TYPE = "symlink";
92
87
  /**
93
88
  * The default branch to deploy to
94
89
  */
@@ -109,11 +104,11 @@ export declare const DEFAULT_SERVE_HOST = "localhost";
109
104
  * Mapping of `@appium/docutils`' log levels to `consola` log levels
110
105
  */
111
106
  export declare const LogLevelMap: {
112
- readonly silent: LogLevel.Silent;
113
- readonly error: LogLevel.Fatal;
114
- readonly warn: LogLevel.Warn;
115
- readonly info: LogLevel.Info;
116
- readonly debug: LogLevel.Debug;
107
+ readonly silent: any;
108
+ readonly error: any;
109
+ readonly warn: any;
110
+ readonly info: any;
111
+ readonly debug: any;
117
112
  };
118
113
  /**
119
114
  * If the user does not specify a site directory _and_ the `mkdocs.yml` doesn't either, use this dir.
@@ -1 +1 @@
1
- {"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../lib/constants.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAC,QAAQ,EAAC,MAAM,SAAS,CAAC;AAIjC,OAAO,EAAC,WAAW,EAAC,MAAM,WAAW,CAAC;AAEtC;;GAEG;AACH,eAAO,MAAM,QAAQ,gBAAgB,CAAC;AAEtC;;GAEG;AACH,eAAO,MAAM,eAAe,eAAe,CAAC;AAE5C;;GAEG;AACH,eAAO,MAAM,kBAAkB,kBAAkB,CAAC;AAClD;;GAEG;AACH,eAAO,MAAM,WAAW,WAAW,CAAC;AACpC;;GAEG;AACH,eAAO,MAAM,iBAAiB,iBAAiB,CAAC;AAChD;;GAEG;AACH,eAAO,MAAM,qBAAqB,qBAAqB,CAAC;AACxD;;;GAGG;AACH,eAAO,MAAM,WAAW,YAAY,CAAC;AACrC;;GAEG;AACH,eAAO,MAAM,WAAW,WAAW,CAAC;AAEpC;;GAEG;AACH,eAAO,MAAM,SAAS,SAAS,CAAC;AAEhC;;;;;GAKG;AACH,eAAO,MAAM,QAAQ,QAAQ,CAAC;AAE9B;;GAEG;AACH,eAAO,MAAM,QAAQ,QAAQ,CAAC;AAE9B;;GAEG;AACH,eAAO,MAAM,eAAe,eAAe,CAAC;AAE5C;;GAEG;AACH,eAAO,MAAM,eAAe,WAAW,CAAC;AAExC;;GAEG;AACH,eAAO,MAAM,eAAe,WAAW,CAAC;AAExC;;GAEG;AACH,eAAO,MAAM,UAAU,aAAa,CAAC;AAErC;;GAEG;AACH,eAAO,MAAM,iBAAiB,SAAS,CAAC;AACxC;;GAEG;AACH,eAAO,MAAM,YAAY,QAAyB,CAAC;AACnD;;GAEG;AAEH,eAAO,MAAM,YAAY,EAAE,WAE1B,CAAC;AAEF;;GAEG;AAEH,eAAO,MAAM,qBAAqB,QAAiD,CAAC;AAEpF;;;GAGG;AACH,eAAO,MAAM,yBAAyB,aAAa,CAAC;AAEpD;;GAEG;AACH,eAAO,MAAM,qBAAqB,aAAa,CAAC;AAEhD;;GAEG;AACH,eAAO,MAAM,qBAAqB,WAAW,CAAC;AAE9C;;GAEG;AACH,eAAO,MAAM,kBAAkB,OAAO,CAAC;AAEvC;;GAEG;AACH,eAAO,MAAM,kBAAkB,cAAc,CAAC;AAE9C;;GAEG;AACH,eAAO,MAAM,WAAW;;;;;;CAMd,CAAC;AAEX;;GAEG;AACH,eAAO,MAAM,gBAAgB,SAAS,CAAC"}
1
+ {"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../lib/constants.ts"],"names":[],"mappings":"AASA,OAAO,EAAC,WAAW,EAAC,MAAM,WAAW,CAAC;AAEtC;;GAEG;AACH,eAAO,MAAM,QAAQ,gBAAgB,CAAC;AAEtC;;GAEG;AACH,eAAO,MAAM,eAAe,eAAe,CAAC;AAE5C;;GAEG;AACH,eAAO,MAAM,kBAAkB,kBAAkB,CAAC;AAClD;;GAEG;AACH,eAAO,MAAM,WAAW,WAAW,CAAC;AACpC;;GAEG;AACH,eAAO,MAAM,iBAAiB,iBAAiB,CAAC;AAChD;;GAEG;AACH,eAAO,MAAM,qBAAqB,qBAAqB,CAAC;AACxD;;;GAGG;AACH,eAAO,MAAM,WAAW,YAAY,CAAC;AACrC;;GAEG;AACH,eAAO,MAAM,WAAW,WAAW,CAAC;AAEpC;;GAEG;AACH,eAAO,MAAM,SAAS,SAAS,CAAC;AAEhC;;;;;GAKG;AACH,eAAO,MAAM,QAAQ,QAAQ,CAAC;AAE9B;;GAEG;AACH,eAAO,MAAM,QAAQ,QAAQ,CAAC;AAE9B;;GAEG;AACH,eAAO,MAAM,eAAe,eAAe,CAAC;AAE5C;;GAEG;AACH,eAAO,MAAM,eAAe,WAAW,CAAC;AAExC;;GAEG;AACH,eAAO,MAAM,eAAe,WAAW,CAAC;AAExC;;GAEG;AACH,eAAO,MAAM,UAAU,aAAa,CAAC;AAErC;;GAEG;AACH,eAAO,MAAM,iBAAiB,SAAS,CAAC;AACxC;;GAEG;AACH,eAAO,MAAM,YAAY,QAAyB,CAAC;AACnD;;GAEG;AAEH,eAAO,MAAM,YAAY,EAAE,WAE1B,CAAC;AAEF;;GAEG;AAEH,eAAO,MAAM,qBAAqB,QAAiD,CAAC;AAEpF;;;GAGG;AACH,eAAO,MAAM,yBAAyB,YAAY,CAAC;AAEnD;;GAEG;AACH,eAAO,MAAM,qBAAqB,aAAa,CAAC;AAEhD;;GAEG;AACH,eAAO,MAAM,qBAAqB,WAAW,CAAC;AAE9C;;GAEG;AACH,eAAO,MAAM,kBAAkB,OAAO,CAAC;AAEvC;;GAEG;AACH,eAAO,MAAM,kBAAkB,cAAc,CAAC;AAE9C;;GAEG;AACH,eAAO,MAAM,WAAW;;;;;;CAMd,CAAC;AAEX;;GAEG;AACH,eAAO,MAAM,gBAAgB,SAAS,CAAC"}
@@ -8,7 +8,8 @@ exports.DEFAULT_SITE_DIR = exports.LogLevelMap = exports.DEFAULT_SERVE_HOST = ex
8
8
  * Constants used across various modules in this package
9
9
  * @module
10
10
  */
11
- const consola_1 = require("consola");
11
+ // eslint-disable-next-line @typescript-eslint/no-var-requires -- Consola 3 import call is ESM
12
+ const { LogLevels } = require('consola');
12
13
  const node_fs_1 = require("node:fs");
13
14
  const support_1 = require("@appium/support");
14
15
  const node_path_1 = __importDefault(require("node:path"));
@@ -96,7 +97,7 @@ exports.REQUIREMENTS_TXT_PATH = node_path_1.default.join(exports.PKG_ROOT_DIR, e
96
97
  * The default alias creation strategy to pass to `mike` when deploying
97
98
  * (`symlink`, `redirect` or `copy`)
98
99
  */
99
- exports.DEFAULT_DEPLOY_ALIAS_TYPE = 'redirect';
100
+ exports.DEFAULT_DEPLOY_ALIAS_TYPE = 'symlink';
100
101
  /**
101
102
  * The default branch to deploy to
102
103
  */
@@ -117,11 +118,11 @@ exports.DEFAULT_SERVE_HOST = 'localhost';
117
118
  * Mapping of `@appium/docutils`' log levels to `consola` log levels
118
119
  */
119
120
  exports.LogLevelMap = {
120
- silent: consola_1.LogLevel.Silent,
121
- error: consola_1.LogLevel.Error,
122
- warn: consola_1.LogLevel.Warn,
123
- info: consola_1.LogLevel.Info,
124
- debug: consola_1.LogLevel.Debug,
121
+ silent: LogLevels.silent,
122
+ error: LogLevels.error,
123
+ warn: LogLevels.warn,
124
+ info: LogLevels.info,
125
+ debug: LogLevels.debug,
125
126
  };
126
127
  /**
127
128
  * If the user does not specify a site directory _and_ the `mkdocs.yml` doesn't either, use this dir.
@@ -1 +1 @@
1
- {"version":3,"file":"constants.js","sourceRoot":"","sources":["../../lib/constants.ts"],"names":[],"mappings":";;;;;;AAAA;;;GAGG;AACH,qCAAiC;AACjC,qCAAqC;AACrC,6CAAmC;AACnC,0DAA6B;AAG7B;;GAEG;AACU,QAAA,QAAQ,GAAG,aAAa,CAAC;AAEtC;;GAEG;AACU,QAAA,eAAe,GAAG,YAAY,CAAC;AAE5C;;GAEG;AACU,QAAA,kBAAkB,GAAG,eAAe,CAAC;AAClD;;GAEG;AACU,QAAA,WAAW,GAAG,QAAQ,CAAC;AACpC;;GAEG;AACU,QAAA,iBAAiB,GAAG,cAAc,CAAC;AAChD;;GAEG;AACU,QAAA,qBAAqB,GAAG,kBAAkB,CAAC;AACxD;;;GAGG;AACU,QAAA,WAAW,GAAG,SAAS,CAAC;AACrC;;GAEG;AACU,QAAA,WAAW,GAAG,QAAQ,CAAC;AAEpC;;GAEG;AACU,QAAA,SAAS,GAAG,MAAM,CAAC;AAEhC;;;;;GAKG;AACU,QAAA,QAAQ,GAAG,KAAK,CAAC;AAE9B;;GAEG;AACU,QAAA,QAAQ,GAAG,KAAK,CAAC;AAE9B;;GAEG;AACU,QAAA,eAAe,GAAG,YAAY,CAAC;AAE5C;;GAEG;AACU,QAAA,eAAe,GAAG,QAAQ,CAAC;AAExC;;GAEG;AACU,QAAA,eAAe,GAAG,QAAQ,CAAC;AAExC;;GAEG;AACU,QAAA,UAAU,GAAG,UAAU,CAAC;AAErC;;GAEG;AACU,QAAA,iBAAiB,GAAG,MAAM,CAAC;AACxC;;GAEG;AACU,QAAA,YAAY,GAAG,YAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;AACnD;;GAEG;AAEU,QAAA,YAAY,GAAgB,IAAI,CAAC,KAAK,CACjD,IAAA,sBAAY,EAAC,mBAAI,CAAC,IAAI,CAAC,oBAAY,EAAE,yBAAiB,CAAC,EAAE,MAAM,CAAC,CACjE,CAAC;AAEF;;GAEG;AAEU,QAAA,qBAAqB,GAAG,mBAAI,CAAC,IAAI,CAAC,oBAAY,EAAE,6BAAqB,CAAC,CAAC;AAEpF;;;GAGG;AACU,QAAA,yBAAyB,GAAG,UAAU,CAAC;AAEpD;;GAEG;AACU,QAAA,qBAAqB,GAAG,UAAU,CAAC;AAEhD;;GAEG;AACU,QAAA,qBAAqB,GAAG,QAAQ,CAAC;AAE9C;;GAEG;AACU,QAAA,kBAAkB,GAAG,IAAI,CAAC;AAEvC;;GAEG;AACU,QAAA,kBAAkB,GAAG,WAAW,CAAC;AAE9C;;GAEG;AACU,QAAA,WAAW,GAAG;IACzB,MAAM,EAAE,kBAAQ,CAAC,MAAM;IACvB,KAAK,EAAE,kBAAQ,CAAC,KAAK;IACrB,IAAI,EAAE,kBAAQ,CAAC,IAAI;IACnB,IAAI,EAAE,kBAAQ,CAAC,IAAI;IACnB,KAAK,EAAE,kBAAQ,CAAC,KAAK;CACb,CAAC;AAEX;;GAEG;AACU,QAAA,gBAAgB,GAAG,MAAM,CAAC"}
1
+ {"version":3,"file":"constants.js","sourceRoot":"","sources":["../../lib/constants.ts"],"names":[],"mappings":";;;;;;AAAA;;;GAGG;AACH,8FAA8F;AAC9F,MAAM,EAAC,SAAS,EAAC,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;AACvC,qCAAqC;AACrC,6CAAmC;AACnC,0DAA6B;AAG7B;;GAEG;AACU,QAAA,QAAQ,GAAG,aAAa,CAAC;AAEtC;;GAEG;AACU,QAAA,eAAe,GAAG,YAAY,CAAC;AAE5C;;GAEG;AACU,QAAA,kBAAkB,GAAG,eAAe,CAAC;AAClD;;GAEG;AACU,QAAA,WAAW,GAAG,QAAQ,CAAC;AACpC;;GAEG;AACU,QAAA,iBAAiB,GAAG,cAAc,CAAC;AAChD;;GAEG;AACU,QAAA,qBAAqB,GAAG,kBAAkB,CAAC;AACxD;;;GAGG;AACU,QAAA,WAAW,GAAG,SAAS,CAAC;AACrC;;GAEG;AACU,QAAA,WAAW,GAAG,QAAQ,CAAC;AAEpC;;GAEG;AACU,QAAA,SAAS,GAAG,MAAM,CAAC;AAEhC;;;;;GAKG;AACU,QAAA,QAAQ,GAAG,KAAK,CAAC;AAE9B;;GAEG;AACU,QAAA,QAAQ,GAAG,KAAK,CAAC;AAE9B;;GAEG;AACU,QAAA,eAAe,GAAG,YAAY,CAAC;AAE5C;;GAEG;AACU,QAAA,eAAe,GAAG,QAAQ,CAAC;AAExC;;GAEG;AACU,QAAA,eAAe,GAAG,QAAQ,CAAC;AAExC;;GAEG;AACU,QAAA,UAAU,GAAG,UAAU,CAAC;AAErC;;GAEG;AACU,QAAA,iBAAiB,GAAG,MAAM,CAAC;AACxC;;GAEG;AACU,QAAA,YAAY,GAAG,YAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;AACnD;;GAEG;AAEU,QAAA,YAAY,GAAgB,IAAI,CAAC,KAAK,CACjD,IAAA,sBAAY,EAAC,mBAAI,CAAC,IAAI,CAAC,oBAAY,EAAE,yBAAiB,CAAC,EAAE,MAAM,CAAC,CACjE,CAAC;AAEF;;GAEG;AAEU,QAAA,qBAAqB,GAAG,mBAAI,CAAC,IAAI,CAAC,oBAAY,EAAE,6BAAqB,CAAC,CAAC;AAEpF;;;GAGG;AACU,QAAA,yBAAyB,GAAG,SAAS,CAAC;AAEnD;;GAEG;AACU,QAAA,qBAAqB,GAAG,UAAU,CAAC;AAEhD;;GAEG;AACU,QAAA,qBAAqB,GAAG,QAAQ,CAAC;AAE9C;;GAEG;AACU,QAAA,kBAAkB,GAAG,IAAI,CAAC;AAEvC;;GAEG;AACU,QAAA,kBAAkB,GAAG,WAAW,CAAC;AAE9C;;GAEG;AACU,QAAA,WAAW,GAAG;IACzB,MAAM,EAAE,SAAS,CAAC,MAAM;IACxB,KAAK,EAAE,SAAS,CAAC,KAAK;IACtB,IAAI,EAAE,SAAS,CAAC,IAAI;IACpB,IAAI,EAAE,SAAS,CAAC,IAAI;IACpB,KAAK,EAAE,SAAS,CAAC,KAAK;CACd,CAAC;AAEX;;GAEG;AACU,QAAA,gBAAgB,GAAG,MAAM,CAAC"}
@@ -5,14 +5,14 @@
5
5
  *
6
6
  * @module
7
7
  */
8
- import { type Consola, type LogLevel } from 'consola';
8
+ declare const LogLevel: any;
9
9
  import { LogLevelMap } from './constants';
10
10
  /**
11
11
  * Type guard to see if a string is a recognized log level
12
12
  * @param level any value
13
13
  */
14
14
  export declare function isLogLevelString(level: any): level is keyof typeof LogLevelMap;
15
- export declare function getLogger(tag: string, parent?: Consola): Consola;
15
+ export declare function getLogger(tag: string, parent?: any): any;
16
16
  /**
17
17
  * Initialize the logging system.
18
18
  *
@@ -20,5 +20,6 @@ export declare function getLogger(tag: string, parent?: Consola): Consola;
20
20
  *
21
21
  * @remarks Child loggers seem to inherit the "paused" state of the parent, so when this is called, we must resume all of them.
22
22
  */
23
- export declare const initLogger: (level: keyof typeof LogLevelMap | LogLevel) => void;
23
+ export declare const initLogger: (level: keyof typeof LogLevelMap | typeof LogLevel) => void;
24
+ export {};
24
25
  //# sourceMappingURL=logger.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../lib/logger.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAGH,OAAgB,EACd,KAAK,OAAO,EAIZ,KAAK,QAAQ,EAEd,MAAM,SAAS,CAAC;AAIjB,OAAO,EAAoB,WAAW,EAAC,MAAM,aAAa,CAAC;AAqH3D;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,GAAG,GAAG,KAAK,IAAI,MAAM,OAAO,WAAW,CAE9E;AAkBD,wBAAgB,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,UAAa,WAWzD;AAED;;;;;;GAMG;AACH,eAAO,MAAM,UAAU,UAAkB,MAAM,kBAAkB,GAAG,QAAQ,SAW1E,CAAC"}
1
+ {"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../lib/logger.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAGH,QAAA,MAAuC,QAAQ,KAAsB,CAAC;AAEtE,OAAO,EAAoB,WAAW,EAAC,MAAM,aAAa,CAAC;AAS3D;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,GAAG,GAAG,KAAK,IAAI,MAAM,OAAO,WAAW,CAE9E;AAsBD,wBAAgB,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,MAAa,OAWzD;AAED;;;;;;GAMG;AACH,eAAO,MAAM,UAAU,UAAkB,MAAM,kBAAkB,GAAG,eAAe,SAWjF,CAAC"}
@@ -6,127 +6,15 @@
6
6
  *
7
7
  * @module
8
8
  */
9
- var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
10
- if (k2 === undefined) k2 = k;
11
- var desc = Object.getOwnPropertyDescriptor(m, k);
12
- if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
13
- desc = { enumerable: true, get: function() { return m[k]; } };
14
- }
15
- Object.defineProperty(o, k2, desc);
16
- }) : (function(o, m, k, k2) {
17
- if (k2 === undefined) k2 = k;
18
- o[k2] = m[k];
19
- }));
20
- var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
21
- Object.defineProperty(o, "default", { enumerable: true, value: v });
22
- }) : function(o, v) {
23
- o["default"] = v;
24
- });
25
- var __importStar = (this && this.__importStar) || function (mod) {
26
- if (mod && mod.__esModule) return mod;
27
- var result = {};
28
- if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
29
- __setModuleDefault(result, mod);
30
- return result;
31
- };
32
9
  var __importDefault = (this && this.__importDefault) || function (mod) {
33
10
  return (mod && mod.__esModule) ? mod : { "default": mod };
34
11
  };
35
12
  Object.defineProperty(exports, "__esModule", { value: true });
36
13
  exports.initLogger = exports.getLogger = exports.isLogLevelString = void 0;
37
- const chalk_1 = __importDefault(require("chalk"));
38
- const consola_1 = __importStar(require("consola"));
39
- const figures_1 = __importDefault(require("figures"));
14
+ // eslint-disable-next-line @typescript-eslint/no-var-requires -- Consola 3 import call is ESM
15
+ const { ConsolaInstance, createConsola, LogLevel } = require('consola');
40
16
  const lodash_1 = __importDefault(require("lodash"));
41
- const log_symbols_1 = __importDefault(require("log-symbols"));
42
17
  const constants_1 = require("./constants");
43
- /**
44
- * This is a reporter for `consola` which uses some extra/custom icons and colors.
45
- *
46
- * @privateRemarks
47
- * I did not like that the default `FancyReport` logs errors in _green_ without any sort of icon.
48
- * Both `log-symbols` and `consola` consume `chalk`, so we do too. `consola` also depends on `figures`.
49
- */
50
- class DocutilsReporter extends consola_1.FancyReporter {
51
- /**
52
- * Type guard to check if a log type has a color
53
- * @param type A log type
54
- */
55
- static hasTypeColor(type) {
56
- return type in DocutilsReporter.TYPE_COLOR_MAP;
57
- }
58
- /**
59
- * Type guard to check if a log level has a color
60
- * @param level A log level
61
- */
62
- static hasLevelColor(level) {
63
- return level in DocutilsReporter.LEVEL_COLORS;
64
- }
65
- /**
66
- * Type guard to check if a log type has an icon
67
- * @param type A log type
68
- */
69
- static hasTypeIcon(type) {
70
- return type in DocutilsReporter.TYPE_ICONS;
71
- }
72
- /**
73
- * Prefixes the logging output with colors and symbols, depending on contents of `logObj`.
74
- * @param logObj Consola's log object
75
- * @param isBadge {@linkcode FancyReporter} uses this; I think it depends on the terminal width
76
- * @returns
77
- */
78
- formatType(logObj, isBadge) {
79
- const { TYPE_COLOR_MAP, LEVEL_COLORS, TYPE_ICONS, hasTypeColor, hasLevelColor, hasTypeIcon, DEFAULT_COLOR, } = DocutilsReporter;
80
- let typeColor;
81
- if (hasTypeColor(logObj.type)) {
82
- typeColor = TYPE_COLOR_MAP[logObj.type];
83
- }
84
- else if (hasLevelColor(logObj.level)) {
85
- typeColor = LEVEL_COLORS[logObj.level];
86
- }
87
- else {
88
- typeColor = ((this.options.secondaryColor ?? DEFAULT_COLOR));
89
- }
90
- if (isBadge) {
91
- return chalk_1.default[('bg' + lodash_1.default.capitalize(typeColor))].black(` ${lodash_1.default.toUpper(logObj.type)}`);
92
- }
93
- const type = hasTypeIcon(logObj.type) ? TYPE_ICONS[logObj.type] : logObj.type;
94
- return type ? chalk_1.default[typeColor](type) : '';
95
- }
96
- }
97
- /**
98
- * Mapping of log types (the name of the logging method called) to chalk fg colors
99
- */
100
- DocutilsReporter.TYPE_COLOR_MAP = {
101
- info: 'cyan',
102
- success: 'green',
103
- error: 'red',
104
- warn: 'yellow',
105
- };
106
- /**
107
- * Mapping of log levels to chalk fg colors
108
- */
109
- DocutilsReporter.LEVEL_COLORS = {
110
- 0: 'red',
111
- 1: 'yellow',
112
- 2: 'white',
113
- 3: 'green',
114
- };
115
- /**
116
- * Mapping of log types to icons/symbols
117
- */
118
- DocutilsReporter.TYPE_ICONS = {
119
- info: log_symbols_1.default.info,
120
- success: log_symbols_1.default.success,
121
- error: log_symbols_1.default.error,
122
- warn: log_symbols_1.default.warning,
123
- debug: (0, figures_1.default)('›'),
124
- trace: (0, figures_1.default)('›'),
125
- };
126
- /**
127
- * Default color to use if we can't find a color for the log type or level
128
- */
129
- DocutilsReporter.DEFAULT_COLOR = 'grey';
130
18
  /**
131
19
  * The global log level
132
20
  *
@@ -142,15 +30,19 @@ function isLogLevelString(level) {
142
30
  }
143
31
  exports.isLogLevelString = isLogLevelString;
144
32
  /**
145
- * The logger from which all loggers are created. This one uses a unique tag and our custom reporter.
33
+ * The logger from which all loggers are created. This one uses a unique tag.
146
34
  */
147
- const rootLogger = consola_1.default.create({
35
+ const rootLogger = createConsola({
148
36
  defaults: { tag: 'docutils' },
149
- reporters: [new DocutilsReporter()],
37
+ fancy: true,
150
38
  level: globalLevel,
39
+ formatOptions: {
40
+ colors: true,
41
+ date: false,
42
+ },
151
43
  });
152
44
  // this prevents logging before `initLogger` is called
153
- rootLogger.pause();
45
+ rootLogger.pauseLogs();
154
46
  /**
155
47
  * A map of tags to loggers
156
48
  */
@@ -178,12 +70,12 @@ exports.getLogger = getLogger;
178
70
  exports.initLogger = lodash_1.default.once((level) => {
179
71
  globalLevel = isLogLevelString(level) ? constants_1.LogLevelMap[level] : level;
180
72
  rootLogger.level = globalLevel;
181
- rootLogger.resume();
73
+ rootLogger.resumeLogs();
182
74
  for (const ref of loggers.values()) {
183
75
  const logger = ref.deref();
184
76
  if (logger) {
185
77
  logger.level = globalLevel;
186
- logger.resume();
78
+ logger.resumeLogs();
187
79
  }
188
80
  }
189
81
  });
@@ -1 +1 @@
1
- {"version":3,"file":"logger.js","sourceRoot":"","sources":["../../lib/logger.ts"],"names":[],"mappings":";AAAA;;;;;;GAMG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,kDAAwE;AACxE,mDAOiB;AACjB,sDAA8B;AAC9B,oDAAuB;AACvB,8DAAqC;AACrC,2CAA2D;AAE3D;;;;;;GAMG;AACH,MAAM,gBAAiB,SAAQ,uBAAa;IAsC1C;;;OAGG;IACH,MAAM,CAAC,YAAY,CAAC,IAAa;QAC/B,OAAO,IAAI,IAAI,gBAAgB,CAAC,cAAc,CAAC;IACjD,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,aAAa,CAAC,KAAe;QAClC,OAAO,KAAK,IAAI,gBAAgB,CAAC,YAAY,CAAC;IAChD,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,WAAW,CAAC,IAAa;QAC9B,OAAO,IAAI,IAAI,gBAAgB,CAAC,UAAU,CAAC;IAC7C,CAAC;IAED;;;;;OAKG;IACgB,UAAU,CAAC,MAAgC,EAAE,OAAiB;QAC/E,MAAM,EACJ,cAAc,EACd,YAAY,EACZ,UAAU,EACV,YAAY,EACZ,aAAa,EACb,WAAW,EACX,aAAa,GACd,GAAG,gBAAgB,CAAC;QAErB,IAAI,SAAiC,CAAC;QACtC,IAAI,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE;YAC7B,SAAS,GAAG,cAAc,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;SACzC;aAAM,IAAI,aAAa,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE;YACtC,SAAS,GAAG,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;SACxC;aAAM;YACL,SAAS,GAA2B,CAClC,CAAE,IAAI,CAAC,OAAgC,CAAC,cAAc,IAAI,aAAa,CAAC,CACzE,CAAC;SACH;QAED,IAAI,OAAO,EAAE;YACX,OAAO,eAAK,CAAC,CAAC,IAAI,GAAG,gBAAC,CAAC,UAAU,CAAC,SAAS,CAAC,CAA2B,CAAC,CAAC,KAAK,CAC5E,IAAI,gBAAC,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAC7B,CAAC;SACH;QAED,MAAM,IAAI,GAAG,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC;QAC9E,OAAO,IAAI,CAAC,CAAC,CAAC,eAAK,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAC5C,CAAC;;AAjGD;;GAEG;AACa,+BAAc,GAAG;IAC/B,IAAI,EAAE,MAAM;IACZ,OAAO,EAAE,OAAO;IAChB,KAAK,EAAE,KAAK;IACZ,IAAI,EAAE,QAAQ;CACqC,CAAC;AAEtD;;GAEG;AACa,6BAAY,GAAG;IAC7B,CAAC,EAAE,KAAK;IACR,CAAC,EAAE,QAAQ;IACX,CAAC,EAAE,OAAO;IACV,CAAC,EAAE,OAAO;CAC0C,CAAC;AAEvD;;GAEG;AACa,2BAAU,GAAG;IAC3B,IAAI,EAAE,qBAAU,CAAC,IAAI;IACrB,OAAO,EAAE,qBAAU,CAAC,OAAO;IAC3B,KAAK,EAAE,qBAAU,CAAC,KAAK;IACvB,IAAI,EAAE,qBAAU,CAAC,OAAO;IACxB,KAAK,EAAE,IAAA,iBAAO,EAAC,GAAG,CAAC;IACnB,KAAK,EAAE,IAAA,iBAAO,EAAC,GAAG,CAAC;CACgB,CAAC;AAEtC;;GAEG;AACa,8BAAa,GAAG,MAAM,CAAC;AAiEzC;;;;GAIG;AACH,IAAI,WAAW,GAAa,uBAAW,CAAC,6BAAiB,CAAC,CAAC;AAE3D;;;GAGG;AACH,SAAgB,gBAAgB,CAAC,KAAU;IACzC,OAAO,KAAK,IAAI,uBAAW,CAAC;AAC9B,CAAC;AAFD,4CAEC;AAED;;GAEG;AACH,MAAM,UAAU,GAAG,iBAAO,CAAC,MAAM,CAAC;IAChC,QAAQ,EAAE,EAAC,GAAG,EAAE,UAAU,EAAC;IAC3B,SAAS,EAAE,CAAC,IAAI,gBAAgB,EAAE,CAAC;IACnC,KAAK,EAAE,WAAW;CACnB,CAAC,CAAC;AACH,sDAAsD;AACtD,UAAU,CAAC,KAAK,EAAE,CAAC;AAEnB;;GAEG;AACH,MAAM,OAAO,GAAkC,IAAI,GAAG,EAAE,CAAC;AAEzD,SAAgB,SAAS,CAAC,GAAW,EAAE,MAAM,GAAG,UAAU;IACxD,IAAI,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;QACpB,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,KAAK,EAAE,CAAC;QACzC,IAAI,MAAM,EAAE;YACV,OAAO,MAAM,CAAC;SACf;KACF;IACD,MAAM,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACnC,MAAM,CAAC,KAAK,GAAG,WAAW,CAAC;IAC3B,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;IACtC,OAAO,MAAM,CAAC;AAChB,CAAC;AAXD,8BAWC;AAED;;;;;;GAMG;AACU,QAAA,UAAU,GAAG,gBAAC,CAAC,IAAI,CAAC,CAAC,KAA0C,EAAE,EAAE;IAC9E,WAAW,GAAG,gBAAgB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,uBAAW,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;IACnE,UAAU,CAAC,KAAK,GAAG,WAAW,CAAC;IAC/B,UAAU,CAAC,MAAM,EAAE,CAAC;IACpB,KAAK,MAAM,GAAG,IAAI,OAAO,CAAC,MAAM,EAAE,EAAE;QAClC,MAAM,MAAM,GAAG,GAAG,CAAC,KAAK,EAAE,CAAC;QAC3B,IAAI,MAAM,EAAE;YACV,MAAM,CAAC,KAAK,GAAG,WAAW,CAAC;YAC3B,MAAM,CAAC,MAAM,EAAE,CAAC;SACjB;KACF;AACH,CAAC,CAAC,CAAC"}
1
+ {"version":3,"file":"logger.js","sourceRoot":"","sources":["../../lib/logger.ts"],"names":[],"mappings":";AAAA;;;;;;GAMG;;;;;;AAEH,8FAA8F;AAC9F,MAAM,EAAC,eAAe,EAAE,aAAa,EAAE,QAAQ,EAAC,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;AACtE,oDAAuB;AACvB,2CAA2D;AAE3D;;;;GAIG;AACH,IAAI,WAAW,GAAoB,uBAAW,CAAC,6BAAiB,CAAC,CAAC;AAElE;;;GAGG;AACH,SAAgB,gBAAgB,CAAC,KAAU;IACzC,OAAO,KAAK,IAAI,uBAAW,CAAC;AAC9B,CAAC;AAFD,4CAEC;AAED;;GAEG;AACH,MAAM,UAAU,GAAG,aAAa,CAAC;IAC/B,QAAQ,EAAE,EAAC,GAAG,EAAE,UAAU,EAAC;IAC3B,KAAK,EAAE,IAAI;IACX,KAAK,EAAE,WAAW;IAClB,aAAa,EAAE;QACb,MAAM,EAAE,IAAI;QACZ,IAAI,EAAE,KAAK;KACZ;CACF,CAAC,CAAC;AACH,sDAAsD;AACtD,UAAU,CAAC,SAAS,EAAE,CAAC;AAEvB;;GAEG;AACH,MAAM,OAAO,GAAiD,IAAI,GAAG,EAAE,CAAC;AAExE,SAAgB,SAAS,CAAC,GAAW,EAAE,MAAM,GAAG,UAAU;IACxD,IAAI,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;QACpB,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,KAAK,EAAE,CAAC;QACzC,IAAI,MAAM,EAAE;YACV,OAAO,MAAM,CAAC;SACf;KACF;IACD,MAAM,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACnC,MAAM,CAAC,KAAK,GAAG,WAAW,CAAC;IAC3B,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;IACtC,OAAO,MAAM,CAAC;AAChB,CAAC;AAXD,8BAWC;AAED;;;;;;GAMG;AACU,QAAA,UAAU,GAAG,gBAAC,CAAC,IAAI,CAAC,CAAC,KAAiD,EAAE,EAAE;IACrF,WAAW,GAAG,gBAAgB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,uBAAW,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;IACnE,UAAU,CAAC,KAAK,GAAG,WAAW,CAAC;IAC/B,UAAU,CAAC,UAAU,EAAE,CAAC;IACxB,KAAK,MAAM,GAAG,IAAI,OAAO,CAAC,MAAM,EAAE,EAAE;QAClC,MAAM,MAAM,GAAG,GAAG,CAAC,KAAK,EAAE,CAAC;QAC3B,IAAI,MAAM,EAAE;YACV,MAAM,CAAC,KAAK,GAAG,WAAW,CAAC;YAC3B,MAAM,CAAC,UAAU,EAAE,CAAC;SACrB;KACF;AACH,CAAC,CAAC,CAAC"}
@@ -139,12 +139,6 @@ export async function deploy({
139
139
  const mikeArgs = [
140
140
  ...argify(_.pickBy(mikeOpts, (value) => _.isNumber(value) || Boolean(value))),
141
141
  ];
142
- if (alias) {
143
- mikeArgs.push('--update-aliases', version, alias);
144
- mikeArgs.push('--alias-type', aliasType);
145
- } else {
146
- mikeArgs.push(version);
147
- }
148
142
  stop(); // discard
149
143
  // unsure about how SIGHUP is handled here
150
144
  await doServe(mikePath, mikeArgs, serveOpts);
@@ -159,8 +153,8 @@ export async function deploy({
159
153
  ),
160
154
  ];
161
155
  if (alias) {
162
- mikeArgs.push('--update-aliases', version, alias);
163
- mikeArgs.push('--alias-type', aliasType);
156
+ mikeArgs.push('--update-aliases', '--alias-type', aliasType);
157
+ mikeArgs.push(version, alias);
164
158
  } else {
165
159
  mikeArgs.push(version);
166
160
  }
package/lib/cli/config.ts CHANGED
@@ -4,7 +4,6 @@
4
4
  */
5
5
 
6
6
  import loadTs from '@sliphua/lilconfig-ts-loader';
7
- import {LogLevel} from 'consola';
8
7
  import {lilconfig, Loader} from 'lilconfig';
9
8
  import _ from 'lodash';
10
9
  import path from 'node:path';
@@ -46,9 +45,9 @@ export async function findConfig(argv: string[] = hideBin(process.argv)) {
46
45
 
47
46
  // if --verbose is used, set the log level to debug.
48
47
  // otherwise use --log-level or the default.
49
- let logLevel: LogLevel | keyof typeof LogLevelMap;
48
+ let logLevel: keyof typeof LogLevelMap;
50
49
  if (preArgs.verbose) {
51
- logLevel = LogLevel.Debug;
50
+ logLevel = 'debug';
52
51
  } else {
53
52
  // if the loglevel is valid, use it, otherwise use the default
54
53
  logLevel = isLogLevelString(preArgs.logLevel) ? preArgs.logLevel : DEFAULT_LOG_LEVEL;
package/lib/constants.ts CHANGED
@@ -2,7 +2,8 @@
2
2
  * Constants used across various modules in this package
3
3
  * @module
4
4
  */
5
- import {LogLevel} from 'consola';
5
+ // eslint-disable-next-line @typescript-eslint/no-var-requires -- Consola 3 import call is ESM
6
+ const {LogLevels} = require('consola');
6
7
  import {readFileSync} from 'node:fs';
7
8
  import {fs} from '@appium/support';
8
9
  import path from 'node:path';
@@ -108,7 +109,7 @@ export const REQUIREMENTS_TXT_PATH = path.join(PKG_ROOT_DIR, NAME_REQUIREMENTS_T
108
109
  * The default alias creation strategy to pass to `mike` when deploying
109
110
  * (`symlink`, `redirect` or `copy`)
110
111
  */
111
- export const DEFAULT_DEPLOY_ALIAS_TYPE = 'redirect';
112
+ export const DEFAULT_DEPLOY_ALIAS_TYPE = 'symlink';
112
113
 
113
114
  /**
114
115
  * The default branch to deploy to
@@ -134,11 +135,11 @@ export const DEFAULT_SERVE_HOST = 'localhost';
134
135
  * Mapping of `@appium/docutils`' log levels to `consola` log levels
135
136
  */
136
137
  export const LogLevelMap = {
137
- silent: LogLevel.Silent,
138
- error: LogLevel.Error,
139
- warn: LogLevel.Warn,
140
- info: LogLevel.Info,
141
- debug: LogLevel.Debug,
138
+ silent: LogLevels.silent,
139
+ error: LogLevels.error,
140
+ warn: LogLevels.warn,
141
+ info: LogLevels.info,
142
+ debug: LogLevels.debug,
142
143
  } as const;
143
144
 
144
145
  /**
package/lib/logger.ts CHANGED
@@ -6,134 +6,17 @@
6
6
  * @module
7
7
  */
8
8
 
9
- import chalk, {type BackgroundColor, type ForegroundColor} from 'chalk';
10
- import consola, {
11
- type Consola,
12
- type ConsolaReporterLogObject,
13
- FancyReporter,
14
- type FancyReporterOptions,
15
- type LogLevel,
16
- type logType as LogType,
17
- } from 'consola';
18
- import figures from 'figures';
9
+ // eslint-disable-next-line @typescript-eslint/no-var-requires -- Consola 3 import call is ESM
10
+ const {ConsolaInstance, createConsola, LogLevel} = require('consola');
19
11
  import _ from 'lodash';
20
- import logSymbols from 'log-symbols';
21
12
  import {DEFAULT_LOG_LEVEL, LogLevelMap} from './constants';
22
13
 
23
- /**
24
- * This is a reporter for `consola` which uses some extra/custom icons and colors.
25
- *
26
- * @privateRemarks
27
- * I did not like that the default `FancyReport` logs errors in _green_ without any sort of icon.
28
- * Both `log-symbols` and `consola` consume `chalk`, so we do too. `consola` also depends on `figures`.
29
- */
30
- class DocutilsReporter extends FancyReporter {
31
- /**
32
- * Mapping of log types (the name of the logging method called) to chalk fg colors
33
- */
34
- static readonly TYPE_COLOR_MAP = {
35
- info: 'cyan',
36
- success: 'green',
37
- error: 'red',
38
- warn: 'yellow',
39
- } satisfies {[k in LogType]?: typeof ForegroundColor};
40
-
41
- /**
42
- * Mapping of log levels to chalk fg colors
43
- */
44
- static readonly LEVEL_COLORS = {
45
- 0: 'red',
46
- 1: 'yellow',
47
- 2: 'white',
48
- 3: 'green',
49
- } satisfies {[k in LogLevel]?: typeof ForegroundColor};
50
-
51
- /**
52
- * Mapping of log types to icons/symbols
53
- */
54
- static readonly TYPE_ICONS = {
55
- info: logSymbols.info,
56
- success: logSymbols.success,
57
- error: logSymbols.error,
58
- warn: logSymbols.warning,
59
- debug: figures('›'),
60
- trace: figures('›'),
61
- } satisfies {[k in LogType]?: string};
62
-
63
- /**
64
- * Default color to use if we can't find a color for the log type or level
65
- */
66
- static readonly DEFAULT_COLOR = 'grey';
67
-
68
- /**
69
- * Type guard to check if a log type has a color
70
- * @param type A log type
71
- */
72
- static hasTypeColor(type: LogType): type is keyof typeof DocutilsReporter.TYPE_COLOR_MAP {
73
- return type in DocutilsReporter.TYPE_COLOR_MAP;
74
- }
75
-
76
- /**
77
- * Type guard to check if a log level has a color
78
- * @param level A log level
79
- */
80
- static hasLevelColor(level: LogLevel): level is keyof typeof DocutilsReporter.LEVEL_COLORS {
81
- return level in DocutilsReporter.LEVEL_COLORS;
82
- }
83
-
84
- /**
85
- * Type guard to check if a log type has an icon
86
- * @param type A log type
87
- */
88
- static hasTypeIcon(type: LogType): type is keyof typeof DocutilsReporter.TYPE_ICONS {
89
- return type in DocutilsReporter.TYPE_ICONS;
90
- }
91
-
92
- /**
93
- * Prefixes the logging output with colors and symbols, depending on contents of `logObj`.
94
- * @param logObj Consola's log object
95
- * @param isBadge {@linkcode FancyReporter} uses this; I think it depends on the terminal width
96
- * @returns
97
- */
98
- protected override formatType(logObj: ConsolaReporterLogObject, isBadge?: boolean): string {
99
- const {
100
- TYPE_COLOR_MAP,
101
- LEVEL_COLORS,
102
- TYPE_ICONS,
103
- hasTypeColor,
104
- hasLevelColor,
105
- hasTypeIcon,
106
- DEFAULT_COLOR,
107
- } = DocutilsReporter;
108
-
109
- let typeColor: typeof ForegroundColor;
110
- if (hasTypeColor(logObj.type)) {
111
- typeColor = TYPE_COLOR_MAP[logObj.type];
112
- } else if (hasLevelColor(logObj.level)) {
113
- typeColor = LEVEL_COLORS[logObj.level];
114
- } else {
115
- typeColor = <typeof ForegroundColor>(
116
- ((this.options as FancyReporterOptions).secondaryColor ?? DEFAULT_COLOR)
117
- );
118
- }
119
-
120
- if (isBadge) {
121
- return chalk[('bg' + _.capitalize(typeColor)) as typeof BackgroundColor].black(
122
- ` ${_.toUpper(logObj.type)}`
123
- );
124
- }
125
-
126
- const type = hasTypeIcon(logObj.type) ? TYPE_ICONS[logObj.type] : logObj.type;
127
- return type ? chalk[typeColor](type) : '';
128
- }
129
- }
130
-
131
14
  /**
132
15
  * The global log level
133
16
  *
134
17
  * "Global" inasmuch as any logger created from the root logger will use this level.
135
18
  */
136
- let globalLevel: LogLevel = LogLevelMap[DEFAULT_LOG_LEVEL];
19
+ let globalLevel: typeof LogLevel = LogLevelMap[DEFAULT_LOG_LEVEL];
137
20
 
138
21
  /**
139
22
  * Type guard to see if a string is a recognized log level
@@ -144,20 +27,24 @@ export function isLogLevelString(level: any): level is keyof typeof LogLevelMap
144
27
  }
145
28
 
146
29
  /**
147
- * The logger from which all loggers are created. This one uses a unique tag and our custom reporter.
30
+ * The logger from which all loggers are created. This one uses a unique tag.
148
31
  */
149
- const rootLogger = consola.create({
32
+ const rootLogger = createConsola({
150
33
  defaults: {tag: 'docutils'},
151
- reporters: [new DocutilsReporter()],
34
+ fancy: true,
152
35
  level: globalLevel,
36
+ formatOptions: {
37
+ colors: true,
38
+ date: false,
39
+ },
153
40
  });
154
41
  // this prevents logging before `initLogger` is called
155
- rootLogger.pause();
42
+ rootLogger.pauseLogs();
156
43
 
157
44
  /**
158
45
  * A map of tags to loggers
159
46
  */
160
- const loggers: Map<string, WeakRef<Consola>> = new Map();
47
+ const loggers: Map<string, WeakRef<typeof ConsolaInstance>> = new Map();
161
48
 
162
49
  export function getLogger(tag: string, parent = rootLogger) {
163
50
  if (loggers.has(tag)) {
@@ -179,15 +66,15 @@ export function getLogger(tag: string, parent = rootLogger) {
179
66
  *
180
67
  * @remarks Child loggers seem to inherit the "paused" state of the parent, so when this is called, we must resume all of them.
181
68
  */
182
- export const initLogger = _.once((level: keyof typeof LogLevelMap | LogLevel) => {
69
+ export const initLogger = _.once((level: keyof typeof LogLevelMap | typeof LogLevel) => {
183
70
  globalLevel = isLogLevelString(level) ? LogLevelMap[level] : level;
184
71
  rootLogger.level = globalLevel;
185
- rootLogger.resume();
72
+ rootLogger.resumeLogs();
186
73
  for (const ref of loggers.values()) {
187
74
  const logger = ref.deref();
188
75
  if (logger) {
189
76
  logger.level = globalLevel;
190
- logger.resume();
77
+ logger.resumeLogs();
191
78
  }
192
79
  }
193
80
  });
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@appium/docutils",
3
- "version": "1.0.1",
3
+ "version": "1.0.3",
4
4
  "description": "Documentation generation utilities for Appium and related projects",
5
5
  "keywords": [
6
6
  "automation",
@@ -48,24 +48,22 @@
48
48
  "start": "node ./build/lib/cli/index.js"
49
49
  },
50
50
  "dependencies": {
51
- "@appium/support": "^4.1.11",
51
+ "@appium/support": "^4.2.1",
52
52
  "@appium/tsconfig": "^0.x",
53
53
  "@sliphua/lilconfig-ts-loader": "3.2.2",
54
54
  "@types/which": "3.0.3",
55
55
  "chalk": "4.1.2",
56
- "consola": "2.15.3",
56
+ "consola": "3.2.3",
57
57
  "diff": "5.1.0",
58
- "figures": "3.2.0",
59
58
  "json5": "2.2.3",
60
- "lilconfig": "2.1.0",
59
+ "lilconfig": "3.0.0",
61
60
  "lodash": "4.17.21",
62
- "log-symbols": "4.1.0",
63
61
  "pkg-dir": "5.0.0",
64
62
  "read-pkg": "5.2.0",
65
63
  "semver": "7.5.4",
66
64
  "source-map-support": "0.5.21",
67
65
  "teen_process": "2.1.1",
68
- "type-fest": "4.8.3",
66
+ "type-fest": "4.10.1",
69
67
  "typescript": "5.2.2",
70
68
  "yaml": "2.3.4",
71
69
  "yargs": "17.7.2",
@@ -78,5 +76,5 @@
78
76
  "publishConfig": {
79
77
  "access": "public"
80
78
  },
81
- "gitHead": "5c1d20517cfc8773cd5ffb0f8bb996668d71116b"
79
+ "gitHead": "9cc598a92c2f0d2dfbf40d54698f0ee39b50e4dc"
82
80
  }
package/requirements.txt CHANGED
@@ -1,5 +1,5 @@
1
1
  mkdocs==1.5.3
2
- mkdocs-git-revision-date-localized-plugin==1.2.1
3
- mkdocs-material==9.5.2
2
+ mkdocs-git-revision-date-localized-plugin==1.2.4
3
+ mkdocs-material==9.5.7
4
4
  mkdocs-redirects==1.2.1
5
5
  mike==2.0.0