@powerlines/plugin-env 0.16.156 → 0.16.158

package/dist/components/docs.mjs

@@ -1,109 +0,0 @@
-import { __ΩEnvPluginContext } from "../types/plugin.mjs";
-import { stringifyType } from "@powerlines/deepkit/vendor/type";
-import { getDocsOutputPath } from "powerlines/plugin-utils";
-import { createComponent, mergeProps } from "@alloy-js/core/jsx-runtime";
-import { Show, code } from "@alloy-js/core";
-import { Link } from "@alloy-js/markdown";
-import { Spacing } from "@powerlines/plugin-alloy/core/components/spacing";
-import { usePowerlines } from "@powerlines/plugin-alloy/core/contexts/context";
-import { Heading } from "@powerlines/plugin-alloy/markdown/components/heading";
-import { MarkdownFile } from "@powerlines/plugin-alloy/markdown/components/markdown-file";
-import { MarkdownTable } from "@powerlines/plugin-alloy/markdown/components/markdown-table";
-import { joinPaths } from "@stryke/path/join";
-
-//#region src/components/docs.tsx
-const __ΩPartial = [
-	"T",
-	"Partial",
-	"l+e#!e\"!fRb!Pde\"!gN#\"w\"y"
-];
-function __assignType(fn, args) {
-	fn.__type = args;
-	return fn;
-}
-const __ΩEnvDocsFileProps = [
-	() => __ΩPartial,
-	"levelOffset",
-	0,
-	"The heading level offset to apply to the generated documentation.",
-	"reflection",
-	"EnvDocsFileProps",
-	"P!o!\"'4\"8>#?$!4%Mw&y"
-];
-/**
-* Generates the environment configuration markdown documentation for the Powerlines project.
-*/
-function EnvDocsFile(props) {
-	const { levelOffset = 0, reflection, ...rest } = props;
-	const context = (usePowerlines.Ω = [[() => __ΩEnvPluginContext, "n!"]], usePowerlines());
-	return createComponent(MarkdownFile, mergeProps({ get path() {
-		return joinPaths(getDocsOutputPath(context.config.root), "env.md");
-	} }, rest, { get children() {
-		return [
-			createComponent(Heading, {
-				level: 1 + levelOffset,
-				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.`,
-			createComponent(Spacing, {}),
-			createComponent(Heading, {
-				level: 2 + levelOffset,
-				children: "Environment Variables"
-			}),
-			createComponent(Spacing, {}),
-			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.`,
-			createComponent(Spacing, {}),
-			createComponent(MarkdownTable, { get data() {
-				return reflection?.getProperties().filter(__assignType((property) => !property.isHidden() && !property.isIgnored() && !property.isReadonly() && !property.isInternal(), [
-					"property",
-					"",
-					"P\"2!\"/\""
-				])).sort(__assignType((a, b) => a.getNameAsString().localeCompare(b.getNameAsString()), [
-					"a",
-					"b",
-					"",
-					"P\"2!\"2\"\"/#"
-				])).map(__assignType((reflectionProperty) => {
-					return {
-						name: reflectionProperty.getNameAsString().trim(),
-						description: (reflectionProperty.getDescription() ?? "").trim(),
-						type: stringifyType(reflectionProperty.getType()).trim().replaceAll(/\s*(?:\||&)\s*/g, ", or "),
-						defaultValue: reflectionProperty.hasDefault() ? String(reflectionProperty.getDefaultValue())?.includes("\"") ? reflectionProperty.getDefaultValue() : `\`${reflectionProperty.getDefaultValue()}\`` : "",
-						required: reflectionProperty.isValueRequired() ? "" : "✔"
-					};
-				}, [
-					"reflectionProperty",
-					"",
-					"P\"2!\"/\""
-				])) ?? [];
-			} })
-		];
-	} }));
-}
-EnvDocsFile.__type = [
-	() => __ΩEnvDocsFileProps,
-	"props",
-	"EnvDocsFile",
-	"Generates the environment configuration markdown documentation for the Powerlines project.",
-	"Pn!2\"\"/#?$"
-];
-
-//#endregion
-export { EnvDocsFile, __ΩEnvDocsFileProps };
-//# sourceMappingURL=docs.mjs.map

package/dist/components/docs.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"docs.mjs","names":[],"sources":["../../src/components/docs.tsx"],"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 { code, Show } from \"@alloy-js/core\";\nimport { Link } from \"@alloy-js/markdown\";\nimport {\n  ReflectionClass,\n  stringifyType\n} from \"@powerlines/deepkit/vendor/type\";\nimport { Spacing } from \"@powerlines/plugin-alloy/core/components/spacing\";\nimport { usePowerlines } from \"@powerlines/plugin-alloy/core/contexts/context\";\nimport { Heading } from \"@powerlines/plugin-alloy/markdown/components/heading\";\nimport {\n  MarkdownFile,\n  MarkdownFileProps\n} from \"@powerlines/plugin-alloy/markdown/components/markdown-file\";\nimport { MarkdownTable } from \"@powerlines/plugin-alloy/markdown/components/markdown-table\";\nimport { joinPaths } from \"@stryke/path/join\";\nimport { getDocsOutputPath } from \"powerlines/plugin-utils\";\nimport { EnvPluginContext } from \"../types/plugin\";\n\nexport interface EnvDocsFileProps extends Partial<MarkdownFileProps> {\n  /**\n   * The heading level offset to apply to the generated documentation.\n   *\n   * @remarks\n   * This is useful when nesting the documentation within other markdown files.\n   *\n   * @defaultValue 0\n   */\n  levelOffset?: number;\n\n  reflection: ReflectionClass<any>;\n}\n\n/**\n * Generates the environment configuration markdown documentation for the Powerlines project.\n */\nexport function EnvDocsFile(props: EnvDocsFileProps) {\n  const { levelOffset = 0, reflection, ...rest } = props;\n\n  const context = usePowerlines<EnvPluginContext>();\n\n  return (\n    <MarkdownFile\n      path={joinPaths(getDocsOutputPath(context.config.root), \"env.md\")}\n      {...rest}>\n      <Heading level={1 + levelOffset}>Environment Configuration</Heading>\n      {code`Below is a list of environment variables used by the`}\n      <Show when={!!context.packageJson.name}>\n        <Link\n          href={`https://www.npmjs.com/package/${context.packageJson.name}`}\n          title={context.packageJson.name!}\n        />\n      </Show>\n      {code`package. These values can be updated in the \\`.env\\` file in the root of the project.`}\n      <Spacing />\n      <Heading level={2 + levelOffset}>Environment Variables</Heading>\n      <Spacing />\n      {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.`}\n      <Spacing />\n      <MarkdownTable\n        data={\n          reflection\n            ?.getProperties()\n            .filter(\n              property =>\n                !property.isHidden() &&\n                !property.isIgnored() &&\n                !property.isReadonly() &&\n                !property.isInternal()\n            )\n            .sort((a, b) =>\n              a.getNameAsString().localeCompare(b.getNameAsString())\n            )\n            .map(reflectionProperty => {\n              return {\n                name: reflectionProperty.getNameAsString().trim(),\n                description: (reflectionProperty.getDescription() ?? \"\").trim(),\n                type: stringifyType(reflectionProperty.getType())\n                  .trim()\n                  .replaceAll(/\\s*(?:\\||&)\\s*/g, \", or \"),\n                defaultValue: reflectionProperty.hasDefault()\n                  ? String(reflectionProperty.getDefaultValue())?.includes('\"')\n                    ? reflectionProperty.getDefaultValue()\n                    : `\\`${reflectionProperty.getDefaultValue()}\\``\n                  : \"\",\n                required: reflectionProperty.isValueRequired() ? \"\" : \"✔\"\n              };\n            }) ?? []\n        }\n      />\n    </MarkdownFile>\n  );\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;AAIA,SAAM,aAAS,IAAW,MAAM;AAC/B,IAAG,SAAU;AACb,QAAQ;;;;;;;;;;;;;;AAkCT,SAAM,YAAA,OAAA;CACJ,MAAG,EACF,cAAA,GACC,YACA,GAAA,SACF;;AAEA,QAAA,gBAAY,cAAoB,WAAA,EAClC,IAAA,OAAA;;IAGG,EAAA,MAAA,EACD,IAAA,WAAA;AACI,SAAC;GAAA,gBAAqB,SAAO;IAC3B,OAAE,IAAA;;IAEH,CAAC;GAAA,IAAA;GAA2C,gBAAA,MAAA;;AAE1C,YAAA,CAAA,CAAA,QAAA,YAAA;;IAEH,IAAM,WAAU;AACZ,YAAK,gBAAA,MAAA;MACR,IAAQ,OAAQ;AACX,cAAS,iCAAgC,QAAQ,YAAI;;MAExD,IAAA,QAAA;AACK,cAAG,QAAY,YAAU;;MAE9B,CAAA;;IAEF,CAAA;GAAA,IAAK;GAAsF,gBAAA,SAAA,EAAA,CAAA;GAAA,gBAAA,SAAA;IAC3F,OAAQ,IAAC;IACT,UAAQ;IACR,CAAA;GAAA,gBAAS,SAAA,EAAA,CAAA;GAAA,IAAA;GAAA,gBAAA,SAAA,EAAA,CAAA;GAAA,gBAAA,eAAA,EACT,IAAK,OAAI;AACT,WAAS,YAAA,eAAA,CAAA,OAAA,cAAA,aAAA,CAAA,SAAA,UAAA,IAAA,CAAA,SAAA,WAAA,IAAA,CAAA,SAAA,YAAA,IAAA,CAAA,SAAA,YAAA,EAAA;KAAA;KAAA;KAAA;KAAA,CAAA,CAAA,CAAA,KAAA,cAAA,GAAA,MAAA,EAAA,iBAAA,CAAA,cAAA,EAAA,iBAAA,CAAA,EAAA;KAAA;KAAA;KAAA;KAAA;KAAA,CAAA,CAAA,CAAA,IAAA,cAAA,uBAAA;AACT,YAAA;MACM,MAAA,mBAAA,iBAAA,CAAA,MAAA;MACH,cAAA,mBAAA,gBAAA,IAAA,IAAA,MAAA;MACI,MAAA,cAAc,mBAAA,SAAA,CAAA,CAAA,MAAA,CAAA,WAAA,mBAAA,QAAA;MACf,cAAM,mBAAA,YAAA,GAAA,OAAA,mBAAA,iBAAA,CAAA,EAAA,SAAA,KAAA,GAAA,mBAAA,iBAAA,GAAA,KAAA,mBAAA,iBAAA,CAAA,MAAA;MACL,UAAU,mBAAA,iBAAA,GAAA,KAAA;MACX;OACA;KAAC;KAAsB;KAAG;KAAA,CAAA,CAAA,IAAA,EAAA;MAEhC,CAAC;GAAC;IAEN,CAAC,CAAC;;AAEL,YAAY,SAAA;OAAA;CAAA;CAAA;CAAA;CAAA;CAAA"}