@powerlines/plugin-typedoc 0.10.167 → 0.10.169

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/index.cjs CHANGED
@@ -3,6 +3,7 @@ const require_rolldown_runtime = require('./_virtual/rolldown_runtime.cjs');
3
3
  let __storm_software_config_tools_types = require("@storm-software/config-tools/types");
4
4
  let __stryke_fs_exists = require("@stryke/fs/exists");
5
5
  let __stryke_fs_helpers = require("@stryke/fs/helpers");
6
+ let __stryke_path_append = require("@stryke/path/append");
6
7
  let __stryke_path_join = require("@stryke/path/join");
7
8
  let defu = require("defu");
8
9
  defu = require_rolldown_runtime.__toESM(defu);
@@ -37,7 +38,7 @@ function plugin(options = {}) {
37
38
  ...this.config.docs.typedoc,
38
39
  exclude: this.config.docs.typedoc.exclude ?? this.tsconfig.tsconfigJson.exclude?.filter(Boolean) ?? [],
39
40
  out: this.config.output.outputPath,
40
- entryPoints: this.entry.map((entry) => (0, __stryke_path_join.joinPaths)(this.config.projectRoot, entry.file)),
41
+ entryPoints: this.entry.map((entry) => (0, __stryke_path_append.appendPath)(entry.file, this.config.projectRoot)),
41
42
  ...this.config.docs.typedoc.override
42
43
  }, [
43
44
  new typedoc.TypeDocReader(),
package/dist/index.mjs CHANGED
@@ -1,6 +1,7 @@
1
1
  import { LogLevelLabel } from "@storm-software/config-tools/types";
2
2
  import { existsSync } from "@stryke/fs/exists";
3
3
  import { createDirectory, removeDirectory } from "@stryke/fs/helpers";
4
+ import { appendPath } from "@stryke/path/append";
4
5
  import { joinPaths } from "@stryke/path/join";
5
6
  import defu from "defu";
6
7
  import { Application, PackageJsonReader, TSConfigReader, TypeDocReader } from "typedoc";
@@ -34,7 +35,7 @@ function plugin(options = {}) {
34
35
  ...this.config.docs.typedoc,
35
36
  exclude: this.config.docs.typedoc.exclude ?? this.tsconfig.tsconfigJson.exclude?.filter(Boolean) ?? [],
36
37
  out: this.config.output.outputPath,
37
- entryPoints: this.entry.map((entry) => joinPaths(this.config.projectRoot, entry.file)),
38
+ entryPoints: this.entry.map((entry) => appendPath(entry.file, this.config.projectRoot)),
38
39
  ...this.config.docs.typedoc.override
39
40
  }, [
40
41
  new TypeDocReader(),
@@ -297,14 +297,14 @@ interface CommonUserConfig extends BaseConfig {
297
297
  */
298
298
  configFile?: string;
299
299
  /**
300
- * Should the Powerlines CLI processes skip installing missing packages?
300
+ * Should the Powerlines processes automatically install missing package dependencies?
301
301
  *
302
302
  * @remarks
303
- * This option is useful for CI/CD environments where the installation of packages is handled by a different process.
303
+ * When set to `true`, Powerlines will attempt to install any missing dependencies using the package manager detected in the project (e.g., npm, yarn, pnpm). This can be useful for ensuring that all required packages are available during the build and preparation phases.
304
304
  *
305
305
  * @defaultValue false
306
306
  */
307
- skipInstalls?: boolean;
307
+ autoInstall?: boolean;
308
308
  /**
309
309
  * Should the compiler processes skip any improvements that make use of cache?
310
310
  *
@@ -297,14 +297,14 @@ interface CommonUserConfig extends BaseConfig {
297
297
  */
298
298
  configFile?: string;
299
299
  /**
300
- * Should the Powerlines CLI processes skip installing missing packages?
300
+ * Should the Powerlines processes automatically install missing package dependencies?
301
301
  *
302
302
  * @remarks
303
- * This option is useful for CI/CD environments where the installation of packages is handled by a different process.
303
+ * When set to `true`, Powerlines will attempt to install any missing dependencies using the package manager detected in the project (e.g., npm, yarn, pnpm). This can be useful for ensuring that all required packages are available during the build and preparation phases.
304
304
  *
305
305
  * @defaultValue false
306
306
  */
307
- skipInstalls?: boolean;
307
+ autoInstall?: boolean;
308
308
  /**
309
309
  * Should the compiler processes skip any improvements that make use of cache?
310
310
  *
@@ -1,2 +1 @@
1
- import { GenerateDocsOptions, TypeDocPluginContext, TypeDocPluginOptions, TypeDocPluginResolvedConfig, TypeDocPluginUserConfig, __ΩGenerateDocsOptions, __ΩTypeDocPluginContext, __ΩTypeDocPluginOptions, __ΩTypeDocPluginResolvedConfig, __ΩTypeDocPluginUserConfig } from "./plugin.mjs";
2
- export { GenerateDocsOptions, TypeDocPluginContext, TypeDocPluginOptions, TypeDocPluginResolvedConfig, TypeDocPluginUserConfig, __ΩGenerateDocsOptions, __ΩTypeDocPluginContext, __ΩTypeDocPluginOptions, __ΩTypeDocPluginResolvedConfig, __ΩTypeDocPluginUserConfig };
1
+ import { GenerateDocsOptions, TypeDocPluginContext, TypeDocPluginOptions, TypeDocPluginResolvedConfig, TypeDocPluginUserConfig, __ΩGenerateDocsOptions, __ΩTypeDocPluginContext, __ΩTypeDocPluginOptions, __ΩTypeDocPluginResolvedConfig, __ΩTypeDocPluginUserConfig } from "./plugin.mjs";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@powerlines/plugin-typedoc",
3
- "version": "0.10.167",
3
+ "version": "0.10.169",
4
4
  "type": "module",
5
5
  "description": "A package containing a Powerlines plugin for running TypeDoc on the codebase.",
6
6
  "repository": {
@@ -101,17 +101,17 @@
101
101
  "keywords": ["powerlines", "storm-software", "powerlines-plugin"],
102
102
  "dependencies": {
103
103
  "@storm-software/config-tools": "^1.188.80",
104
- "@stryke/fs": "^0.33.29",
105
- "@stryke/path": "^0.24.2",
104
+ "@stryke/fs": "^0.33.30",
105
+ "@stryke/path": "^0.24.3",
106
106
  "defu": "^6.1.4",
107
- "powerlines": "^0.37.33",
107
+ "powerlines": "^0.37.35",
108
108
  "typedoc": "0.25.12",
109
109
  "typedoc-plugin-markdown": "4.0.0-next.20"
110
110
  },
111
111
  "devDependencies": {
112
- "@powerlines/plugin-plugin": "^0.12.111",
112
+ "@powerlines/plugin-plugin": "^0.12.113",
113
113
  "@types/node": "^24.10.8"
114
114
  },
115
115
  "publishConfig": { "access": "public" },
116
- "gitHead": "03b9cc77ab231fb6ef6907889e68dde29f9e77bb"
116
+ "gitHead": "65656903e05b8a85e4d46f7449a8c2bd8f90332e"
117
117
  }
File without changes
@@ -1,2 +0,0 @@
1
- import { GenerateDocsOptions, TypeDocPluginContext, TypeDocPluginOptions, TypeDocPluginResolvedConfig, TypeDocPluginUserConfig, __ΩGenerateDocsOptions, __ΩTypeDocPluginContext, __ΩTypeDocPluginOptions, __ΩTypeDocPluginResolvedConfig, __ΩTypeDocPluginUserConfig } from "./plugin.cjs";
2
- export { GenerateDocsOptions, TypeDocPluginContext, TypeDocPluginOptions, TypeDocPluginResolvedConfig, TypeDocPluginUserConfig, __ΩGenerateDocsOptions, __ΩTypeDocPluginContext, __ΩTypeDocPluginOptions, __ΩTypeDocPluginResolvedConfig, __ΩTypeDocPluginUserConfig };
@@ -1 +0,0 @@
1
- export { };
File without changes
@@ -1 +0,0 @@
1
- export { };