@powerlines/plugin-env 0.15.161 → 0.15.162

package/dist/components/docs.mjs

@@ -1,7 +1,67 @@
-import "../runtime-C5ukCv3P.mjs";
-import "../plugin-eBjQJP6x.mjs";
-import "../join-paths-Dd9KxuyL.mjs";
-import "../docs-helper-BSYSI2cH.mjs";
-import { t as EnvDocsFile } from "../docs-WdCIcQmw.mjs";
+import { joinPaths } from "../node_modules/.pnpm/@stryke_path@0.26.4/node_modules/@stryke/path/dist/join-paths.mjs";
+import { getDocsOutputPath } from "../helpers/docs-helper.mjs";
+import { stringifyType } from "@powerlines/deepkit/vendor/type";
+import { createComponent, createIntrinsic, mergeProps } from "@alloy-js/core/jsx-runtime";
+import { Show, code } from "@alloy-js/core";
+import { Heading, Link } from "@alloy-js/markdown";
+import { usePowerlines } from "@powerlines/plugin-alloy/core/contexts/context";
+import { MarkdownFile } from "@powerlines/plugin-alloy/markdown/components/markdown-file";
+import { MarkdownTable } from "@powerlines/plugin-alloy/markdown/components/markdown-table";
 
-export { EnvDocsFile };
+//#region src/components/docs.tsx
+/**
+* Generates the environment configuration markdown documentation for the Powerlines project.
+*/
+function EnvDocsFile(props) {
+	const { levelOffset = 0, reflection, ...rest } = props;
+	const context = usePowerlines();
+	return createComponent(MarkdownFile, mergeProps({ get path() {
+		return joinPaths(getDocsOutputPath(context), "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.`,
+			createIntrinsic("hbr", {}),
+			createComponent(Heading, {
+				level: 2 + levelOffset,
+				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?.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 { EnvDocsFile };
+//# sourceMappingURL=docs.mjs.map

package/dist/components/docs.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"docs.mjs","names":["code","Show","Heading","Link","stringifyType","usePowerlines","MarkdownFile","MarkdownTable","joinPaths","getDocsOutputPath","EnvDocsFile","props","levelOffset","reflection","rest","context","_$createComponent","_$mergeProps","path","children","level","when","packageJson","name","href","title","_$createIntrinsic","data","getProperties","filter","property","getNameAsString","sort","a","b","localeCompare","map","reflectionProperty","trim","description","getDescription","type","getType","replaceAll","defaultValue","hasDefault","String","getDefaultValue","includes","required","isValueRequired"],"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 { Heading, Link } from \"@alloy-js/markdown\";\nimport {\n  ReflectionClass,\n  stringifyType\n} from \"@powerlines/deepkit/vendor/type\";\nimport { usePowerlines } from \"@powerlines/plugin-alloy/core/contexts/context\";\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 \"../helpers/docs-helper\";\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), \"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      <hbr />\n      <Heading level={2 + levelOffset}>Environment Variables</Heading>\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 to the public.`}\n      <hbr />\n      <MarkdownTable\n        data={\n          reflection\n            ?.getProperties()\n            .filter(\n              property => property.getNameAsString() !== \"__STORM_INJECTED__\"\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(\" | \", \", 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":";;;;;;;;;;;;;;AAmDA,SAAgBU,YAAYC,OAAyB;CACnD,MAAM,EAAEC,cAAc,GAAGC,YAAY,GAAGC,SAASH;CAEjD,MAAMI,UAAUV,eAAiC;AAEjD,QAAAW,gBACGV,cAAYW,WAAA,EAAA,IACXC,OAAI;AAAA,SAAEV,UAAUC,kBAAkBM,QAAQ,EAAE,SAAS;IAAA,EACjDD,MAAI,EAAA,IAAAK,WAAA;AAAA,SAAA;GAAAH,gBACPd,SAAO;IAACkB,OAAO,IAAIR;IAAWO,UAAA;IAAA,CAAA;GAC9BnB,IAAI;GAAsDgB,gBAC1Df,MAAI;IAAA,IAACoB,OAAI;AAAA,YAAE,CAAC,CAACN,QAAQO,YAAYC;;IAAI,IAAAJ,WAAA;AAAA,YAAAH,gBACnCb,MAAI;MAAA,IACHqB,OAAI;AAAA,cAAE,iCAAiCT,QAAQO,YAAYC;;MAAM,IACjEE,QAAK;AAAA,cAAEV,QAAQO,YAAYC;;MAAI,CAAA;;IAAA,CAAA;GAGlCvB,IAAI;GAAuF0B,gBAAA,OAAA,EAAA,CAAA;GAAAV,gBAE3Fd,SAAO;IAACkB,OAAO,IAAIR;IAAWO,UAAA;IAAA,CAAA;GAC9BnB,IAAI;GAAwS0B,gBAAA,OAAA,EAAA,CAAA;GAAAV,gBAE5ST,eAAa,EAAA,IACZoB,OAAI;AAAA,WACFd,YACIe,eAAe,CAChBC,QACCC,aAAYA,SAASC,iBAAiB,KAAK,qBAC5C,CACAC,MAAMC,GAAGC,MACRD,EAAEF,iBAAiB,CAACI,cAAcD,EAAEH,iBAAiB,CACvD,CAAC,CACAK,KAAIC,uBAAsB;AACzB,YAAO;MACLd,MAAMc,mBAAmBN,iBAAiB,CAACO,MAAM;MACjDC,cAAcF,mBAAmBG,gBAAgB,IAAI,IAAIF,MAAM;MAC/DG,MAAMrC,cAAciC,mBAAmBK,SAAS,CAAC,CAC9CJ,MAAM,CACNK,WAAW,OAAO,QAAQ;MAC7BC,cAAcP,mBAAmBQ,YAAY,GACzCC,OAAOT,mBAAmBU,iBAAiB,CAAC,EAAEC,SAAS,KAAI,GACzDX,mBAAmBU,iBAAiB,GACpC,KAAKV,mBAAmBU,iBAAiB,CAAA,MAC3C;MACJE,UAAUZ,mBAAmBa,iBAAiB,GAAG,KAAK;MACvD;MACD,IAAI,EAAE;MAAA,CAAA;GAAA;IAAA,CAAA,CAAA"}