@powerlines/plugin-typedoc 0.10.124 → 0.10.126

package/dist/_virtual/rolldown_runtime.cjs

@@ -1 +1,29 @@
-var e=Object.create,t=Object.defineProperty,n=Object.getOwnPropertyDescriptor,r=Object.getOwnPropertyNames,i=Object.getPrototypeOf,a=Object.prototype.hasOwnProperty,o=(e,i,o,s)=>{if(i&&typeof i==`object`||typeof i==`function`)for(var c=r(i),l=0,u=c.length,d;l<u;l++)d=c[l],!a.call(e,d)&&d!==o&&t(e,d,{get:(e=>i[e]).bind(null,d),enumerable:!(s=n(i,d))||s.enumerable});return e},s=(n,r,a)=>(a=n==null?{}:e(i(n)),o(r||!n||!n.__esModule?t(a,`default`,{value:n,enumerable:!0}):a,n));exports.__toESM=s;
+//#region rolldown:runtime
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+	if (from && typeof from === "object" || typeof from === "function") {
+		for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
+			key = keys[i];
+			if (!__hasOwnProp.call(to, key) && key !== except) {
+				__defProp(to, key, {
+					get: ((k) => from[k]).bind(null, key),
+					enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
+				});
+			}
+		}
+	}
+	return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", {
+	value: mod,
+	enumerable: true
+}) : target, mod));
+
+//#endregion
+
+exports.__toESM = __toESM;

package/dist/index.cjs

@@ -1 +1,61 @@
-Object.defineProperty(exports,`__esModule`,{value:!0});const e=require(`./_virtual/rolldown_runtime.cjs`);let t=require(`@storm-software/config-tools/types`),n=require(`@stryke/fs/exists`),r=require(`@stryke/fs/helpers`),i=require(`@stryke/path/join`),a=require(`defu`);a=e.__toESM(a);let o=require(`typedoc`);function s(e={}){return{name:`typedoc`,async config(){return this.log(t.LogLevelLabel.TRACE,"Providing default configuration for the Powerlines `typedoc` build plugin."),{docs:{typedoc:(0,a.default)(e,{outputPath:(0,i.joinPaths)(this.config.projectRoot,`docs`,`generated`,`api-reference`),baseUrl:`/docs/`,excludeExternals:!0,excludeInternal:!0,excludePrivate:!0,excludeProtected:!0,hideGenerator:!0,githubPages:!1,readme:`none`,gitRevision:this.workspaceConfig.branch||`main`,tsconfig:this.tsconfig.tsconfigFilePath,plugin:e.plugin?[]:[`typedoc-plugin-markdown`]})}}},async configResolved(){this.typedoc=await o.Application.bootstrapWithPlugins({...this.config.docs.typedoc,exclude:this.config.docs.typedoc.exclude??this.tsconfig.tsconfigJson.exclude?.filter(Boolean)??[],out:this.config.output.outputPath,entryPoints:this.entry.map(e=>(0,i.joinPaths)(this.config.projectRoot,e.file)),...this.config.docs.typedoc.override},[new o.TypeDocReader,new o.PackageJsonReader,new o.TSConfigReader])},async docs(){this.log(t.LogLevelLabel.TRACE,`Generating documentation for the Powerlines application with TypeDoc.`),(0,n.existsSync)(this.config.docs.typedoc.outputPath)&&await(0,r.removeDirectory)(this.config.docs.typedoc.outputPath),await(0,r.createDirectory)(this.config.docs.typedoc.outputPath);let e=await this.typedoc.convert();e&&await this.typedoc.generateDocs(e,this.config.docs.typedoc.outputPath)}}}var c=s;exports.default=c,exports.plugin=s;
+Object.defineProperty(exports, '__esModule', { value: true });
+const require_rolldown_runtime = require('./_virtual/rolldown_runtime.cjs');
+let __storm_software_config_tools_types = require("@storm-software/config-tools/types");
+let __stryke_fs_exists = require("@stryke/fs/exists");
+let __stryke_fs_helpers = require("@stryke/fs/helpers");
+let __stryke_path_join = require("@stryke/path/join");
+let defu = require("defu");
+defu = require_rolldown_runtime.__toESM(defu);
+let typedoc = require("typedoc");
+
+//#region src/index.ts
+/**
+* A Powerlines plugin to assist in generating documentation with TypeDoc.
+*/
+function plugin(options = {}) {
+	return {
+		name: "typedoc",
+		async config() {
+			this.log(__storm_software_config_tools_types.LogLevelLabel.TRACE, "Providing default configuration for the Powerlines `typedoc` build plugin.");
+			return { docs: { typedoc: (0, defu.default)(options, {
+				outputPath: (0, __stryke_path_join.joinPaths)(this.config.projectRoot, "docs", "generated", "api-reference"),
+				baseUrl: "/docs/",
+				excludeExternals: true,
+				excludeInternal: true,
+				excludePrivate: true,
+				excludeProtected: true,
+				hideGenerator: true,
+				githubPages: false,
+				readme: "none",
+				gitRevision: this.workspaceConfig.branch || "main",
+				tsconfig: this.tsconfig.tsconfigFilePath,
+				plugin: options.plugin ? [] : ["typedoc-plugin-markdown"]
+			}) } };
+		},
+		async configResolved() {
+			this.typedoc = await typedoc.Application.bootstrapWithPlugins({
+				...this.config.docs.typedoc,
+				exclude: this.config.docs.typedoc.exclude ?? this.tsconfig.tsconfigJson.exclude?.filter(Boolean) ?? [],
+				out: this.config.output.outputPath,
+				entryPoints: this.entry.map((entry) => (0, __stryke_path_join.joinPaths)(this.config.projectRoot, entry.file)),
+				...this.config.docs.typedoc.override
+			}, [
+				new typedoc.TypeDocReader(),
+				new typedoc.PackageJsonReader(),
+				new typedoc.TSConfigReader()
+			]);
+		},
+		async docs() {
+			this.log(__storm_software_config_tools_types.LogLevelLabel.TRACE, `Generating documentation for the Powerlines application with TypeDoc.`);
+			if ((0, __stryke_fs_exists.existsSync)(this.config.docs.typedoc.outputPath)) await (0, __stryke_fs_helpers.removeDirectory)(this.config.docs.typedoc.outputPath);
+			await (0, __stryke_fs_helpers.createDirectory)(this.config.docs.typedoc.outputPath);
+			const project = await this.typedoc.convert();
+			if (project) await this.typedoc.generateDocs(project, this.config.docs.typedoc.outputPath);
+		}
+	};
+}
+var src_default = plugin;
+
+//#endregion
+exports.default = src_default;
+exports.plugin = plugin;

package/dist/index.mjs

@@ -1 +1,57 @@
-import{LogLevelLabel as e}from"@storm-software/config-tools/types";import{existsSync as t}from"@stryke/fs/exists";import{createDirectory as n,removeDirectory as r}from"@stryke/fs/helpers";import{joinPaths as i}from"@stryke/path/join";import a from"defu";import{Application as o,PackageJsonReader as s,TSConfigReader as c,TypeDocReader as l}from"typedoc";function u(u={}){return{name:`typedoc`,async config(){return this.log(e.TRACE,"Providing default configuration for the Powerlines `typedoc` build plugin."),{docs:{typedoc:a(u,{outputPath:i(this.config.projectRoot,`docs`,`generated`,`api-reference`),baseUrl:`/docs/`,excludeExternals:!0,excludeInternal:!0,excludePrivate:!0,excludeProtected:!0,hideGenerator:!0,githubPages:!1,readme:`none`,gitRevision:this.workspaceConfig.branch||`main`,tsconfig:this.tsconfig.tsconfigFilePath,plugin:u.plugin?[]:[`typedoc-plugin-markdown`]})}}},async configResolved(){this.typedoc=await o.bootstrapWithPlugins({...this.config.docs.typedoc,exclude:this.config.docs.typedoc.exclude??this.tsconfig.tsconfigJson.exclude?.filter(Boolean)??[],out:this.config.output.outputPath,entryPoints:this.entry.map(e=>i(this.config.projectRoot,e.file)),...this.config.docs.typedoc.override},[new l,new s,new c])},async docs(){this.log(e.TRACE,`Generating documentation for the Powerlines application with TypeDoc.`),t(this.config.docs.typedoc.outputPath)&&await r(this.config.docs.typedoc.outputPath),await n(this.config.docs.typedoc.outputPath);let i=await this.typedoc.convert();i&&await this.typedoc.generateDocs(i,this.config.docs.typedoc.outputPath)}}}var d=u;export{d as default,u as plugin};
+import { LogLevelLabel } from "@storm-software/config-tools/types";
+import { existsSync } from "@stryke/fs/exists";
+import { createDirectory, removeDirectory } from "@stryke/fs/helpers";
+import { joinPaths } from "@stryke/path/join";
+import defu from "defu";
+import { Application, PackageJsonReader, TSConfigReader, TypeDocReader } from "typedoc";
+
+//#region src/index.ts
+/**
+* A Powerlines plugin to assist in generating documentation with TypeDoc.
+*/
+function plugin(options = {}) {
+	return {
+		name: "typedoc",
+		async config() {
+			this.log(LogLevelLabel.TRACE, "Providing default configuration for the Powerlines `typedoc` build plugin.");
+			return { docs: { typedoc: defu(options, {
+				outputPath: joinPaths(this.config.projectRoot, "docs", "generated", "api-reference"),
+				baseUrl: "/docs/",
+				excludeExternals: true,
+				excludeInternal: true,
+				excludePrivate: true,
+				excludeProtected: true,
+				hideGenerator: true,
+				githubPages: false,
+				readme: "none",
+				gitRevision: this.workspaceConfig.branch || "main",
+				tsconfig: this.tsconfig.tsconfigFilePath,
+				plugin: options.plugin ? [] : ["typedoc-plugin-markdown"]
+			}) } };
+		},
+		async configResolved() {
+			this.typedoc = await Application.bootstrapWithPlugins({
+				...this.config.docs.typedoc,
+				exclude: this.config.docs.typedoc.exclude ?? this.tsconfig.tsconfigJson.exclude?.filter(Boolean) ?? [],
+				out: this.config.output.outputPath,
+				entryPoints: this.entry.map((entry) => joinPaths(this.config.projectRoot, entry.file)),
+				...this.config.docs.typedoc.override
+			}, [
+				new TypeDocReader(),
+				new PackageJsonReader(),
+				new TSConfigReader()
+			]);
+		},
+		async docs() {
+			this.log(LogLevelLabel.TRACE, `Generating documentation for the Powerlines application with TypeDoc.`);
+			if (existsSync(this.config.docs.typedoc.outputPath)) await removeDirectory(this.config.docs.typedoc.outputPath);
+			await createDirectory(this.config.docs.typedoc.outputPath);
+			const project = await this.typedoc.convert();
+			if (project) await this.typedoc.generateDocs(project, this.config.docs.typedoc.outputPath);
+		}
+	};
+}
+var src_default = plugin;
+
+//#endregion
+export { src_default as default, plugin };

package/dist/powerlines/src/types/context.d.cts

@@ -78,10 +78,18 @@ interface ParseOptions extends ParserOptions {
    */
   allowReturnOutsideFunction?: boolean;
 }
+interface EmitOptions extends WriteOptions {
+  /**
+   * If true, will emit the file using {@link UnpluginBuildContext.emitFile | the bundler's emit function}.
+   */
+  emitWithBundler?: boolean;
+  needsCodeReference?: Parameters<UnpluginBuildContext["emitFile"]>[0]["needsCodeReference"];
+  originalFileName?: Parameters<UnpluginBuildContext["emitFile"]>[0]["originalFileName"];
+}
 /**
  * Options for emitting entry virtual files
  */
-type EmitEntryOptions = WriteOptions & Omit<ResolvedEntryTypeDefinition, "file">;
+type EmitEntryOptions = EmitOptions & Omit<ResolvedEntryTypeDefinition, "file">;
 /**
  * The unresolved Powerlines context.
  *
@@ -292,6 +300,22 @@ interface UnresolvedContext<TResolvedConfig extends ResolvedConfig = ResolvedCon
    * The Powerlines builtin virtual files
    */
   getBuiltins: () => Promise<VirtualFile[]>;
+  /**
+   * Resolves a file and writes it to the VFS if it does not already exist
+   *
+   * @param code - The source code of the file
+   * @param path - The path to write the file to
+   * @param options - Additional options for writing the file
+   */
+  emit: (code: string, path: string, options?: EmitOptions) => Promise<void>;
+  /**
+   * Synchronously resolves a file and writes it to the VFS if it does not already exist
+   *
+   * @param code - The source code of the file
+   * @param path - The path to write the file to
+   * @param options - Additional options for writing the file
+   */
+  emitSync: (code: string, path: string, options?: EmitOptions) => void;
   /**
    * Resolves a builtin virtual file and writes it to the VFS if it does not already exist
    *
@@ -300,7 +324,16 @@ interface UnresolvedContext<TResolvedConfig extends ResolvedConfig = ResolvedCon
    * @param path - An optional path to write the builtin file to
    * @param options - Additional options for writing the builtin file
    */
-  emitBuiltin: (code: string, id: string, path?: string, options?: WriteOptions) => Promise<void>;
+  emitBuiltin: (code: string, id: string, path?: string, options?: EmitOptions) => Promise<void>;
+  /**
+   * Synchronously resolves a builtin virtual file and writes it to the VFS if it does not already exist
+   *
+   * @param code - The source code of the builtin file
+   * @param id - The unique identifier of the builtin file
+   * @param path - An optional path to write the builtin file to
+   * @param options - Additional options for writing the builtin file
+   */
+  emitBuiltinSync: (code: string, id: string, path?: string, options?: EmitOptions) => void;
   /**
    * Resolves a entry virtual file and writes it to the VFS if it does not already exist
    *
@@ -309,6 +342,14 @@ interface UnresolvedContext<TResolvedConfig extends ResolvedConfig = ResolvedCon
    * @param options - Additional options for writing the entry file
    */
   emitEntry: (code: string, path: string, options?: EmitEntryOptions) => Promise<void>;
+  /**
+   * Synchronously resolves a entry virtual file and writes it to the VFS if it does not already exist
+   *
+   * @param code - The source code of the entry file
+   * @param path - An optional path to write the entry file to
+   * @param options - Additional options for writing the entry file
+   */
+  emitEntrySync: (code: string, path: string, options?: EmitEntryOptions) => void;
   /**
    * A function to update the context fields using a new user configuration options
    */

package/dist/powerlines/src/types/context.d.mts

@@ -80,10 +80,18 @@ interface ParseOptions extends ParserOptions {
    */
   allowReturnOutsideFunction?: boolean;
 }
+interface EmitOptions extends WriteOptions {
+  /**
+   * If true, will emit the file using {@link UnpluginBuildContext.emitFile | the bundler's emit function}.
+   */
+  emitWithBundler?: boolean;
+  needsCodeReference?: Parameters<UnpluginBuildContext["emitFile"]>[0]["needsCodeReference"];
+  originalFileName?: Parameters<UnpluginBuildContext["emitFile"]>[0]["originalFileName"];
+}
 /**
  * Options for emitting entry virtual files
  */
-type EmitEntryOptions = WriteOptions & Omit<ResolvedEntryTypeDefinition, "file">;
+type EmitEntryOptions = EmitOptions & Omit<ResolvedEntryTypeDefinition, "file">;
 /**
  * The unresolved Powerlines context.
  *
@@ -294,6 +302,22 @@ interface UnresolvedContext<TResolvedConfig extends ResolvedConfig = ResolvedCon
    * The Powerlines builtin virtual files
    */
   getBuiltins: () => Promise<VirtualFile[]>;
+  /**
+   * Resolves a file and writes it to the VFS if it does not already exist
+   *
+   * @param code - The source code of the file
+   * @param path - The path to write the file to
+   * @param options - Additional options for writing the file
+   */
+  emit: (code: string, path: string, options?: EmitOptions) => Promise<void>;
+  /**
+   * Synchronously resolves a file and writes it to the VFS if it does not already exist
+   *
+   * @param code - The source code of the file
+   * @param path - The path to write the file to
+   * @param options - Additional options for writing the file
+   */
+  emitSync: (code: string, path: string, options?: EmitOptions) => void;
   /**
    * Resolves a builtin virtual file and writes it to the VFS if it does not already exist
    *
@@ -302,7 +326,16 @@ interface UnresolvedContext<TResolvedConfig extends ResolvedConfig = ResolvedCon
    * @param path - An optional path to write the builtin file to
    * @param options - Additional options for writing the builtin file
    */
-  emitBuiltin: (code: string, id: string, path?: string, options?: WriteOptions) => Promise<void>;
+  emitBuiltin: (code: string, id: string, path?: string, options?: EmitOptions) => Promise<void>;
+  /**
+   * Synchronously resolves a builtin virtual file and writes it to the VFS if it does not already exist
+   *
+   * @param code - The source code of the builtin file
+   * @param id - The unique identifier of the builtin file
+   * @param path - An optional path to write the builtin file to
+   * @param options - Additional options for writing the builtin file
+   */
+  emitBuiltinSync: (code: string, id: string, path?: string, options?: EmitOptions) => void;
   /**
    * Resolves a entry virtual file and writes it to the VFS if it does not already exist
    *
@@ -311,6 +344,14 @@ interface UnresolvedContext<TResolvedConfig extends ResolvedConfig = ResolvedCon
    * @param options - Additional options for writing the entry file
    */
   emitEntry: (code: string, path: string, options?: EmitEntryOptions) => Promise<void>;
+  /**
+   * Synchronously resolves a entry virtual file and writes it to the VFS if it does not already exist
+   *
+   * @param code - The source code of the entry file
+   * @param path - An optional path to write the entry file to
+   * @param options - Additional options for writing the entry file
+   */
+  emitEntrySync: (code: string, path: string, options?: EmitEntryOptions) => void;
   /**
    * A function to update the context fields using a new user configuration options
    */

package/dist/powerlines/src/types/fs.d.cts

@@ -13,6 +13,13 @@ interface StorageAdapter {
    * A name identifying the storage adapter type.
    */
   name: string;
+  /**
+   * The storage preset for the adapter.
+   *
+   * @remarks
+   * This can be used as an alternate way to identify the type of storage being used.
+   */
+  preset?: StoragePreset | null;
   /**
    * Checks if a key exists in the storage.
    *
@@ -207,6 +214,13 @@ interface WriteOptions {
    * @defaultValue false
    */
   skipFormat?: boolean;
+  /**
+   * The storage preset or adapter name for the output file.
+   *
+   * @remarks
+   * If not specified, the output mode will be determined by the provided `output.mode` value.
+   */
+  storage?: StoragePreset | string;
   /**
    * Additional metadata for the file.
    */

package/dist/powerlines/src/types/fs.d.mts

@@ -13,6 +13,13 @@ interface StorageAdapter {
    * A name identifying the storage adapter type.
    */
   name: string;
+  /**
+   * The storage preset for the adapter.
+   *
+   * @remarks
+   * This can be used as an alternate way to identify the type of storage being used.
+   */
+  preset?: StoragePreset | null;
   /**
    * Checks if a key exists in the storage.
    *
@@ -207,6 +214,13 @@ interface WriteOptions {
    * @defaultValue false
    */
   skipFormat?: boolean;
+  /**
+   * The storage preset or adapter name for the output file.
+   *
+   * @remarks
+   * If not specified, the output mode will be determined by the provided `output.mode` value.
+   */
+  storage?: StoragePreset | string;
   /**
    * Additional metadata for the file.
    */

package/dist/types/index.mjs

@@ -1 +1 @@
-export{};
+export {  };

package/dist/types/plugin.mjs

@@ -1 +1 @@
-export{};
+export {  };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@powerlines/plugin-typedoc",
-  "version": "0.10.124",
+  "version": "0.10.126",
   "type": "module",
   "description": "A package containing a Powerlines plugin for running TypeDoc on the codebase.",
   "repository": {
@@ -101,18 +101,18 @@
   "keywords": ["powerlines", "storm-software", "powerlines-plugin"],
   "dependencies": {
     "@storm-software/config-tools": "^1.188.74",
-    "@stryke/fs": "^0.33.26",
-    "@stryke/path": "^0.24.0",
-    "powerlines": "^0.36.21",
+    "@stryke/fs": "^0.33.27",
+    "@stryke/path": "^0.24.1",
+    "powerlines": "^0.36.23",
     "typedoc": "0.25.12",
     "typedoc-plugin-markdown": "4.0.0-next.20"
   },
   "devDependencies": {
-    "@powerlines/nx": "^0.11.47",
+    "@powerlines/nx": "^0.11.49",
     "@storm-software/tsup": "^0.2.72",
     "@types/node": "^24.10.4",
     "tsup": "8.4.0"
   },
   "publishConfig": { "access": "public" },
-  "gitHead": "b16324cf857ea5743fd7ad06e18607b1ba32abe0"
+  "gitHead": "be47e546b48b9a82e460b5c5d4f02fb66e821f18"
 }