@powerlines/plugin-date 0.12.260 → 0.12.261

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.
Files changed (184) hide show
  1. package/dist/components/date-fns.cjs +3 -2
  2. package/dist/components/date-fns.mjs +1 -1
  3. package/dist/components/dayjs.cjs +3 -2
  4. package/dist/components/dayjs.mjs +1 -1
  5. package/dist/components/luxon.cjs +3 -2
  6. package/dist/components/luxon.mjs +1 -1
  7. package/dist/components/moment.cjs +3 -2
  8. package/dist/components/moment.mjs +1 -1
  9. package/dist/index.cjs +3 -2
  10. package/dist/index.d.cts +1 -1
  11. package/dist/index.d.mts +1 -1
  12. package/dist/index.mjs +2 -2
  13. package/dist/types/plugin.d.cts +1 -1
  14. package/dist/types/plugin.d.mts +1 -1
  15. package/package.json +4 -4
  16. package/dist/deepkit/schemas/reflection.cjs +0 -3998
  17. package/dist/deepkit/schemas/reflection.d.cts +0 -1560
  18. package/dist/deepkit/schemas/reflection.d.mts +0 -1560
  19. package/dist/deepkit/schemas/reflection.mjs +0 -3996
  20. package/dist/deepkit/schemas/reflection2.cjs +0 -4112
  21. package/dist/deepkit/schemas/reflection2.mjs +0 -4110
  22. package/dist/deepkit/src/capnp.cjs +0 -913
  23. package/dist/deepkit/src/capnp.mjs +0 -911
  24. package/dist/deepkit/src/esbuild-plugin.cjs +0 -47
  25. package/dist/deepkit/src/esbuild-plugin.mjs +0 -46
  26. package/dist/deepkit/src/reflect-type.cjs +0 -22
  27. package/dist/deepkit/src/reflect-type.mjs +0 -20
  28. package/dist/deepkit/src/resolve-reflections.cjs +0 -16
  29. package/dist/deepkit/src/resolve-reflections.mjs +0 -15
  30. package/dist/deepkit/src/transformer.cjs +0 -52
  31. package/dist/deepkit/src/transformer.mjs +0 -49
  32. package/dist/deepkit/src/transpile.cjs +0 -29
  33. package/dist/deepkit/src/transpile.mjs +0 -27
  34. package/dist/deepkit/src/types.d.cts +0 -10
  35. package/dist/deepkit/src/types.d.mts +0 -10
  36. package/dist/deepkit/src/utilities.cjs +0 -67
  37. package/dist/deepkit/src/utilities.mjs +0 -66
  38. package/dist/plugin-alloy/src/core/components/output.cjs +0 -36
  39. package/dist/plugin-alloy/src/core/components/output.mjs +0 -35
  40. package/dist/plugin-alloy/src/core/components/single-line-comment.cjs +0 -20
  41. package/dist/plugin-alloy/src/core/components/single-line-comment.mjs +0 -19
  42. package/dist/plugin-alloy/src/core/components/source-file.cjs +0 -60
  43. package/dist/plugin-alloy/src/core/components/source-file.mjs +0 -58
  44. package/dist/plugin-alloy/src/core/contexts/context.cjs +0 -38
  45. package/dist/plugin-alloy/src/core/contexts/context.mjs +0 -34
  46. package/dist/plugin-alloy/src/core/contexts/index.cjs +0 -2
  47. package/dist/plugin-alloy/src/core/contexts/index.mjs +0 -4
  48. package/dist/plugin-alloy/src/core/contexts/reflection.cjs +0 -46
  49. package/dist/plugin-alloy/src/core/contexts/reflection.mjs +0 -42
  50. package/dist/plugin-alloy/src/helpers/refkey.cjs +0 -16
  51. package/dist/plugin-alloy/src/helpers/refkey.mjs +0 -15
  52. package/dist/plugin-alloy/src/index.cjs +0 -102
  53. package/dist/plugin-alloy/src/index.mjs +0 -100
  54. package/dist/plugin-alloy/src/markdown/components/markdown-file.cjs +0 -89
  55. package/dist/plugin-alloy/src/markdown/components/markdown-file.mjs +0 -88
  56. package/dist/plugin-alloy/src/markdown/components/markdown-table.cjs +0 -33
  57. package/dist/plugin-alloy/src/markdown/components/markdown-table.mjs +0 -32
  58. package/dist/plugin-alloy/src/markdown/contexts/markdown-table.cjs +0 -18
  59. package/dist/plugin-alloy/src/markdown/contexts/markdown-table.mjs +0 -17
  60. package/dist/plugin-alloy/src/types/components.d.mts +0 -3
  61. package/dist/plugin-alloy/src/types/index.d.mts +0 -2
  62. package/dist/plugin-alloy/src/types/plugin.d.cts +0 -36
  63. package/dist/plugin-alloy/src/types/plugin.d.mts +0 -36
  64. package/dist/plugin-alloy/src/typescript/components/builtin-file.cjs +0 -52
  65. package/dist/plugin-alloy/src/typescript/components/builtin-file.mjs +0 -51
  66. package/dist/plugin-alloy/src/typescript/components/tsdoc-reflection.cjs +0 -78
  67. package/dist/plugin-alloy/src/typescript/components/tsdoc-reflection.mjs +0 -76
  68. package/dist/plugin-alloy/src/typescript/components/tsdoc.cjs +0 -364
  69. package/dist/plugin-alloy/src/typescript/components/tsdoc.mjs +0 -355
  70. package/dist/plugin-alloy/src/typescript/components/typescript-file.cjs +0 -157
  71. package/dist/plugin-alloy/src/typescript/components/typescript-file.mjs +0 -154
  72. package/dist/plugin-alloy/src/typescript/components/typescript-interface.cjs +0 -57
  73. package/dist/plugin-alloy/src/typescript/components/typescript-interface.mjs +0 -56
  74. package/dist/plugin-alloy/src/typescript/components/typescript-object.cjs +0 -94
  75. package/dist/plugin-alloy/src/typescript/components/typescript-object.mjs +0 -93
  76. package/dist/plugin-automd/src/index.cjs +0 -101
  77. package/dist/plugin-automd/src/index.mjs +0 -98
  78. package/dist/plugin-automd/src/types/plugin.d.cts +0 -38
  79. package/dist/plugin-automd/src/types/plugin.d.mts +0 -40
  80. package/dist/plugin-automd/src/types/toc.d.cts +0 -33
  81. package/dist/plugin-automd/src/types/toc.d.mts +0 -33
  82. package/dist/plugin-babel/src/helpers/ast-utils.cjs +0 -10
  83. package/dist/plugin-babel/src/helpers/ast-utils.mjs +0 -9
  84. package/dist/plugin-babel/src/helpers/create-plugin.cjs +0 -41
  85. package/dist/plugin-babel/src/helpers/create-plugin.mjs +0 -39
  86. package/dist/plugin-babel/src/helpers/filters.cjs +0 -23
  87. package/dist/plugin-babel/src/helpers/filters.mjs +0 -21
  88. package/dist/plugin-babel/src/helpers/index.cjs +0 -5
  89. package/dist/plugin-babel/src/helpers/index.mjs +0 -7
  90. package/dist/plugin-babel/src/helpers/module-helpers.cjs +0 -38
  91. package/dist/plugin-babel/src/helpers/module-helpers.mjs +0 -35
  92. package/dist/plugin-babel/src/helpers/options.cjs +0 -49
  93. package/dist/plugin-babel/src/helpers/options.mjs +0 -46
  94. package/dist/plugin-babel/src/index.cjs +0 -85
  95. package/dist/plugin-babel/src/index.mjs +0 -83
  96. package/dist/plugin-babel/src/types/index.d.mts +0 -1
  97. package/dist/plugin-babel/src/types/plugin.d.cts +0 -15
  98. package/dist/plugin-babel/src/types/plugin.d.mts +0 -15
  99. package/dist/plugin-env/src/babel/index.cjs +0 -1
  100. package/dist/plugin-env/src/babel/index.mjs +0 -3
  101. package/dist/plugin-env/src/babel/plugin.cjs +0 -70
  102. package/dist/plugin-env/src/babel/plugin.mjs +0 -69
  103. package/dist/plugin-env/src/components/docs.cjs +0 -60
  104. package/dist/plugin-env/src/components/docs.mjs +0 -59
  105. package/dist/plugin-env/src/components/env.cjs +0 -497
  106. package/dist/plugin-env/src/components/env.mjs +0 -494
  107. package/dist/plugin-env/src/components/index.cjs +0 -2
  108. package/dist/plugin-env/src/components/index.mjs +0 -4
  109. package/dist/plugin-env/src/helpers/automd-generator.cjs +0 -22
  110. package/dist/plugin-env/src/helpers/automd-generator.mjs +0 -21
  111. package/dist/plugin-env/src/helpers/create-reflection-resource.cjs +0 -55
  112. package/dist/plugin-env/src/helpers/create-reflection-resource.mjs +0 -54
  113. package/dist/plugin-env/src/helpers/docs-helper.cjs +0 -16
  114. package/dist/plugin-env/src/helpers/docs-helper.mjs +0 -15
  115. package/dist/plugin-env/src/helpers/index.cjs +0 -6
  116. package/dist/plugin-env/src/helpers/index.mjs +0 -8
  117. package/dist/plugin-env/src/helpers/load.cjs +0 -84
  118. package/dist/plugin-env/src/helpers/load.mjs +0 -81
  119. package/dist/plugin-env/src/helpers/persistence.cjs +0 -201
  120. package/dist/plugin-env/src/helpers/persistence.mjs +0 -190
  121. package/dist/plugin-env/src/helpers/reflect.cjs +0 -125
  122. package/dist/plugin-env/src/helpers/reflect.mjs +0 -117
  123. package/dist/plugin-env/src/helpers/source-file-env.cjs +0 -24
  124. package/dist/plugin-env/src/helpers/source-file-env.mjs +0 -23
  125. package/dist/plugin-env/src/helpers/template-helpers.cjs +0 -2
  126. package/dist/plugin-env/src/helpers/template-helpers.mjs +0 -4
  127. package/dist/plugin-env/src/index.cjs +0 -174
  128. package/dist/plugin-env/src/index.mjs +0 -172
  129. package/dist/plugin-env/src/types/plugin.d.cts +0 -148
  130. package/dist/plugin-env/src/types/plugin.d.mts +0 -150
  131. package/dist/plugin-env/src/types/runtime.d.cts +0 -789
  132. package/dist/plugin-env/src/types/runtime.d.mts +0 -789
  133. package/dist/powerlines/src/internal/helpers/hooks.d.cts +0 -47
  134. package/dist/powerlines/src/internal/helpers/hooks.d.mts +0 -49
  135. package/dist/powerlines/src/lib/build/esbuild.cjs +0 -93
  136. package/dist/powerlines/src/lib/build/esbuild.mjs +0 -91
  137. package/dist/powerlines/src/lib/constants/environments.cjs +0 -6
  138. package/dist/powerlines/src/lib/constants/environments.mjs +0 -5
  139. package/dist/powerlines/src/lib/entry.cjs +0 -11
  140. package/dist/powerlines/src/lib/entry.mjs +0 -13
  141. package/dist/powerlines/src/lib/logger.cjs +0 -41
  142. package/dist/powerlines/src/lib/logger.mjs +0 -39
  143. package/dist/powerlines/src/lib/unplugin/helpers.cjs +0 -3
  144. package/dist/powerlines/src/lib/unplugin/helpers.mjs +0 -5
  145. package/dist/powerlines/src/lib/unplugin/module-resolution.cjs +0 -66
  146. package/dist/powerlines/src/lib/unplugin/module-resolution.mjs +0 -65
  147. package/dist/powerlines/src/lib/unplugin/plugin.cjs +0 -46
  148. package/dist/powerlines/src/lib/unplugin/plugin.mjs +0 -45
  149. package/dist/powerlines/src/lib/utilities/bundle.cjs +0 -42
  150. package/dist/powerlines/src/lib/utilities/bundle.mjs +0 -40
  151. package/dist/powerlines/src/lib/utilities/file-header.cjs +0 -22
  152. package/dist/powerlines/src/lib/utilities/file-header.mjs +0 -21
  153. package/dist/powerlines/src/lib/utilities/resolve.cjs +0 -50
  154. package/dist/powerlines/src/lib/utilities/resolve.mjs +0 -49
  155. package/dist/powerlines/src/lib/utilities/source-file.cjs +0 -5
  156. package/dist/powerlines/src/lib/utilities/source-file.mjs +0 -5
  157. package/dist/powerlines/src/plugin-utils/paths.cjs +0 -1
  158. package/dist/powerlines/src/plugin-utils/paths.mjs +0 -3
  159. package/dist/powerlines/src/types/api.d.cts +0 -104
  160. package/dist/powerlines/src/types/api.d.mts +0 -104
  161. package/dist/powerlines/src/types/babel.d.cts +0 -22
  162. package/dist/powerlines/src/types/babel.d.mts +0 -22
  163. package/dist/powerlines/src/types/build.cjs +0 -21
  164. package/dist/powerlines/src/types/build.d.cts +0 -185
  165. package/dist/powerlines/src/types/build.d.mts +0 -185
  166. package/dist/powerlines/src/types/build.mjs +0 -21
  167. package/dist/powerlines/src/types/commands.d.cts +0 -8
  168. package/dist/powerlines/src/types/commands.d.mts +0 -9
  169. package/dist/powerlines/src/types/config.d.cts +0 -435
  170. package/dist/powerlines/src/types/config.d.mts +0 -436
  171. package/dist/powerlines/src/types/context.d.cts +0 -514
  172. package/dist/powerlines/src/types/context.d.mts +0 -514
  173. package/dist/powerlines/src/types/fs.d.cts +0 -486
  174. package/dist/powerlines/src/types/fs.d.mts +0 -486
  175. package/dist/powerlines/src/types/hooks.d.cts +0 -32
  176. package/dist/powerlines/src/types/hooks.d.mts +0 -32
  177. package/dist/powerlines/src/types/plugin.d.cts +0 -205
  178. package/dist/powerlines/src/types/plugin.d.mts +0 -205
  179. package/dist/powerlines/src/types/resolved.d.cts +0 -94
  180. package/dist/powerlines/src/types/resolved.d.mts +0 -94
  181. package/dist/powerlines/src/types/tsconfig.d.cts +0 -69
  182. package/dist/powerlines/src/types/tsconfig.d.mts +0 -69
  183. package/dist/powerlines/src/types/unplugin.d.cts +0 -22
  184. package/dist/powerlines/src/types/unplugin.d.mts +0 -23
@@ -1,69 +0,0 @@
1
- import { createBabelPlugin } from "../../../plugin-babel/src/helpers/create-plugin.mjs";
2
- import { addImport } from "../../../plugin-babel/src/helpers/module-helpers.mjs";
3
- import { stringifyDefaultValue } from "../../../deepkit/src/utilities.mjs";
4
- import { LogLevelLabel } from "@storm-software/config-tools/types";
5
-
6
- //#region ../plugin-env/src/babel/plugin.ts
7
- const envBabelPlugin = createBabelPlugin("env", ({ log, context }) => {
8
- function extractEnv(node, pass, isInjectable = false) {
9
- const envTypesAliasProperties = context.env.types.env?.getProperties().filter((prop) => prop.getAlias().length > 0);
10
- if (node.name) {
11
- const prefix = context.config.env.prefix.find((pre) => node.name && node.name.startsWith(pre) && (context.env.types.env?.hasProperty(node.name.replace(`${pre}_`, "")) || envTypesAliasProperties.some((prop) => prop.getAlias().includes(node.name.replace(`${pre}_`, "")))));
12
- let name = node.name;
13
- if (prefix) name = node.name.replace(`${prefix}_`, "");
14
- log(LogLevelLabel.TRACE, `Environment variable ${name} found in ${pass.filename || "unknown file"}.`);
15
- if (context.env.types.env?.hasProperty(name) || envTypesAliasProperties.some((prop) => prop.getAlias().includes(name))) {
16
- const envProperty = context.env.types.env.hasProperty(name) ? context.env.types.env.getProperty(name) : envTypesAliasProperties.find((prop) => prop.getAlias().includes(name));
17
- if (!envProperty || envProperty.isIgnored()) return;
18
- if (!context.env.used.env.hasProperty(name)) {
19
- log(LogLevelLabel.DEBUG, `Adding "${name}" environment variables found in "${pass.filename || "unknown file"}" to used environment configuration reflection object.`);
20
- context.env.used.env.addProperty(envProperty.property);
21
- }
22
- if (context.config.env.inject && isInjectable) {
23
- let value = context.env.parsed?.[name];
24
- if (value === void 0) {
25
- const prefix$1 = context.config.env.prefix.find((pre) => {
26
- return context.env.parsed[`${pre.replace(/_$/g, "")}_${name}`];
27
- });
28
- if (prefix$1) value = context.env.parsed[`${prefix$1.replace(/_$/g, "")}_${name}`];
29
- }
30
- value ??= envProperty.getDefaultValue();
31
- if (envProperty.isValueRequired() && value === void 0) throw new Error(`Environment variable \`${name}\` is not defined in the .env configuration files`);
32
- return stringifyDefaultValue(envProperty, value);
33
- }
34
- } else throw new Error(`The "${name}" environment variable is not defined in the \`env\` type definition, but is used in the source code file ${pass.filename ? pass.filename : "unknown"}.
35
-
36
- The following environment configuration names are defined in the \`env\` type definition: \n${context.env.types.env?.getPropertyNames().sort((a, b) => String(a).localeCompare(String(b))).map((typeDef) => ` - ${String(typeDef)} ${envTypesAliasProperties.some((prop) => prop.getNameAsString() === String(typeDef) && prop.getAlias().length > 0) ? `(Alias: ${envTypesAliasProperties?.find((prop) => prop.getNameAsString() === String(typeDef))?.getAlias().join(", ")})` : ""}`).join("\n")} \n\nUsing the following env prefix: \n${context.config.env.prefix.map((prefix$1) => ` - ${prefix$1}`).join("\n")} \n\nPlease check your \`env\` configuration option. If you are using a custom dotenv type definition, please make sure that the configuration names match the ones in the code. \n\n`);
37
- }
38
- }
39
- return { visitor: { MemberExpression(path, pass) {
40
- if (path.get("object")?.get("property")?.isIdentifier({ name: "env" }) && path.get("object")?.get("object")?.isIdentifier({ name: "process" }) && path.get("property")?.isIdentifier()) {
41
- const identifier = path.get("property")?.node;
42
- if (!identifier.name) return;
43
- extractEnv(identifier, pass, false);
44
- path.replaceWithSourceString(`env.${identifier.name}`);
45
- addImport(path, {
46
- module: `${context.config.framework || "powerlines"}:env`,
47
- name: "env",
48
- imported: "env"
49
- });
50
- } else if (path.get("object")?.get("property")?.isIdentifier({ name: "env" }) && path.get("object")?.get("object")?.isMetaProperty() && path.get("property")?.isIdentifier()) {
51
- const identifier = path.get("property")?.node;
52
- if (!identifier.name) return;
53
- extractEnv(identifier, pass, false);
54
- path.replaceWithSourceString(`env.${identifier.name}`);
55
- addImport(path, {
56
- module: `${context.config.framework || "powerlines"}:env`,
57
- name: "env",
58
- imported: "env"
59
- });
60
- } else if (path.get("object")?.isIdentifier({ name: "env" }) && path.get("property")?.isIdentifier()) {
61
- const identifier = path.get("property")?.node;
62
- if (!identifier.name) return;
63
- extractEnv(identifier, pass, false);
64
- }
65
- } } };
66
- });
67
-
68
- //#endregion
69
- export { envBabelPlugin };
@@ -1,60 +0,0 @@
1
- const require_rolldown_runtime = require('../../../_virtual/rolldown_runtime.cjs');
2
- const require_context = require('../../../plugin-alloy/src/core/contexts/context.cjs');
3
- const require_markdown_file = require('../../../plugin-alloy/src/markdown/components/markdown-file.cjs');
4
- const require_markdown_table = require('../../../plugin-alloy/src/markdown/components/markdown-table.cjs');
5
- const require_create_reflection_resource = require('../helpers/create-reflection-resource.cjs');
6
- const require_docs_helper = require('../helpers/docs-helper.cjs');
7
- let __powerlines_deepkit_vendor_type = require("@powerlines/deepkit/vendor/type");
8
- let __alloy_js_core = require("@alloy-js/core");
9
- let react_jsx_runtime = require("react/jsx-runtime");
10
- let __stryke_path_join = require("@stryke/path/join");
11
- let __alloy_js_markdown = require("@alloy-js/markdown");
12
-
13
- //#region ../plugin-env/src/components/docs.tsx
14
- /**
15
- * Generates the environment configuration markdown documentation for the Powerlines project.
16
- */
17
- function EnvDocsFile(props) {
18
- const { levelOffset = 0, ...rest } = props;
19
- const context = require_context.usePowerlinesSafe();
20
- if (!context) return null;
21
- const reflection = require_create_reflection_resource.createReflectionResource(context);
22
- return /* @__PURE__ */ (0, react_jsx_runtime.jsxs)(require_markdown_file.MarkdownFile, {
23
- path: (0, __stryke_path_join.joinPaths)(require_docs_helper.getDocsOutputPath(context), "env.md"),
24
- ...rest,
25
- children: [
26
- /* @__PURE__ */ (0, react_jsx_runtime.jsx)(__alloy_js_markdown.Heading, {
27
- level: 1 + levelOffset,
28
- children: "Environment Configuration"
29
- }),
30
- __alloy_js_core.code`Below is a list of environment variables used by the`,
31
- /* @__PURE__ */ (0, react_jsx_runtime.jsx)(__alloy_js_core.Show, {
32
- when: !!context?.packageJson.name,
33
- children: /* @__PURE__ */ (0, react_jsx_runtime.jsx)(__alloy_js_markdown.Link, {
34
- href: `https://www.npmjs.com/package/${context?.packageJson.name}`,
35
- title: context.packageJson.name
36
- })
37
- }),
38
- __alloy_js_core.code`package. These values can be updated in the \`.env\` file in the root of the project.`,
39
- /* @__PURE__ */ (0, react_jsx_runtime.jsx)("hbr", {}),
40
- /* @__PURE__ */ (0, react_jsx_runtime.jsx)(__alloy_js_markdown.Heading, {
41
- level: 2 + levelOffset,
42
- children: "Environment Variables"
43
- }),
44
- __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.`,
45
- /* @__PURE__ */ (0, react_jsx_runtime.jsx)("hbr", {}),
46
- /* @__PURE__ */ (0, react_jsx_runtime.jsx)(require_markdown_table.MarkdownTable, { data: reflection.data?.getProperties().filter((property) => property.getNameAsString() !== "__STORM_INJECTED__").sort((a, b) => a.getNameAsString().localeCompare(b.getNameAsString())).map((reflectionProperty) => {
47
- return {
48
- name: reflectionProperty.getNameAsString().trim(),
49
- description: (reflectionProperty.getDescription() ?? "").trim(),
50
- type: (0, __powerlines_deepkit_vendor_type.stringifyType)(reflectionProperty.getType()).trim().replaceAll(" | ", ", or "),
51
- defaultValue: reflectionProperty.hasDefault() ? String(reflectionProperty.getDefaultValue())?.includes("\"") ? reflectionProperty.getDefaultValue() : `\`${reflectionProperty.getDefaultValue()}\`` : "",
52
- required: reflectionProperty.isValueRequired() ? "" : "✔"
53
- };
54
- }) ?? [] })
55
- ]
56
- });
57
- }
58
-
59
- //#endregion
60
- exports.EnvDocsFile = EnvDocsFile;
@@ -1,59 +0,0 @@
1
- import { usePowerlinesSafe } from "../../../plugin-alloy/src/core/contexts/context.mjs";
2
- import { MarkdownFile } from "../../../plugin-alloy/src/markdown/components/markdown-file.mjs";
3
- import { MarkdownTable } from "../../../plugin-alloy/src/markdown/components/markdown-table.mjs";
4
- import { createReflectionResource } from "../helpers/create-reflection-resource.mjs";
5
- import { getDocsOutputPath } from "../helpers/docs-helper.mjs";
6
- import { stringifyType } from "@powerlines/deepkit/vendor/type";
7
- import { Show, code } from "@alloy-js/core";
8
- import { jsx, jsxs } from "react/jsx-runtime";
9
- import { joinPaths } from "@stryke/path/join";
10
- import { Heading, Link } from "@alloy-js/markdown";
11
-
12
- //#region ../plugin-env/src/components/docs.tsx
13
- /**
14
- * Generates the environment configuration markdown documentation for the Powerlines project.
15
- */
16
- function EnvDocsFile(props) {
17
- const { levelOffset = 0, ...rest } = props;
18
- const context = usePowerlinesSafe();
19
- if (!context) return null;
20
- const reflection = createReflectionResource(context);
21
- return /* @__PURE__ */ jsxs(MarkdownFile, {
22
- path: joinPaths(getDocsOutputPath(context), "env.md"),
23
- ...rest,
24
- children: [
25
- /* @__PURE__ */ jsx(Heading, {
26
- level: 1 + levelOffset,
27
- children: "Environment Configuration"
28
- }),
29
- code`Below is a list of environment variables used by the`,
30
- /* @__PURE__ */ jsx(Show, {
31
- when: !!context?.packageJson.name,
32
- children: /* @__PURE__ */ jsx(Link, {
33
- href: `https://www.npmjs.com/package/${context?.packageJson.name}`,
34
- title: context.packageJson.name
35
- })
36
- }),
37
- code`package. These values can be updated in the \`.env\` file in the root of the project.`,
38
- /* @__PURE__ */ jsx("hbr", {}),
39
- /* @__PURE__ */ jsx(Heading, {
40
- level: 2 + levelOffset,
41
- children: "Environment Variables"
42
- }),
43
- 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.`,
44
- /* @__PURE__ */ jsx("hbr", {}),
45
- /* @__PURE__ */ jsx(MarkdownTable, { data: reflection.data?.getProperties().filter((property) => property.getNameAsString() !== "__STORM_INJECTED__").sort((a, b) => a.getNameAsString().localeCompare(b.getNameAsString())).map((reflectionProperty) => {
46
- return {
47
- name: reflectionProperty.getNameAsString().trim(),
48
- description: (reflectionProperty.getDescription() ?? "").trim(),
49
- type: stringifyType(reflectionProperty.getType()).trim().replaceAll(" | ", ", or "),
50
- defaultValue: reflectionProperty.hasDefault() ? String(reflectionProperty.getDefaultValue())?.includes("\"") ? reflectionProperty.getDefaultValue() : `\`${reflectionProperty.getDefaultValue()}\`` : "",
51
- required: reflectionProperty.isValueRequired() ? "" : "✔"
52
- };
53
- }) ?? [] })
54
- ]
55
- });
56
- }
57
-
58
- //#endregion
59
- export { EnvDocsFile };