@powerlines/plugin-typedoc 0.10.7 → 0.10.9

package/dist/src/index.cjs

@@ -0,0 +1,7 @@
+'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]}})});

package/dist/src/index.d.cts

@@ -0,0 +1,30 @@
+import { T as TypeDocPluginOptions, P as Plugin, a as TypeDocPluginContext } from '../index-B7n5dnGG.cjs';
+export { G as GenerateDocsOptions, c as TypeDocPluginResolvedConfig, b as TypeDocPluginUserConfig } from '../index-B7n5dnGG.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/types/package-json';
+import 'jiti';
+import 'oxc-parser';
+import 'semver';
+import 'unplugin';
+import '@stryke/types/tsconfig';
+import 'typescript';
+import '@stryke/json/types';
+import 'memfs';
+import 'node:fs';
+import 'unionfs';
+import '@stryke/types/array';
+import 'typedoc';
+
+/**
+ * A Powerlines plugin to assist in generating documentation with TypeDoc.
+ */
+declare function plugin(options?: TypeDocPluginOptions): Plugin<TypeDocPluginContext>;
+
+export { TypeDocPluginContext, TypeDocPluginOptions, plugin as default, plugin };

package/dist/src/index.d.ts

@@ -0,0 +1,30 @@
+import { T as TypeDocPluginOptions, P as Plugin, a as TypeDocPluginContext } from '../index-B7n5dnGG.js';
+export { G as GenerateDocsOptions, c as TypeDocPluginResolvedConfig, b as TypeDocPluginUserConfig } from '../index-B7n5dnGG.js';
+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/types/package-json';
+import 'jiti';
+import 'oxc-parser';
+import 'semver';
+import 'unplugin';
+import '@stryke/types/tsconfig';
+import 'typescript';
+import '@stryke/json/types';
+import 'memfs';
+import 'node:fs';
+import 'unionfs';
+import '@stryke/types/array';
+import 'typedoc';
+
+/**
+ * A Powerlines plugin to assist in generating documentation with TypeDoc.
+ */
+declare function plugin(options?: TypeDocPluginOptions): Plugin<TypeDocPluginContext>;
+
+export { TypeDocPluginContext, TypeDocPluginOptions, plugin as default, plugin };

package/dist/src/index.js

@@ -0,0 +1,7 @@
+import {LogLevelLabel}from'@storm-software/config-tools/types';import {existsSync}from'@stryke/fs/exists';import {removeDirectory,createDirectory}from'@stryke/fs/helpers';import {joinPaths}from'@stryke/path/join';import p from'defu';import {Application,TypeDocReader,PackageJsonReader,TSConfigReader}from'typedoc';export*from'./types';/*****************************************
+*
+*      ⚡ 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(LogLevelLabel.TRACE,"Providing default configuration for the Powerlines `typedoc` build plugin."),{docs:{typedoc:p(o,{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:o.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(t=>joinPaths(this.config.projectRoot,t.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."),existsSync(this.config.docs.typedoc.outputPath)&&await removeDirectory(this.config.docs.typedoc.outputPath),await 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 A=l;export{A as default,l as plugin};

package/dist/types/index.cjs

@@ -0,0 +1 @@
+'use strict';var plugin=require('./plugin');Object.keys(plugin).forEach(function(k){if(k!=='default'&&!Object.prototype.hasOwnProperty.call(exports,k))Object.defineProperty(exports,k,{enumerable:true,get:function(){return plugin[k]}})});

package/dist/types/index.d.cts

@@ -0,0 +1,22 @@
+export { G as GenerateDocsOptions, a as TypeDocPluginContext, T as TypeDocPluginOptions, c as TypeDocPluginResolvedConfig, b as TypeDocPluginUserConfig } from '../index-B7n5dnGG.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/types/package-json';
+import 'jiti';
+import 'oxc-parser';
+import 'semver';
+import 'unplugin';
+import '@stryke/types/tsconfig';
+import 'typescript';
+import '@stryke/json/types';
+import 'memfs';
+import 'node:fs';
+import 'unionfs';
+import '@stryke/types/array';
+import 'typedoc';

package/dist/types/index.d.ts

@@ -0,0 +1,22 @@
+export { G as GenerateDocsOptions, a as TypeDocPluginContext, T as TypeDocPluginOptions, c as TypeDocPluginResolvedConfig, b as TypeDocPluginUserConfig } from '../index-B7n5dnGG.js';
+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/types/package-json';
+import 'jiti';
+import 'oxc-parser';
+import 'semver';
+import 'unplugin';
+import '@stryke/types/tsconfig';
+import 'typescript';
+import '@stryke/json/types';
+import 'memfs';
+import 'node:fs';
+import 'unionfs';
+import '@stryke/types/array';
+import 'typedoc';

package/dist/types/index.js

@@ -0,0 +1 @@
+export*from'./plugin';

package/dist/types/plugin.cjs

@@ -0,0 +1 @@
+'use strict';

package/dist/types/plugin.d.cts

@@ -0,0 +1,22 @@
+export { G as GenerateDocsOptions, a as TypeDocPluginContext, T as TypeDocPluginOptions, c as TypeDocPluginResolvedConfig, b as TypeDocPluginUserConfig } from '../index-B7n5dnGG.cjs';
+import 'typedoc';
+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/types/package-json';
+import 'jiti';
+import 'oxc-parser';
+import 'semver';
+import 'unplugin';
+import '@stryke/types/tsconfig';
+import 'typescript';
+import '@stryke/json/types';
+import 'memfs';
+import 'node:fs';
+import 'unionfs';
+import '@stryke/types/array';

package/dist/types/plugin.d.ts

@@ -0,0 +1,22 @@
+export { G as GenerateDocsOptions, a as TypeDocPluginContext, T as TypeDocPluginOptions, c as TypeDocPluginResolvedConfig, b as TypeDocPluginUserConfig } from '../index-B7n5dnGG.js';
+import 'typedoc';
+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/types/package-json';
+import 'jiti';
+import 'oxc-parser';
+import 'semver';
+import 'unplugin';
+import '@stryke/types/tsconfig';
+import 'typescript';
+import '@stryke/json/types';
+import 'memfs';
+import 'node:fs';
+import 'unionfs';
+import '@stryke/types/array';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@powerlines/plugin-typedoc",
-  "version": "0.10.7",
+  "version": "0.10.9",
   "type": "module",
   "description": "A package containing a Powerlines plugin for running TypeDoc on the codebase.",
   "repository": {
@@ -88,19 +88,19 @@
   "files": ["dist/**/*"],
   "keywords": ["powerlines", "storm-software", "powerlines-plugin"],
   "dependencies": {
-    "@storm-software/config-tools": "^1.188.13",
-    "@stryke/fs": "^0.32.3",
-    "@stryke/path": "^0.17.0",
-    "powerlines": "^0.14.1",
+    "@storm-software/config-tools": "^1.188.19",
+    "@stryke/fs": "^0.32.10",
+    "@stryke/path": "^0.18.5",
+    "powerlines": "^0.16.0",
     "typedoc": "0.25.12",
     "typedoc-plugin-markdown": "4.0.0-next.20"
   },
   "devDependencies": {
-    "@powerlines/nx": "^0.9.5",
-    "@storm-software/tsup": "^0.2.11",
-    "@types/node": "^22.18.12",
+    "@powerlines/nx": "^0.10.1",
+    "@storm-software/tsup": "^0.2.17",
+    "@types/node": "^22.19.0",
     "tsup": "8.4.0"
   },
   "publishConfig": { "access": "public" },
-  "gitHead": "284d279fb9c466a627d4506600e0d16315ec96ac"
+  "gitHead": "097e9f257b733719a3aead815ef79686f4c46f25"
 }