@powerlines/plugin-env 0.15.4 → 0.15.6

package/dist/docs-5r844zC1.d.mts

@@ -1,9 +0,0 @@
-import * as _alloy_js_core0 from "@alloy-js/core";
-
-//#region src/components/docs.d.ts
-/**
- * Generates the environment configuration markdown documentation for the Powerlines project.
- */
-declare function EnvDocs(): _alloy_js_core0.Children;
-//#endregion
-export { EnvDocs as t };

package/dist/docs-B66b9li3.mjs

@@ -1,219 +0,0 @@
-import { P as usePowerlines, d as SingleLineComment, o as SourceFile, t as createReflectionResource } from "./create-reflection-resource-BNYxBgW2.mjs";
-import { createComponent, createIntrinsic, mergeProps } from "@alloy-js/core/jsx-runtime";
-import { stringifyType } from "@powerlines/deepkit/vendor/type";
-import { Prose, Show, code, computed, createContext, createNamedContext, splitProps, useContext } from "@alloy-js/core";
-import { titleCase } from "@stryke/string-format/title-case";
-import { joinPaths } from "@stryke/path/join";
-import { isUndefined } from "@stryke/type-checks/is-undefined";
-import { Heading, Link } from "@alloy-js/markdown";
-
-//#region ../plugin-alloy/src/markdown/components/markdown-file.tsx
-/**
-* A base component representing a Powerlines generated markdown source file.
-*
-* @param props - The properties for the source file.
-* @returns The rendered source file component.
-*/
-function MarkdownFile(props) {
-	const [{ children, storage }, rest] = splitProps(props, ["children", "storage"]);
-	return createComponent(SourceFile, mergeProps({ get header() {
-		return createComponent(MarkdownFileHeader, {});
-	} }, rest, {
-		filetype: "md",
-		reference: Link,
-		storage,
-		get children() {
-			return createComponent(Show, {
-				get when() {
-					return Boolean(children);
-				},
-				children
-			});
-		}
-	}));
-}
-/**
-* Renders the header for a Powerlines Typescript source file.
-*
-* @param props - The properties for the source file header.
-* @returns The rendered source file header.
-*/
-function MarkdownFileHeader(props) {
-	const [{ children, disableEslint = true, disableBiome = true, disablePrettier = false }] = splitProps(props, [
-		"children",
-		"disableEslint",
-		"disableBiome",
-		"disablePrettier"
-	]);
-	const context = usePowerlines();
-	return [
-		createComponent(Show, {
-			get when() {
-				return Boolean(disableEslint);
-			},
-			get children() {
-				return [createComponent(SingleLineComment, {
-					variant: "markdown",
-					children: "eslint-disable"
-				}), createIntrinsic("hbr", {})];
-			}
-		}),
-		createComponent(Show, {
-			get when() {
-				return Boolean(disablePrettier);
-			},
-			get children() {
-				return [createComponent(SingleLineComment, {
-					variant: "markdown",
-					children: "prettier-ignore"
-				}), createIntrinsic("hbr", {})];
-			}
-		}),
-		createComponent(Show, {
-			get when() {
-				return Boolean(disableBiome);
-			},
-			get children() {
-				return [createComponent(SingleLineComment, {
-					variant: "markdown",
-					children: "biome-ignore lint: disable"
-				}), createIntrinsic("hbr", {})];
-			}
-		}),
-		createComponent(Show, {
-			get when() {
-				return Boolean(disableEslint) || Boolean(disablePrettier) || Boolean(disableBiome);
-			},
-			get children() {
-				return createIntrinsic("hbr", {});
-			}
-		}),
-		createComponent(Show, {
-			get when() {
-				return Boolean(children);
-			},
-			get children() {
-				return [children, createIntrinsic("hbr", {})];
-			}
-		}),
-		createComponent(SingleLineComment, {
-			variant: "markdown",
-			get children() {
-				return code`Generated by ${titleCase(context?.config.framework) || "Powerlines"}`;
-			}
-		}),
-		createIntrinsic("hbr", {}),
-		createComponent(SingleLineComment, {
-			variant: "markdown",
-			children: code`NOTE: Do not edit this file manually - it will be overwritten automatically by the "prepare" command`
-		}),
-		createIntrinsic("hbr", {})
-	];
-}
-
-//#endregion
-//#region ../plugin-alloy/src/markdown/contexts/markdown-table.ts
-/**
-* The Powerlines context used in template rendering.
-*/
-const MarkdownTableColumnContext = createNamedContext("markdown-table-column", {});
-/**
-* The Powerlines context used in template rendering.
-*/
-const MarkdownTableContext = createContext({
-	columns: [],
-	data: []
-});
-
-//#endregion
-//#region ../plugin-alloy/src/markdown/components/markdown-table.tsx
-/**
-* Component that provides a context for rendering markdown tables.
-*/
-function MarkdownTable(props) {
-	const [{ children, data }] = splitProps(props, ["children", "data"]);
-	const columns = computed(() => Object.keys(data).map((name, index) => ({
-		index,
-		name,
-		align: "left",
-		width: 20
-	})));
-	return createComponent(MarkdownTableContext.Provider, {
-		get value() {
-			return {
-				columns: columns.value,
-				data
-			};
-		},
-		get children() {
-			return createComponent(Show, {
-				get when() {
-					return Boolean(children);
-				},
-				children
-			});
-		}
-	});
-}
-
-//#endregion
-//#region src/components/docs.tsx
-/**
-* Generates the environment configuration markdown documentation for the Powerlines project.
-*/
-function EnvDocs() {
-	const context = usePowerlines();
-	if (!context) return null;
-	const reflection = createReflectionResource(context);
-	return createComponent(MarkdownFile, {
-		get path() {
-			return joinPaths(context.config.projectRoot, "docs", "generated", "env.md");
-		},
-		get children() {
-			return [
-				createComponent(Heading, {
-					level: 1,
-					children: "Environment Configuration"
-				}),
-				code`Below is a list of environment variables used by the`,
-				createComponent(Show, {
-					get when() {
-						return !!context?.packageJson.name;
-					},
-					get children() {
-						return createComponent(Link, {
-							get href() {
-								return `https://www.npmjs.com/package/${context?.packageJson.name}`;
-							},
-							get title() {
-								return context.packageJson.name;
-							}
-						});
-					}
-				}),
-				code`package. These values can be updated in the \`.env\` file in the root of the project.`,
-				createIntrinsic("hbr", {}),
-				createComponent(Heading, {
-					level: 2,
-					children: "Environment Variables"
-				}),
-				code`The below list of environment variables are used as configuration parameters to drive the processing of the application. The data contained in these variables are **not** considered sensitive or confidential. Any values provided in these variables will be available in plain text to the public.`,
-				createIntrinsic("hbr", {}),
-				createComponent(MarkdownTable, { get data() {
-					return reflection.data?.getProperties().filter((property) => property.getNameAsString() !== "__STORM_INJECTED__").sort((a, b) => a.getNameAsString().localeCompare(b.getNameAsString())).map((reflectionProperty) => {
-						return {
-							name: reflectionProperty.getNameAsString().trim(),
-							description: (reflectionProperty.getDescription() ?? "").trim(),
-							type: stringifyType(reflectionProperty.getType()).trim().replaceAll(" | ", ", or "),
-							defaultValue: reflectionProperty.hasDefault() ? String(reflectionProperty.getDefaultValue())?.includes("\"") ? reflectionProperty.getDefaultValue() : `\`${reflectionProperty.getDefaultValue()}\`` : "",
-							required: reflectionProperty.isValueRequired() ? "" : "✔"
-						};
-					}) ?? [];
-				} })
-			];
-		}
-	});
-}
-
-//#endregion
-export { EnvDocs as t };

package/dist/docs-_MmTNBQX.d.cts

@@ -1,9 +0,0 @@
-import * as _alloy_js_core0 from "@alloy-js/core";
-
-//#region src/components/docs.d.ts
-/**
- * Generates the environment configuration markdown documentation for the Powerlines project.
- */
-declare function EnvDocs(): _alloy_js_core0.Children;
-//#endregion
-export { EnvDocs as t };

package/dist/docs-hBlKCRWK.cjs

@@ -1,224 +0,0 @@
-const require_create_reflection_resource = require('./create-reflection-resource-BWYhmX7O.cjs');
-let __alloy_js_core_jsx_runtime = require("@alloy-js/core/jsx-runtime");
-let __powerlines_deepkit_vendor_type = require("@powerlines/deepkit/vendor/type");
-let __alloy_js_core = require("@alloy-js/core");
-let __stryke_string_format_title_case = require("@stryke/string-format/title-case");
-let __stryke_path_join = require("@stryke/path/join");
-let __stryke_type_checks_is_undefined = require("@stryke/type-checks/is-undefined");
-let __alloy_js_markdown = require("@alloy-js/markdown");
-
-//#region ../plugin-alloy/src/markdown/components/markdown-file.tsx
-/**
-* A base component representing a Powerlines generated markdown source file.
-*
-* @param props - The properties for the source file.
-* @returns The rendered source file component.
-*/
-function MarkdownFile(props) {
-	const [{ children, storage }, rest] = (0, __alloy_js_core.splitProps)(props, ["children", "storage"]);
-	return (0, __alloy_js_core_jsx_runtime.createComponent)(require_create_reflection_resource.SourceFile, (0, __alloy_js_core_jsx_runtime.mergeProps)({ get header() {
-		return (0, __alloy_js_core_jsx_runtime.createComponent)(MarkdownFileHeader, {});
-	} }, rest, {
-		filetype: "md",
-		reference: __alloy_js_markdown.Link,
-		storage,
-		get children() {
-			return (0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_core.Show, {
-				get when() {
-					return Boolean(children);
-				},
-				children
-			});
-		}
-	}));
-}
-/**
-* Renders the header for a Powerlines Typescript source file.
-*
-* @param props - The properties for the source file header.
-* @returns The rendered source file header.
-*/
-function MarkdownFileHeader(props) {
-	const [{ children, disableEslint = true, disableBiome = true, disablePrettier = false }] = (0, __alloy_js_core.splitProps)(props, [
-		"children",
-		"disableEslint",
-		"disableBiome",
-		"disablePrettier"
-	]);
-	const context = require_create_reflection_resource.usePowerlines();
-	return [
-		(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_core.Show, {
-			get when() {
-				return Boolean(disableEslint);
-			},
-			get children() {
-				return [(0, __alloy_js_core_jsx_runtime.createComponent)(require_create_reflection_resource.SingleLineComment, {
-					variant: "markdown",
-					children: "eslint-disable"
-				}), (0, __alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {})];
-			}
-		}),
-		(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_core.Show, {
-			get when() {
-				return Boolean(disablePrettier);
-			},
-			get children() {
-				return [(0, __alloy_js_core_jsx_runtime.createComponent)(require_create_reflection_resource.SingleLineComment, {
-					variant: "markdown",
-					children: "prettier-ignore"
-				}), (0, __alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {})];
-			}
-		}),
-		(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_core.Show, {
-			get when() {
-				return Boolean(disableBiome);
-			},
-			get children() {
-				return [(0, __alloy_js_core_jsx_runtime.createComponent)(require_create_reflection_resource.SingleLineComment, {
-					variant: "markdown",
-					children: "biome-ignore lint: disable"
-				}), (0, __alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {})];
-			}
-		}),
-		(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_core.Show, {
-			get when() {
-				return Boolean(disableEslint) || Boolean(disablePrettier) || Boolean(disableBiome);
-			},
-			get children() {
-				return (0, __alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {});
-			}
-		}),
-		(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_core.Show, {
-			get when() {
-				return Boolean(children);
-			},
-			get children() {
-				return [children, (0, __alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {})];
-			}
-		}),
-		(0, __alloy_js_core_jsx_runtime.createComponent)(require_create_reflection_resource.SingleLineComment, {
-			variant: "markdown",
-			get children() {
-				return __alloy_js_core.code`Generated by ${(0, __stryke_string_format_title_case.titleCase)(context?.config.framework) || "Powerlines"}`;
-			}
-		}),
-		(0, __alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {}),
-		(0, __alloy_js_core_jsx_runtime.createComponent)(require_create_reflection_resource.SingleLineComment, {
-			variant: "markdown",
-			children: __alloy_js_core.code`NOTE: Do not edit this file manually - it will be overwritten automatically by the "prepare" command`
-		}),
-		(0, __alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {})
-	];
-}
-
-//#endregion
-//#region ../plugin-alloy/src/markdown/contexts/markdown-table.ts
-/**
-* The Powerlines context used in template rendering.
-*/
-const MarkdownTableColumnContext = (0, __alloy_js_core.createNamedContext)("markdown-table-column", {});
-/**
-* The Powerlines context used in template rendering.
-*/
-const MarkdownTableContext = (0, __alloy_js_core.createContext)({
-	columns: [],
-	data: []
-});
-
-//#endregion
-//#region ../plugin-alloy/src/markdown/components/markdown-table.tsx
-/**
-* Component that provides a context for rendering markdown tables.
-*/
-function MarkdownTable(props) {
-	const [{ children, data }] = (0, __alloy_js_core.splitProps)(props, ["children", "data"]);
-	const columns = (0, __alloy_js_core.computed)(() => Object.keys(data).map((name, index) => ({
-		index,
-		name,
-		align: "left",
-		width: 20
-	})));
-	return (0, __alloy_js_core_jsx_runtime.createComponent)(MarkdownTableContext.Provider, {
-		get value() {
-			return {
-				columns: columns.value,
-				data
-			};
-		},
-		get children() {
-			return (0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_core.Show, {
-				get when() {
-					return Boolean(children);
-				},
-				children
-			});
-		}
-	});
-}
-
-//#endregion
-//#region src/components/docs.tsx
-/**
-* Generates the environment configuration markdown documentation for the Powerlines project.
-*/
-function EnvDocs() {
-	const context = require_create_reflection_resource.usePowerlines();
-	if (!context) return null;
-	const reflection = require_create_reflection_resource.createReflectionResource(context);
-	return (0, __alloy_js_core_jsx_runtime.createComponent)(MarkdownFile, {
-		get path() {
-			return (0, __stryke_path_join.joinPaths)(context.config.projectRoot, "docs", "generated", "env.md");
-		},
-		get children() {
-			return [
-				(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_markdown.Heading, {
-					level: 1,
-					children: "Environment Configuration"
-				}),
-				__alloy_js_core.code`Below is a list of environment variables used by the`,
-				(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_core.Show, {
-					get when() {
-						return !!context?.packageJson.name;
-					},
-					get children() {
-						return (0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_markdown.Link, {
-							get href() {
-								return `https://www.npmjs.com/package/${context?.packageJson.name}`;
-							},
-							get title() {
-								return context.packageJson.name;
-							}
-						});
-					}
-				}),
-				__alloy_js_core.code`package. These values can be updated in the \`.env\` file in the root of the project.`,
-				(0, __alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {}),
-				(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_markdown.Heading, {
-					level: 2,
-					children: "Environment Variables"
-				}),
-				__alloy_js_core.code`The below list of environment variables are used as configuration parameters to drive the processing of the application. The data contained in these variables are **not** considered sensitive or confidential. Any values provided in these variables will be available in plain text to the public.`,
-				(0, __alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {}),
-				(0, __alloy_js_core_jsx_runtime.createComponent)(MarkdownTable, { get data() {
-					return reflection.data?.getProperties().filter((property) => property.getNameAsString() !== "__STORM_INJECTED__").sort((a, b) => a.getNameAsString().localeCompare(b.getNameAsString())).map((reflectionProperty) => {
-						return {
-							name: reflectionProperty.getNameAsString().trim(),
-							description: (reflectionProperty.getDescription() ?? "").trim(),
-							type: (0, __powerlines_deepkit_vendor_type.stringifyType)(reflectionProperty.getType()).trim().replaceAll(" | ", ", or "),
-							defaultValue: reflectionProperty.hasDefault() ? String(reflectionProperty.getDefaultValue())?.includes("\"") ? reflectionProperty.getDefaultValue() : `\`${reflectionProperty.getDefaultValue()}\`` : "",
-							required: reflectionProperty.isValueRequired() ? "" : "✔"
-						};
-					}) ?? [];
-				} })
-			];
-		}
-	});
-}
-
-//#endregion
-Object.defineProperty(exports, 'EnvDocs', {
-  enumerable: true,
-  get: function () {
-    return EnvDocs;
-  }
-});

package/dist/env-BPodCdD1.d.cts

@@ -1,116 +0,0 @@
-import { f as StoragePreset } from "./resolved-BZG2cwRG.cjs";
-import { Children, SourceFileProps } from "@alloy-js/core";
-import { InterfaceDeclarationProps } from "@alloy-js/typescript";
-import { ReflectionClass } from "@powerlines/deepkit/vendor/type";
-
-//#region ../plugin-alloy/src/types/components.d.ts
-
-/**
- * A type that represents the props of a component that can have children.
- */
-interface ComponentProps {
-  children?: Children;
-}
-interface TypescriptFileImportItem {
-  name: string;
-  default?: boolean;
-  alias?: string;
-  type?: boolean;
-}
-type TypescriptFileImportList = Record<string, null | Array<TypescriptFileImportItem | string>>;
-type TypescriptFileImports = TypescriptFileImportList & {
-  $builtins?: TypescriptFileImportList;
-};
-//#endregion
-//#region ../plugin-alloy/src/typescript/components/tsdoc.d.ts
-
-interface TSDocModuleProps extends ComponentProps {
-  /**
-   * the prefix for the builtin module name
-   *
-   * @defaultValue "storm"
-   */
-  prefix?: string;
-  /**
-   * The name of the module
-   *
-   * @remarks
-   * This will be used in the `@module` tag as well as the import path for the module, e.g. `storm:<name>`.
-   *
-   * @example
-   * ```ts
-   * import { MyModule } from "storm:my-module";
-   * ```
-   */
-  name: Children;
-}
-//#endregion
-//#region ../plugin-alloy/src/core/components/source-file.d.ts
-type SourceFileProps$1 = SourceFileProps & ComponentProps & {
-  /**
-   * The storage preset for the output files.
-   *
-   * @remarks
-   * If not specified, the output mode will be determined by the provided `output.mode` value.
-   */
-  storage?: StoragePreset;
-  /**
-   * The metadata associated with the source file.
-   *
-   * @remarks
-   * The values stored in the metadata will be available in the rendering context.
-   */
-  meta?: Record<string, any>;
-};
-//#endregion
-//#region ../plugin-alloy/src/typescript/components/typescript-file.d.ts
-type TypescriptFileProps = Omit<SourceFileProps$1, "filetype"> & ComponentProps & {
-  hashbang?: Children | true;
-  header?: Children;
-  imports?: TypescriptFileImports;
-  export?: boolean | string;
-  tsx?: boolean;
-};
-//#endregion
-//#region ../plugin-alloy/src/typescript/components/builtin-file.d.ts
-type BuiltinFileProps = Omit<TypescriptFileProps, "path"> & Omit<TSDocModuleProps, "name"> & {
-  /**
-   * The runtime module identifier.
-   *
-   * @remarks
-   * This value will be included after the \`storm:\` prefix in the import statement.
-   */
-  id: string;
-  /**
-   * The description for the builtin module.
-   */
-  description?: string;
-  /**
-   * Whether the file is a TSX file.
-   *
-   * @defaultValue false
-   */
-  tsx?: boolean;
-};
-//#endregion
-//#region ../plugin-alloy/src/typescript/components/typescript-interface.d.ts
-interface TypeScriptInterfaceProps<T extends Record<string, any> = Record<string, any>> extends InterfaceDeclarationProps, ComponentProps {
-  reflection: ReflectionClass<T>;
-  defaultValue?: Partial<T>;
-}
-//#endregion
-//#region src/components/env.d.ts
-/**
- * Generates the environment configuration typescript definition for the Powerlines project.
- */
-declare function EnvTypeDefinition(props: Omit<TypeScriptInterfaceProps, "name">): Children;
-interface EnvBuiltinProps extends Omit<BuiltinFileProps, "id"> {
-  defaultConfig?: Children;
-}
-/**
- * Generates the environment configuration module for the Powerlines project.
- */
-declare function EnvBuiltin(props: EnvBuiltinProps): Children;
-declare type __ΩEnvBuiltinProps = any[];
-//#endregion
-export { __ΩEnvBuiltinProps as i, EnvBuiltinProps as n, EnvTypeDefinition as r, EnvBuiltin as t };