@powerlines/plugin-typedoc 0.10.339 → 0.10.341

package/dist/index.mjs

@@ -54,5 +54,4 @@ function plugin(options = {}) {
 var src_default = plugin;
 
 //#endregion
-export { src_default as default, plugin };
-//# sourceMappingURL=index.mjs.map
+export { src_default as default, plugin };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@powerlines/plugin-typedoc",
-  "version": "0.10.339",
+  "version": "0.10.341",
   "type": "module",
   "description": "A package containing a Powerlines plugin for running TypeDoc on the codebase.",
   "repository": {
@@ -86,21 +86,21 @@
   "files": ["dist/**/*"],
   "keywords": ["powerlines", "storm-software", "powerlines-plugin"],
   "dependencies": {
-    "@storm-software/config-tools": "^1.189.21",
-    "@stryke/fs": "^0.33.55",
-    "@stryke/path": "^0.26.17",
+    "@storm-software/config-tools": "^1.189.27",
+    "@stryke/fs": "^0.33.57",
+    "@stryke/path": "^0.26.19",
     "defu": "^6.1.4",
-    "powerlines": "^0.40.18",
+    "powerlines": "^0.40.20",
     "typedoc": "0.25.12",
     "typedoc-plugin-markdown": "4.0.0-next.20"
   },
   "devDependencies": {
-    "@powerlines/plugin-plugin": "^0.12.282",
-    "@types/node": "^25.3.5"
+    "@powerlines/plugin-plugin": "^0.12.284",
+    "@types/node": "^25.4.0"
   },
   "publishConfig": { "access": "public" },
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.cts",
-  "gitHead": "7aff4b34ac598df76db48e9b713a2ff08ee85134"
+  "gitHead": "8d772181f794749e0f19f97c732dd921148c31c8"
 }

package/dist/index.d.cts

@@ -1,17 +0,0 @@
-import { GenerateDocsOptions, TypeDocPluginContext, TypeDocPluginOptions, TypeDocPluginResolvedConfig, TypeDocPluginUserConfig, __ΩGenerateDocsOptions, __ΩTypeDocPluginContext, __ΩTypeDocPluginOptions, __ΩTypeDocPluginResolvedConfig, __ΩTypeDocPluginUserConfig } from "./types/plugin.cjs";
-import "./types/index.cjs";
-import { Plugin } from "powerlines";
-
-//#region src/index.d.ts
-declare module "powerlines" {
-  interface Config {
-    typedoc?: TypeDocPluginOptions;
-  }
-}
-/**
- * A Powerlines plugin to assist in generating documentation with TypeDoc.
- */
-declare function plugin(options?: TypeDocPluginOptions): Plugin<TypeDocPluginContext>;
-//#endregion
-export { GenerateDocsOptions, TypeDocPluginContext, TypeDocPluginOptions, TypeDocPluginResolvedConfig, TypeDocPluginUserConfig, __ΩGenerateDocsOptions, __ΩTypeDocPluginContext, __ΩTypeDocPluginOptions, __ΩTypeDocPluginResolvedConfig, __ΩTypeDocPluginUserConfig, plugin as default, plugin };
-//# sourceMappingURL=index.d.cts.map

package/dist/index.d.cts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.cts","names":[],"sources":["../src/index.ts"],"sourcesContent":[],"mappings":";;;;;;;IAoCwB,OAAA,CAAA,EAIV,oBAJU;EAAA;;;;AAWxB;AACW,iBADK,MAAA,CACL,OAAA,CAAA,EAAA,oBAAA,CAAA,EACR,MADQ,CACD,oBADC,CAAA"}

package/dist/index.d.mts

@@ -1,17 +0,0 @@
-import { GenerateDocsOptions, TypeDocPluginContext, TypeDocPluginOptions, TypeDocPluginResolvedConfig, TypeDocPluginUserConfig, __ΩGenerateDocsOptions, __ΩTypeDocPluginContext, __ΩTypeDocPluginOptions, __ΩTypeDocPluginResolvedConfig, __ΩTypeDocPluginUserConfig } from "./types/plugin.mjs";
-import "./types/index.mjs";
-import { Plugin } from "powerlines";
-
-//#region src/index.d.ts
-declare module "powerlines" {
-  interface Config {
-    typedoc?: TypeDocPluginOptions;
-  }
-}
-/**
- * A Powerlines plugin to assist in generating documentation with TypeDoc.
- */
-declare function plugin(options?: TypeDocPluginOptions): Plugin<TypeDocPluginContext>;
-//#endregion
-export { GenerateDocsOptions, TypeDocPluginContext, TypeDocPluginOptions, TypeDocPluginResolvedConfig, TypeDocPluginUserConfig, __ΩGenerateDocsOptions, __ΩTypeDocPluginContext, __ΩTypeDocPluginOptions, __ΩTypeDocPluginResolvedConfig, __ΩTypeDocPluginUserConfig, plugin as default, plugin };
-//# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.mts","names":[],"sources":["../src/index.ts"],"sourcesContent":[],"mappings":";;;;;;;IAoCwB,OAAA,CAAA,EAIV,oBAJU;EAAA;;;;AAWxB;AACW,iBADK,MAAA,CACL,OAAA,CAAA,EAAA,oBAAA,CAAA,EACR,MADQ,CACD,oBADC,CAAA"}

package/dist/index.mjs.map

@@ -1 +0,0 @@
-{"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: this.workspaceConfig.branch || \"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,KAAK,gBAAgB,UAAU;IAC5C,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;;AAGH,kBAAe"}

package/dist/types/index.d.cts

@@ -1,2 +0,0 @@
-import { GenerateDocsOptions, TypeDocPluginContext, TypeDocPluginOptions, TypeDocPluginResolvedConfig, TypeDocPluginUserConfig, __ΩGenerateDocsOptions, __ΩTypeDocPluginContext, __ΩTypeDocPluginOptions, __ΩTypeDocPluginResolvedConfig, __ΩTypeDocPluginUserConfig } from "./plugin.cjs";
-export { GenerateDocsOptions, TypeDocPluginContext, TypeDocPluginOptions, TypeDocPluginResolvedConfig, TypeDocPluginUserConfig, __ΩGenerateDocsOptions, __ΩTypeDocPluginContext, __ΩTypeDocPluginOptions, __ΩTypeDocPluginResolvedConfig, __ΩTypeDocPluginUserConfig };

package/dist/types/index.d.mts

@@ -1,2 +0,0 @@
-import { GenerateDocsOptions, TypeDocPluginContext, TypeDocPluginOptions, TypeDocPluginResolvedConfig, TypeDocPluginUserConfig, __ΩGenerateDocsOptions, __ΩTypeDocPluginContext, __ΩTypeDocPluginOptions, __ΩTypeDocPluginResolvedConfig, __ΩTypeDocPluginUserConfig } from "./plugin.mjs";
-export { GenerateDocsOptions, TypeDocPluginContext, TypeDocPluginOptions, TypeDocPluginResolvedConfig, TypeDocPluginUserConfig, __ΩGenerateDocsOptions, __ΩTypeDocPluginContext, __ΩTypeDocPluginOptions, __ΩTypeDocPluginResolvedConfig, __ΩTypeDocPluginUserConfig };

package/dist/types/plugin.d.cts

@@ -1,60 +0,0 @@
-import { PluginContext, ResolvedConfig, UserConfig } from "powerlines";
-import { Application, ProjectReflection, TypeDocOptions } from "typedoc";
-
-//#region src/types/plugin.d.ts
-interface GenerateDocsOptions {
-  frontmatter?: Record<string, any>;
-  outputPath?: string;
-  project: ProjectReflection;
-}
-interface TypeDocPluginOptions extends Partial<Omit<TypeDocOptions, "out">> {
-  /**
-   * The output path for the generated documentation.
-   *
-   * @defaultValue "docs/generated/api-reference"
-   */
-  outputPath?: string;
-  /**
-   * The base URL for the documentation site.
-   *
-   * @defaultValue "/docs/"
-   */
-  basePath?: string;
-  /**
-   * Options to be passed to the TypeDoc generator.
-   *
-   * @remarks
-   * These options will be override any other values passed to the TypeDoc generator.
-   */
-  override?: Partial<TypeDocOptions>;
-}
-interface TypeDocPluginUserConfig extends UserConfig {
-  /**
-   * Options for the TypeDoc plugin.
-   */
-  typedoc: TypeDocPluginOptions;
-}
-interface TypeDocPluginResolvedConfig extends ResolvedConfig {
-  /**
-   * Options for the TypeDoc plugin.
-   */
-  typedoc: TypeDocOptions & {
-    outputPath: string;
-    baseUrl: string;
-    override?: Partial<TypeDocOptions>;
-  };
-}
-type TypeDocPluginContext<TResolvedConfig extends TypeDocPluginResolvedConfig = TypeDocPluginResolvedConfig> = PluginContext<TResolvedConfig> & {
-  /**
-   * The initialized TypeDoc application.
-   */
-  typedoc: Application;
-};
-declare type __ΩGenerateDocsOptions = any[];
-declare type __ΩTypeDocPluginOptions = any[];
-declare type __ΩTypeDocPluginUserConfig = any[];
-declare type __ΩTypeDocPluginResolvedConfig = any[];
-declare type __ΩTypeDocPluginContext = any[];
-//#endregion
-export { GenerateDocsOptions, TypeDocPluginContext, TypeDocPluginOptions, TypeDocPluginResolvedConfig, TypeDocPluginUserConfig, __ΩGenerateDocsOptions, __ΩTypeDocPluginContext, __ΩTypeDocPluginOptions, __ΩTypeDocPluginResolvedConfig, __ΩTypeDocPluginUserConfig };
-//# sourceMappingURL=plugin.d.cts.map

package/dist/types/plugin.d.cts.map

@@ -1 +0,0 @@
-{"version":3,"file":"plugin.d.cts","names":[],"sources":["../../src/types/plugin.ts"],"sourcesContent":[],"mappings":";;;;UAqBiB,mBAAA;gBACD;EADC,UAAA,CAAA,EAAA,MAAA;EAMA,OAAA,EAHN,iBAG2B;;AACpC,UADe,oBAAA,SAA6B,OAC5C,CAAA,IAAA,CAAK,cAAL,EAAA,KAAA,CAAA,CAAA,CAAA;EAsBmB;;;;AAGrB;EAOiB,UAAA,CAAA,EAAA,MAAA;EAIN;;;;;EAOC,QAAA,CAAA,EAAA,MAAA;EACc;;;;;;aAtBb,QAAQ;;UAGJ,uBAAA,SAAgC;;;;WAItC;;UAGM,2BAAA,SAAoC;;;;WAI1C;;;eAGI,QAAQ;;;KAIX,6CACc,8BACtB,+BACA,cAAc;;;;WAIP"}

package/dist/types/plugin.d.mts

@@ -1,60 +0,0 @@
-import { Application, ProjectReflection, TypeDocOptions } from "typedoc";
-import { PluginContext, ResolvedConfig, UserConfig } from "powerlines";
-
-//#region src/types/plugin.d.ts
-interface GenerateDocsOptions {
-  frontmatter?: Record<string, any>;
-  outputPath?: string;
-  project: ProjectReflection;
-}
-interface TypeDocPluginOptions extends Partial<Omit<TypeDocOptions, "out">> {
-  /**
-   * The output path for the generated documentation.
-   *
-   * @defaultValue "docs/generated/api-reference"
-   */
-  outputPath?: string;
-  /**
-   * The base URL for the documentation site.
-   *
-   * @defaultValue "/docs/"
-   */
-  basePath?: string;
-  /**
-   * Options to be passed to the TypeDoc generator.
-   *
-   * @remarks
-   * These options will be override any other values passed to the TypeDoc generator.
-   */
-  override?: Partial<TypeDocOptions>;
-}
-interface TypeDocPluginUserConfig extends UserConfig {
-  /**
-   * Options for the TypeDoc plugin.
-   */
-  typedoc: TypeDocPluginOptions;
-}
-interface TypeDocPluginResolvedConfig extends ResolvedConfig {
-  /**
-   * Options for the TypeDoc plugin.
-   */
-  typedoc: TypeDocOptions & {
-    outputPath: string;
-    baseUrl: string;
-    override?: Partial<TypeDocOptions>;
-  };
-}
-type TypeDocPluginContext<TResolvedConfig extends TypeDocPluginResolvedConfig = TypeDocPluginResolvedConfig> = PluginContext<TResolvedConfig> & {
-  /**
-   * The initialized TypeDoc application.
-   */
-  typedoc: Application;
-};
-declare type __ΩGenerateDocsOptions = any[];
-declare type __ΩTypeDocPluginOptions = any[];
-declare type __ΩTypeDocPluginUserConfig = any[];
-declare type __ΩTypeDocPluginResolvedConfig = any[];
-declare type __ΩTypeDocPluginContext = any[];
-//#endregion
-export { GenerateDocsOptions, TypeDocPluginContext, TypeDocPluginOptions, TypeDocPluginResolvedConfig, TypeDocPluginUserConfig, __ΩGenerateDocsOptions, __ΩTypeDocPluginContext, __ΩTypeDocPluginOptions, __ΩTypeDocPluginResolvedConfig, __ΩTypeDocPluginUserConfig };
-//# sourceMappingURL=plugin.d.mts.map

package/dist/types/plugin.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"plugin.d.mts","names":[],"sources":["../../src/types/plugin.ts"],"sourcesContent":[],"mappings":";;;;UAqBiB,mBAAA;gBACD;EADC,UAAA,CAAA,EAAA,MAAA;EAMA,OAAA,EAHN,iBAG2B;;AACpC,UADe,oBAAA,SAA6B,OAC5C,CAAA,IAAA,CAAK,cAAL,EAAA,KAAA,CAAA,CAAA,CAAA;EAsBmB;;;;AAGrB;EAOiB,UAAA,CAAA,EAAA,MAAA;EAIN;;;;;EAOC,QAAA,CAAA,EAAA,MAAA;EACc;;;;;;aAtBb,QAAQ;;UAGJ,uBAAA,SAAgC;;;;WAItC;;UAGM,2BAAA,SAAoC;;;;WAI1C;;;eAGI,QAAQ;;;KAIX,6CACc,8BACtB,+BACA,cAAc;;;;WAIP"}