@powerlines/plugin-env 0.16.123 → 0.16.125
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/components/docs.cjs
CHANGED
|
@@ -68,10 +68,10 @@ function EnvDocsFile(props) {
|
|
|
68
68
|
children: "Environment Variables"
|
|
69
69
|
}),
|
|
70
70
|
(0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_core_components_spacing.Spacing, {}),
|
|
71
|
-
_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
|
|
71
|
+
_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.`,
|
|
72
72
|
(0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_core_components_spacing.Spacing, {}),
|
|
73
73
|
(0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_markdown_components_markdown_table.MarkdownTable, { get data() {
|
|
74
|
-
return reflection?.getProperties().filter(__assignType((property) => property.
|
|
74
|
+
return reflection?.getProperties().filter(__assignType((property) => !property.isHidden() && !property.isIgnored() && !property.isReadonly() && !property.isInternal(), [
|
|
75
75
|
"property",
|
|
76
76
|
"",
|
|
77
77
|
"P\"2!\"/\""
|
|
@@ -84,7 +84,7 @@ function EnvDocsFile(props) {
|
|
|
84
84
|
return {
|
|
85
85
|
name: reflectionProperty.getNameAsString().trim(),
|
|
86
86
|
description: (reflectionProperty.getDescription() ?? "").trim(),
|
|
87
|
-
type: (0, _powerlines_deepkit_vendor_type.stringifyType)(reflectionProperty.getType()).trim().replaceAll(
|
|
87
|
+
type: (0, _powerlines_deepkit_vendor_type.stringifyType)(reflectionProperty.getType()).trim().replaceAll(/\s*(?:\||&)\s*/g, ", or "),
|
|
88
88
|
defaultValue: reflectionProperty.hasDefault() ? String(reflectionProperty.getDefaultValue())?.includes("\"") ? reflectionProperty.getDefaultValue() : `\`${reflectionProperty.getDefaultValue()}\`` : "",
|
|
89
89
|
required: reflectionProperty.isValueRequired() ? "" : "✔"
|
|
90
90
|
};
|
package/dist/components/docs.mjs
CHANGED
|
@@ -66,10 +66,10 @@ function EnvDocsFile(props) {
|
|
|
66
66
|
children: "Environment Variables"
|
|
67
67
|
}),
|
|
68
68
|
createComponent(Spacing, {}),
|
|
69
|
-
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
|
|
69
|
+
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.`,
|
|
70
70
|
createComponent(Spacing, {}),
|
|
71
71
|
createComponent(MarkdownTable, { get data() {
|
|
72
|
-
return reflection?.getProperties().filter(__assignType((property) => property.
|
|
72
|
+
return reflection?.getProperties().filter(__assignType((property) => !property.isHidden() && !property.isIgnored() && !property.isReadonly() && !property.isInternal(), [
|
|
73
73
|
"property",
|
|
74
74
|
"",
|
|
75
75
|
"P\"2!\"/\""
|
|
@@ -82,7 +82,7 @@ function EnvDocsFile(props) {
|
|
|
82
82
|
return {
|
|
83
83
|
name: reflectionProperty.getNameAsString().trim(),
|
|
84
84
|
description: (reflectionProperty.getDescription() ?? "").trim(),
|
|
85
|
-
type: stringifyType(reflectionProperty.getType()).trim().replaceAll(
|
|
85
|
+
type: stringifyType(reflectionProperty.getType()).trim().replaceAll(/\s*(?:\||&)\s*/g, ", or "),
|
|
86
86
|
defaultValue: reflectionProperty.hasDefault() ? String(reflectionProperty.getDefaultValue())?.includes("\"") ? reflectionProperty.getDefaultValue() : `\`${reflectionProperty.getDefaultValue()}\`` : "",
|
|
87
87
|
required: reflectionProperty.isValueRequired() ? "" : "✔"
|
|
88
88
|
};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"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 { Heading, 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 {\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 <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
|
|
1
|
+
{"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 { Heading, 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 {\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 <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;;;;;;;;;;;;;;AAiCT,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"}
|
package/dist/helpers/load.d.cts
CHANGED
|
@@ -23,7 +23,7 @@ declare function loadEnvFromContext(context: EnvPluginContext, parsed: DotenvPar
|
|
|
23
23
|
ERROR_URL: string | undefined;
|
|
24
24
|
ORGANIZATION: string | undefined;
|
|
25
25
|
PLATFORM: "node" | "browser" | "neutral";
|
|
26
|
-
MODE: "
|
|
26
|
+
MODE: "development" | "test" | "production";
|
|
27
27
|
TEST: boolean;
|
|
28
28
|
DEBUG: boolean;
|
|
29
29
|
STACKTRACE: boolean;
|
package/dist/helpers/load.d.mts
CHANGED
|
@@ -23,7 +23,7 @@ declare function loadEnvFromContext(context: EnvPluginContext, parsed: DotenvPar
|
|
|
23
23
|
ERROR_URL: string | undefined;
|
|
24
24
|
ORGANIZATION: string | undefined;
|
|
25
25
|
PLATFORM: "node" | "browser" | "neutral";
|
|
26
|
-
MODE: "
|
|
26
|
+
MODE: "development" | "test" | "production";
|
|
27
27
|
TEST: boolean;
|
|
28
28
|
DEBUG: boolean;
|
|
29
29
|
STACKTRACE: boolean;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@powerlines/plugin-env",
|
|
3
|
-
"version": "0.16.
|
|
3
|
+
"version": "0.16.125",
|
|
4
4
|
"private": false,
|
|
5
5
|
"description": "A package containing a Powerlines plugin for injecting static .env configuration values to the code so that they're accessible at runtime.",
|
|
6
6
|
"keywords": ["dotenv", "powerlines", "storm-software", "powerlines-plugin"],
|
|
@@ -306,13 +306,13 @@
|
|
|
306
306
|
"@alloy-js/typescript": "0.23.0-dev.4",
|
|
307
307
|
"@babel/core": "^7.29.0",
|
|
308
308
|
"@babel/types": "^7.29.0",
|
|
309
|
-
"@powerlines/plugin-alloy": "^0.26.
|
|
310
|
-
"@powerlines/plugin-automd": "^0.1.
|
|
311
|
-
"@powerlines/plugin-babel": "^0.12.
|
|
312
|
-
"@powerlines/plugin-plugin": "^0.12.
|
|
313
|
-
"@powerlines/deepkit": "^0.8.
|
|
314
|
-
"@powerlines/plugin-deepkit": "^0.11.
|
|
315
|
-
"@storm-software/config-tools": "^1.189.
|
|
309
|
+
"@powerlines/plugin-alloy": "^0.26.19",
|
|
310
|
+
"@powerlines/plugin-automd": "^0.1.400",
|
|
311
|
+
"@powerlines/plugin-babel": "^0.12.395",
|
|
312
|
+
"@powerlines/plugin-plugin": "^0.12.351",
|
|
313
|
+
"@powerlines/deepkit": "^0.8.3",
|
|
314
|
+
"@powerlines/plugin-deepkit": "^0.11.281",
|
|
315
|
+
"@storm-software/config-tools": "^1.189.77",
|
|
316
316
|
"@stryke/capnp": "^0.12.92",
|
|
317
317
|
"@stryke/convert": "^0.6.58",
|
|
318
318
|
"@stryke/env": "^0.20.83",
|
|
@@ -325,10 +325,10 @@
|
|
|
325
325
|
"@stryke/types": "^0.11.3",
|
|
326
326
|
"automd": "^0.4.3",
|
|
327
327
|
"defu": "^6.1.7",
|
|
328
|
-
"powerlines": "^0.42.
|
|
328
|
+
"powerlines": "^0.42.41",
|
|
329
329
|
"c12": "^3.3.4"
|
|
330
330
|
},
|
|
331
331
|
"devDependencies": { "@types/node": "^25.6.0", "vite": "^8.0.8" },
|
|
332
332
|
"publishConfig": { "access": "public" },
|
|
333
|
-
"gitHead": "
|
|
333
|
+
"gitHead": "10e11a88d7fa6920f7139649cd74470cab2fd514"
|
|
334
334
|
}
|