@powerlines/plugin-plugin 0.11.54 → 0.11.55

package/dist/src/index.cjs

@@ -7,9 +7,12 @@ var alloyBabelPreset = require('@alloy-js/babel-preset');
 var typescriptBabelPreset = require('@babel/preset-typescript');
 var types = require('@storm-software/config-tools/types');
 var tsup = require('@storm-software/tsup');
+var parseTypeDefinition = require('@stryke/convert/parse-type-definition');
 var stormJson = require('@stryke/json/storm-json');
 var isParentPath = require('@stryke/path/is-parent-path');
 var join = require('@stryke/path/join');
+var titleCase = require('@stryke/string-format/title-case');
+var isString = require('@stryke/type-checks/is-string');
 var defu = require('defu');
 var index = require('../node_modules/.pnpm/esbuild-plugin-babel@0.2.3_@babel_core@7.28.5/node_modules/esbuild-plugin-babel/src/index.cjs');
 var tsup$1 = require('powerlines/lib/build/tsup');
@@ -31,7 +34,6 @@ const plugin = __assignType((options = {}) => {
                 type: "library",
                 entry: ["src/**/*.ts", "src/**/*.tsx"],
                 output: {
-                    dts: false,
                     format: ["cjs", "esm"]
                 },
                 build: {
@@ -52,6 +54,38 @@ const plugin = __assignType((options = {}) => {
                 await this.fs.write(this.tsconfig.tsconfigFilePath, stormJson.StormJSON.stringify(this.tsconfig.tsconfigJson));
             }
         }, ['configResolved', 'P"/!']),
+        generateTypes: __assignType(async function generateTypes(code) {
+            if (!options.types?.userConfig) {
+                return;
+            }
+            let typeDef;
+            if (isString.isString(options.types.userConfig) &&
+                !options.types.userConfig.includes("#") &&
+                this.packageJson?.name) {
+                const pluginRoot = await this.resolve(this.packageJson.name);
+                if (pluginRoot &&
+                    this.packageJson?.name &&
+                    !(await this.resolve(options.types.userConfig, pluginRoot.id))) {
+                    typeDef = {
+                        file: this.packageJson.name,
+                        name: options.types.userConfig
+                    };
+                }
+            }
+            if (!typeDef) {
+                typeDef = parseTypeDefinition.parseTypeDefinition(options.types.userConfig);
+                if (!typeDef) {
+                    return;
+                }
+            }
+            return `${code}
+
+// Extend \`UserConfig\` with the ${titleCase.titleCase(this.config.name)} plugin's type definition
+declare module "powerlines" {
+  export interface UserConfig extends import("${typeDef.file}").${typeDef.name || "default"}
+}
+`;
+        }, ['code', 'generateTypes', 'P&2!"/"']),
         async build() {
             await tsup.build(await tsup.resolveOptions(defu.defu({
                 config: false,
@@ -90,6 +124,7 @@ exports.__ΩPluginPluginAlloyOptions = src_types_plugin.__ΩPluginPluginAlloyOpt
 exports.__ΩPluginPluginContext = src_types_plugin.__ΩPluginPluginContext;
 exports.__ΩPluginPluginOptions = src_types_plugin.__ΩPluginPluginOptions;
 exports.__ΩPluginPluginResolvedConfig = src_types_plugin.__ΩPluginPluginResolvedConfig;
+exports.__ΩPluginPluginTypesOptions = src_types_plugin.__ΩPluginPluginTypesOptions;
 exports.__ΩPluginPluginUserConfig = src_types_plugin.__ΩPluginPluginUserConfig;
 exports.default = plugin;
 exports.plugin = plugin;

package/dist/src/index.js

@@ -1,12 +1,15 @@
 import { __ΩPluginPluginOptions as ___PluginPluginOptions } from './types/plugin.js';
-export { __ΩPluginPluginAlloyOptions, __ΩPluginPluginContext, __ΩPluginPluginResolvedConfig, __ΩPluginPluginUserConfig } from './types/plugin.js';
+export { __ΩPluginPluginAlloyOptions, __ΩPluginPluginContext, __ΩPluginPluginResolvedConfig, __ΩPluginPluginTypesOptions, __ΩPluginPluginUserConfig } from './types/plugin.js';
 import alloyBabelPreset from '@alloy-js/babel-preset';
 import typescriptBabelPreset from '@babel/preset-typescript';
 import { LogLevelLabel } from '@storm-software/config-tools/types';
 import { build, resolveOptions } from '@storm-software/tsup';
+import { parseTypeDefinition } from '@stryke/convert/parse-type-definition';
 import { StormJSON } from '@stryke/json/storm-json';
 import { isParentPath } from '@stryke/path/is-parent-path';
 import { joinPaths } from '@stryke/path/join';
+import { titleCase } from '@stryke/string-format/title-case';
+import { isString } from '@stryke/type-checks/is-string';
 import { defu } from 'defu';
 import pluginBabel from '../node_modules/.pnpm/esbuild-plugin-babel@0.2.3_@babel_core@7.28.5/node_modules/esbuild-plugin-babel/src/index.js';
 import { resolveTsupEntry, extractTsupConfig } from 'powerlines/lib/build/tsup';
@@ -28,7 +31,6 @@ const plugin = __assignType((options = {}) => {
                 type: "library",
                 entry: ["src/**/*.ts", "src/**/*.tsx"],
                 output: {
-                    dts: false,
                     format: ["cjs", "esm"]
                 },
                 build: {
@@ -49,6 +51,38 @@ const plugin = __assignType((options = {}) => {
                 await this.fs.write(this.tsconfig.tsconfigFilePath, StormJSON.stringify(this.tsconfig.tsconfigJson));
             }
         }, ['configResolved', 'P"/!']),
+        generateTypes: __assignType(async function generateTypes(code) {
+            if (!options.types?.userConfig) {
+                return;
+            }
+            let typeDef;
+            if (isString(options.types.userConfig) &&
+                !options.types.userConfig.includes("#") &&
+                this.packageJson?.name) {
+                const pluginRoot = await this.resolve(this.packageJson.name);
+                if (pluginRoot &&
+                    this.packageJson?.name &&
+                    !(await this.resolve(options.types.userConfig, pluginRoot.id))) {
+                    typeDef = {
+                        file: this.packageJson.name,
+                        name: options.types.userConfig
+                    };
+                }
+            }
+            if (!typeDef) {
+                typeDef = parseTypeDefinition(options.types.userConfig);
+                if (!typeDef) {
+                    return;
+                }
+            }
+            return `${code}
+
+// Extend \`UserConfig\` with the ${titleCase(this.config.name)} plugin's type definition
+declare module "powerlines" {
+  export interface UserConfig extends import("${typeDef.file}").${typeDef.name || "default"}
+}
+`;
+        }, ['code', 'generateTypes', 'P&2!"/"']),
         async build() {
             await build(await resolveOptions(defu({
                 config: false,

package/dist/src/types/index.cjs

@@ -8,4 +8,5 @@ exports.__ΩPluginPluginAlloyOptions = src_types_plugin.__ΩPluginPluginAlloyOpt
 exports.__ΩPluginPluginContext = src_types_plugin.__ΩPluginPluginContext;
 exports.__ΩPluginPluginOptions = src_types_plugin.__ΩPluginPluginOptions;
 exports.__ΩPluginPluginResolvedConfig = src_types_plugin.__ΩPluginPluginResolvedConfig;
+exports.__ΩPluginPluginTypesOptions = src_types_plugin.__ΩPluginPluginTypesOptions;
 exports.__ΩPluginPluginUserConfig = src_types_plugin.__ΩPluginPluginUserConfig;

package/dist/src/types/index.js

@@ -1 +1 @@
-export { __ΩPluginPluginAlloyOptions, __ΩPluginPluginContext, __ΩPluginPluginOptions, __ΩPluginPluginResolvedConfig, __ΩPluginPluginUserConfig } from './plugin.js';
+export { __ΩPluginPluginAlloyOptions, __ΩPluginPluginContext, __ΩPluginPluginOptions, __ΩPluginPluginResolvedConfig, __ΩPluginPluginTypesOptions, __ΩPluginPluginUserConfig } from './plugin.js';

package/dist/src/types/plugin.cjs

@@ -1,15 +1,16 @@
 'use strict';
 
 const __ΩPartial = ['T', 'Partial', 'l+e#!e"!fRb!Pde"!gN#"w"y'];
-const __ΩRequired = ['T', 'Required', 'l+e#!e"!fRb!Pde"!gN##w"y'];
 const __ΩPluginPluginAlloyOptions = [() => __ΩPartial, 'PrintTreeOptions', 'generatesJson', true, 'generatesMarkdown', 'PluginPluginAlloyOptions', 'P"w"o!"P)4#8>$)4%8>$MKw&y'];
-const __ΩPluginPluginOptions = [() => __ΩPluginPluginAlloyOptions, 'alloy', false, 'PluginPluginOptions', 'PPn!)J4"8>#Mw$y'];
-const __ΩPluginPluginUserConfig = [false, () => __ΩPartial, () => __ΩPluginPluginAlloyOptions, 'alloy', 'PluginPluginUserConfig', 'P!PP.!n#o""J4$8MKw%y'];
-const __ΩPluginPluginResolvedConfig = [false, () => __ΩRequired, () => __ΩPluginPluginAlloyOptions, 'alloy', 'PluginPluginResolvedConfig', 'P!PP.!n#o""J4$MKw%y'];
+const __ΩPluginPluginTypesOptions = ['TypeDefinitionParameter', 'options', 'userConfig', 'PluginPluginTypesOptions', 'P"w!4"8"w!4#8Mw$y'];
+const __ΩPluginPluginOptions = [() => __ΩPluginPluginAlloyOptions, 'alloy', false, () => __ΩPluginPluginTypesOptions, 'types', 'PluginPluginOptions', 'PPn!)J4"8>#n$4%8Mw&y'];
+const __ΩPluginPluginUserConfig = [() => __ΩPluginPluginOptions, 'plugin', 'PluginPluginUserConfig', 'P!Pn!4"MKw#y'];
+const __ΩPluginPluginResolvedConfig = [() => __ΩPluginPluginOptions, 'plugin', 'PluginPluginResolvedConfig', 'P!Pn!4"MKw#y'];
 const __ΩPluginPluginContext = [() => __ΩPluginPluginResolvedConfig, 'TResolvedConfig', 'PluginPluginContext', 'n!c"!w#y'];
 
 exports.__ΩPluginPluginAlloyOptions = __ΩPluginPluginAlloyOptions;
 exports.__ΩPluginPluginContext = __ΩPluginPluginContext;
 exports.__ΩPluginPluginOptions = __ΩPluginPluginOptions;
 exports.__ΩPluginPluginResolvedConfig = __ΩPluginPluginResolvedConfig;
+exports.__ΩPluginPluginTypesOptions = __ΩPluginPluginTypesOptions;
 exports.__ΩPluginPluginUserConfig = __ΩPluginPluginUserConfig;

package/dist/src/types/plugin.d.ts

@@ -1,4 +1,5 @@
 import type { PrintTreeOptions } from "@alloy-js/core";
+import { TypeDefinitionParameter } from "@stryke/types/configuration";
 import type { TsupBuildConfig, TsupResolvedBuildConfig } from "powerlines/types/build";
 import type { UserConfig } from "powerlines/types/config";
 import type { PluginContext } from "powerlines/types/context";
@@ -17,6 +18,16 @@ export type PluginPluginAlloyOptions = Partial<PrintTreeOptions> & {
      */
     generatesMarkdown?: boolean;
 };
+export interface PluginPluginTypesOptions {
+    /**
+     * The type definition for the plugin's options.
+     */
+    options?: TypeDefinitionParameter;
+    /**
+     * The type definition for the plugin's user config.
+     */
+    userConfig?: TypeDefinitionParameter;
+}
 export interface PluginPluginOptions {
     /**
      * The options applied to the [Alloy framework](https://alloy-framework.github.io/alloy/) for rendering templates.
@@ -27,15 +38,20 @@ export interface PluginPluginOptions {
      * @defaultValue false
      */
     alloy?: PluginPluginAlloyOptions | boolean;
+    /**
+     * The type definitions for the Plugin plugin.
+     */
+    types?: PluginPluginTypesOptions;
 }
 export type PluginPluginUserConfig = UserConfig<TsupBuildConfig, TsupResolvedBuildConfig, "tsup"> & {
-    alloy?: false | Partial<PluginPluginAlloyOptions>;
+    plugin: PluginPluginOptions;
 };
 export type PluginPluginResolvedConfig = ResolvedConfig<PluginPluginUserConfig> & {
-    alloy: false | Required<PluginPluginAlloyOptions>;
+    plugin: PluginPluginOptions;
 };
 export type PluginPluginContext<TResolvedConfig extends PluginPluginResolvedConfig = PluginPluginResolvedConfig> = PluginContext<TResolvedConfig>;
 export declare type __ΩPluginPluginAlloyOptions = any[];
+export declare type __ΩPluginPluginTypesOptions = any[];
 export declare type __ΩPluginPluginOptions = any[];
 export declare type __ΩPluginPluginUserConfig = any[];
 export declare type __ΩPluginPluginResolvedConfig = any[];

package/dist/src/types/plugin.js

@@ -1,9 +1,9 @@
 const __ΩPartial = ['T', 'Partial', 'l+e#!e"!fRb!Pde"!gN#"w"y'];
-const __ΩRequired = ['T', 'Required', 'l+e#!e"!fRb!Pde"!gN##w"y'];
 const __ΩPluginPluginAlloyOptions = [() => __ΩPartial, 'PrintTreeOptions', 'generatesJson', true, 'generatesMarkdown', 'PluginPluginAlloyOptions', 'P"w"o!"P)4#8>$)4%8>$MKw&y'];
-const __ΩPluginPluginOptions = [() => __ΩPluginPluginAlloyOptions, 'alloy', false, 'PluginPluginOptions', 'PPn!)J4"8>#Mw$y'];
-const __ΩPluginPluginUserConfig = [false, () => __ΩPartial, () => __ΩPluginPluginAlloyOptions, 'alloy', 'PluginPluginUserConfig', 'P!PP.!n#o""J4$8MKw%y'];
-const __ΩPluginPluginResolvedConfig = [false, () => __ΩRequired, () => __ΩPluginPluginAlloyOptions, 'alloy', 'PluginPluginResolvedConfig', 'P!PP.!n#o""J4$MKw%y'];
+const __ΩPluginPluginTypesOptions = ['TypeDefinitionParameter', 'options', 'userConfig', 'PluginPluginTypesOptions', 'P"w!4"8"w!4#8Mw$y'];
+const __ΩPluginPluginOptions = [() => __ΩPluginPluginAlloyOptions, 'alloy', false, () => __ΩPluginPluginTypesOptions, 'types', 'PluginPluginOptions', 'PPn!)J4"8>#n$4%8Mw&y'];
+const __ΩPluginPluginUserConfig = [() => __ΩPluginPluginOptions, 'plugin', 'PluginPluginUserConfig', 'P!Pn!4"MKw#y'];
+const __ΩPluginPluginResolvedConfig = [() => __ΩPluginPluginOptions, 'plugin', 'PluginPluginResolvedConfig', 'P!Pn!4"MKw#y'];
 const __ΩPluginPluginContext = [() => __ΩPluginPluginResolvedConfig, 'TResolvedConfig', 'PluginPluginContext', 'n!c"!w#y'];
 
-export { __ΩPluginPluginAlloyOptions, __ΩPluginPluginContext, __ΩPluginPluginOptions, __ΩPluginPluginResolvedConfig, __ΩPluginPluginUserConfig };
+export { __ΩPluginPluginAlloyOptions, __ΩPluginPluginContext, __ΩPluginPluginOptions, __ΩPluginPluginResolvedConfig, __ΩPluginPluginTypesOptions, __ΩPluginPluginUserConfig };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@powerlines/plugin-plugin",
-  "version": "0.11.54",
+  "version": "0.11.55",
   "type": "module",
   "description": "A package containing a Powerlines plugin to assist in developing other Powerlines plugins.",
   "repository": {
@@ -124,19 +124,20 @@
     "@alloy-js/typescript": "^0.20.0",
     "@babel/preset-typescript": "^7.28.5",
     "@storm-software/tsup": "^0.2.48",
-    "@stryke/fs": "^0.33.4",
-    "@stryke/json": "^0.9.11",
-    "@stryke/path": "^0.21.2",
-    "@stryke/type-checks": "^0.3.18",
-    "@stryke/types": "^0.10.8",
+    "@stryke/fs": "^0.33.8",
+    "@stryke/json": "^0.9.15",
+    "@stryke/path": "^0.21.6",
+    "@stryke/string-format": "^0.12.12",
+    "@stryke/type-checks": "^0.4.3",
+    "@stryke/types": "^0.10.12",
     "defu": "^6.1.4",
     "esbuild-plugin-babel": "^0.2.3",
     "jiti": "^2.6.1",
-    "powerlines": "^0.27.0"
+    "powerlines": "^0.28.0"
   },
   "devDependencies": {
     "@alloy-js/rollup-plugin": "^0.1.0",
-    "@powerlines/nx": "^0.10.46",
+    "@powerlines/nx": "^0.10.47",
     "@rollup/plugin-commonjs": "^28.0.9",
     "@rollup/plugin-node-resolve": "^16.0.3",
     "@types/babel__helper-plugin-utils": "^7.10.3",
@@ -146,5 +147,5 @@
     "rollup-plugin-typescript2": "^0.36.0"
   },
   "publishConfig": { "access": "public" },
-  "gitHead": "bbbbe4fd720918401d58e4553d93ff2018d78e6a"
+  "gitHead": "3feaa815e117c46d827eee84c3521e54670abb9b"
 }

package/dist/config.d.ts

@@ -1,23 +0,0 @@
-/* -------------------------------------------------------------------
-
-                   ⚡ Storm Software - Powerlines
-
- This code was released as part of the Powerlines project. Powerlines
- is maintained by Storm Software under the Apache-2.0 license, and is
- free for commercial and private use. For more information, please visit
- our licensing page at https://stormsoftware.com/licenses/projects/powerlines.
-
- Website:                  https://stormsoftware.com
- Repository:               https://github.com/storm-software/powerlines
- Documentation:            https://docs.stormsoftware.com/projects/powerlines
- Contact:                  https://stormsoftware.com/contact
-
- SPDX-License-Identifier:  Apache-2.0
-
- ------------------------------------------------------------------- */
-
-/// <reference path="./src/types/plugin.d.ts" />
-
-declare module "powerlines" {
-  export interface BaseConfig extends PluginPluginUserConfig {}
-}