@powerlines/plugin-nodejs 0.1.0 → 0.1.2

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 (200) hide show
  1. package/dist/_virtual/rolldown_runtime.cjs +29 -0
  2. package/dist/components/env.cjs +188 -2
  3. package/dist/components/env.d.cts +9 -2
  4. package/dist/components/env.d.mts +9 -2
  5. package/dist/components/env.mjs +185 -1
  6. package/dist/components/index.cjs +2 -3
  7. package/dist/components/index.d.cts +1 -3
  8. package/dist/components/index.d.mts +1 -3
  9. package/dist/components/index.mjs +1 -2
  10. package/dist/deepkit/schemas/reflection.cjs +3940 -0
  11. package/dist/{plugin-D7kBf19k.d.cts → deepkit/schemas/reflection.d.cts} +1 -1078
  12. package/dist/{plugin-JL1BtFku.d.mts → deepkit/schemas/reflection.d.mts} +59 -1136
  13. package/dist/deepkit/schemas/reflection.mjs +3938 -0
  14. package/dist/deepkit/schemas/reflection2.cjs +4112 -0
  15. package/dist/deepkit/schemas/reflection2.mjs +4110 -0
  16. package/dist/deepkit/src/capnp.cjs +913 -0
  17. package/dist/deepkit/src/capnp.mjs +911 -0
  18. package/dist/deepkit/src/esbuild-plugin.cjs +47 -0
  19. package/dist/deepkit/src/esbuild-plugin.mjs +46 -0
  20. package/dist/deepkit/src/reflect-type.cjs +22 -0
  21. package/dist/deepkit/src/reflect-type.mjs +20 -0
  22. package/dist/deepkit/src/resolve-reflections.cjs +16 -0
  23. package/dist/deepkit/src/resolve-reflections.mjs +15 -0
  24. package/dist/deepkit/src/transformer.cjs +52 -0
  25. package/dist/deepkit/src/transformer.mjs +49 -0
  26. package/dist/deepkit/src/transpile.cjs +29 -0
  27. package/dist/deepkit/src/transpile.mjs +27 -0
  28. package/dist/deepkit/src/types.d.cts +10 -0
  29. package/dist/deepkit/src/types.d.mts +10 -0
  30. package/dist/deepkit/src/utilities.cjs +66 -0
  31. package/dist/deepkit/src/utilities.mjs +65 -0
  32. package/dist/index.cjs +14 -813
  33. package/dist/index.d.cts +5 -5
  34. package/dist/index.d.mts +5 -5
  35. package/dist/index.mjs +11 -803
  36. package/dist/plugin-alloy/src/core/components/output.cjs +45 -0
  37. package/dist/plugin-alloy/src/core/components/output.mjs +44 -0
  38. package/dist/plugin-alloy/src/core/components/single-line-comment.cjs +22 -0
  39. package/dist/plugin-alloy/src/core/components/single-line-comment.mjs +21 -0
  40. package/dist/plugin-alloy/src/core/components/source-file.cjs +64 -0
  41. package/dist/plugin-alloy/src/core/components/source-file.d.cts +23 -0
  42. package/dist/plugin-alloy/src/core/components/source-file.d.mts +23 -0
  43. package/dist/plugin-alloy/src/core/components/source-file.mjs +62 -0
  44. package/dist/plugin-alloy/src/core/contexts/context.cjs +60 -0
  45. package/dist/plugin-alloy/src/core/contexts/context.mjs +54 -0
  46. package/dist/plugin-alloy/src/core/contexts/index.cjs +2 -0
  47. package/dist/plugin-alloy/src/core/contexts/index.mjs +4 -0
  48. package/dist/plugin-alloy/src/core/contexts/reflection.cjs +46 -0
  49. package/dist/plugin-alloy/src/core/contexts/reflection.mjs +42 -0
  50. package/dist/plugin-alloy/src/helpers/refkey.cjs +16 -0
  51. package/dist/plugin-alloy/src/helpers/refkey.mjs +15 -0
  52. package/dist/plugin-alloy/src/index.cjs +99 -0
  53. package/dist/plugin-alloy/src/index.mjs +97 -0
  54. package/dist/plugin-alloy/src/markdown/components/markdown-file.cjs +7 -0
  55. package/dist/plugin-alloy/src/markdown/components/markdown-file.mjs +9 -0
  56. package/dist/plugin-alloy/src/markdown/components/markdown-table.cjs +5 -0
  57. package/dist/plugin-alloy/src/markdown/components/markdown-table.mjs +7 -0
  58. package/dist/plugin-alloy/src/markdown/contexts/markdown-table.cjs +17 -0
  59. package/dist/plugin-alloy/src/markdown/contexts/markdown-table.mjs +17 -0
  60. package/dist/plugin-alloy/src/types/components.d.cts +23 -0
  61. package/dist/plugin-alloy/src/types/components.d.mts +24 -0
  62. package/dist/plugin-alloy/src/types/index.d.cts +2 -0
  63. package/dist/plugin-alloy/src/types/index.d.mts +2 -0
  64. package/dist/plugin-alloy/src/types/plugin.d.cts +37 -0
  65. package/dist/plugin-alloy/src/types/plugin.d.mts +37 -0
  66. package/dist/plugin-alloy/src/typescript/components/builtin-file.cjs +57 -0
  67. package/dist/plugin-alloy/src/typescript/components/builtin-file.d.cts +26 -0
  68. package/dist/plugin-alloy/src/typescript/components/builtin-file.d.mts +26 -0
  69. package/dist/plugin-alloy/src/typescript/components/builtin-file.mjs +56 -0
  70. package/dist/plugin-alloy/src/typescript/components/tsdoc-reflection.cjs +126 -0
  71. package/dist/plugin-alloy/src/typescript/components/tsdoc-reflection.mjs +124 -0
  72. package/dist/plugin-alloy/src/typescript/components/tsdoc.cjs +442 -0
  73. package/dist/plugin-alloy/src/typescript/components/tsdoc.d.cts +28 -0
  74. package/dist/plugin-alloy/src/typescript/components/tsdoc.d.mts +28 -0
  75. package/dist/plugin-alloy/src/typescript/components/tsdoc.mjs +433 -0
  76. package/dist/plugin-alloy/src/typescript/components/typescript-file.cjs +194 -0
  77. package/dist/plugin-alloy/src/typescript/components/typescript-file.d.cts +15 -0
  78. package/dist/plugin-alloy/src/typescript/components/typescript-file.d.mts +15 -0
  79. package/dist/plugin-alloy/src/typescript/components/typescript-file.mjs +191 -0
  80. package/dist/plugin-alloy/src/typescript/components/typescript-interface.cjs +68 -0
  81. package/dist/plugin-alloy/src/typescript/components/typescript-interface.d.cts +4 -0
  82. package/dist/plugin-alloy/src/typescript/components/typescript-interface.d.mts +4 -0
  83. package/dist/plugin-alloy/src/typescript/components/typescript-interface.mjs +67 -0
  84. package/dist/plugin-alloy/src/typescript/components/typescript-object.cjs +124 -0
  85. package/dist/plugin-alloy/src/typescript/components/typescript-object.mjs +123 -0
  86. package/dist/plugin-automd/src/index.cjs +101 -0
  87. package/dist/plugin-automd/src/index.mjs +98 -0
  88. package/dist/plugin-automd/src/types/plugin.d.cts +38 -0
  89. package/dist/plugin-automd/src/types/plugin.d.mts +40 -0
  90. package/dist/plugin-automd/src/types/toc.d.cts +33 -0
  91. package/dist/plugin-automd/src/types/toc.d.mts +33 -0
  92. package/dist/plugin-babel/src/helpers/ast-utils.cjs +10 -0
  93. package/dist/plugin-babel/src/helpers/ast-utils.mjs +9 -0
  94. package/dist/plugin-babel/src/helpers/create-plugin.cjs +41 -0
  95. package/dist/plugin-babel/src/helpers/create-plugin.mjs +39 -0
  96. package/dist/plugin-babel/src/helpers/filters.cjs +23 -0
  97. package/dist/plugin-babel/src/helpers/filters.mjs +21 -0
  98. package/dist/plugin-babel/src/helpers/index.cjs +5 -0
  99. package/dist/plugin-babel/src/helpers/index.mjs +7 -0
  100. package/dist/plugin-babel/src/helpers/module-helpers.cjs +38 -0
  101. package/dist/plugin-babel/src/helpers/module-helpers.mjs +35 -0
  102. package/dist/plugin-babel/src/helpers/options.cjs +50 -0
  103. package/dist/plugin-babel/src/helpers/options.mjs +47 -0
  104. package/dist/plugin-babel/src/index.cjs +91 -0
  105. package/dist/plugin-babel/src/index.mjs +89 -0
  106. package/dist/plugin-babel/src/types/index.d.mts +1 -0
  107. package/dist/plugin-babel/src/types/plugin.d.cts +15 -0
  108. package/dist/plugin-babel/src/types/plugin.d.mts +15 -0
  109. package/dist/plugin-env/src/babel/index.cjs +1 -0
  110. package/dist/plugin-env/src/babel/index.mjs +3 -0
  111. package/dist/plugin-env/src/babel/plugin.cjs +121 -0
  112. package/dist/plugin-env/src/babel/plugin.mjs +119 -0
  113. package/dist/plugin-env/src/components/docs.cjs +9 -0
  114. package/dist/plugin-env/src/components/docs.mjs +11 -0
  115. package/dist/plugin-env/src/components/env.cjs +575 -0
  116. package/dist/plugin-env/src/components/env.d.cts +11 -0
  117. package/dist/plugin-env/src/components/env.d.mts +11 -0
  118. package/dist/plugin-env/src/components/env.mjs +572 -0
  119. package/dist/plugin-env/src/components/index.cjs +2 -0
  120. package/dist/plugin-env/src/components/index.mjs +4 -0
  121. package/dist/plugin-env/src/helpers/automd-generator.cjs +22 -0
  122. package/dist/plugin-env/src/helpers/automd-generator.mjs +21 -0
  123. package/dist/plugin-env/src/helpers/create-reflection-resource.cjs +55 -0
  124. package/dist/plugin-env/src/helpers/create-reflection-resource.mjs +54 -0
  125. package/dist/plugin-env/src/helpers/index.cjs +6 -0
  126. package/dist/plugin-env/src/helpers/index.mjs +8 -0
  127. package/dist/plugin-env/src/helpers/load.cjs +83 -0
  128. package/dist/plugin-env/src/helpers/load.mjs +80 -0
  129. package/dist/plugin-env/src/helpers/persistence.cjs +199 -0
  130. package/dist/plugin-env/src/helpers/persistence.mjs +188 -0
  131. package/dist/plugin-env/src/helpers/reflect.cjs +111 -0
  132. package/dist/plugin-env/src/helpers/reflect.mjs +103 -0
  133. package/dist/plugin-env/src/helpers/source-file-env.cjs +24 -0
  134. package/dist/plugin-env/src/helpers/source-file-env.mjs +23 -0
  135. package/dist/plugin-env/src/helpers/template-helpers.cjs +2 -0
  136. package/dist/plugin-env/src/helpers/template-helpers.mjs +4 -0
  137. package/dist/plugin-env/src/index.cjs +175 -0
  138. package/dist/plugin-env/src/index.mjs +173 -0
  139. package/dist/plugin-env/src/types/plugin.d.cts +152 -0
  140. package/dist/plugin-env/src/types/plugin.d.mts +153 -0
  141. package/dist/plugin-env/src/types/runtime.d.cts +792 -0
  142. package/dist/plugin-env/src/types/runtime.d.mts +792 -0
  143. package/dist/powerlines/src/lib/build/esbuild.cjs +102 -0
  144. package/dist/powerlines/src/lib/build/esbuild.mjs +100 -0
  145. package/dist/powerlines/src/lib/entry.cjs +12 -0
  146. package/dist/powerlines/src/lib/entry.mjs +14 -0
  147. package/dist/powerlines/src/lib/logger.cjs +41 -0
  148. package/dist/powerlines/src/lib/logger.mjs +39 -0
  149. package/dist/powerlines/src/lib/typescript/tsconfig.cjs +38 -0
  150. package/dist/powerlines/src/lib/typescript/tsconfig.mjs +35 -0
  151. package/dist/powerlines/src/lib/utilities/bundle.cjs +35 -0
  152. package/dist/powerlines/src/lib/utilities/bundle.mjs +34 -0
  153. package/dist/powerlines/src/lib/utilities/resolve.cjs +30 -0
  154. package/dist/powerlines/src/lib/utilities/resolve.mjs +29 -0
  155. package/dist/powerlines/src/plugin-utils/paths.cjs +1 -0
  156. package/dist/powerlines/src/plugin-utils/paths.mjs +3 -0
  157. package/dist/powerlines/src/types/babel.d.cts +22 -0
  158. package/dist/powerlines/src/types/babel.d.mts +22 -0
  159. package/dist/powerlines/src/types/build.d.cts +145 -0
  160. package/dist/powerlines/src/types/build.d.mts +145 -0
  161. package/dist/powerlines/src/types/commands.d.cts +8 -0
  162. package/dist/powerlines/src/types/commands.d.mts +9 -0
  163. package/dist/powerlines/src/types/config.d.cts +387 -0
  164. package/dist/powerlines/src/types/config.d.mts +388 -0
  165. package/dist/powerlines/src/types/context.d.cts +414 -0
  166. package/dist/powerlines/src/types/context.d.mts +416 -0
  167. package/dist/powerlines/src/types/fs.d.cts +486 -0
  168. package/dist/powerlines/src/types/fs.d.mts +486 -0
  169. package/dist/powerlines/src/types/hooks.d.mts +2 -0
  170. package/dist/powerlines/src/types/plugin.d.cts +231 -0
  171. package/dist/powerlines/src/types/plugin.d.mts +231 -0
  172. package/dist/powerlines/src/types/resolved.d.cts +82 -0
  173. package/dist/powerlines/src/types/resolved.d.mts +82 -0
  174. package/dist/powerlines/src/types/tsconfig.d.cts +69 -0
  175. package/dist/powerlines/src/types/tsconfig.d.mts +69 -0
  176. package/dist/types/index.cjs +0 -2
  177. package/dist/types/index.d.cts +1 -3
  178. package/dist/types/index.d.mts +1 -3
  179. package/dist/types/index.mjs +0 -3
  180. package/dist/types/plugin.cjs +0 -1
  181. package/dist/types/plugin.d.cts +22 -2
  182. package/dist/types/plugin.d.mts +22 -2
  183. package/dist/types/plugin.mjs +0 -2
  184. package/package.json +6 -6
  185. package/dist/components-BWLXb7a2.cjs +0 -0
  186. package/dist/components-CXZYcH4q.d.mts +0 -1816
  187. package/dist/components-kh0CpIG2.mjs +0 -1
  188. package/dist/env-CAhIy_H3.cjs +0 -11713
  189. package/dist/env-CUyFiniR.d.cts +0 -107
  190. package/dist/env-IF4XhMjG.mjs +0 -11570
  191. package/dist/env-sRb-Y8mJ.d.mts +0 -89
  192. package/dist/index-CUbWeWHc.d.mts +0 -1
  193. package/dist/index-D6CnpA_r.d.cts +0 -1
  194. package/dist/index-DL0uimUT.d.mts +0 -1
  195. package/dist/index-DWPDThxu.d.cts +0 -1
  196. package/dist/plugin-ifZVa20V.mjs +0 -1
  197. package/dist/plugin-pBKbb5K9.cjs +0 -0
  198. package/dist/resolved-zsx09G03.d.cts +0 -1795
  199. package/dist/types-U3zd8PTP.mjs +0 -1
  200. package/dist/types-o3zWarRp.cjs +0 -0
@@ -1,22 +1,5 @@
1
- import { a as LogLevel, i as UserConfig, n as ResolvedConfig, o as PluginContext, r as BabelUserConfig, t as BabelResolvedConfig } from "./resolved-zsx09G03.cjs";
2
- import { Children, PrintTreeOptions } from "@alloy-js/core";
3
- import { DotenvConfiguration, TypeDefinition, TypeDefinitionParameter } from "@stryke/types/configuration";
4
- import { ReflectionClass } from "@powerlines/deepkit/vendor/type";
5
- import { Children as Children$1 } from "@alloy-js/core/jsx-runtime";
6
1
  import * as $ from "@stryke/capnp";
7
- import { Config } from "automd";
8
- import { DotenvParseOutput } from "@stryke/env/types";
9
2
 
10
- //#region ../plugin-babel/src/types/plugin.d.ts
11
- type BabelPluginOptions = Partial<BabelUserConfig>;
12
- type BabelPluginUserConfig = UserConfig;
13
- interface BabelPluginResolvedConfig extends ResolvedConfig {
14
- transform: {
15
- babel: BabelResolvedConfig;
16
- };
17
- }
18
- type BabelPluginContext<TResolvedConfig extends BabelPluginResolvedConfig = BabelPluginResolvedConfig> = PluginContext<TResolvedConfig>;
19
- //#endregion
20
3
  //#region ../deepkit/schemas/reflection.d.ts
21
4
  declare const ReflectionKind: {
22
5
  readonly NEVER: 0;
@@ -1574,1064 +1557,4 @@ declare class SerializedTypes extends $.Struct {
1574
1557
  toString(): string;
1575
1558
  }
1576
1559
  //#endregion
1577
- //#region ../deepkit/src/types.d.ts
1578
- type Reflection<T extends Record<string, any> = Record<string, any>> = ReflectionClass<T> & {
1579
- dataBuffer?: ArrayBuffer;
1580
- messageRoot?: SerializedTypes;
1581
- };
1582
- //#endregion
1583
- //#region ../plugin-alloy/src/types/plugin.d.ts
1584
- type AlloyPluginOptions = Partial<PrintTreeOptions> & {
1585
- /**
1586
- * If true, the Alloy framework is used to generate Typescript output files.
1587
- *
1588
- * @defaultValue true
1589
- */
1590
- typescript?: boolean;
1591
- /**
1592
- * If true, the Alloy framework is used to generate JSON output files.
1593
- *
1594
- * @defaultValue false
1595
- */
1596
- json?: boolean;
1597
- /**
1598
- * If true, the Alloy framework is used to generate Markdown output files.
1599
- *
1600
- * @defaultValue false
1601
- */
1602
- markdown?: boolean;
1603
- };
1604
- type AlloyPluginUserConfig = UserConfig & {
1605
- alloy?: AlloyPluginOptions;
1606
- };
1607
- type AlloyPluginResolvedConfig = ResolvedConfig & {
1608
- alloy: AlloyPluginOptions;
1609
- };
1610
- type AlloyPluginContext<TResolvedConfig extends AlloyPluginResolvedConfig = AlloyPluginResolvedConfig> = PluginContext<TResolvedConfig> & {
1611
- render: <TContext extends AlloyPluginContext>(this: TContext, children: Children) => Promise<void>;
1612
- };
1613
- //#endregion
1614
- //#region ../plugin-automd/src/types/toc.d.ts
1615
- interface TOCOptions {
1616
- /**
1617
- * A slugify function to generate slugs for the headings.
1618
- */
1619
- slugify?: (str: string) => string;
1620
- /**
1621
- * The maximum depth of headings to include in the TOC.
1622
- *
1623
- * @defaultValue 6
1624
- */
1625
- maxDepth?: number;
1626
- /**
1627
- * Whether to include the first H1 heading in the TOC.
1628
- */
1629
- firstH1?: boolean;
1630
- /**
1631
- * The bullet character to use for list items in the TOC.
1632
- *
1633
- * @defaultValue "-"
1634
- */
1635
- bullets?: string;
1636
- /**
1637
- * A prefix to add to each heading in the TOC.
1638
- */
1639
- prefix?: string;
1640
- /**
1641
- * A filter function to determine which headings to include in the TOC.
1642
- */
1643
- filter?: (str: string, level: number) => boolean;
1644
- }
1645
- //#endregion
1646
- //#region ../plugin-automd/src/types/plugin.d.ts
1647
- type AutoMDPluginOptions = Omit<Config, "dir" | "watch" | "onWatch" | "prefix"> & {
1648
- /**
1649
- * Path to the AutoMD configuration file.
1650
- *
1651
- * @remarks
1652
- * If not provided, the plugin will use the default AutoMD configuration resolution mechanism.
1653
- */
1654
- configFile?: string;
1655
- /**
1656
- * An indicator specifying whether or not issues found by AutoMD during the prepare task are considered fatal.
1657
- *
1658
- * @defaultValue true
1659
- */
1660
- allowIssues?: boolean;
1661
- /**
1662
- * Alternate prefix strings to use for finding generators
1663
- *
1664
- * @remarks
1665
- * By default, AutoMD looks for generators with the "automd" prefix, so that any `<!-- automd:generator [...args] --> ... <!-- /automd -->` comments will be picked up. If you want to use different prefixes (for example, to avoid conflicts with other tools), you would provide a value like "myPrefix" and AutoMD would also look for `<!-- myPrefix:generator [...args] --> ... <!-- /myPrefix -->` comments.
1666
- *
1667
- * @defaultValue ["automd", "powerlines", "\{framework\}"]
1668
- */
1669
- prefix?: string | string[];
1670
- /**
1671
- * Table of Contents generator options
1672
- *
1673
- * @remarks
1674
- * If set to `false`, the built-in Table of Contents generator will be disabled.
1675
- */
1676
- toc?: false | TOCOptions;
1677
- };
1678
- //#endregion
1679
- //#region ../plugin-env/src/types/runtime.d.ts
1680
- /**
1681
- * The base environment configuration used by Powerlines applications
1682
- *
1683
- * @remarks
1684
- * This interface is used to define the environment variables, configuration options, and runtime settings used by applications. It is used to provide type safety, autocompletion, and default values for the environment variables. The comments of each variable are used to provide documentation descriptions when running the \`powerlines docs\` command.
1685
- *
1686
- * @categoryDescription Platform
1687
- * The name of the platform the configuration parameter is intended for use in.
1688
- *
1689
- * @showCategories
1690
- */
1691
- interface EnvInterface {
1692
- /**
1693
- * The name of the application.
1694
- *
1695
- * @readonly
1696
- * @category neutral
1697
- */
1698
- readonly APP_NAME: string;
1699
- /**
1700
- * The version of the application.
1701
- *
1702
- * @defaultValue "1.0.0"
1703
- *
1704
- * @readonly
1705
- * @category neutral
1706
- */
1707
- readonly APP_VERSION: string;
1708
- /**
1709
- * The unique identifier for the build.
1710
- *
1711
- * @readonly
1712
- * @category neutral
1713
- */
1714
- readonly BUILD_ID: string;
1715
- /**
1716
- * The timestamp the build was ran at.
1717
- *
1718
- * @readonly
1719
- * @category neutral
1720
- */
1721
- readonly BUILD_TIMESTAMP: string;
1722
- /**
1723
- * A checksum hash created during the build.
1724
- *
1725
- * @readonly
1726
- * @category neutral
1727
- */
1728
- readonly BUILD_CHECKSUM: string;
1729
- /**
1730
- * The unique identifier for the release.
1731
- *
1732
- * @readonly
1733
- * @category neutral
1734
- */
1735
- readonly RELEASE_ID: string;
1736
- /**
1737
- * The tag for the release. This is generally in the format of "\<APP_NAME\>\@\<APP_VERSION\>".
1738
- *
1739
- * @readonly
1740
- * @category neutral
1741
- */
1742
- readonly RELEASE_TAG: string;
1743
- /**
1744
- * The name of the organization that maintains the application.
1745
- *
1746
- * @remarks
1747
- * This variable is used to specify the name of the organization that maintains the application. If not provided in an environment, it will try to use the value in {@link @storm-software/config-tools/StormWorkspaceConfig#organization}.
1748
- *
1749
- * @alias ORG
1750
- * @alias ORG_ID
1751
- * @category neutral
1752
- */
1753
- ORGANIZATION: string;
1754
- /**
1755
- * The platform for which the application was built.
1756
- *
1757
- * @defaultValue "neutral"
1758
- *
1759
- * @category neutral
1760
- */
1761
- PLATFORM: "node" | "neutral" | "browser";
1762
- /**
1763
- * The mode in which the application is running.
1764
- *
1765
- * @defaultValue "production"
1766
- *
1767
- * @alias NODE_ENV
1768
- *
1769
- * @category neutral
1770
- */
1771
- MODE: "development" | "test" | "production";
1772
- /**
1773
- * The environment the application is running in. This value will be populated with the value of `MODE` if not provided.
1774
- *
1775
- * @defaultValue "production"
1776
- *
1777
- * @alias ENV
1778
- * @alias VERCEL_ENV
1779
- * @category neutral
1780
- */
1781
- ENVIRONMENT: string;
1782
- /**
1783
- * Indicates if the application is running in debug mode.
1784
- *
1785
- * @category neutral
1786
- */
1787
- DEBUG: boolean;
1788
- /**
1789
- * An indicator that specifies the current runtime is a test environment.
1790
- *
1791
- * @category neutral
1792
- */
1793
- TEST: boolean;
1794
- /**
1795
- * An indicator that specifies the current runtime is a minimal environment.
1796
- *
1797
- * @category node
1798
- */
1799
- MINIMAL: boolean;
1800
- /**
1801
- * An indicator that specifies the current runtime is a no color environment.
1802
- *
1803
- * @category node
1804
- */
1805
- NO_COLOR: boolean;
1806
- /**
1807
- * An indicator that specifies the current runtime is a force color environment.
1808
- *
1809
- * @category node
1810
- */
1811
- FORCE_COLOR: boolean | number;
1812
- /**
1813
- * An indicator that specifies the current runtime should force hyperlinks in terminal output.
1814
- *
1815
- * @remarks
1816
- * This variable is used to force hyperlinks in terminal output, even if the terminal does not support them. This is useful for debugging and development purposes.
1817
- * @category node
1818
- */
1819
- FORCE_HYPERLINK: boolean | number;
1820
- /**
1821
- * The name of the agent running the application. This variable is set by certain CI/CD systems.
1822
- *
1823
- * @readonly
1824
- * @category neutral
1825
- */
1826
- readonly AGENT_NAME?: string;
1827
- /**
1828
- * The color terminal type. This variable is set by certain terminal emulators.
1829
- *
1830
- * @readonly
1831
- * @category node
1832
- */
1833
- readonly COLORTERM?: string;
1834
- /**
1835
- * The terminal type. This variable is set by certain CI/CD systems.
1836
- *
1837
- * @remarks
1838
- * This variable is used to specify the terminal type that the application is running in. It can be used to determine how to format output for the terminal.
1839
- *
1840
- * @readonly
1841
- * @category node
1842
- */
1843
- readonly TERM?: string;
1844
- /**
1845
- * The terminal program name. This variable is set by certain terminal emulators.
1846
- *
1847
- * @readonly
1848
- * @category node
1849
- */
1850
- readonly TERM_PROGRAM?: string;
1851
- /**
1852
- * The terminal program version. This variable is set by certain terminal emulators.
1853
- *
1854
- * @readonly
1855
- * @category node
1856
- */
1857
- readonly TERM_PROGRAM_VERSION?: string;
1858
- /**
1859
- * The terminal emulator name. This variable is set by certain terminal emulators.
1860
- *
1861
- * @readonly
1862
- * @category node
1863
- */
1864
- readonly TERMINAL_EMULATOR?: string;
1865
- /**
1866
- * The terminal emulator session ID. This variable is set by certain terminal emulators.
1867
- *
1868
- * @readonly
1869
- * @category node
1870
- */
1871
- readonly WT_SESSION?: string;
1872
- /**
1873
- * An indicator that specifies the current terminal is running Terminus Sublime. This variable is set by certain terminal emulators.
1874
- *
1875
- * @readonly
1876
- * @category node
1877
- */
1878
- readonly TERMINUS_SUBLIME?: boolean;
1879
- /**
1880
- * The ConEmu task name. This variable is set by certain terminal emulators.
1881
- *
1882
- * @readonly
1883
- * @category node
1884
- */
1885
- readonly ConEmuTask?: string;
1886
- /**
1887
- * The cursor trace ID. This variable is set by certain terminal emulators.
1888
- *
1889
- * @readonly
1890
- * @category node
1891
- */
1892
- readonly CURSOR_TRACE_ID?: string;
1893
- /**
1894
- * The VTE version. This variable is set by certain terminal emulators.
1895
- *
1896
- * @readonly
1897
- * @category node
1898
- */
1899
- readonly VTE_VERSION?: string;
1900
- /**
1901
- * Indicates if error stack traces should be captured.
1902
- *
1903
- * @category neutral
1904
- */
1905
- STACKTRACE: boolean;
1906
- /**
1907
- * Indicates if error data should be included.
1908
- *
1909
- * @category neutral
1910
- */
1911
- INCLUDE_ERROR_DATA: boolean;
1912
- /**
1913
- * A web page to lookup error messages and display additional information given an error code.
1914
- *
1915
- * @remarks
1916
- * This variable is used to provide a URL to a page that can be used to look up error messages given an error code. This is used to provide a more user-friendly error message to the user.
1917
- *
1918
- * @title Error Details URL
1919
- * @category neutral
1920
- */
1921
- ERROR_URL: string;
1922
- /**
1923
- * The default timezone for the application.
1924
- *
1925
- * @defaultValue "America/New_York"
1926
- * @category neutral
1927
- */
1928
- DEFAULT_TIMEZONE: string;
1929
- /**
1930
- * The default locale to be used in the application.
1931
- *
1932
- * @defaultValue "en_US"
1933
- * @category neutral
1934
- */
1935
- DEFAULT_LOCALE: string;
1936
- /**
1937
- * The default lowest log level to accept. If `null`, the logger will reject all records. This value only applies if `lowestLogLevel` is not provided to the `logs` configuration.
1938
- *
1939
- * @defaultValue "info"
1940
- *
1941
- * @category neutral
1942
- */
1943
- LOG_LEVEL?: LogLevel | null;
1944
- /**
1945
- * An indicator that specifies the current runtime is a continuous integration environment.
1946
- *
1947
- * @title Continuous Integration
1948
- * @alias CONTINUOUS_INTEGRATION
1949
- * @category neutral
1950
- */
1951
- CI: boolean;
1952
- /**
1953
- * The unique identifier for the current run. This value is set by certain CI/CD systems.
1954
- *
1955
- * @readonly
1956
- * @category node
1957
- */
1958
- readonly RUN_ID?: string;
1959
- /**
1960
- * The agola git reference. This value is set by certain CI/CD systems.
1961
- *
1962
- * @readonly
1963
- * @category node
1964
- */
1965
- readonly AGOLA_GIT_REF?: string;
1966
- /**
1967
- * The appcircle build ID. This value is set by certain CI/CD systems.
1968
- *
1969
- * @readonly
1970
- * @category node
1971
- */
1972
- readonly AC_APPCIRCLE?: string;
1973
- /**
1974
- * The appveyor build ID. This value is set by certain CI/CD systems.
1975
- *
1976
- * @readonly
1977
- * @category node
1978
- */
1979
- readonly APPVEYOR?: string;
1980
- /**
1981
- * The codebuild build ID. This value is set by certain CI/CD systems.
1982
- *
1983
- * @readonly
1984
- * @category node
1985
- */
1986
- readonly CODEBUILD?: string;
1987
- /**
1988
- * The task force build ID. This value is set by certain CI/CD systems.
1989
- *
1990
- * @readonly
1991
- * @category node
1992
- */
1993
- readonly TF_BUILD?: string;
1994
- /**
1995
- * The bamboo plan key. This value is set by certain CI/CD systems.
1996
- *
1997
- * @readonly
1998
- * @category node
1999
- */
2000
- readonly bamboo_planKey?: string;
2001
- /**
2002
- * The bitbucket commit. This value is set by certain CI/CD systems.
2003
- *
2004
- * @readonly
2005
- * @category node
2006
- */
2007
- readonly BITBUCKET_COMMIT?: string;
2008
- /**
2009
- * The bitrise build ID. This value is set by certain CI/CD systems.
2010
- *
2011
- * @readonly
2012
- * @category node
2013
- */
2014
- readonly BITRISE_IO?: string;
2015
- /**
2016
- * The buddy workspace ID. This value is set by certain CI/CD systems.
2017
- *
2018
- * @readonly
2019
- * @category node
2020
- */
2021
- readonly BUDDY_WORKSPACE_ID?: string;
2022
- /**
2023
- * The buildkite build ID. This value is set by certain CI/CD systems.
2024
- *
2025
- * @readonly
2026
- * @category node
2027
- */
2028
- readonly BUILDKITE?: string;
2029
- /**
2030
- * The circleci build ID. This value is set by certain CI/CD systems.
2031
- *
2032
- * @readonly
2033
- * @category node
2034
- */
2035
- readonly CIRCLECI?: string;
2036
- /**
2037
- * The cirrus-ci build ID. This value is set by certain CI/CD systems.
2038
- *
2039
- * @readonly
2040
- * @category node
2041
- */
2042
- readonly CIRRUS_CI?: string;
2043
- /**
2044
- * The cf build ID. This value is set by certain CI/CD systems.
2045
- *
2046
- * @readonly
2047
- * @category node
2048
- */
2049
- readonly CF_BUILD_ID?: string;
2050
- /**
2051
- * The cm build ID. This value is set by certain CI/CD systems.
2052
- *
2053
- * @readonly
2054
- * @category node
2055
- */
2056
- readonly CM_BUILD_ID?: string;
2057
- /**
2058
- * The ci name. This value is set by certain CI/CD systems.
2059
- *
2060
- * @readonly
2061
- * @category node
2062
- */
2063
- readonly CI_NAME?: string;
2064
- /**
2065
- * The drone build ID. This value is set by certain CI/CD systems.
2066
- *
2067
- * @readonly
2068
- * @category node
2069
- */
2070
- readonly DRONE?: string;
2071
- /**
2072
- * The dsari build ID. This value is set by certain CI/CD systems.
2073
- *
2074
- * @readonly
2075
- * @category node
2076
- */
2077
- readonly DSARI?: string;
2078
- /**
2079
- * The earthly build ID. This value is set by certain CI/CD systems.
2080
- *
2081
- * @readonly
2082
- * @category node
2083
- */
2084
- readonly EARTHLY_CI?: string;
2085
- /**
2086
- * The eas build ID. This value is set by certain CI/CD systems.
2087
- *
2088
- * @readonly
2089
- * @category node
2090
- */
2091
- readonly EAS_BUILD?: string;
2092
- /**
2093
- * The gerrit project. This value is set by certain CI/CD systems.
2094
- *
2095
- * @readonly
2096
- * @category node
2097
- */
2098
- readonly GERRIT_PROJECT?: string;
2099
- /**
2100
- * The gitea actions build ID. This value is set by certain CI/CD systems.
2101
- *
2102
- * @readonly
2103
- * @category node
2104
- */
2105
- readonly GITEA_ACTIONS?: string;
2106
- /**
2107
- * The github actions build ID. This value is set by certain CI/CD systems.
2108
- *
2109
- * @readonly
2110
- * @category node
2111
- */
2112
- readonly GITHUB_ACTIONS?: string;
2113
- /**
2114
- * The gitlab ci build ID. This value is set by certain CI/CD systems.
2115
- *
2116
- * @readonly
2117
- * @category node
2118
- */
2119
- readonly GITLAB_CI?: string;
2120
- /**
2121
- * The go cd build ID. This value is set by certain CI/CD systems.
2122
- *
2123
- * @readonly
2124
- * @category node
2125
- */
2126
- readonly GOCD?: string;
2127
- /**
2128
- * The builder output build ID. This value is set by certain CI/CD systems.
2129
- *
2130
- * @readonly
2131
- * @category node
2132
- */
2133
- readonly BUILDER_OUTPUT?: string;
2134
- /**
2135
- * The harness build ID. This value is set by certain CI/CD systems.
2136
- *
2137
- * @readonly
2138
- * @category node
2139
- */
2140
- readonly HARNESS_BUILD_ID?: string;
2141
- /**
2142
- * The jenkins url. This value is set by certain CI/CD systems.
2143
- *
2144
- * @readonly
2145
- * @category node
2146
- */
2147
- readonly JENKINS_URL?: string;
2148
- /**
2149
- * The layerci build ID. This value is set by certain CI/CD systems.
2150
- *
2151
- * @readonly
2152
- * @category node
2153
- */
2154
- readonly LAYERCI?: string;
2155
- /**
2156
- * The magnum build ID. This value is set by certain CI/CD systems.
2157
- *
2158
- * @readonly
2159
- * @category node
2160
- */
2161
- readonly MAGNUM?: string;
2162
- /**
2163
- * The netlify build ID. This value is set by certain CI/CD systems.
2164
- *
2165
- * @readonly
2166
- * @category node
2167
- */
2168
- readonly NETLIFY?: string;
2169
- /**
2170
- * The nevercode build ID. This value is set by certain CI/CD systems.
2171
- *
2172
- * @readonly
2173
- * @category node
2174
- */
2175
- readonly NEVERCODE?: string;
2176
- /**
2177
- * The prow job ID. This value is set by certain CI/CD systems.
2178
- *
2179
- * @readonly
2180
- * @category node
2181
- */
2182
- readonly PROW_JOB_ID?: string;
2183
- /**
2184
- * The release build ID. This value is set by certain CI/CD systems.
2185
- *
2186
- * @readonly
2187
- * @category node
2188
- */
2189
- readonly RELEASE_BUILD_ID?: string;
2190
- /**
2191
- * The render build ID. This value is set by certain CI/CD systems.
2192
- *
2193
- * @readonly
2194
- * @category node
2195
- */
2196
- readonly RENDER?: string;
2197
- /**
2198
- * The sailci build ID. This value is set by certain CI/CD systems.
2199
- *
2200
- * @readonly
2201
- * @category node
2202
- */
2203
- readonly SAILCI?: string;
2204
- /**
2205
- * The hudson build ID. This value is set by certain CI/CD systems.
2206
- *
2207
- * @readonly
2208
- * @category node
2209
- */
2210
- readonly HUDSON?: string;
2211
- /**
2212
- * The screwdriver build ID. This value is set by certain CI/CD systems.
2213
- *
2214
- * @readonly
2215
- * @category node
2216
- */
2217
- readonly SCREWDRIVER?: string;
2218
- /**
2219
- * The semaphore build ID. This value is set by certain CI/CD systems.
2220
- *
2221
- * @readonly
2222
- * @category node
2223
- */
2224
- readonly SEMAPHORE?: string;
2225
- /**
2226
- * The sourcehut build ID. This value is set by certain CI/CD systems.
2227
- *
2228
- * @readonly
2229
- * @category node
2230
- */
2231
- readonly SOURCEHUT?: string;
2232
- /**
2233
- * The spaceship build ID. This value is set by certain CI/CD systems.
2234
- *
2235
- * @readonly
2236
- * @category node
2237
- */
2238
- readonly SPACESHIP_CI?: string;
2239
- /**
2240
- * The strider build ID. This value is set by certain CI/CD systems.
2241
- *
2242
- * @readonly
2243
- * @category node
2244
- */
2245
- readonly STRIDER?: string;
2246
- /**
2247
- * The task ID. This value is set by certain CI/CD systems.
2248
- *
2249
- * @readonly
2250
- * @category node
2251
- */
2252
- readonly TASK_ID?: string;
2253
- /**
2254
- * The teamcity version. This value is set by certain CI/CD systems.
2255
- *
2256
- * @readonly
2257
- * @category node
2258
- */
2259
- readonly TEAMCITY_VERSION?: string;
2260
- /**
2261
- * The travis build ID. This value is set by certain CI/CD systems.
2262
- *
2263
- * @readonly
2264
- * @category node
2265
- */
2266
- readonly TRAVIS?: string;
2267
- /**
2268
- * The vela build ID. This value is set by certain CI/CD systems.
2269
- *
2270
- * @readonly
2271
- * @category node
2272
- */
2273
- readonly VELA?: string;
2274
- /**
2275
- * The now builder build ID. This value is set by certain CI/CD systems.
2276
- *
2277
- * @readonly
2278
- * @category node
2279
- */
2280
- readonly NOW_BUILDER?: string;
2281
- /**
2282
- * The appcenter build ID. This value is set by certain CI/CD systems.
2283
- *
2284
- * @readonly
2285
- * @category node
2286
- */
2287
- readonly APPCENTER_BUILD_ID?: string;
2288
- /**
2289
- * The xcode project build ID. This value is set by certain CI/CD systems.
2290
- *
2291
- * @readonly
2292
- * @category node
2293
- */
2294
- readonly CI_XCODE_PROJECT?: string;
2295
- /**
2296
- * The xcode server build ID. This value is set by certain CI/CD systems.
2297
- *
2298
- * @readonly
2299
- * @category node
2300
- */
2301
- readonly XCS?: string;
2302
- /**
2303
- * The application's runtime data directory.
2304
- *
2305
- * @remarks
2306
- * This variable is used to override the base path of the system's local application data directory. This variable is used to set the \`$storm.paths.data\` property.
2307
- *
2308
- * @title Data Directory
2309
- * @category node
2310
- */
2311
- DATA_DIR?: string;
2312
- /**
2313
- * The application's configuration data directory.
2314
- *
2315
- * @remarks
2316
- * This variable is used to override the base path of the system's local application configuration directory. This variable is used to set the \`$storm.paths.config\` property.
2317
- *
2318
- * @title Configuration Directory
2319
- * @category node
2320
- */
2321
- CONFIG_DIR?: string;
2322
- /**
2323
- * The application's cached data directory.
2324
- *
2325
- * @remarks
2326
- * This variable is used to override the base path of the system's local cache data directory. This variable is used to set the \`$storm.paths.cache\` property.
2327
- *
2328
- * @title Cache Directory
2329
- * @category node
2330
- */
2331
- CACHE_DIR?: string;
2332
- /**
2333
- * The application's logging directory.
2334
- *
2335
- * @remarks
2336
- * This variable is used to override the base path of the system's local application log directory. This variable is used to set the \`$storm.paths.log\` property.
2337
- *
2338
- * @title Log Directory
2339
- * @category node
2340
- */
2341
- LOG_DIR?: string;
2342
- /**
2343
- * The application's temporary data directory.
2344
- *
2345
- * @remarks
2346
- * This variable is used to override the base path of the system's local temporary data directory. This variable is used to set the \`$storm.paths.temp\` property.
2347
- *
2348
- * @title Temporary Directory
2349
- * @category node
2350
- */
2351
- TEMP_DIR?: string;
2352
- /**
2353
- * A variable that specifies the current user's local application data directory on Windows.
2354
- *
2355
- * @see https://www.advancedinstaller.com/appdata-localappdata-programdata.html
2356
- *
2357
- * @remarks
2358
- * This variable is used to specify a path to application data that is specific to the current user. This variable can be used to set the \`$storm.paths.data\`, \`$storm.paths.cache\`, and \`$storm.paths.log\` properties.
2359
- *
2360
- * @readonly
2361
- * @category node
2362
- */
2363
- readonly LOCALAPPDATA?: string;
2364
- /**
2365
- * A variable that specifies the application data directory on Windows.
2366
- *
2367
- * @see https://www.advancedinstaller.com/appdata-localappdata-programdata.html
2368
- *
2369
- * @remarks
2370
- * This variable is used to specify a path to application data that is specific to the current user. This variable can be used to set the \`$storm.paths.config\` property.
2371
- *
2372
- * @readonly
2373
- * @category node
2374
- */
2375
- readonly APPDATA?: string;
2376
- /**
2377
- * A variable that specifies the data path in the home directory on Linux systems using the XDG base directory specification.
2378
- *
2379
- * @see https://gist.github.com/roalcantara/107ba66dfa3b9d023ac9329e639bc58c
2380
- *
2381
- * @remarks
2382
- * This variable is used to specify a path to application data that is specific to the current user. This variable can be used to set the \`$storm.paths.data\` property.
2383
- *
2384
- * @readonly
2385
- * @category node
2386
- */
2387
- readonly XDG_DATA_HOME?: string;
2388
- /**
2389
- * A variable that specifies the configuration path in the home directory on Linux systems using the XDG base directory specification.
2390
- *
2391
- * @see https://gist.github.com/roalcantara/107ba66dfa3b9d023ac9329e639bc58c
2392
- *
2393
- * @remarks
2394
- * This variable is used to specify a path to configuration data that is specific to the current user. This variable can be used to set the \`$storm.paths.config\` property.
2395
- *
2396
- * @readonly
2397
- * @category node
2398
- */
2399
- readonly XDG_CONFIG_HOME?: string;
2400
- /**
2401
- * A variable that specifies the cache path in the home directory on Linux systems using the XDG base directory specification.
2402
- *
2403
- * @see https://gist.github.com/roalcantara/107ba66dfa3b9d023ac9329e639bc58c
2404
- *
2405
- * @remarks
2406
- * This variable is used to specify a path to cache data that is specific to the current user. This variable can be used to set the \`$storm.paths.cache\` property.
2407
- *
2408
- * @readonly
2409
- * @category node
2410
- */
2411
- readonly XDG_CACHE_HOME?: string;
2412
- /**
2413
- * A variable that specifies the state directory on Linux systems using the XDG base directory specification.
2414
- *
2415
- * @see https://gist.github.com/roalcantara/107ba66dfa3b9d023ac9329e639bc58c
2416
- *
2417
- * @remarks
2418
- * This variable is used to specify a path to application state data that is specific to the current user. This variable can be used to set the \`$storm.paths.state\` property.
2419
- *
2420
- * @readonly
2421
- * @category node
2422
- */
2423
- readonly XDG_STATE_HOME?: string;
2424
- /**
2425
- * A variable that specifies the runtime directory on Linux systems using the XDG base directory specification.
2426
- *
2427
- * @see https://gist.github.com/roalcantara/107ba66dfa3b9d023ac9329e639bc58c
2428
- *
2429
- * @remarks
2430
- * This variable is used to specify a path to runtime data that is specific to the current user. This variable can be used to set the \`$storm.paths.temp\` property.
2431
- *
2432
- * @readonly
2433
- * @category node
2434
- */
2435
- readonly XDG_RUNTIME_DIR?: string;
2436
- /**
2437
- * A variable that specifies the [Devenv](https://devenv.sh/) runtime directory.
2438
- *
2439
- * @see https://devenv.sh/files-and-variables/#devenv_dotfile
2440
- * @see https://nixos.org/
2441
- *
2442
- * @remarks
2443
- * This variable is used to specify a path to application data that is specific to the current [Nix](https://nixos.org/) environment. This variable can be used to set the \`$storm.paths.temp\` property.
2444
- *
2445
- * @category node
2446
- */
2447
- DEVENV_RUNTIME?: string;
2448
- }
2449
- /**
2450
- * The base secrets configuration used by Powerlines applications
2451
- *
2452
- * @remarks
2453
- * This interface is used to define the secret configuration options used by Powerlines applications. It is used to provide type safety, autocompletion, and default values for the environment variables. The comments of each variable are used to provide documentation descriptions when running the \`storm docs\` command. Since these are secrets, no default values should be provided and the values should be kept confidential (excluded from the client).
2454
- */
2455
- interface SecretsInterface {
2456
- /**
2457
- * The secret key used for encryption and decryption.
2458
- *
2459
- * @remarks
2460
- * This variable is used to provide a secret key for encryption and decryption of sensitive data. It is important that this value is kept confidential and not exposed in client-side code or public repositories.
2461
- *
2462
- * @title Encryption Key
2463
- */
2464
- ENCRYPTION_KEY: string;
2465
- }
2466
- //#endregion
2467
- //#region ../plugin-env/src/types/plugin.d.ts
2468
- type EnvPluginOptions = Omit<DotenvConfiguration, "types"> & {
2469
- /**
2470
- * A path to the type definition for the expected env configuration parameters. This value can include both a path to the typescript file and the name of the type definition to use separated by a `":"` or `"#"` character. For example: `"./src/types/env.ts#ConfigConfiguration"`.
2471
- */
2472
- types?: TypeDefinitionParameter;
2473
- /**
2474
- * A path to the type definition for the expected env secret parameters. This value can include both a path to the typescript file and the name of the type definition to use separated by a `":"` or `"#"` character. For example: `"./src/types/env.ts#ConfigSecrets"`.
2475
- */
2476
- secrets?: TypeDefinitionParameter;
2477
- /**
2478
- * An additional prefix (or list of additional prefixes) to apply to the environment variables
2479
- *
2480
- * @remarks
2481
- * By default, the plugin will use the `POWERLINES_` prefix. This option is useful for avoiding conflicts with other environment variables.
2482
- */
2483
- prefix?: string | string[];
2484
- /**
2485
- * Should the plugin inject the env variables in the source code with their values?
2486
- *
2487
- * @remarks
2488
- * This option is set to `true` when building an application project.
2489
- *
2490
- * @defaultValue false
2491
- */
2492
- inject?: boolean;
2493
- /**
2494
- * The default configuration to use when loading environment variables.
2495
- *
2496
- * @remarks
2497
- * This configuration is used as the base configuration when loading environment variables, and will be overridden by any values found in the `.env` file or the process environment.
2498
- */
2499
- defaultConfig?: Children$1;
2500
- /**
2501
- * Babel configuration options to use when injecting environment variables into the source code.
2502
- *
2503
- * @remarks
2504
- * This option allows you to customize the Babel transformation process used to inject environment variables into the source code. If not provided, the plugin will use default Babel settings.
2505
- */
2506
- babel?: BabelPluginOptions;
2507
- /**
2508
- * AutoMD configuration options to allow injecting environment variables documentation into a markdown file such as a README.md.
2509
- *
2510
- * @remarks
2511
- * The README.md file should contain the `<!-- automd:env --><!-- /automd -->` comment block where the documentation will be injected.
2512
- */
2513
- automd?: AutoMDPluginOptions;
2514
- /**
2515
- * Alloy configuration options to use when injecting environment variables into the source code.
2516
- *
2517
- * @remarks
2518
- * This option allows you to customize the Alloy transformation process used to inject environment variables into the source code. If not provided, the plugin will use default Alloy settings.
2519
- */
2520
- alloy?: AlloyPluginOptions;
2521
- };
2522
- type EnvPluginUserConfig = BabelPluginUserConfig & AlloyPluginUserConfig & {
2523
- env: EnvPluginOptions;
2524
- };
2525
- type EnvPluginResolvedConfig = BabelPluginResolvedConfig & AlloyPluginResolvedConfig & {
2526
- env: Required<Pick<DotenvConfiguration, "additionalFiles">> & Required<Pick<EnvPluginOptions, "defaultConfig">> & {
2527
- /**
2528
- * The type definition for the expected env variable parameters
2529
- *
2530
- * @remarks
2531
- * This value is parsed from the {@link EnvPluginOptions.types} option.
2532
- */
2533
- types: TypeDefinition;
2534
- /**
2535
- * The type definition for the expected env secret parameters
2536
- *
2537
- * @remarks
2538
- * This value is parsed from the {@link EnvPluginOptions.secrets} option.
2539
- */
2540
- secrets: TypeDefinition;
2541
- /**
2542
- * Should the plugin inject the env variables in the source code with their values?
2543
- *
2544
- * @remarks
2545
- * This value is the result of reflecting the {@link EnvPluginOptions.inject} option.
2546
- */
2547
- inject: EnvPluginOptions["inject"];
2548
- /**
2549
- * The prefix used for environment variables
2550
- *
2551
- * @remarks
2552
- * This value is used to filter environment variables that are loaded from the .env file and the process environment.
2553
- */
2554
- prefix: string[];
2555
- };
2556
- };
2557
- interface EnvPluginContext<TResolvedConfig extends EnvPluginResolvedConfig = EnvPluginResolvedConfig> extends BabelPluginContext<TResolvedConfig>, AlloyPluginContext<TResolvedConfig> {
2558
- env: {
2559
- /**
2560
- * The type definitions reflection for the env variables and secrets
2561
- *
2562
- * @remarks
2563
- * These reflections contains the structure of the expected environment variables and secrets as defined by the type definitions provided in the plugin configuration.
2564
- */
2565
- types: {
2566
- /**
2567
- * The type definitions for the expected env variables
2568
- */
2569
- env: Reflection;
2570
- /**
2571
- * The type definitions for the expected env secrets
2572
- */
2573
- secrets: Reflection;
2574
- };
2575
- /**
2576
- * The current **used** environment variables and secrets reflection
2577
- *
2578
- * @remarks
2579
- * This reflection contains the structure of the current environment variables and secrets as defined during the plugin initialization by extracting the values from the source code.
2580
- */
2581
- used: {
2582
- /**
2583
- * The current env variables reflection
2584
- */
2585
- env: Reflection<EnvInterface>;
2586
- /**
2587
- * The current env secrets reflection
2588
- */
2589
- secrets: Reflection<SecretsInterface>;
2590
- };
2591
- /**
2592
- * The parsed .env configuration object
2593
- *
2594
- * @remarks
2595
- * This value is the result of loading the .env configuration file found in the project root directory and merging it with the values provided at {@link EnvPluginOptions.values}
2596
- */
2597
- parsed: DotenvParseOutput;
2598
- /**
2599
- * The injected environment variables and secrets reflection
2600
- *
2601
- * @remarks
2602
- * This reflection contains the structure of the injected environment variables and secrets that were injected into the source code during the build process.
2603
- */
2604
- injected: Reflection;
2605
- };
2606
- }
2607
- //#endregion
2608
- //#region src/types/plugin.d.ts
2609
- interface NodeJsPluginOptions {
2610
- /**
2611
- * Options to pass to the [Babel plugin](https://npmjs.com/package/\@powerlines/plugin-babel).
2612
- */
2613
- babel?: Partial<BabelPluginOptions>;
2614
- /**
2615
- * Options to pass to the [Env plugin](https://npmjs.com/package/\@powerlines/plugin-env).
2616
- */
2617
- env?: Partial<Omit<EnvPluginOptions, "babel">>;
2618
- }
2619
- type NodeJsPluginUserConfig = EnvPluginUserConfig & {
2620
- /**
2621
- * Options for the NodeJs plugin.
2622
- */
2623
- nodejs?: NodeJsPluginOptions;
2624
- };
2625
- type NodeJsPluginResolvedConfig = EnvPluginResolvedConfig & {
2626
- /**
2627
- * Options for the Node.js plugin.
2628
- */
2629
- nodejs: NodeJsPluginOptions;
2630
- };
2631
- interface NodeJsPluginContext<TResolvedConfig extends NodeJsPluginResolvedConfig = NodeJsPluginResolvedConfig> extends EnvPluginContext<TResolvedConfig> {}
2632
- declare type __ΩNodeJsPluginOptions = any[];
2633
- declare type __ΩNodeJsPluginUserConfig = any[];
2634
- declare type __ΩNodeJsPluginResolvedConfig = any[];
2635
- declare type __ΩNodeJsPluginContext = any[];
2636
- //#endregion
2637
- export { __ΩNodeJsPluginContext as a, __ΩNodeJsPluginUserConfig as c, NodeJsPluginUserConfig as i, NodeJsPluginOptions as n, __ΩNodeJsPluginOptions as o, NodeJsPluginResolvedConfig as r, __ΩNodeJsPluginResolvedConfig as s, NodeJsPluginContext as t };
1560
+ export { SerializedTypes };