@powerlines/plugin-typedoc 0.10.55 → 0.10.56

package/dist/index-BgAdqTbb.d.mts

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

package/dist/index-CEgs-Dz2.d.cts

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

package/dist/index.cjs

@@ -1,7 +1 @@
-'use strict';Object.defineProperty(exports,'__esModule',{value:true});var types$1=require('@storm-software/config-tools/types'),exists=require('@stryke/fs/exists'),helpers=require('@stryke/fs/helpers'),join=require('@stryke/path/join'),p=require('defu'),typedoc=require('typedoc'),types=require('./types');function _interopDefault(e){return e&&e.__esModule?e:{default:e}}var p__default=/*#__PURE__*/_interopDefault(p);/*****************************************
-*
-*      ⚡ Built by Storm Software
-*
-*****************************************/
-
-var c=Object.defineProperty;var e=(o,t)=>c(o,"name",{value:t,configurable:true});function l(o={}){return {name:"typedoc",async config(){return this.log(types$1.LogLevelLabel.TRACE,"Providing default configuration for the Powerlines `typedoc` build plugin."),{docs:{typedoc:p__default.default(o,{outputPath: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:o.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(t=>join.joinPaths(this.config.projectRoot,t.file)),...this.config.docs.typedoc.override},[new typedoc.TypeDocReader,new typedoc.PackageJsonReader,new typedoc.TSConfigReader]);},async docs(){this.log(types$1.LogLevelLabel.TRACE,"Generating documentation for the Powerlines application with TypeDoc."),exists.existsSync(this.config.docs.typedoc.outputPath)&&await helpers.removeDirectory(this.config.docs.typedoc.outputPath),await helpers.createDirectory(this.config.docs.typedoc.outputPath);const t=await this.typedoc.convert();t&&await this.typedoc.generateDocs(t,this.config.docs.typedoc.outputPath);}}}e(l,"plugin");var k=l;exports.default=k;exports.plugin=l;Object.keys(types).forEach(function(k){if(k!=='default'&&!Object.prototype.hasOwnProperty.call(exports,k))Object.defineProperty(exports,k,{enumerable:true,get:function(){return types[k]}})});
+Object.defineProperty(exports,`__esModule`,{value:!0});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));require(`./plugin-DHXHjv16.cjs`),require(`./types-DHkg7xmX.cjs`);let c=require(`@storm-software/config-tools/types`),l=require(`@stryke/fs/exists`),u=require(`@stryke/fs/helpers`),d=require(`@stryke/path/join`),f=require(`defu`);f=s(f);let p=require(`typedoc`);function m(e={}){return{name:`typedoc`,async config(){return this.log(c.LogLevelLabel.TRACE,"Providing default configuration for the Powerlines `typedoc` build plugin."),{docs:{typedoc:(0,f.default)(e,{outputPath:(0,d.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 p.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,d.joinPaths)(this.config.projectRoot,e.file)),...this.config.docs.typedoc.override},[new p.TypeDocReader,new p.PackageJsonReader,new p.TSConfigReader])},async docs(){this.log(c.LogLevelLabel.TRACE,`Generating documentation for the Powerlines application with TypeDoc.`),(0,l.existsSync)(this.config.docs.typedoc.outputPath)&&await(0,u.removeDirectory)(this.config.docs.typedoc.outputPath),await(0,u.createDirectory)(this.config.docs.typedoc.outputPath);let e=await this.typedoc.convert();e&&await this.typedoc.generateDocs(e,this.config.docs.typedoc.outputPath)}}}var h=m;exports.default=h,exports.plugin=m;

package/dist/index.d.cts

@@ -1,31 +1,12 @@
-import { T as TypeDocPluginOptions, P as Plugin, a as TypeDocPluginContext } from './index-C-Su88lx.cjs';
-export { G as GenerateDocsOptions, c as TypeDocPluginResolvedConfig, b as TypeDocPluginUserConfig, _ as __ΩGenerateDocsOptions, g as __ΩTypeDocPluginContext, d as __ΩTypeDocPluginOptions, f as __ΩTypeDocPluginResolvedConfig, e as __ΩTypeDocPluginUserConfig } from './index-C-Su88lx.cjs';
-import '@storm-software/build-tools/types';
-import '@storm-software/config-tools/types';
-import '@storm-software/config/types';
-import '@stryke/types/base';
-import '@stryke/types/configuration';
-import '@stryke/types/file';
-import 'vite';
-import '@stryke/env/get-env-paths';
-import '@stryke/http/fetch';
-import '@stryke/types/package-json';
-import 'jiti';
-import 'magic-string';
-import 'oxc-parser';
-import 'semver';
-import 'ts-morph';
-import 'undici';
-import 'unplugin';
-import '@stryke/fs/resolve';
-import '@stryke/types/tsconfig';
-import 'typescript';
-import '@stryke/types/array';
-import 'typedoc';
+import { a as TypeDocPluginUserConfig, c as __ΩTypeDocPluginOptions, d as Plugin, i as TypeDocPluginResolvedConfig, l as __ΩTypeDocPluginResolvedConfig, n as TypeDocPluginContext, o as __ΩGenerateDocsOptions, r as TypeDocPluginOptions, s as __ΩTypeDocPluginContext, t as GenerateDocsOptions, u as __ΩTypeDocPluginUserConfig } from "./plugin-BNfbliVw.cjs";
+import "./index-CEgs-Dz2.cjs";
+
+//#region src/index.d.ts
 
 /**
  * A Powerlines plugin to assist in generating documentation with TypeDoc.
  */
 declare function plugin(options?: TypeDocPluginOptions): Plugin<TypeDocPluginContext>;
-
-export { TypeDocPluginContext, TypeDocPluginOptions, plugin as default, plugin };
+//#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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.cts","names":[],"sources":["../src/index.ts"],"sourcesContent":[],"mappings":";;;;;;AAqCA;;AAEU,iBAFM,MAAA,CAEN,OAAA,CAAA,EADC,oBACD,CAAA,EAAP,MAAO,CAAA,oBAAA,CAAA"}

package/dist/index.d.mts

@@ -0,0 +1,12 @@
+import { a as TypeDocPluginUserConfig, c as __ΩTypeDocPluginOptions, d as Plugin, i as TypeDocPluginResolvedConfig, l as __ΩTypeDocPluginResolvedConfig, n as TypeDocPluginContext, o as __ΩGenerateDocsOptions, r as TypeDocPluginOptions, s as __ΩTypeDocPluginContext, t as GenerateDocsOptions, u as __ΩTypeDocPluginUserConfig } from "./plugin-BrranLnT.mjs";
+import "./index-BgAdqTbb.mjs";
+
+//#region src/index.d.ts
+
+/**
+ * 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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","names":[],"sources":["../src/index.ts"],"sourcesContent":[],"mappings":";;;;;;AAqCA;;AAEU,iBAFM,MAAA,CAEN,OAAA,CAAA,EADC,oBACD,CAAA,EAAP,MAAO,CAAA,oBAAA,CAAA"}

package/dist/index.mjs

@@ -0,0 +1,2 @@
+import"./plugin-Bvn-he2n.mjs";import"./types-B7VYa_Pp.mjs";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};
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +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 { LogLevelLabel } from \"@storm-software/config-tools/types\";\nimport { existsSync } from \"@stryke/fs/exists\";\nimport { createDirectory, removeDirectory } from \"@stryke/fs/helpers\";\nimport { joinPaths } from \"@stryke/path/join\";\nimport defu from \"defu\";\nimport { Plugin } from \"powerlines/types/plugin\";\nimport {\n  Application,\n  PackageJsonReader,\n  TSConfigReader,\n  TypeDocReader\n} from \"typedoc\";\nimport { TypeDocPluginContext, TypeDocPluginOptions } from \"./types/plugin\";\n\nexport * from \"./types\";\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.log(\n        LogLevelLabel.TRACE,\n        \"Providing default configuration for the Powerlines `typedoc` build plugin.\"\n      );\n\n      return {\n        docs: {\n          typedoc: defu(options, {\n            outputPath: joinPaths(\n              this.config.projectRoot,\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        }\n      };\n    },\n    async configResolved() {\n      this.typedoc = await Application.bootstrapWithPlugins(\n        {\n          ...this.config.docs.typedoc,\n          exclude:\n            this.config.docs.typedoc.exclude ??\n            this.tsconfig.tsconfigJson.exclude?.filter(Boolean) ??\n            [],\n          out: this.config.output.outputPath,\n          entryPoints: this.entry.map(entry =>\n            joinPaths(this.config.projectRoot, entry.file)\n          ),\n          ...this.config.docs.typedoc.override\n        },\n        [new TypeDocReader(), new PackageJsonReader(), new TSConfigReader()]\n      );\n    },\n    async docs() {\n      this.log(\n        LogLevelLabel.TRACE,\n        `Generating documentation for the Powerlines application with TypeDoc.`\n      );\n\n      if (existsSync(this.config.docs.typedoc.outputPath)) {\n        await removeDirectory(this.config.docs.typedoc.outputPath);\n      }\n\n      await createDirectory(this.config.docs.typedoc.outputPath);\n\n      const project = await this.typedoc.convert();\n      if (project) {\n        await this.typedoc.generateDocs(\n          project,\n          this.config.docs.typedoc.outputPath\n        );\n      }\n    }\n  };\n}\n\nexport default plugin;\n"],"mappings":"6ZAqCA,SAAgB,EACd,EAAgC,EAAE,CACJ,CAC9B,MAAO,CACL,KAAM,UACN,MAAM,QAAS,CAMb,OALA,KAAK,IACH,EAAc,MACd,6EACD,CAEM,CACL,KAAM,CACJ,QAAS,EAAK,EAAS,CACrB,WAAY,EACV,KAAK,OAAO,YACZ,OACA,YACA,gBACD,CACD,QAAS,SACT,iBAAkB,GAClB,gBAAiB,GACjB,eAAgB,GAChB,iBAAkB,GAClB,cAAe,GACf,YAAa,GACb,OAAQ,OACR,YAAa,KAAK,gBAAgB,QAAU,OAC5C,SAAU,KAAK,SAAS,iBACxB,OAAQ,EAAQ,OAAS,EAAE,CAAG,CAAC,0BAA0B,CAC1D,CAAC,CACH,CACF,EAEH,MAAM,gBAAiB,CACrB,KAAK,QAAU,MAAM,EAAY,qBAC/B,CACE,GAAG,KAAK,OAAO,KAAK,QACpB,QACE,KAAK,OAAO,KAAK,QAAQ,SACzB,KAAK,SAAS,aAAa,SAAS,OAAO,QAAQ,EACnD,EAAE,CACJ,IAAK,KAAK,OAAO,OAAO,WACxB,YAAa,KAAK,MAAM,IAAI,GAC1B,EAAU,KAAK,OAAO,YAAa,EAAM,KAAK,CAC/C,CACD,GAAG,KAAK,OAAO,KAAK,QAAQ,SAC7B,CACD,CAAC,IAAI,EAAiB,IAAI,EAAqB,IAAI,EAAiB,CACrE,EAEH,MAAM,MAAO,CACX,KAAK,IACH,EAAc,MACd,wEACD,CAEG,EAAW,KAAK,OAAO,KAAK,QAAQ,WAAW,EACjD,MAAM,EAAgB,KAAK,OAAO,KAAK,QAAQ,WAAW,CAG5D,MAAM,EAAgB,KAAK,OAAO,KAAK,QAAQ,WAAW,CAE1D,IAAM,EAAU,MAAM,KAAK,QAAQ,SAAS,CACxC,GACF,MAAM,KAAK,QAAQ,aACjB,EACA,KAAK,OAAO,KAAK,QAAQ,WAC1B,EAGN,CAGH,IAAA,EAAe"}