@appium/docutils 0.4.13 → 1.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (76) hide show
  1. package/README.md +14 -10
  2. package/base-mkdocs.yml +45 -5
  3. package/build/lib/builder/deploy.d.ts +4 -4
  4. package/build/lib/builder/deploy.d.ts.map +1 -1
  5. package/build/lib/builder/deploy.js +5 -4
  6. package/build/lib/builder/deploy.js.map +1 -1
  7. package/build/lib/builder/index.d.ts +0 -2
  8. package/build/lib/builder/index.d.ts.map +1 -1
  9. package/build/lib/builder/index.js +0 -2
  10. package/build/lib/builder/index.js.map +1 -1
  11. package/build/lib/builder/site.d.ts +2 -2
  12. package/build/lib/builder/site.js +2 -2
  13. package/build/lib/cli/command/build.d.ts +8 -45
  14. package/build/lib/cli/command/build.d.ts.map +1 -1
  15. package/build/lib/cli/command/build.js +11 -56
  16. package/build/lib/cli/command/build.js.map +1 -1
  17. package/build/lib/cli/command/init.d.ts +0 -27
  18. package/build/lib/cli/command/init.d.ts.map +1 -1
  19. package/build/lib/cli/command/init.js +0 -27
  20. package/build/lib/cli/command/init.js.map +1 -1
  21. package/build/lib/cli/command/validate.d.ts +0 -24
  22. package/build/lib/cli/command/validate.d.ts.map +1 -1
  23. package/build/lib/cli/command/validate.js +2 -26
  24. package/build/lib/cli/command/validate.js.map +1 -1
  25. package/build/lib/constants.d.ts +3 -14
  26. package/build/lib/constants.d.ts.map +1 -1
  27. package/build/lib/constants.js +4 -15
  28. package/build/lib/constants.js.map +1 -1
  29. package/build/lib/fs.d.ts +0 -29
  30. package/build/lib/fs.d.ts.map +1 -1
  31. package/build/lib/fs.js +4 -57
  32. package/build/lib/fs.js.map +1 -1
  33. package/build/lib/index.d.ts +0 -1
  34. package/build/lib/index.d.ts.map +1 -1
  35. package/build/lib/index.js +0 -1
  36. package/build/lib/index.js.map +1 -1
  37. package/build/lib/init.d.ts +7 -131
  38. package/build/lib/init.d.ts.map +1 -1
  39. package/build/lib/init.js +2 -55
  40. package/build/lib/init.js.map +1 -1
  41. package/build/lib/model.d.ts +0 -11
  42. package/build/lib/model.d.ts.map +1 -1
  43. package/build/lib/validate.d.ts +2 -30
  44. package/build/lib/validate.d.ts.map +1 -1
  45. package/build/lib/validate.js +2 -93
  46. package/build/lib/validate.js.map +1 -1
  47. package/lib/builder/deploy.ts +17 -15
  48. package/lib/builder/index.ts +0 -2
  49. package/lib/builder/site.ts +6 -6
  50. package/lib/cli/command/build.ts +12 -59
  51. package/lib/cli/command/init.ts +0 -27
  52. package/lib/cli/command/validate.ts +3 -27
  53. package/lib/constants.ts +4 -17
  54. package/lib/fs.ts +16 -84
  55. package/lib/index.ts +0 -1
  56. package/lib/init.ts +9 -106
  57. package/lib/model.ts +0 -14
  58. package/lib/validate.ts +23 -172
  59. package/package.json +8 -14
  60. package/requirements.txt +4 -3
  61. package/tsconfig.json +1 -0
  62. package/build/lib/builder/nav.d.ts +0 -81
  63. package/build/lib/builder/nav.d.ts.map +0 -1
  64. package/build/lib/builder/nav.js +0 -288
  65. package/build/lib/builder/nav.js.map +0 -1
  66. package/build/lib/builder/reference.d.ts +0 -57
  67. package/build/lib/builder/reference.d.ts.map +0 -1
  68. package/build/lib/builder/reference.js +0 -111
  69. package/build/lib/builder/reference.js.map +0 -1
  70. package/build/lib/mike.d.ts +0 -81
  71. package/build/lib/mike.d.ts.map +0 -1
  72. package/build/lib/mike.js +0 -146
  73. package/build/lib/mike.js.map +0 -1
  74. package/lib/builder/nav.ts +0 -402
  75. package/lib/builder/reference.ts +0 -171
  76. package/lib/mike.js +0 -153
@@ -64,30 +64,6 @@ const opts = {
64
64
  requiresArg: true,
65
65
  type: 'string',
66
66
  },
67
- typedoc: {
68
- default: true,
69
- description: 'Validate TypoDoc environment',
70
- group: ValidateCommandGroup.Behavior,
71
- type: 'boolean',
72
- },
73
- 'typedoc-json': {
74
- defaultDescription: './typedoc.json',
75
- describe: 'Path to typedoc.json',
76
- group: ValidateCommandGroup.Paths,
77
- nargs: 1,
78
- normalize: true,
79
- requiresArg: true,
80
- type: 'string',
81
- },
82
- 'typedoc-path': {
83
- defaultDescription: '(derived from shell)',
84
- description: 'Path to typedoc executable',
85
- group: ValidateCommandGroup.Paths,
86
- nargs: 1,
87
- normalize: true,
88
- requiresArg: true,
89
- type: 'string',
90
- },
91
67
  typescript: {
92
68
  default: true,
93
69
  description: 'Validate TypeScript environment',
@@ -100,8 +76,8 @@ exports.default = {
100
76
  describe: 'Validate Environment',
101
77
  builder(yargs) {
102
78
  return yargs.options(opts).check(async (argv) => {
103
- if (!argv.python && !argv.typedoc && !argv.typescript && !argv.mkdocs) {
104
- return 'No validation targets specified; one or more of --python, --typescript, --typedoc or --mkdocs must be provided';
79
+ if (!argv.python && !argv.typescript && !argv.mkdocs) {
80
+ return 'No validation targets specified; one or more of --python, --typescript or --mkdocs must be provided';
105
81
  }
106
82
  return (0, check_1.checkMissingPaths)(opts, ValidateCommandGroup.Paths, argv);
107
83
  });
@@ -1 +1 @@
1
- {"version":3,"file":"validate.js","sourceRoot":"","sources":["../../../../lib/cli/command/validate.ts"],"names":[],"mappings":";AAAA;;;GAGG;;AAEH,6CAAqC;AAErC,uCAA0C;AAC1C,6CAAiE;AACjE,yCAAuC;AACvC,oCAA2C;AAE3C,MAAM,GAAG,GAAG,IAAA,kBAAS,EAAC,UAAU,CAAC,CAAC;AAElC,IAAK,oBAGJ;AAHD,WAAK,oBAAoB;IACvB,yDAAiC,CAAA;IACjC,+CAAuB,CAAA;AACzB,CAAC,EAHI,oBAAoB,KAApB,oBAAoB,QAGxB;AAED,MAAM,IAAI,GAAG;IACX,MAAM,EAAE;QACN,OAAO,EAAE,IAAI;QACb,WAAW,EAAE,6BAA6B;QAC1C,KAAK,EAAE,oBAAoB,CAAC,QAAQ;QACpC,IAAI,EAAE,SAAS;KAChB;IACD,YAAY,EAAE;QACZ,kBAAkB,EAAE,cAAc;QAClC,WAAW,EAAE,oBAAoB;QACjC,KAAK,EAAE,oBAAoB,CAAC,KAAK;QACjC,KAAK,EAAE,CAAC;QACR,SAAS,EAAE,IAAI;QACf,WAAW,EAAE,IAAI;QACjB,IAAI,EAAE,QAAQ;KACf;IACD,UAAU,EAAE;QACV,kBAAkB,EAAE,sBAAsB;QAC1C,WAAW,EAAE,wBAAwB;QACrC,KAAK,EAAE,oBAAoB,CAAC,KAAK;QACjC,KAAK,EAAE,CAAC;QACR,SAAS,EAAE,IAAI;QACf,WAAW,EAAE,IAAI;QACjB,IAAI,EAAE,QAAQ;KACf;IACD,MAAM,EAAE;QACN,OAAO,EAAE,IAAI;QACb,WAAW,EAAE,+BAA+B;QAC5C,KAAK,EAAE,oBAAoB,CAAC,QAAQ;QACpC,IAAI,EAAE,SAAS;KAChB;IACD,aAAa,EAAE;QACb,kBAAkB,EAAE,sBAAsB;QAC1C,WAAW,EAAE,4BAA4B;QACzC,KAAK,EAAE,oBAAoB,CAAC,KAAK;QACjC,KAAK,EAAE,CAAC;QACR,SAAS,EAAE,IAAI;QACf,WAAW,EAAE,IAAI;QACjB,IAAI,EAAE,QAAQ;KACf;IACD,eAAe,EAAE;QACf,kBAAkB,EAAE,iBAAiB;QACrC,QAAQ,EAAE,uBAAuB;QACjC,KAAK,EAAE,oBAAoB,CAAC,KAAK;QACjC,KAAK,EAAE,CAAC;QACR,SAAS,EAAE,IAAI;QACf,WAAW,EAAE,IAAI;QACjB,IAAI,EAAE,QAAQ;KACf;IACD,OAAO,EAAE;QACP,OAAO,EAAE,IAAI;QACb,WAAW,EAAE,8BAA8B;QAC3C,KAAK,EAAE,oBAAoB,CAAC,QAAQ;QACpC,IAAI,EAAE,SAAS;KAChB;IACD,cAAc,EAAE;QACd,kBAAkB,EAAE,gBAAgB;QACpC,QAAQ,EAAE,sBAAsB;QAChC,KAAK,EAAE,oBAAoB,CAAC,KAAK;QACjC,KAAK,EAAE,CAAC;QACR,SAAS,EAAE,IAAI;QACf,WAAW,EAAE,IAAI;QACjB,IAAI,EAAE,QAAQ;KACf;IACD,cAAc,EAAE;QACd,kBAAkB,EAAE,sBAAsB;QAC1C,WAAW,EAAE,4BAA4B;QACzC,KAAK,EAAE,oBAAoB,CAAC,KAAK;QACjC,KAAK,EAAE,CAAC;QACR,SAAS,EAAE,IAAI;QACf,WAAW,EAAE,IAAI;QACjB,IAAI,EAAE,QAAQ;KACf;IACD,UAAU,EAAE;QACV,OAAO,EAAE,IAAI;QACb,WAAW,EAAE,iCAAiC;QAC9C,KAAK,EAAE,oBAAoB,CAAC,QAAQ;QACpC,IAAI,EAAE,SAAS;KAChB;CACyC,CAAC;AAI7C,kBAAe;IACb,OAAO,EAAE,UAAU;IACnB,QAAQ,EAAE,sBAAsB;IAChC,OAAO,CAAC,KAAK;QACX,OAAO,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE;YAC9C,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,IAAI,CAAC,IAAI,CAAC,UAAU,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;gBACrE,OAAO,gHAAgH,CAAC;aACzH;YACD,OAAO,IAAA,yBAAiB,EAAC,IAAI,EAAE,oBAAoB,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QACnE,CAAC,CAAC,CAAC;IACL,CAAC;IACD,KAAK,CAAC,OAAO,CAAC,IAAI;QAChB,IAAI,UAAU,GAAG,CAAC,CAAC;QACnB,MAAM,SAAS,GAAG,IAAI,4BAAiB,CAAC,IAAI,CAAC;aAC1C,IAAI,CAAC,4BAAiB,CAAC,KAAK,EAAE,CAAC,KAAuB,EAAE,EAAE;YACzD,GAAG,CAAC,IAAI,CAAC,eAAe,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAC9C,CAAC,CAAC;aACD,IAAI,CAAC,4BAAiB,CAAC,GAAG,EAAE,CAAC,QAAgB,EAAE,EAAE;YAChD,UAAU,GAAG,QAAQ,CAAC;QACxB,CAAC,CAAC;aACD,EAAE,CAAC,4BAAiB,CAAC,OAAO,EAAE,CAAC,GAAkB,EAAE,EAAE;YACpD,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QACzB,CAAC,CAAC;aACD,EAAE,CAAC,4BAAiB,CAAC,OAAO,EAAE,CAAC,GAAW,EAAE,EAAE;YAC7C,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACnB,CAAC,CAAC,CAAC;QAEL,MAAM,SAAS,CAAC,QAAQ,EAAE,CAAC;QAE3B,IAAI,UAAU,EAAE;YACd,MAAM,IAAI,qBAAa,CACrB,0BAA0B,UAAU,IAAI,cAAI,CAAC,SAAS,CAAC,OAAO,EAAE,UAAU,CAAC,EAAE,CAC9E,CAAC;SACH;IACH,CAAC;CACwC,CAAC"}
1
+ {"version":3,"file":"validate.js","sourceRoot":"","sources":["../../../../lib/cli/command/validate.ts"],"names":[],"mappings":";AAAA;;;GAGG;;AAEH,6CAAqC;AAErC,uCAA0C;AAC1C,6CAAiE;AACjE,yCAAuC;AACvC,oCAA2C;AAE3C,MAAM,GAAG,GAAG,IAAA,kBAAS,EAAC,UAAU,CAAC,CAAC;AAElC,IAAK,oBAGJ;AAHD,WAAK,oBAAoB;IACvB,yDAAiC,CAAA;IACjC,+CAAuB,CAAA;AACzB,CAAC,EAHI,oBAAoB,KAApB,oBAAoB,QAGxB;AAED,MAAM,IAAI,GAAG;IACX,MAAM,EAAE;QACN,OAAO,EAAE,IAAI;QACb,WAAW,EAAE,6BAA6B;QAC1C,KAAK,EAAE,oBAAoB,CAAC,QAAQ;QACpC,IAAI,EAAE,SAAS;KAChB;IACD,YAAY,EAAE;QACZ,kBAAkB,EAAE,cAAc;QAClC,WAAW,EAAE,oBAAoB;QACjC,KAAK,EAAE,oBAAoB,CAAC,KAAK;QACjC,KAAK,EAAE,CAAC;QACR,SAAS,EAAE,IAAI;QACf,WAAW,EAAE,IAAI;QACjB,IAAI,EAAE,QAAQ;KACf;IACD,UAAU,EAAE;QACV,kBAAkB,EAAE,sBAAsB;QAC1C,WAAW,EAAE,wBAAwB;QACrC,KAAK,EAAE,oBAAoB,CAAC,KAAK;QACjC,KAAK,EAAE,CAAC;QACR,SAAS,EAAE,IAAI;QACf,WAAW,EAAE,IAAI;QACjB,IAAI,EAAE,QAAQ;KACf;IACD,MAAM,EAAE;QACN,OAAO,EAAE,IAAI;QACb,WAAW,EAAE,+BAA+B;QAC5C,KAAK,EAAE,oBAAoB,CAAC,QAAQ;QACpC,IAAI,EAAE,SAAS;KAChB;IACD,aAAa,EAAE;QACb,kBAAkB,EAAE,sBAAsB;QAC1C,WAAW,EAAE,4BAA4B;QACzC,KAAK,EAAE,oBAAoB,CAAC,KAAK;QACjC,KAAK,EAAE,CAAC;QACR,SAAS,EAAE,IAAI;QACf,WAAW,EAAE,IAAI;QACjB,IAAI,EAAE,QAAQ;KACf;IACD,eAAe,EAAE;QACf,kBAAkB,EAAE,iBAAiB;QACrC,QAAQ,EAAE,uBAAuB;QACjC,KAAK,EAAE,oBAAoB,CAAC,KAAK;QACjC,KAAK,EAAE,CAAC;QACR,SAAS,EAAE,IAAI;QACf,WAAW,EAAE,IAAI;QACjB,IAAI,EAAE,QAAQ;KACf;IACD,UAAU,EAAE;QACV,OAAO,EAAE,IAAI;QACb,WAAW,EAAE,iCAAiC;QAC9C,KAAK,EAAE,oBAAoB,CAAC,QAAQ;QACpC,IAAI,EAAE,SAAS;KAChB;CACyC,CAAC;AAI7C,kBAAe;IACb,OAAO,EAAE,UAAU;IACnB,QAAQ,EAAE,sBAAsB;IAChC,OAAO,CAAC,KAAK;QACX,OAAO,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE;YAC9C,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,UAAU,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;gBACpD,OAAO,qGAAqG,CAAC;aAC9G;YACD,OAAO,IAAA,yBAAiB,EAAC,IAAI,EAAE,oBAAoB,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QACnE,CAAC,CAAC,CAAC;IACL,CAAC;IACD,KAAK,CAAC,OAAO,CAAC,IAAI;QAChB,IAAI,UAAU,GAAG,CAAC,CAAC;QACnB,MAAM,SAAS,GAAG,IAAI,4BAAiB,CAAC,IAAI,CAAC;aAC1C,IAAI,CAAC,4BAAiB,CAAC,KAAK,EAAE,CAAC,KAAuB,EAAE,EAAE;YACzD,GAAG,CAAC,IAAI,CAAC,eAAe,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAC9C,CAAC,CAAC;aACD,IAAI,CAAC,4BAAiB,CAAC,GAAG,EAAE,CAAC,QAAgB,EAAE,EAAE;YAChD,UAAU,GAAG,QAAQ,CAAC;QACxB,CAAC,CAAC;aACD,EAAE,CAAC,4BAAiB,CAAC,OAAO,EAAE,CAAC,GAAkB,EAAE,EAAE;YACpD,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QACzB,CAAC,CAAC;aACD,EAAE,CAAC,4BAAiB,CAAC,OAAO,EAAE,CAAC,GAAW,EAAE,EAAE;YAC7C,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACnB,CAAC,CAAC,CAAC;QAEL,MAAM,SAAS,CAAC,QAAQ,EAAE,CAAC;QAE3B,IAAI,UAAU,EAAE;YACd,MAAM,IAAI,qBAAa,CACrB,0BAA0B,UAAU,IAAI,cAAI,CAAC,SAAS,CAAC,OAAO,EAAE,UAAU,CAAC,EAAE,CAC9E,CAAC;SACH;IACH,CAAC;CACwC,CAAC"}
@@ -20,10 +20,6 @@ export declare const NAME_TSCONFIG_JSON = "tsconfig.json";
20
20
  * `python` executable
21
21
  */
22
22
  export declare const NAME_PYTHON = "python";
23
- /**
24
- * Default name of the `typedoc.json` config file
25
- */
26
- export declare const NAME_TYPEDOC_JSON = "typedoc.json";
27
23
  /**
28
24
  * It's `package.json`!
29
25
  */
@@ -45,10 +41,6 @@ export declare const NAME_MKDOCS = "mkdocs";
45
41
  * Name of the `mike` executable
46
42
  */
47
43
  export declare const NAME_MIKE = "mike";
48
- /**
49
- * Name of the `typedoc` executable
50
- */
51
- export declare const NAME_TYPEDOC = "typedoc";
52
44
  /**
53
45
  * Name of the `pip` module.
54
46
  *
@@ -93,9 +85,10 @@ export declare const DOCUTILS_PKG: PackageJson;
93
85
  */
94
86
  export declare const REQUIREMENTS_TXT_PATH: string;
95
87
  /**
96
- * The default output path for Typedoc, computed relative to the consuming package's root
88
+ * The default alias creation strategy to pass to `mike` when deploying
89
+ * (`symlink`, `redirect` or `copy`)
97
90
  */
98
- export declare const DEFAULT_REL_TYPEDOC_OUT_PATH: string;
91
+ export declare const DEFAULT_DEPLOY_ALIAS_TYPE = "redirect";
99
92
  /**
100
93
  * The default branch to deploy to
101
94
  */
@@ -122,10 +115,6 @@ export declare const LogLevelMap: {
122
115
  readonly info: LogLevel.Info;
123
116
  readonly debug: LogLevel.Debug;
124
117
  };
125
- /**
126
- * Default site nav header text
127
- */
128
- export declare const DEFAULT_NAV_HEADER = "Reference";
129
118
  /**
130
119
  * If the user does not specify a site directory _and_ the `mkdocs.yml` doesn't either, use this dir.
131
120
  */
@@ -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,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;;GAEG;AACH,eAAO,MAAM,YAAY,YAAY,CAAC;AAEtC;;;;;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;;GAEG;AACH,eAAO,MAAM,4BAA4B,QAAiC,CAAC;AAE3E;;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,kBAAkB,cAAc,CAAC;AAE9C;;GAEG;AACH,eAAO,MAAM,gBAAgB,SAAS,CAAC"}
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"}
@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
3
3
  return (mod && mod.__esModule) ? mod : { "default": mod };
4
4
  };
5
5
  Object.defineProperty(exports, "__esModule", { value: true });
6
- exports.DEFAULT_SITE_DIR = exports.DEFAULT_NAV_HEADER = exports.LogLevelMap = exports.DEFAULT_SERVE_HOST = exports.DEFAULT_SERVE_PORT = exports.DEFAULT_DEPLOY_REMOTE = exports.DEFAULT_DEPLOY_BRANCH = exports.DEFAULT_REL_TYPEDOC_OUT_PATH = exports.REQUIREMENTS_TXT_PATH = exports.DOCUTILS_PKG = exports.PKG_ROOT_DIR = exports.DEFAULT_LOG_LEVEL = exports.NAME_THEME = exports.NAME_ERR_EEXIST = exports.NAME_ERR_ENOENT = exports.NAME_TYPESCRIPT = exports.NAME_NPM = exports.NAME_PIP = exports.NAME_TYPEDOC = exports.NAME_MIKE = exports.NAME_MKDOCS = exports.NAME_SCHEMA = exports.NAME_REQUIREMENTS_TXT = exports.NAME_PACKAGE_JSON = exports.NAME_TYPEDOC_JSON = exports.NAME_PYTHON = exports.NAME_TSCONFIG_JSON = exports.NAME_MKDOCS_YML = exports.NAME_BIN = void 0;
6
+ exports.DEFAULT_SITE_DIR = exports.LogLevelMap = exports.DEFAULT_SERVE_HOST = exports.DEFAULT_SERVE_PORT = exports.DEFAULT_DEPLOY_REMOTE = exports.DEFAULT_DEPLOY_BRANCH = exports.DEFAULT_DEPLOY_ALIAS_TYPE = exports.REQUIREMENTS_TXT_PATH = exports.DOCUTILS_PKG = exports.PKG_ROOT_DIR = exports.DEFAULT_LOG_LEVEL = exports.NAME_THEME = exports.NAME_ERR_EEXIST = exports.NAME_ERR_ENOENT = exports.NAME_TYPESCRIPT = exports.NAME_NPM = exports.NAME_PIP = exports.NAME_MIKE = exports.NAME_MKDOCS = exports.NAME_SCHEMA = exports.NAME_REQUIREMENTS_TXT = exports.NAME_PACKAGE_JSON = exports.NAME_PYTHON = exports.NAME_TSCONFIG_JSON = exports.NAME_MKDOCS_YML = exports.NAME_BIN = void 0;
7
7
  /**
8
8
  * Constants used across various modules in this package
9
9
  * @module
@@ -28,10 +28,6 @@ exports.NAME_TSCONFIG_JSON = 'tsconfig.json';
28
28
  * `python` executable
29
29
  */
30
30
  exports.NAME_PYTHON = 'python';
31
- /**
32
- * Default name of the `typedoc.json` config file
33
- */
34
- exports.NAME_TYPEDOC_JSON = 'typedoc.json';
35
31
  /**
36
32
  * It's `package.json`!
37
33
  */
@@ -53,10 +49,6 @@ exports.NAME_MKDOCS = 'mkdocs';
53
49
  * Name of the `mike` executable
54
50
  */
55
51
  exports.NAME_MIKE = 'mike';
56
- /**
57
- * Name of the `typedoc` executable
58
- */
59
- exports.NAME_TYPEDOC = 'typedoc';
60
52
  /**
61
53
  * Name of the `pip` module.
62
54
  *
@@ -101,9 +93,10 @@ exports.DOCUTILS_PKG = JSON.parse((0, node_fs_1.readFileSync)(node_path_1.defaul
101
93
  */
102
94
  exports.REQUIREMENTS_TXT_PATH = node_path_1.default.join(exports.PKG_ROOT_DIR, exports.NAME_REQUIREMENTS_TXT);
103
95
  /**
104
- * The default output path for Typedoc, computed relative to the consuming package's root
96
+ * The default alias creation strategy to pass to `mike` when deploying
97
+ * (`symlink`, `redirect` or `copy`)
105
98
  */
106
- exports.DEFAULT_REL_TYPEDOC_OUT_PATH = node_path_1.default.join('docs', 'reference');
99
+ exports.DEFAULT_DEPLOY_ALIAS_TYPE = 'redirect';
107
100
  /**
108
101
  * The default branch to deploy to
109
102
  */
@@ -130,10 +123,6 @@ exports.LogLevelMap = {
130
123
  info: consola_1.LogLevel.Info,
131
124
  debug: consola_1.LogLevel.Debug,
132
125
  };
133
- /**
134
- * Default site nav header text
135
- */
136
- exports.DEFAULT_NAV_HEADER = 'Reference';
137
126
  /**
138
127
  * If the user does not specify a site directory _and_ the `mkdocs.yml` doesn't either, use this dir.
139
128
  */
@@ -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,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;;GAEG;AACU,QAAA,YAAY,GAAG,SAAS,CAAC;AAEtC;;;;;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;;GAEG;AACU,QAAA,4BAA4B,GAAG,mBAAI,CAAC,IAAI,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;AAE3E;;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,kBAAkB,GAAG,WAAW,CAAC;AAE9C;;GAEG;AACU,QAAA,gBAAgB,GAAG,MAAM,CAAC"}
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"}
package/build/lib/fs.d.ts CHANGED
@@ -34,10 +34,6 @@ export declare const stringifyJson5: (value: JsonValue) => string;
34
34
  * @returns JSON string
35
35
  */
36
36
  export declare const stringifyJson: (value: JsonValue) => string;
37
- /**
38
- * Reads a YAML file, parses it and caches the result
39
- */
40
- export declare const readYaml: ((filepath: string) => Promise<any>) & _.MemoizedFunction;
41
37
  /**
42
38
  * Finds a file from `cwd`. Searches up to the package root (dir containing `package.json`).
43
39
  *
@@ -46,14 +42,6 @@ export declare const readYaml: ((filepath: string) => Promise<any>) & _.Memoized
46
42
  * @returns
47
43
  */
48
44
  export declare function findInPkgDir(filename: string, cwd?: string): Promise<string | undefined>;
49
- /**
50
- * Finds a `typedoc.json`, expected to be a sibling of `package.json`
51
- *
52
- * Caches the result.
53
- * @param cwd - Current working directory
54
- * @returns Path to `typedoc.json`
55
- */
56
- export declare const findTypeDocJsonPath: ((cwd?: any) => Promise<string | undefined>) & _.MemoizedFunction;
57
45
  /**
58
46
  * Finds an `mkdocs.yml`, expected to be a sibling of `package.json`
59
47
  *
@@ -80,13 +68,6 @@ declare function _readPkgJson(cwd: string, normalize?: false): Promise<{
80
68
  * Given a directory to start from, reads a `package.json` file and returns its path and contents
81
69
  */
82
70
  export declare const readPackageJson: typeof _readPkgJson & _.MemoizedFunction;
83
- /**
84
- * Reads a `typedoc.json` file and returns its parsed contents.
85
- *
86
- * TypeDoc expands the "extends" field, which is why we use its facilities. It, unfortunately, is a
87
- * blocking operation.
88
- */
89
- export declare const readTypedocJson: ((typedocJsonPath: string) => Readonly<Partial<import("typedoc").TypeDocOptions>>) & _.MemoizedFunction;
90
71
  /**
91
72
  * Reads a JSON5 file and parses it
92
73
  */
@@ -112,12 +93,6 @@ export declare const whichNpm: () => Promise<string>;
112
93
  * `mike` cannot be invoked via `python -m`, so we need to find the script.
113
94
  */
114
95
  export declare const findMike: () => Promise<string | undefined>;
115
- /**
116
- * Finds the `typedoc` executable.
117
- *
118
- * Looks in the `node_modules/.bin` dir from the current working directory, and if this fails, in the `node_modules` dir for the file which `.bin/typedoc` should be a symlink of, and if _that_ fails, try the `PATH`.
119
- */
120
- export declare const findTypeDoc: ((cwd?: any) => Promise<string | undefined>) & _.MemoizedFunction;
121
96
  /**
122
97
  * Finds the `python3` or `python` executable in the user's `PATH`.
123
98
  *
@@ -133,9 +108,5 @@ export declare const findPython: (() => Promise<string | undefined>) & _.Memoize
133
108
  * @returns Parsed `mkdocs.yml` file
134
109
  */
135
110
  export declare const readMkDocsYml: ((filepath: string, cwd?: any) => Promise<MkDocsYml>) & _.MemoizedFunction;
136
- /**
137
- * Given an abs path to a directory, return a list of all abs paths of all directories in it
138
- */
139
- export declare const findDirsIn: ((dirpath: string) => Promise<string[]>) & _.MemoizedFunction;
140
111
  export {};
141
112
  //# sourceMappingURL=fs.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"fs.d.ts","sourceRoot":"","sources":["../../lib/fs.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAKH,OAAO,CAAC,MAAM,QAAQ,CAAC;AAGvB,OAAgB,EAAC,qBAAqB,EAAE,WAAW,EAAC,MAAM,UAAU,CAAC;AACrE,OAAO,EAAC,SAAS,EAAC,MAAM,WAAW,CAAC;AAcpC,OAAO,EAAC,SAAS,EAAC,MAAM,SAAS,CAAC;AAKlC;;;;GAIG;AACH,eAAO,MAAM,UAAU;;;sBAAqB,CAAC;AAE7C;;;;GAIG;AACH,eAAO,MAAM,aAAa,EAAE,CAAC,KAAK,EAAE,SAAS,KAAK,MAIjD,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,cAAc,EAAE,CAAC,KAAK,EAAE,SAAS,KAAK,MAEjD,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,aAAa,EAAE,CAAC,KAAK,EAAE,SAAS,KAAK,MAIjD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,QAAQ,cAA8B,MAAM,uCAKxD,CAAC;AAEF;;;;;;GAMG;AACH,wBAAsB,YAAY,CAChC,QAAQ,EAAE,MAAM,EAChB,GAAG,SAAgB,GAClB,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAM7B;AAED;;;;;;GAMG;AACH,eAAO,MAAM,mBAAmB,mEAI9B,CAAC;AAEH;;;;;;GAMG;AACH,eAAO,MAAM,aAAa,kFAAsD,CAAC;AAEjF;;;;;GAKG;AACH,iBAAe,YAAY,CACzB,GAAG,EAAE,MAAM,EACX,SAAS,EAAE,IAAI,GACd,OAAO,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,qBAAqB,CAAA;CAAC,CAAC,CAAC;AAC1D,iBAAe,YAAY,CACzB,GAAG,EAAE,MAAM,EACX,SAAS,CAAC,EAAE,KAAK,GAChB,OAAO,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,WAAW,CAAA;CAAC,CAAC,CAAC;AAsBhD;;GAEG;AACH,eAAO,MAAM,eAAe,0CAA0B,CAAC;AAEvD;;;;;GAKG;AACH,eAAO,MAAM,eAAe,qBAA+B,MAAM,8EAO/D,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,SAAS,mCACkB,MAAM,qCAE7C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,QAAQ,mCACmB,MAAM,qCAE7C,CAAC;AAEF;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,UAAQ,iBAMpF;AAOD;;GAEG;AACH,eAAO,MAAM,QAAQ,uBAAoD,CAAC;AAiB1E;;GAEG;AACH,eAAO,MAAM,QAAQ,mCAuBnB,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,WAAW,kBAA0C,QAAQ,MAAM,GAAG,SAAS,CAAC,sBAM3F,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,UAAU,SACX,QAAQ,MAAM,GAAG,SAAS,CAAC,sBACtC,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,aAAa,cACP,MAAM,gBAAwB,QAAQ,SAAS,CAAC,sBAyBlE,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,UAAU,aAA6B,MAAM,KAAG,QAAQ,MAAM,EAAE,CAAC,sBAM5E,CAAC"}
1
+ {"version":3,"file":"fs.d.ts","sourceRoot":"","sources":["../../lib/fs.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,CAAC,MAAM,QAAQ,CAAC;AAGvB,OAAgB,EAAC,qBAAqB,EAAE,WAAW,EAAC,MAAM,UAAU,CAAC;AACrE,OAAO,EAAC,SAAS,EAAC,MAAM,WAAW,CAAC;AAKpC,OAAO,EAAC,SAAS,EAAC,MAAM,SAAS,CAAC;AAKlC;;;;GAIG;AACH,eAAO,MAAM,UAAU;;;sBAAqB,CAAC;AAE7C;;;;GAIG;AACH,eAAO,MAAM,aAAa,EAAE,CAAC,KAAK,EAAE,SAAS,KAAK,MAIjD,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,cAAc,EAAE,CAAC,KAAK,EAAE,SAAS,KAAK,MAEjD,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,aAAa,EAAE,CAAC,KAAK,EAAE,SAAS,KAAK,MAIjD,CAAC;AAYF;;;;;;GAMG;AACH,wBAAsB,YAAY,CAChC,QAAQ,EAAE,MAAM,EAChB,GAAG,SAAgB,GAClB,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAM7B;AAED;;;;;;GAMG;AACH,eAAO,MAAM,aAAa,kFAAsD,CAAC;AAEjF;;;;;GAKG;AACH,iBAAe,YAAY,CACzB,GAAG,EAAE,MAAM,EACX,SAAS,EAAE,IAAI,GACd,OAAO,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,qBAAqB,CAAA;CAAC,CAAC,CAAC;AAC1D,iBAAe,YAAY,CACzB,GAAG,EAAE,MAAM,EACX,SAAS,CAAC,EAAE,KAAK,GAChB,OAAO,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,WAAW,CAAA;CAAC,CAAC,CAAC;AAsBhD;;GAEG;AACH,eAAO,MAAM,eAAe,0CAA0B,CAAC;AAEvD;;GAEG;AACH,eAAO,MAAM,SAAS,mCACkB,MAAM,qCAE7C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,QAAQ,mCACmB,MAAM,qCAE7C,CAAC;AAEF;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,UAAQ,iBAMpF;AAOD;;GAEG;AACH,eAAO,MAAM,QAAQ,uBAAoD,CAAC;AAY1E;;GAEG;AACH,eAAO,MAAM,QAAQ,mCAsBnB,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,UAAU,SACX,QAAQ,MAAM,GAAG,SAAS,CAAC,sBACtC,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,aAAa,cACP,MAAM,gBAAwB,QAAQ,SAAS,CAAC,sBAyBlE,CAAC"}
package/build/lib/fs.js CHANGED
@@ -30,15 +30,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
30
30
  return (mod && mod.__esModule) ? mod : { "default": mod };
31
31
  };
32
32
  Object.defineProperty(exports, "__esModule", { value: true });
33
- exports.findDirsIn = exports.readMkDocsYml = exports.findPython = exports.findTypeDoc = exports.findMike = exports.whichNpm = exports.safeWriteFile = exports.readJson = exports.readJson5 = exports.readTypedocJson = exports.readPackageJson = exports.findMkDocsYml = exports.findTypeDocJsonPath = exports.findInPkgDir = exports.readYaml = exports.stringifyJson = exports.stringifyJson5 = exports.stringifyYaml = exports.findPkgDir = void 0;
33
+ exports.readMkDocsYml = exports.findPython = exports.findMike = exports.whichNpm = exports.safeWriteFile = exports.readJson = exports.readJson5 = exports.readPackageJson = exports.findMkDocsYml = exports.findInPkgDir = exports.stringifyJson = exports.stringifyJson5 = exports.stringifyYaml = exports.findPkgDir = void 0;
34
34
  const support_1 = require("@appium/support");
35
- const find_up_1 = __importDefault(require("find-up"));
36
35
  const JSON5 = __importStar(require("json5"));
37
36
  const lodash_1 = __importDefault(require("lodash"));
38
37
  const node_path_1 = __importDefault(require("node:path"));
39
38
  const pkg_dir_1 = __importDefault(require("pkg-dir"));
40
39
  const read_pkg_1 = __importDefault(require("read-pkg"));
41
- const typedoc_1 = require("typedoc");
42
40
  const yaml_1 = __importDefault(require("yaml"));
43
41
  const constants_1 = require("./constants");
44
42
  const error_1 = require("./error");
@@ -75,7 +73,7 @@ exports.stringifyJson = lodash_1.default.partialRight(JSON.stringify, 2, undefin
75
73
  /**
76
74
  * Reads a YAML file, parses it and caches the result
77
75
  */
78
- exports.readYaml = lodash_1.default.memoize(async (filepath) => yaml_1.default.parse(await support_1.fs.readFile(filepath, 'utf8'), {
76
+ const readYaml = lodash_1.default.memoize(async (filepath) => yaml_1.default.parse(await support_1.fs.readFile(filepath, 'utf8'), {
79
77
  prettyErrors: false,
80
78
  logLevel: 'silent',
81
79
  }));
@@ -94,18 +92,6 @@ async function findInPkgDir(filename, cwd = process.cwd()) {
94
92
  return node_path_1.default.join(pkgDir, filename);
95
93
  }
96
94
  exports.findInPkgDir = findInPkgDir;
97
- /**
98
- * Finds a `typedoc.json`, expected to be a sibling of `package.json`
99
- *
100
- * Caches the result.
101
- * @param cwd - Current working directory
102
- * @returns Path to `typedoc.json`
103
- */
104
- exports.findTypeDocJsonPath = lodash_1.default.memoize(async (cwd = process.cwd()) => {
105
- const filepath = await (0, find_up_1.default)(constants_1.NAME_TYPEDOC_JSON, { cwd, type: 'file' });
106
- log.debug('Found `typedoc.json` at %s', filepath);
107
- return filepath;
108
- });
109
95
  /**
110
96
  * Finds an `mkdocs.yml`, expected to be a sibling of `package.json`
111
97
  *
@@ -134,20 +120,6 @@ async function _readPkgJson(cwd, normalize) {
134
120
  * Given a directory to start from, reads a `package.json` file and returns its path and contents
135
121
  */
136
122
  exports.readPackageJson = lodash_1.default.memoize(_readPkgJson);
137
- /**
138
- * Reads a `typedoc.json` file and returns its parsed contents.
139
- *
140
- * TypeDoc expands the "extends" field, which is why we use its facilities. It, unfortunately, is a
141
- * blocking operation.
142
- */
143
- exports.readTypedocJson = lodash_1.default.memoize((typedocJsonPath) => {
144
- const app = new typedoc_1.Application();
145
- app.options.setValue('plugin', 'none');
146
- app.options.setValue('logger', 'none');
147
- app.options.addReader(new typedoc_1.TypeDocReader());
148
- app.bootstrap({ options: node_path_1.default.dirname(typedocJsonPath) });
149
- return app.options.getRawValues();
150
- });
151
123
  /**
152
124
  * Reads a JSON5 file and parses it
153
125
  */
@@ -188,10 +160,6 @@ const whichPython = lodash_1.default.partial(cachedWhich, constants_1.NAME_PYTHO
188
160
  * Finds `python3` executable
189
161
  */
190
162
  const whichPython3 = lodash_1.default.partial(cachedWhich, `${constants_1.NAME_PYTHON}3`, { nothrow: true });
191
- /**
192
- * Finds `typedoc` executable
193
- */
194
- const whichTypeDoc = lodash_1.default.partial(cachedWhich, constants_1.NAME_TYPEDOC, { nothrow: true });
195
163
  /**
196
164
  * `mike` cannot be invoked via `python -m`, so we need to find the script.
197
165
  */
@@ -219,17 +187,6 @@ exports.findMike = lodash_1.default.partial(async () => {
219
187
  }
220
188
  catch { }
221
189
  });
222
- /**
223
- * Finds the `typedoc` executable.
224
- *
225
- * Looks in the `node_modules/.bin` dir from the current working directory, and if this fails, in the `node_modules` dir for the file which `.bin/typedoc` should be a symlink of, and if _that_ fails, try the `PATH`.
226
- */
227
- exports.findTypeDoc = lodash_1.default.memoize(async (cwd = process.cwd()) => {
228
- // .cmd is for win32, of course. note that glob _always_ uses posix dir separators.
229
- const globResult = (await support_1.fs.glob('node_modules/.bin/typedoc?(.cmd)', { cwd, nodir: true })) ??
230
- (await support_1.fs.glob('node_modules/**/typedoc/bin/typedoc', { cwd, nodir: true, follow: true }));
231
- return lodash_1.default.first(globResult) ?? (await whichTypeDoc());
232
- });
233
190
  /**
234
191
  * Finds the `python3` or `python` executable in the user's `PATH`.
235
192
  *
@@ -245,14 +202,14 @@ exports.findPython = lodash_1.default.memoize(async () => (await whichPython3())
245
202
  * @returns Parsed `mkdocs.yml` file
246
203
  */
247
204
  exports.readMkDocsYml = lodash_1.default.memoize(async (filepath, cwd = process.cwd()) => {
248
- let mkDocsYml = (await (0, exports.readYaml)(filepath));
205
+ let mkDocsYml = (await readYaml(filepath));
249
206
  if (mkDocsYml.site_dir) {
250
207
  mkDocsYml.site_dir = node_path_1.default.resolve(cwd, node_path_1.default.dirname(filepath), mkDocsYml.site_dir);
251
208
  }
252
209
  if (mkDocsYml.INHERIT) {
253
210
  let inheritPath = node_path_1.default.resolve(node_path_1.default.dirname(filepath), mkDocsYml.INHERIT);
254
211
  while (inheritPath) {
255
- const inheritYml = (await (0, exports.readYaml)(inheritPath));
212
+ const inheritYml = (await readYaml(inheritPath));
256
213
  if (inheritYml.site_dir) {
257
214
  inheritYml.site_dir = node_path_1.default.resolve(node_path_1.default.dirname(inheritPath), inheritYml.site_dir);
258
215
  log.debug('Resolved site_dir to %s', inheritYml.site_dir);
@@ -269,14 +226,4 @@ exports.readMkDocsYml = lodash_1.default.memoize(async (filepath, cwd = process.
269
226
  }
270
227
  return mkDocsYml;
271
228
  });
272
- /**
273
- * Given an abs path to a directory, return a list of all abs paths of all directories in it
274
- */
275
- exports.findDirsIn = lodash_1.default.memoize(async (dirpath) => {
276
- if (!node_path_1.default.isAbsolute(dirpath)) {
277
- throw new error_1.DocutilsError(`Expected absolute path, got '${dirpath}'`);
278
- }
279
- const dirEnts = await support_1.fs.readdir(dirpath, { withFileTypes: true });
280
- return dirEnts.filter((ent) => ent.isDirectory()).map((ent) => node_path_1.default.join(dirpath, ent.name));
281
- });
282
229
  //# sourceMappingURL=fs.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"fs.js","sourceRoot":"","sources":["../../lib/fs.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,6CAAmC;AACnC,sDAA6B;AAC7B,6CAA+B;AAC/B,oDAAuB;AACvB,0DAA6B;AAC7B,sDAA8B;AAC9B,wDAAqE;AAErE,qCAAmD;AACnD,gDAAwB;AACxB,2CAQqB;AACrB,mCAAsC;AACtC,qCAAmC;AAEnC,+CAAoC;AAEpC,MAAM,GAAG,GAAG,IAAA,kBAAS,EAAC,IAAI,CAAC,CAAC;AAE5B;;;;GAIG;AACU,QAAA,UAAU,GAAG,gBAAC,CAAC,OAAO,CAAC,iBAAO,CAAC,CAAC;AAE7C;;;;GAIG;AACU,QAAA,aAAa,GAAiC,gBAAC,CAAC,YAAY,CACvE,cAAI,CAAC,SAAS,EACd,EAAC,MAAM,EAAE,CAAC,EAAC,EACX,SAAS,CACV,CAAC;AAEF;;;;;GAKG;AACU,QAAA,cAAc,GAAiC,gBAAC,CAAC,YAAY,CAAC,KAAK,CAAC,SAAS,EAAE;IAC1F,MAAM,EAAE,CAAC;CACV,CAAC,CAAC;AAEH;;;;GAIG;AACU,QAAA,aAAa,GAAiC,gBAAC,CAAC,YAAY,CACvE,IAAI,CAAC,SAAS,EACd,CAAC,EACD,SAAS,CACV,CAAC;AAEF;;GAEG;AACU,QAAA,QAAQ,GAAG,gBAAC,CAAC,OAAO,CAAC,KAAK,EAAE,QAAgB,EAAE,EAAE,CAC3D,cAAI,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,IAAA,kBAAU,EAAC,GAAG,CAAC,CAAC;IACrC,IAAI,CAAC,MAAM,EAAE;QACX,OAAO;KACR;IACD,OAAO,mBAAI,CAAC,IAAI,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;AACrC,CAAC;AATD,oCASC;AAED;;;;;;GAMG;AACU,QAAA,mBAAmB,GAAG,gBAAC,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE,EAAE,EAAE;IACzE,MAAM,QAAQ,GAAG,MAAM,IAAA,iBAAM,EAAC,6BAAiB,EAAE,EAAC,GAAG,EAAE,IAAI,EAAE,MAAM,EAAC,CAAC,CAAC;IACtE,GAAG,CAAC,KAAK,CAAC,4BAA4B,EAAE,QAAQ,CAAC,CAAC;IAClD,OAAO,QAAQ,CAAC;AAClB,CAAC,CAAC,CAAC;AAEH;;;;;;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,IAAA,kBAAU,EAAC,GAAG,CAAC,CAAC;IACrC,IAAI,CAAC,MAAM,EAAE;QACX,MAAM,IAAI,qBAAa,CACrB,oBAAoB,6BAAiB,SAAS,GAAG,8CAA8C,CAChG,CAAC;KACH;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;QACb,MAAM,GAAG,GAAG,MAAM,IAAA,kBAAO,EAAC,EAAC,GAAG,EAAE,MAAM,EAAE,SAAS,EAAC,CAAC,CAAC;QACpD,OAAO,EAAC,GAAG,EAAE,OAAO,EAAC,CAAC;KACvB;SAAM;QACL,MAAM,GAAG,GAAG,MAAM,IAAA,kBAAO,EAAC,EAAC,GAAG,EAAE,MAAM,EAAC,CAAC,CAAC;QACzC,OAAO,EAAC,GAAG,EAAE,OAAO,EAAC,CAAC;KACvB;AACH,CAAC;AAED;;GAEG;AACU,QAAA,eAAe,GAAG,gBAAC,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;AAEvD;;;;;GAKG;AACU,QAAA,eAAe,GAAG,gBAAC,CAAC,OAAO,CAAC,CAAC,eAAuB,EAAE,EAAE;IACnE,MAAM,GAAG,GAAG,IAAI,qBAAW,EAAE,CAAC;IAC9B,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IACvC,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IACvC,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,uBAAa,EAAE,CAAC,CAAC;IAC3C,GAAG,CAAC,SAAS,CAAC,EAAC,OAAO,EAAE,mBAAI,CAAC,OAAO,CAAC,eAAe,CAAC,EAAC,CAAC,CAAC;IACxD,OAAO,GAAG,CAAC,OAAO,CAAC,YAAY,EAAE,CAAC;AACpC,CAAC,CAAC,CAAC;AAEH;;GAEG;AACU,QAAA,SAAS,GAAG,gBAAC,CAAC,OAAO,CAChC,KAAK,EAAuB,QAAgB,EAAc,EAAE,CAC1D,KAAK,CAAC,KAAK,CAAC,MAAM,YAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,CACnD,CAAC;AAEF;;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;;;;;;;GAOG;AACH,SAAgB,aAAa,CAAC,QAAgB,EAAE,OAAkB,EAAE,SAAS,GAAG,KAAK;IACnF,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;QAChB,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI;KAC7B,CAAC,CAAC;AACL,CAAC;AAND,sCAMC;AAED;;GAEG;AACH,MAAM,WAAW,GAAG,gBAAC,CAAC,OAAO,CAAC,YAAE,CAAC,KAA+B,CAAC,CAAC;AAElE;;GAEG;AACU,QAAA,QAAQ,GAAG,gBAAC,CAAC,OAAO,CAAC,WAAW,EAAE,oBAAQ,EAAE,EAAC,OAAO,EAAE,IAAI,EAAC,CAAC,CAAC;AAE1E;;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;AACH,MAAM,YAAY,GAAG,gBAAC,CAAC,OAAO,CAAC,WAAW,EAAE,wBAAY,EAAE,EAAC,OAAO,EAAE,IAAI,EAAC,CAAC,CAAC;AAE3E;;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;QACZ,OAAO,QAAQ,CAAC;KACjB;IACD,uCAAuC;IACvC,MAAM,UAAU,GAAG,MAAM,IAAA,kBAAU,GAAE,CAAC;IACtC,IAAI,CAAC,UAAU,EAAE;QACf,OAAO;KACR;IACD,IAAI;QACF,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;YACV,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;gBACnC,OAAO,QAAQ,CAAC;aACjB;SACF;KACF;IACD,MAAM,GAAE;AACV,CAAC,CAAC,CAAC;AAEH;;;;GAIG;AACU,QAAA,WAAW,GAAG,gBAAC,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE,EAA+B,EAAE;IAC9F,mFAAmF;IACnF,MAAM,UAAU,GACd,CAAC,MAAM,YAAE,CAAC,IAAI,CAAC,kCAAkC,EAAE,EAAC,GAAG,EAAE,KAAK,EAAE,IAAI,EAAC,CAAC,CAAC;QACvE,CAAC,MAAM,YAAE,CAAC,IAAI,CAAC,qCAAqC,EAAE,EAAC,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAC,CAAC,CAAC,CAAC;IAC3F,OAAO,gBAAC,CAAC,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,YAAY,EAAE,CAAC,CAAC;AACvD,CAAC,CAAC,CAAC;AAEH;;;;GAIG;AACU,QAAA,UAAU,GAAG,gBAAC,CAAC,OAAO,CACjC,KAAK,IAAiC,EAAE,CAAC,CAAC,MAAM,YAAY,EAAE,CAAC,IAAI,CAAC,MAAM,WAAW,EAAE,CAAC,CACzF,CAAC;AAEF;;;;;;;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,IAAA,gBAAQ,EAAC,QAAQ,CAAC,CAAc,CAAC;IACxD,IAAI,SAAS,CAAC,QAAQ,EAAE;QACtB,SAAS,CAAC,QAAQ,GAAG,mBAAI,CAAC,OAAO,CAAC,GAAG,EAAE,mBAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,SAAS,CAAC,QAAQ,CAAC,CAAC;KACpF;IACD,IAAI,SAAS,CAAC,OAAO,EAAE;QACrB,IAAI,WAAW,GAAuB,mBAAI,CAAC,OAAO,CAAC,mBAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,SAAS,CAAC,OAAO,CAAC,CAAC;QAC9F,OAAO,WAAW,EAAE;YAClB,MAAM,UAAU,GAAG,CAAC,MAAM,IAAA,gBAAQ,EAAC,WAAW,CAAC,CAAc,CAAC;YAC9D,IAAI,UAAU,CAAC,QAAQ,EAAE;gBACvB,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;aAC3D;YACD,IAAI,UAAU,CAAC,QAAQ,EAAE;gBACvB,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;aAC3D;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;SACf;KACF;IACD,OAAO,SAAS,CAAC;AACnB,CAAC,CACF,CAAC;AAEF;;GAEG;AACU,QAAA,UAAU,GAAG,gBAAC,CAAC,OAAO,CAAC,KAAK,EAAE,OAAe,EAAqB,EAAE;IAC/E,IAAI,CAAC,mBAAI,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE;QAC7B,MAAM,IAAI,qBAAa,CAAC,gCAAgC,OAAO,GAAG,CAAC,CAAC;KACrE;IACD,MAAM,OAAO,GAAG,MAAM,YAAE,CAAC,OAAO,CAAC,OAAO,EAAE,EAAC,aAAa,EAAE,IAAI,EAAC,CAAC,CAAC;IACjE,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,mBAAI,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;AAC/F,CAAC,CAAC,CAAC"}
1
+ {"version":3,"file":"fs.js","sourceRoot":"","sources":["../../lib/fs.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,6CAAmC;AACnC,6CAA+B;AAC/B,oDAAuB;AACvB,0DAA6B;AAC7B,sDAA8B;AAC9B,wDAAqE;AAErE,gDAAwB;AACxB,2CAAiG;AACjG,mCAAsC;AACtC,qCAAmC;AAEnC,+CAAkC;AAElC,MAAM,GAAG,GAAG,IAAA,kBAAS,EAAC,IAAI,CAAC,CAAC;AAE5B;;;;GAIG;AACU,QAAA,UAAU,GAAG,gBAAC,CAAC,OAAO,CAAC,iBAAO,CAAC,CAAC;AAE7C;;;;GAIG;AACU,QAAA,aAAa,GAAiC,gBAAC,CAAC,YAAY,CACvE,cAAI,CAAC,SAAS,EACd,EAAC,MAAM,EAAE,CAAC,EAAC,EACX,SAAS,CACV,CAAC;AAEF;;;;;GAKG;AACU,QAAA,cAAc,GAAiC,gBAAC,CAAC,YAAY,CAAC,KAAK,CAAC,SAAS,EAAE;IAC1F,MAAM,EAAE,CAAC;CACV,CAAC,CAAC;AAEH;;;;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,cAAI,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,IAAA,kBAAU,EAAC,GAAG,CAAC,CAAC;IACrC,IAAI,CAAC,MAAM,EAAE;QACX,OAAO;KACR;IACD,OAAO,mBAAI,CAAC,IAAI,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;AACrC,CAAC;AATD,oCASC;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,IAAA,kBAAU,EAAC,GAAG,CAAC,CAAC;IACrC,IAAI,CAAC,MAAM,EAAE;QACX,MAAM,IAAI,qBAAa,CACrB,oBAAoB,6BAAiB,SAAS,GAAG,8CAA8C,CAChG,CAAC;KACH;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;QACb,MAAM,GAAG,GAAG,MAAM,IAAA,kBAAO,EAAC,EAAC,GAAG,EAAE,MAAM,EAAE,SAAS,EAAC,CAAC,CAAC;QACpD,OAAO,EAAC,GAAG,EAAE,OAAO,EAAC,CAAC;KACvB;SAAM;QACL,MAAM,GAAG,GAAG,MAAM,IAAA,kBAAO,EAAC,EAAC,GAAG,EAAE,MAAM,EAAC,CAAC,CAAC;QACzC,OAAO,EAAC,GAAG,EAAE,OAAO,EAAC,CAAC;KACvB;AACH,CAAC;AAED;;GAEG;AACU,QAAA,eAAe,GAAG,gBAAC,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;AAEvD;;GAEG;AACU,QAAA,SAAS,GAAG,gBAAC,CAAC,OAAO,CAChC,KAAK,EAAuB,QAAgB,EAAc,EAAE,CAC1D,KAAK,CAAC,KAAK,CAAC,MAAM,YAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,CACnD,CAAC;AAEF;;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;;;;;;;GAOG;AACH,SAAgB,aAAa,CAAC,QAAgB,EAAE,OAAkB,EAAE,SAAS,GAAG,KAAK;IACnF,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;QAChB,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI;KAC7B,CAAC,CAAC;AACL,CAAC;AAND,sCAMC;AAED;;GAEG;AACH,MAAM,WAAW,GAAG,gBAAC,CAAC,OAAO,CAAC,YAAE,CAAC,KAA+B,CAAC,CAAC;AAElE;;GAEG;AACU,QAAA,QAAQ,GAAG,gBAAC,CAAC,OAAO,CAAC,WAAW,EAAE,oBAAQ,EAAE,EAAC,OAAO,EAAE,IAAI,EAAC,CAAC,CAAC;AAE1E;;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,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;QACZ,OAAO,QAAQ,CAAC;KACjB;IACD,uCAAuC;IACvC,MAAM,UAAU,GAAG,MAAM,IAAA,kBAAU,GAAE,CAAC;IACtC,IAAI,CAAC,UAAU,EAAE;QACf,OAAO;KACR;IACD,IAAI;QACF,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;YACV,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;gBACnC,OAAO,QAAQ,CAAC;aACjB;SACF;KACF;IAAC,MAAM,GAAE;AACZ,CAAC,CAAC,CAAC;AAEH;;;;GAIG;AACU,QAAA,UAAU,GAAG,gBAAC,CAAC,OAAO,CACjC,KAAK,IAAiC,EAAE,CAAC,CAAC,MAAM,YAAY,EAAE,CAAC,IAAI,CAAC,MAAM,WAAW,EAAE,CAAC,CACzF,CAAC;AAEF;;;;;;;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;QACtB,SAAS,CAAC,QAAQ,GAAG,mBAAI,CAAC,OAAO,CAAC,GAAG,EAAE,mBAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,SAAS,CAAC,QAAQ,CAAC,CAAC;KACpF;IACD,IAAI,SAAS,CAAC,OAAO,EAAE;QACrB,IAAI,WAAW,GAAuB,mBAAI,CAAC,OAAO,CAAC,mBAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,SAAS,CAAC,OAAO,CAAC,CAAC;QAC9F,OAAO,WAAW,EAAE;YAClB,MAAM,UAAU,GAAG,CAAC,MAAM,QAAQ,CAAC,WAAW,CAAC,CAAc,CAAC;YAC9D,IAAI,UAAU,CAAC,QAAQ,EAAE;gBACvB,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;aAC3D;YACD,IAAI,UAAU,CAAC,QAAQ,EAAE;gBACvB,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;aAC3D;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;SACf;KACF;IACD,OAAO,SAAS,CAAC;AACnB,CAAC,CACF,CAAC"}
@@ -2,7 +2,6 @@
2
2
  * Main entry point
3
3
  * @module
4
4
  */
5
- export * from './mike';
6
5
  export * from './builder';
7
6
  export * from './validate';
8
7
  export * from './scaffold';
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../lib/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,cAAc,QAAQ,CAAC;AACvB,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,UAAU,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../lib/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,UAAU,CAAC"}
@@ -18,7 +18,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
18
18
  for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
19
19
  };
20
20
  Object.defineProperty(exports, "__esModule", { value: true });
21
- __exportStar(require("./mike"), exports);
22
21
  __exportStar(require("./builder"), exports);
23
22
  __exportStar(require("./validate"), exports);
24
23
  __exportStar(require("./scaffold"), exports);
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../lib/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;;;;;AAEH,yCAAuB;AACvB,4CAA0B;AAC1B,6CAA2B;AAC3B,6CAA2B;AAC3B,8CAA4B;AAC5B,2CAAyB"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../lib/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;;;;;AAEH,4CAA0B;AAC1B,6CAA2B;AAC3B,6CAA2B;AAC3B,8CAA4B;AAC5B,2CAAyB"}
@@ -3,127 +3,18 @@
3
3
  *
4
4
  * @module
5
5
  */
6
- import { PackageJson, Simplify } from 'type-fest';
6
+ import { Simplify } from 'type-fest';
7
7
  import { ScaffoldTaskOptions } from './scaffold';
8
- import { TsConfigJson } from './model';
8
+ import type { ScaffoldTask } from './scaffold';
9
+ import { MkDocsYml, TsConfigJson } from './model';
9
10
  /**
10
11
  * Function which scaffolds a `tsconfig.json` file
11
12
  */
12
- export declare const initTsConfigJson: import("./scaffold").ScaffoldTask<InitTsConfigOptions, TsConfigJson>;
13
- /**
14
- * Function which scaffolds a `typedoc.json` file
15
- */
16
- export declare const initTypeDocJson: import("./scaffold").ScaffoldTask<InitTypeDocOptions, import("type-fest/source/jsonify").JsonifyObject<{
17
- $schema?: string | undefined;
18
- includes?: string | undefined;
19
- options?: string | undefined;
20
- tsconfig?: string | undefined;
21
- entryPoints?: string[] | undefined;
22
- entryPointStrategy?: "Resolve" | "resolve" | "Expand" | "Packages" | "expand" | "packages" | undefined;
23
- exclude?: string[] | undefined;
24
- externalPattern?: string[] | undefined;
25
- excludeExternals?: boolean | undefined;
26
- excludeNotDocumented?: boolean | undefined;
27
- excludeNotDocumentedKinds?: ("Reference" | "Project" | "Module" | "Namespace" | "Enum" | "EnumMember" | "Variable" | "Function" | "Class" | "Interface" | "Constructor" | "Property" | "Method" | "CallSignature" | "IndexSignature" | "ConstructorSignature" | "Parameter" | "TypeLiteral" | "TypeParameter" | "Accessor" | "GetSignature" | "SetSignature" | "ObjectLiteral" | "TypeAlias" | "All" | "ClassOrInterface" | "VariableOrProperty" | "FunctionOrMethod" | "ClassMember" | "SomeSignature" | "SomeModule" | "SomeType" | "SomeValue" | "SomeMember" | "SomeExport" | "ExportContainer" | "Inheritable" | "ContainsCallSignatures" | "SignatureContainer")[] | undefined;
28
- excludeInternal?: boolean | undefined;
29
- excludePrivate?: boolean | undefined;
30
- excludeProtected?: boolean | undefined;
31
- externalSymbolLinkMappings?: Record<string, Record<string, string>> | undefined;
32
- media?: string | undefined;
33
- out?: string | undefined;
34
- json?: string | undefined;
35
- pretty?: boolean | undefined;
36
- emit?: "docs" | "both" | "none" | undefined;
37
- theme?: string | undefined;
38
- lightHighlightTheme?: import("shiki").Theme | undefined;
39
- darkHighlightTheme?: import("shiki").Theme | undefined;
40
- customCss?: string | undefined;
41
- name?: string | undefined;
42
- includeVersion?: boolean | undefined;
43
- disableSources?: boolean | undefined;
44
- basePath?: string | undefined;
45
- excludeTags?: `@${string}`[] | undefined;
46
- readme?: string | undefined;
47
- cname?: string | undefined;
48
- sourceLinkTemplate?: string | undefined;
49
- gitRevision?: string | undefined;
50
- gitRemote?: string | undefined;
51
- htmlLang?: string | undefined;
52
- githubPages?: boolean | undefined;
53
- gaID?: string | undefined;
54
- hideGenerator?: boolean | undefined;
55
- searchInComments?: boolean | undefined;
56
- cleanOutputDir?: boolean | undefined;
57
- titleLink?: string | undefined;
58
- navigationLinks?: Record<string, string> | undefined;
59
- sidebarLinks?: Record<string, string> | undefined;
60
- commentStyle?: "All" | "JSDoc" | "jsdoc" | "Block" | "Line" | "all" | "block" | "line" | undefined;
61
- blockTags?: `@${string}`[] | undefined;
62
- inlineTags?: `@${string}`[] | undefined;
63
- modifierTags?: `@${string}`[] | undefined;
64
- categorizeByGroup?: boolean | undefined;
65
- defaultCategory?: string | undefined;
66
- categoryOrder?: string[] | undefined;
67
- sort?: ("source-order" | "alphabetical" | "enum-value-ascending" | "enum-value-descending" | "static-first" | "instance-first" | "visibility" | "required-first" | "kind")[] | undefined;
68
- kindSortOrder?: ("Reference" | "Project" | "Module" | "Namespace" | "Enum" | "EnumMember" | "Variable" | "Function" | "Class" | "Interface" | "Constructor" | "Property" | "Method" | "CallSignature" | "IndexSignature" | "ConstructorSignature" | "Parameter" | "TypeLiteral" | "TypeParameter" | "Accessor" | "GetSignature" | "SetSignature" | "ObjectLiteral" | "TypeAlias" | "All" | "ClassOrInterface" | "VariableOrProperty" | "FunctionOrMethod" | "ClassMember" | "SomeSignature" | "SomeModule" | "SomeType" | "SomeValue" | "SomeMember" | "SomeExport" | "ExportContainer" | "Inheritable" | "ContainsCallSignatures" | "SignatureContainer")[] | undefined;
69
- visibilityFilters?: {
70
- [tag: `@${string}`]: boolean;
71
- protected?: boolean | undefined;
72
- private?: boolean | undefined;
73
- inherited?: boolean | undefined;
74
- external?: boolean | undefined;
75
- } | undefined;
76
- searchCategoryBoosts?: Record<string, number> | undefined;
77
- searchGroupBoosts?: Record<string, number> | undefined;
78
- watch?: boolean | undefined;
79
- preserveWatchOutput?: boolean | undefined;
80
- skipErrorChecking?: boolean | undefined;
81
- help?: boolean | undefined;
82
- version?: boolean | undefined;
83
- showConfig?: boolean | undefined;
84
- plugin?: string[] | undefined;
85
- logLevel?: import("typedoc").LogLevel | "Verbose" | "Info" | "Warn" | "Error" | undefined;
86
- treatWarningsAsErrors?: boolean | undefined;
87
- treatValidationWarningsAsErrors?: boolean | undefined;
88
- intentionallyNotExported?: string[] | undefined;
89
- validation?: boolean | Partial<import("typedoc").ValidationOptions> | undefined;
90
- requiredToBeDocumented?: ("Reference" | "Project" | "Module" | "Namespace" | "Enum" | "EnumMember" | "Variable" | "Function" | "Class" | "Interface" | "Constructor" | "Property" | "Method" | "CallSignature" | "IndexSignature" | "ConstructorSignature" | "Parameter" | "TypeLiteral" | "TypeParameter" | "Accessor" | "GetSignature" | "SetSignature" | "ObjectLiteral" | "TypeAlias" | "All" | "ClassOrInterface" | "VariableOrProperty" | "FunctionOrMethod" | "ClassMember" | "SomeSignature" | "SomeModule" | "SomeType" | "SomeValue" | "SomeMember" | "SomeExport" | "ExportContainer" | "Inheritable" | "ContainsCallSignatures" | "SignatureContainer")[] | undefined;
91
- extends?: string | undefined;
92
- }>>;
93
- /**
94
- * Function which scaffolds a `package.json` file
95
- *
96
- * This only amends prop `typedoc.entryPoint` to the `package.json` file.
97
- *
98
- * If, strangely, `package.json` did not exist, then it will now contain _only_ that prop.
99
- */
100
- export declare const initTypeDocPkgJson: import("./scaffold").ScaffoldTask<InitTypeDocOptions, PackageJson>;
13
+ export declare const initTsConfigJson: ScaffoldTask<InitTsConfigOptions, TsConfigJson>;
101
14
  /**
102
15
  * Function which scaffolds an `mkdocs.yml` file
103
16
  */
104
- export declare const initMkDocs: import("./scaffold").ScaffoldTask<InitMkDocsOptions, import("type-fest/source/jsonify").JsonifyObject<{
105
- theme?: import("./model").MkDocsYmlTheme | undefined;
106
- watch?: string[] | undefined;
107
- copyright?: string | undefined;
108
- dev_addr?: string | undefined;
109
- docs_dir?: string | undefined;
110
- extra_css?: string[] | undefined;
111
- extra_javascript?: string[] | undefined;
112
- extra_templates?: string[] | undefined;
113
- extra?: Record<string, import("type-fest").JsonValue> | undefined;
114
- hooks?: string[] | undefined;
115
- INHERIT?: string | undefined;
116
- markdown_extensions?: (string | Record<string, import("type-fest").JsonValue>)[] | undefined;
117
- nav?: import("./model").MkDocsYmlNav | undefined;
118
- plugins?: (string | Record<string, import("type-fest").JsonValue>)[] | undefined;
119
- repo_name?: string | undefined;
120
- repo_url?: string | undefined;
121
- site_dir?: string | undefined;
122
- site_name?: string | undefined;
123
- site_description?: string | undefined;
124
- strict?: boolean | undefined;
125
- use_directory_urls?: boolean | undefined;
126
- }>>;
17
+ export declare const initMkDocs: ScaffoldTask<InitMkDocsOptions, MkDocsYml>;
127
18
  /**
128
19
  * Installs Python dependencies
129
20
  * @param opts Options
@@ -145,10 +36,7 @@ export interface InitMkDocsOptions extends ScaffoldTaskOptions {
145
36
  * This runs tasks in serial; it _could_ run in parallel, but it has deleterious effects upon
146
37
  * console output which would need mitigation.
147
38
  */
148
- export declare function init({ typescript, typedoc, python, tsconfigJson: tsconfigJsonPath, packageJson: packageJsonPath, overwrite, include, mkdocs, mkdocsYml: mkdocsYmlPath, siteName, repoName, repoUrl, copyright, dryRun, cwd, pythonPath, upgrade, typedocJson: typeDocJsonPath, entryPoint: typeDocEntryPoint, }?: InitOptions): Promise<void>;
149
- export interface InitTypeDocOptions extends ScaffoldTaskOptions {
150
- typeDocEntryPoint?: string;
151
- }
39
+ export declare function init({ typescript, python, tsconfigJson: tsconfigJsonPath, packageJson: packageJsonPath, overwrite, include, mkdocs, mkdocsYml: mkdocsYmlPath, siteName, repoName, repoUrl, copyright, dryRun, cwd, pythonPath, upgrade, }?: InitOptions): Promise<void>;
152
40
  export interface InitTsConfigOptions extends ScaffoldTaskOptions {
153
41
  /**
154
42
  * List of source files (globs supported); typically `src` or `lib`
@@ -170,15 +58,11 @@ export interface InitPythonOptions extends ScaffoldTaskOptions {
170
58
  *
171
59
  * The props of the various "path" options are rewritten as `dest` for the scaffold tasks functions.
172
60
  */
173
- export type InitOptions = Simplify<Omit<InitPythonOptions & InitTsConfigOptions & InitTypeDocOptions & InitMkDocsOptions, 'dest'> & {
61
+ export type InitOptions = Simplify<Omit<InitPythonOptions & InitTsConfigOptions & InitMkDocsOptions, 'dest'> & {
174
62
  /**
175
63
  * If `true` will initialize a `tsconfig.json` file
176
64
  */
177
65
  typescript?: boolean;
178
- /**
179
- * If `true` will initialize a `typedoc.json` file
180
- */
181
- typedoc?: boolean;
182
66
  /**
183
67
  * If `true` will install Python deps
184
68
  */
@@ -187,10 +71,6 @@ export type InitOptions = Simplify<Omit<InitPythonOptions & InitTsConfigOptions
187
71
  * If `true` will initialize a `mkdocs.yml` file
188
72
  */
189
73
  mkdocs?: boolean;
190
- /**
191
- * Path to new or existing `typedoc.json` file
192
- */
193
- typedocJson?: string;
194
74
  /**
195
75
  * Path to new or existing `tsconfig.json` file
196
76
  */
@@ -207,9 +87,5 @@ export type InitOptions = Simplify<Omit<InitPythonOptions & InitTsConfigOptions
207
87
  * If `true`, upgrade only
208
88
  */
209
89
  upgrade?: boolean;
210
- /**
211
- * Path to entry point of extension (source; not "main" field)
212
- */
213
- entryPoint?: string;
214
90
  }>;
215
91
  //# sourceMappingURL=init.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"init.d.ts","sourceRoot":"","sources":["../../lib/init.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAaH,OAAO,EAAC,WAAW,EAAE,QAAQ,EAAC,MAAM,WAAW,CAAC;AAEhD,OAAO,EAAqB,mBAAmB,EAAC,MAAM,YAAY,CAAC;AAEnE,OAAO,EAAY,YAAY,EAAc,MAAM,SAAS,CAAC;AAkD7D;;GAEG;AACH,eAAO,MAAM,gBAAgB,sEAyB5B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAI3B,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,kBAAkB,oEAW9B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,UAAU;;;;;;;;;;;;;;;;;;;;;;GAmDtB,CAAC;AAEF;;;GAGG;AACH,wBAAsB,UAAU,CAAC,EAC/B,UAAU,EACV,MAAc,EACd,OAAe,GAChB,GAAE,iBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC,CAyBxC;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,mBAAmB;IAC5D,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;;;GAKG;AACH,wBAAsB,IAAI,CAAC,EACzB,UAAU,EACV,OAAO,EACP,MAAM,EACN,YAAY,EAAE,gBAAgB,EAC9B,WAAW,EAAE,eAAe,EAC5B,SAAS,EACT,OAAO,EACP,MAAM,EACN,SAAS,EAAE,aAAa,EACxB,QAAQ,EACR,QAAQ,EACR,OAAO,EACP,SAAS,EACT,MAAM,EACN,GAAG,EACH,UAAU,EACV,OAAO,EACP,WAAW,EAAE,eAAe,EAC5B,UAAU,EAAE,iBAAiB,GAC9B,GAAE,WAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CAoDlC;AAED,MAAM,WAAW,kBAAmB,SAAQ,mBAAmB;IAC7D,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,mBAAoB,SAAQ,mBAAmB;IAC9D;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;CACpB;AACD,MAAM,WAAW,iBAAkB,SAAQ,mBAAmB;IAC5D;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG,QAAQ,CAChC,IAAI,CAAC,iBAAiB,GAAG,mBAAmB,GAAG,kBAAkB,GAAG,iBAAiB,EAAE,MAAM,CAAC,GAAG;IAC/F;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,CACF,CAAC"}
1
+ {"version":3,"file":"init.d.ts","sourceRoot":"","sources":["../../lib/init.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAMH,OAAO,EAAC,QAAQ,EAAC,MAAM,WAAW,CAAC;AAEnC,OAAO,EAAqB,mBAAmB,EAAC,MAAM,YAAY,CAAC;AACnE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAE/C,OAAO,EAAC,SAAS,EAAE,YAAY,EAAC,MAAM,SAAS,CAAC;AA+BhD;;GAEG;AACH,eAAO,MAAM,gBAAgB,iDAyB5B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,UAAU,EAAE,YAAY,CAAC,iBAAiB,EAAE,SAAS,CAmDjE,CAAC;AAEF;;;GAGG;AACH,wBAAsB,UAAU,CAAC,EAC/B,UAAU,EACV,MAAc,EACd,OAAe,GAChB,GAAE,iBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC,CAyBxC;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,mBAAmB;IAC5D,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;;;GAKG;AACH,wBAAsB,IAAI,CAAC,EACzB,UAAU,EACV,MAAM,EACN,YAAY,EAAE,gBAAgB,EAC9B,WAAW,EAAE,eAAe,EAC5B,SAAS,EACT,OAAO,EACP,MAAM,EACN,SAAS,EAAE,aAAa,EACxB,QAAQ,EACR,QAAQ,EACR,OAAO,EACP,SAAS,EACT,MAAM,EACN,GAAG,EACH,UAAU,EACV,OAAO,GACR,GAAE,WAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CA6BlC;AAED,MAAM,WAAW,mBAAoB,SAAQ,mBAAmB;IAC9D;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;CACpB;AACD,MAAM,WAAW,iBAAkB,SAAQ,mBAAmB;IAC5D;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG,QAAQ,CAChC,IAAI,CAAC,iBAAiB,GAAG,mBAAmB,GAAG,iBAAiB,EAAE,MAAM,CAAC,GAAG;IAC1E;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CACF,CAAC"}