@powerlines/plugin-typedoc 0.10.465 → 0.10.467
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/dist/_virtual/_rolldown/runtime.cjs +29 -1
- package/dist/index.cjs +60 -1
- package/dist/index.mjs +56 -1
- package/dist/index.mjs.map +1 -1
- package/dist/types/index.mjs +1 -1
- package/dist/types/plugin.mjs +1 -1
- package/package.json +4 -4
|
@@ -1 +1,29 @@
|
|
|
1
|
-
|
|
1
|
+
//#region \0rolldown/runtime.js
|
|
2
|
+
var __create = Object.create;
|
|
3
|
+
var __defProp = Object.defineProperty;
|
|
4
|
+
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
|
|
5
|
+
var __getOwnPropNames = Object.getOwnPropertyNames;
|
|
6
|
+
var __getProtoOf = Object.getPrototypeOf;
|
|
7
|
+
var __hasOwnProp = Object.prototype.hasOwnProperty;
|
|
8
|
+
var __copyProps = (to, from, except, desc) => {
|
|
9
|
+
if (from && typeof from === "object" || typeof from === "function") {
|
|
10
|
+
for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
|
|
11
|
+
key = keys[i];
|
|
12
|
+
if (!__hasOwnProp.call(to, key) && key !== except) {
|
|
13
|
+
__defProp(to, key, {
|
|
14
|
+
get: ((k) => from[k]).bind(null, key),
|
|
15
|
+
enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
|
|
16
|
+
});
|
|
17
|
+
}
|
|
18
|
+
}
|
|
19
|
+
}
|
|
20
|
+
return to;
|
|
21
|
+
};
|
|
22
|
+
var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", {
|
|
23
|
+
value: mod,
|
|
24
|
+
enumerable: true
|
|
25
|
+
}) : target, mod));
|
|
26
|
+
|
|
27
|
+
//#endregion
|
|
28
|
+
|
|
29
|
+
exports.__toESM = __toESM;
|
package/dist/index.cjs
CHANGED
|
@@ -1 +1,60 @@
|
|
|
1
|
-
Object.defineProperties(exports,{__esModule:{value
|
|
1
|
+
Object.defineProperties(exports, { __esModule: { value: true }, [Symbol.toStringTag]: { value: 'Module' } });
|
|
2
|
+
const require_runtime = require('./_virtual/_rolldown/runtime.cjs');
|
|
3
|
+
let _stryke_fs_exists = require("@stryke/fs/exists");
|
|
4
|
+
let _stryke_fs_helpers = require("@stryke/fs/helpers");
|
|
5
|
+
let _stryke_path_append = require("@stryke/path/append");
|
|
6
|
+
let _stryke_path_join = require("@stryke/path/join");
|
|
7
|
+
let defu = require("defu");
|
|
8
|
+
defu = require_runtime.__toESM(defu, 1);
|
|
9
|
+
let typedoc = require("typedoc");
|
|
10
|
+
|
|
11
|
+
//#region src/index.ts
|
|
12
|
+
/**
|
|
13
|
+
* A Powerlines plugin to assist in generating documentation with TypeDoc.
|
|
14
|
+
*/
|
|
15
|
+
function plugin(options = {}) {
|
|
16
|
+
return {
|
|
17
|
+
name: "typedoc",
|
|
18
|
+
async config() {
|
|
19
|
+
this.debug("Providing default configuration for the Powerlines `typedoc` build plugin.");
|
|
20
|
+
return { typedoc: (0, defu.default)(options, {
|
|
21
|
+
outputPath: (0, _stryke_path_join.joinPaths)(this.config.root, "docs", "generated", "api-reference"),
|
|
22
|
+
baseUrl: "/docs/",
|
|
23
|
+
excludeExternals: true,
|
|
24
|
+
excludeInternal: true,
|
|
25
|
+
excludePrivate: true,
|
|
26
|
+
excludeProtected: true,
|
|
27
|
+
hideGenerator: true,
|
|
28
|
+
githubPages: false,
|
|
29
|
+
readme: "none",
|
|
30
|
+
gitRevision: "main",
|
|
31
|
+
tsconfig: this.tsconfig.tsconfigFilePath,
|
|
32
|
+
plugin: options.plugin ? [] : ["typedoc-plugin-markdown"]
|
|
33
|
+
}) };
|
|
34
|
+
},
|
|
35
|
+
async configResolved() {
|
|
36
|
+
this.typedoc = await typedoc.Application.bootstrapWithPlugins({
|
|
37
|
+
...this.config.typedoc,
|
|
38
|
+
exclude: this.config.typedoc.exclude ?? this.tsconfig.tsconfigJson.exclude?.filter(Boolean) ?? [],
|
|
39
|
+
out: this.config.typedoc.outputPath,
|
|
40
|
+
entryPoints: this.entry.map((entry) => (0, _stryke_path_append.appendPath)(entry.file, this.config.root)),
|
|
41
|
+
...this.config.typedoc.override
|
|
42
|
+
}, [
|
|
43
|
+
new typedoc.TypeDocReader(),
|
|
44
|
+
new typedoc.PackageJsonReader(),
|
|
45
|
+
new typedoc.TSConfigReader()
|
|
46
|
+
]);
|
|
47
|
+
},
|
|
48
|
+
async docs() {
|
|
49
|
+
this.debug(`Generating documentation for the Powerlines application with TypeDoc.`);
|
|
50
|
+
if ((0, _stryke_fs_exists.existsSync)(this.config.typedoc.outputPath)) await (0, _stryke_fs_helpers.removeDirectory)(this.config.typedoc.outputPath);
|
|
51
|
+
await (0, _stryke_fs_helpers.createDirectory)(this.config.typedoc.outputPath);
|
|
52
|
+
const project = await this.typedoc.convert();
|
|
53
|
+
if (project) await this.typedoc.generateDocs(project, this.config.typedoc.outputPath);
|
|
54
|
+
}
|
|
55
|
+
};
|
|
56
|
+
}
|
|
57
|
+
|
|
58
|
+
//#endregion
|
|
59
|
+
exports.default = plugin;
|
|
60
|
+
exports.plugin = plugin;
|
package/dist/index.mjs
CHANGED
|
@@ -1,2 +1,57 @@
|
|
|
1
|
-
import
|
|
1
|
+
import { existsSync } from "@stryke/fs/exists";
|
|
2
|
+
import { createDirectory, removeDirectory } from "@stryke/fs/helpers";
|
|
3
|
+
import { appendPath } from "@stryke/path/append";
|
|
4
|
+
import { joinPaths } from "@stryke/path/join";
|
|
5
|
+
import defu from "defu";
|
|
6
|
+
import { Application, PackageJsonReader, TSConfigReader, TypeDocReader } from "typedoc";
|
|
7
|
+
|
|
8
|
+
//#region src/index.ts
|
|
9
|
+
/**
|
|
10
|
+
* A Powerlines plugin to assist in generating documentation with TypeDoc.
|
|
11
|
+
*/
|
|
12
|
+
function plugin(options = {}) {
|
|
13
|
+
return {
|
|
14
|
+
name: "typedoc",
|
|
15
|
+
async config() {
|
|
16
|
+
this.debug("Providing default configuration for the Powerlines `typedoc` build plugin.");
|
|
17
|
+
return { typedoc: defu(options, {
|
|
18
|
+
outputPath: joinPaths(this.config.root, "docs", "generated", "api-reference"),
|
|
19
|
+
baseUrl: "/docs/",
|
|
20
|
+
excludeExternals: true,
|
|
21
|
+
excludeInternal: true,
|
|
22
|
+
excludePrivate: true,
|
|
23
|
+
excludeProtected: true,
|
|
24
|
+
hideGenerator: true,
|
|
25
|
+
githubPages: false,
|
|
26
|
+
readme: "none",
|
|
27
|
+
gitRevision: "main",
|
|
28
|
+
tsconfig: this.tsconfig.tsconfigFilePath,
|
|
29
|
+
plugin: options.plugin ? [] : ["typedoc-plugin-markdown"]
|
|
30
|
+
}) };
|
|
31
|
+
},
|
|
32
|
+
async configResolved() {
|
|
33
|
+
this.typedoc = await Application.bootstrapWithPlugins({
|
|
34
|
+
...this.config.typedoc,
|
|
35
|
+
exclude: this.config.typedoc.exclude ?? this.tsconfig.tsconfigJson.exclude?.filter(Boolean) ?? [],
|
|
36
|
+
out: this.config.typedoc.outputPath,
|
|
37
|
+
entryPoints: this.entry.map((entry) => appendPath(entry.file, this.config.root)),
|
|
38
|
+
...this.config.typedoc.override
|
|
39
|
+
}, [
|
|
40
|
+
new TypeDocReader(),
|
|
41
|
+
new PackageJsonReader(),
|
|
42
|
+
new TSConfigReader()
|
|
43
|
+
]);
|
|
44
|
+
},
|
|
45
|
+
async docs() {
|
|
46
|
+
this.debug(`Generating documentation for the Powerlines application with TypeDoc.`);
|
|
47
|
+
if (existsSync(this.config.typedoc.outputPath)) await removeDirectory(this.config.typedoc.outputPath);
|
|
48
|
+
await createDirectory(this.config.typedoc.outputPath);
|
|
49
|
+
const project = await this.typedoc.convert();
|
|
50
|
+
if (project) await this.typedoc.generateDocs(project, this.config.typedoc.outputPath);
|
|
51
|
+
}
|
|
52
|
+
};
|
|
53
|
+
}
|
|
54
|
+
|
|
55
|
+
//#endregion
|
|
56
|
+
export { plugin as default, plugin };
|
|
2
57
|
//# sourceMappingURL=index.mjs.map
|
package/dist/index.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.mjs","names":[],"sources":["../src/index.ts"],"sourcesContent":["/* -------------------------------------------------------------------\n\n ⚡ Storm Software - Powerlines\n\n This code was released as part of the Powerlines project. Powerlines\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/powerlines.\n\n Website: https://stormsoftware.com\n Repository: https://github.com/storm-software/powerlines\n Documentation: https://docs.stormsoftware.com/projects/powerlines\n Contact: https://stormsoftware.com/contact\n\n SPDX-License-Identifier: Apache-2.0\n\n ------------------------------------------------------------------- */\n\nimport { existsSync } from \"@stryke/fs/exists\";\nimport { createDirectory, removeDirectory } from \"@stryke/fs/helpers\";\nimport { appendPath } from \"@stryke/path/append\";\nimport { joinPaths } from \"@stryke/path/join\";\nimport defu from \"defu\";\nimport { Plugin } from \"powerlines\";\nimport {\n Application,\n PackageJsonReader,\n TSConfigReader,\n TypeDocReader\n} from \"typedoc\";\nimport {\n TypeDocPluginContext,\n TypeDocPluginOptions,\n TypeDocPluginUserConfig\n} from \"./types/plugin\";\n\nexport * from \"./types\";\n\ndeclare module \"powerlines\" {\n interface Config {\n typedoc?: TypeDocPluginOptions;\n }\n}\n\n/**\n * A Powerlines plugin to assist in generating documentation with TypeDoc.\n */\nexport function plugin(\n options: TypeDocPluginOptions = {}\n): Plugin<TypeDocPluginContext> {\n return {\n name: \"typedoc\",\n async config() {\n this.debug(\n \"Providing default configuration for the Powerlines `typedoc` build plugin.\"\n );\n\n return {\n typedoc: defu(options, {\n outputPath: joinPaths(\n this.config.root,\n \"docs\",\n \"generated\",\n \"api-reference\"\n ),\n baseUrl: \"/docs/\",\n excludeExternals: true,\n excludeInternal: true,\n excludePrivate: true,\n excludeProtected: true,\n hideGenerator: true,\n githubPages: false,\n readme: \"none\",\n gitRevision: \"main\",\n tsconfig: this.tsconfig.tsconfigFilePath,\n plugin: options.plugin ? [] : [\"typedoc-plugin-markdown\"]\n })\n } as Partial<TypeDocPluginUserConfig>;\n },\n async configResolved() {\n this.typedoc = await Application.bootstrapWithPlugins(\n {\n ...this.config.typedoc,\n exclude:\n this.config.typedoc.exclude ??\n this.tsconfig.tsconfigJson.exclude?.filter(Boolean) ??\n [],\n out: this.config.typedoc.outputPath,\n entryPoints: this.entry.map(entry =>\n appendPath(entry.file, this.config.root)\n ),\n ...this.config.typedoc.override\n },\n [new TypeDocReader(), new PackageJsonReader(), new TSConfigReader()]\n );\n },\n async docs() {\n this.debug(\n `Generating documentation for the Powerlines application with TypeDoc.`\n );\n\n if (existsSync(this.config.typedoc.outputPath)) {\n await removeDirectory(this.config.typedoc.outputPath);\n }\n\n await createDirectory(this.config.typedoc.outputPath);\n\n const project = await this.typedoc.convert();\n if (project) {\n await this.typedoc.generateDocs(\n project,\n this.config.typedoc.outputPath\n );\n }\n }\n };\n}\n\nexport default plugin;\n"],"mappings":"
|
|
1
|
+
{"version":3,"file":"index.mjs","names":[],"sources":["../src/index.ts"],"sourcesContent":["/* -------------------------------------------------------------------\n\n ⚡ Storm Software - Powerlines\n\n This code was released as part of the Powerlines project. Powerlines\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/powerlines.\n\n Website: https://stormsoftware.com\n Repository: https://github.com/storm-software/powerlines\n Documentation: https://docs.stormsoftware.com/projects/powerlines\n Contact: https://stormsoftware.com/contact\n\n SPDX-License-Identifier: Apache-2.0\n\n ------------------------------------------------------------------- */\n\nimport { existsSync } from \"@stryke/fs/exists\";\nimport { createDirectory, removeDirectory } from \"@stryke/fs/helpers\";\nimport { appendPath } from \"@stryke/path/append\";\nimport { joinPaths } from \"@stryke/path/join\";\nimport defu from \"defu\";\nimport { Plugin } from \"powerlines\";\nimport {\n Application,\n PackageJsonReader,\n TSConfigReader,\n TypeDocReader\n} from \"typedoc\";\nimport {\n TypeDocPluginContext,\n TypeDocPluginOptions,\n TypeDocPluginUserConfig\n} from \"./types/plugin\";\n\nexport * from \"./types\";\n\ndeclare module \"powerlines\" {\n interface Config {\n typedoc?: TypeDocPluginOptions;\n }\n}\n\n/**\n * A Powerlines plugin to assist in generating documentation with TypeDoc.\n */\nexport function plugin(\n options: TypeDocPluginOptions = {}\n): Plugin<TypeDocPluginContext> {\n return {\n name: \"typedoc\",\n async config() {\n this.debug(\n \"Providing default configuration for the Powerlines `typedoc` build plugin.\"\n );\n\n return {\n typedoc: defu(options, {\n outputPath: joinPaths(\n this.config.root,\n \"docs\",\n \"generated\",\n \"api-reference\"\n ),\n baseUrl: \"/docs/\",\n excludeExternals: true,\n excludeInternal: true,\n excludePrivate: true,\n excludeProtected: true,\n hideGenerator: true,\n githubPages: false,\n readme: \"none\",\n gitRevision: \"main\",\n tsconfig: this.tsconfig.tsconfigFilePath,\n plugin: options.plugin ? [] : [\"typedoc-plugin-markdown\"]\n })\n } as Partial<TypeDocPluginUserConfig>;\n },\n async configResolved() {\n this.typedoc = await Application.bootstrapWithPlugins(\n {\n ...this.config.typedoc,\n exclude:\n this.config.typedoc.exclude ??\n this.tsconfig.tsconfigJson.exclude?.filter(Boolean) ??\n [],\n out: this.config.typedoc.outputPath,\n entryPoints: this.entry.map(entry =>\n appendPath(entry.file, this.config.root)\n ),\n ...this.config.typedoc.override\n },\n [new TypeDocReader(), new PackageJsonReader(), new TSConfigReader()]\n );\n },\n async docs() {\n this.debug(\n `Generating documentation for the Powerlines application with TypeDoc.`\n );\n\n if (existsSync(this.config.typedoc.outputPath)) {\n await removeDirectory(this.config.typedoc.outputPath);\n }\n\n await createDirectory(this.config.typedoc.outputPath);\n\n const project = await this.typedoc.convert();\n if (project) {\n await this.typedoc.generateDocs(\n project,\n this.config.typedoc.outputPath\n );\n }\n }\n };\n}\n\nexport default plugin;\n"],"mappings":";;;;;;;;;;;AA+CA,SAAgB,OACd,UAAgC,EAAE,EACJ;AAC9B,QAAO;EACL,MAAM;EACN,MAAM,SAAS;AACb,QAAK,MACH,6EACD;AAED,UAAO,EACL,SAAS,KAAK,SAAS;IACrB,YAAY,UACV,KAAK,OAAO,MACZ,QACA,aACA,gBACD;IACD,SAAS;IACT,kBAAkB;IAClB,iBAAiB;IACjB,gBAAgB;IAChB,kBAAkB;IAClB,eAAe;IACf,aAAa;IACb,QAAQ;IACR,aAAa;IACb,UAAU,KAAK,SAAS;IACxB,QAAQ,QAAQ,SAAS,EAAE,GAAG,CAAC,0BAA0B;IAC1D,CAAC,EACH;;EAEH,MAAM,iBAAiB;AACrB,QAAK,UAAU,MAAM,YAAY,qBAC/B;IACE,GAAG,KAAK,OAAO;IACf,SACE,KAAK,OAAO,QAAQ,WACpB,KAAK,SAAS,aAAa,SAAS,OAAO,QAAQ,IACnD,EAAE;IACJ,KAAK,KAAK,OAAO,QAAQ;IACzB,aAAa,KAAK,MAAM,KAAI,UAC1B,WAAW,MAAM,MAAM,KAAK,OAAO,KAAK,CACzC;IACD,GAAG,KAAK,OAAO,QAAQ;IACxB,EACD;IAAC,IAAI,eAAe;IAAE,IAAI,mBAAmB;IAAE,IAAI,gBAAgB;IAAC,CACrE;;EAEH,MAAM,OAAO;AACX,QAAK,MACH,wEACD;AAED,OAAI,WAAW,KAAK,OAAO,QAAQ,WAAW,CAC5C,OAAM,gBAAgB,KAAK,OAAO,QAAQ,WAAW;AAGvD,SAAM,gBAAgB,KAAK,OAAO,QAAQ,WAAW;GAErD,MAAM,UAAU,MAAM,KAAK,QAAQ,SAAS;AAC5C,OAAI,QACF,OAAM,KAAK,QAAQ,aACjB,SACA,KAAK,OAAO,QAAQ,WACrB;;EAGN"}
|
package/dist/types/index.mjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export{};
|
|
1
|
+
export { };
|
package/dist/types/plugin.mjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export{};
|
|
1
|
+
export { };
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@powerlines/plugin-typedoc",
|
|
3
|
-
"version": "0.10.
|
|
3
|
+
"version": "0.10.467",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"description": "A package containing a Powerlines plugin for running TypeDoc on the codebase.",
|
|
6
6
|
"repository": {
|
|
@@ -90,17 +90,17 @@
|
|
|
90
90
|
"@stryke/fs": "^0.33.70",
|
|
91
91
|
"@stryke/path": "^0.28.2",
|
|
92
92
|
"defu": "^6.1.7",
|
|
93
|
-
"powerlines": "^0.46.
|
|
93
|
+
"powerlines": "^0.46.6",
|
|
94
94
|
"typedoc": "0.25.12",
|
|
95
95
|
"typedoc-plugin-markdown": "4.0.0-next.20"
|
|
96
96
|
},
|
|
97
97
|
"devDependencies": {
|
|
98
|
-
"@powerlines/plugin-plugin": "^0.12.
|
|
98
|
+
"@powerlines/plugin-plugin": "^0.12.410",
|
|
99
99
|
"@types/node": "^25.6.0"
|
|
100
100
|
},
|
|
101
101
|
"publishConfig": { "access": "public" },
|
|
102
102
|
"main": "./dist/index.cjs",
|
|
103
103
|
"module": "./dist/index.mjs",
|
|
104
104
|
"types": "./dist/index.d.cts",
|
|
105
|
-
"gitHead": "
|
|
105
|
+
"gitHead": "610c4c943933458c5f433b9002d8c187625b2d3f"
|
|
106
106
|
}
|