@powerlines/plugin-env 0.16.364 → 0.16.365

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 (55) hide show
  1. package/dist/babel/plugin.cjs +4 -26
  2. package/dist/babel/plugin.mjs +4 -26
  3. package/dist/components/docs.cjs +4 -47
  4. package/dist/components/docs.mjs +4 -46
  5. package/dist/components/env-builtin.cjs +70 -250
  6. package/dist/components/env-builtin.mjs +70 -248
  7. package/dist/components/index.cjs +1 -4
  8. package/dist/components/index.mjs +3 -3
  9. package/dist/helpers/automd-generator.cjs +4 -12
  10. package/dist/helpers/automd-generator.mjs +4 -12
  11. package/dist/helpers/index.cjs +1 -1
  12. package/dist/helpers/index.d.cts +2 -2
  13. package/dist/helpers/index.d.mts +2 -2
  14. package/dist/helpers/index.mjs +2 -2
  15. package/dist/helpers/load.cjs +7 -59
  16. package/dist/helpers/load.d.cts +2 -2
  17. package/dist/helpers/load.d.mts +2 -2
  18. package/dist/helpers/load.mjs +7 -59
  19. package/dist/helpers/schema.cjs +35 -154
  20. package/dist/helpers/schema.d.cts +9 -8
  21. package/dist/helpers/schema.d.cts.map +1 -1
  22. package/dist/helpers/schema.d.mts +9 -8
  23. package/dist/helpers/schema.mjs +35 -154
  24. package/dist/helpers/source-file-env.cjs +4 -34
  25. package/dist/helpers/source-file-env.mjs +4 -34
  26. package/dist/index.cjs +20 -47
  27. package/dist/index.d.cts +2 -2
  28. package/dist/index.d.cts.map +1 -1
  29. package/dist/index.d.mts +2 -2
  30. package/dist/index.mjs +18 -39
  31. package/dist/schemas/env.cjs +723 -0
  32. package/dist/schemas/env.d.cts +230 -0
  33. package/dist/schemas/env.d.cts.map +1 -0
  34. package/dist/schemas/env.d.mts +230 -0
  35. package/dist/{types → schemas}/env.d.mts.map +1 -1
  36. package/dist/schemas/env.mjs +715 -0
  37. package/dist/schemas/index.cjs +10 -0
  38. package/dist/schemas/index.d.cts +2 -0
  39. package/dist/schemas/index.d.mts +2 -0
  40. package/dist/schemas/index.mjs +3 -0
  41. package/dist/types/index.cjs +0 -12
  42. package/dist/types/index.d.cts +1 -2
  43. package/dist/types/index.d.mts +1 -2
  44. package/dist/types/index.mjs +1 -4
  45. package/dist/types/plugin.cjs +7 -107
  46. package/dist/types/plugin.d.cts +2 -2
  47. package/dist/types/plugin.d.mts +2 -2
  48. package/dist/types/plugin.mjs +7 -100
  49. package/package.json +40 -25
  50. package/dist/types/env.cjs +0 -541
  51. package/dist/types/env.d.cts +0 -938
  52. package/dist/types/env.d.cts.map +0 -1
  53. package/dist/types/env.d.mts +0 -938
  54. package/dist/types/env.mjs +0 -539
  55. /package/dist/{types → schemas}/env.mjs.map +0 -0
@@ -1,938 +0,0 @@
1
- //#region src/types/env.d.ts
2
- /**
3
- * The base environment configuration used by Powerlines applications
4
- *
5
- * @remarks
6
- * 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.
7
- *
8
- * @categoryDescription Platform
9
- * The name of the platform the configuration parameter is intended for use in.
10
- *
11
- * @showCategories
12
- */
13
- interface EnvInterface {
14
- /**
15
- * The name of the application.
16
- *
17
- * @readonly
18
- * @category neutral
19
- */
20
- readonly APP_NAME: string;
21
- /**
22
- * The version of the application.
23
- *
24
- * @defaultValue "1.0.0"
25
- *
26
- * @readonly
27
- * @category neutral
28
- */
29
- readonly APP_VERSION: string;
30
- /**
31
- * The unique identifier for the build.
32
- *
33
- * @readonly
34
- * @category neutral
35
- */
36
- readonly BUILD_ID: string;
37
- /**
38
- * The timestamp the build was ran at.
39
- *
40
- * @readonly
41
- * @category neutral
42
- */
43
- readonly BUILD_TIMESTAMP: string;
44
- /**
45
- * A checksum hash created during the build.
46
- *
47
- * @readonly
48
- * @category neutral
49
- */
50
- readonly BUILD_CHECKSUM: string;
51
- /**
52
- * The unique identifier for the release.
53
- *
54
- * @readonly
55
- * @category neutral
56
- */
57
- readonly RELEASE_ID: string;
58
- /**
59
- * The tag for the release. This is generally in the format of "\<APP_NAME\>\@\<APP_VERSION\>".
60
- *
61
- * @readonly
62
- * @category neutral
63
- */
64
- readonly RELEASE_TAG: string;
65
- /**
66
- * The name of the organization that maintains the application.
67
- *
68
- * @remarks
69
- * 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}.
70
- *
71
- * @alias ORG
72
- * @alias ORG_ID
73
- * @category neutral
74
- */
75
- ORGANIZATION: string;
76
- /**
77
- * The runtime that the application is running in.
78
- */
79
- RUNTIME?: "nodejs" | "deno" | "workerd" | "browser";
80
- /**
81
- * The platform for which the application was built.
82
- *
83
- * @defaultValue "neutral"
84
- *
85
- * @category neutral
86
- */
87
- PLATFORM: "node" | "neutral" | "browser";
88
- /**
89
- * The mode in which the application is running.
90
- *
91
- * @defaultValue "production"
92
- *
93
- * @alias NODE_ENV
94
- * @alias ENV
95
- * @alias VERCEL_ENV
96
- *
97
- * @category neutral
98
- */
99
- MODE: "development" | "test" | "production";
100
- /**
101
- * The environment the application is running in. This value will be populated with the value of `MODE` if not provided.
102
- *
103
- * @defaultValue "production"
104
- *
105
- * @category neutral
106
- */
107
- ENVIRONMENT: string;
108
- /**
109
- * Indicates if the application is running in debug mode.
110
- *
111
- * @category neutral
112
- */
113
- DEBUG: boolean;
114
- /**
115
- * An indicator that specifies the current runtime is a test environment.
116
- *
117
- * @category neutral
118
- */
119
- TEST: boolean;
120
- /**
121
- * An indicator that specifies the current runtime is a minimal environment.
122
- *
123
- * @category node
124
- */
125
- MINIMAL: boolean;
126
- /**
127
- * An indicator that specifies the current runtime is a no color environment.
128
- *
129
- * @category node
130
- */
131
- NO_COLOR: boolean;
132
- /**
133
- * An indicator that specifies the current runtime is a force color environment.
134
- *
135
- * @category node
136
- */
137
- FORCE_COLOR: boolean | number;
138
- /**
139
- * An indicator that specifies the current runtime should force hyperlinks in terminal output.
140
- *
141
- * @remarks
142
- * 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.
143
- * @category node
144
- */
145
- FORCE_HYPERLINK: boolean | number;
146
- /**
147
- * The name of the agent running the application. This variable is set by certain CI/CD systems.
148
- *
149
- * @readonly
150
- * @runtime
151
- * @hidden
152
- * @category neutral
153
- */
154
- readonly AGENT_NAME?: string;
155
- /**
156
- * The color terminal type. This variable is set by certain terminal emulators.
157
- *
158
- * @readonly
159
- * @runtime
160
- * @hidden
161
- * @category node
162
- */
163
- readonly COLORTERM?: string;
164
- /**
165
- * The terminal type. This variable is set by certain CI/CD systems.
166
- *
167
- * @remarks
168
- * 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.
169
- *
170
- * @readonly
171
- * @runtime
172
- * @hidden
173
- * @category node
174
- */
175
- readonly TERM?: string;
176
- /**
177
- * The terminal program name. This variable is set by certain terminal emulators.
178
- *
179
- * @readonly
180
- * @runtime
181
- * @hidden
182
- * @category node
183
- */
184
- readonly TERM_PROGRAM?: string;
185
- /**
186
- * The terminal program version. This variable is set by certain terminal emulators.
187
- *
188
- * @readonly
189
- * @runtime
190
- * @hidden
191
- * @category node
192
- */
193
- readonly TERM_PROGRAM_VERSION?: string;
194
- /**
195
- * The terminal emulator name. This variable is set by certain terminal emulators.
196
- *
197
- * @readonly
198
- * @runtime
199
- * @hidden
200
- * @category node
201
- */
202
- readonly TERMINAL_EMULATOR?: string;
203
- /**
204
- * The terminal emulator session ID. This variable is set by certain terminal emulators.
205
- *
206
- * @readonly
207
- * @runtime
208
- * @hidden
209
- * @category node
210
- */
211
- readonly WT_SESSION?: string;
212
- /**
213
- * An indicator that specifies the current terminal is running Terminus Sublime. This variable is set by certain terminal emulators.
214
- *
215
- * @readonly
216
- * @runtime
217
- * @hidden
218
- * @category node
219
- */
220
- readonly TERMINUS_SUBLIME?: boolean;
221
- /**
222
- * The ConEmu task name. This variable is set by certain terminal emulators.
223
- *
224
- * @readonly
225
- * @runtime
226
- * @hidden
227
- * @category node
228
- */
229
- readonly ConEmuTask?: string;
230
- /**
231
- * The cursor trace ID. This variable is set by certain terminal emulators.
232
- *
233
- * @readonly
234
- * @runtime
235
- * @hidden
236
- * @category node
237
- */
238
- readonly CURSOR_TRACE_ID?: string;
239
- /**
240
- * The VTE version. This variable is set by certain terminal emulators.
241
- *
242
- * @readonly
243
- * @runtime
244
- * @hidden
245
- * @category node
246
- */
247
- readonly VTE_VERSION?: string;
248
- /**
249
- * Indicates if error stack traces should be captured.
250
- *
251
- * @category neutral
252
- */
253
- STACKTRACE: boolean;
254
- /**
255
- * Indicates if error data should be included.
256
- *
257
- * @category neutral
258
- */
259
- INCLUDE_ERROR_DATA: boolean;
260
- /**
261
- * A web page to lookup error messages and display additional information given an error code.
262
- *
263
- * @remarks
264
- * 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.
265
- *
266
- * @title Error Details URL
267
- * @category neutral
268
- */
269
- ERROR_URL?: string;
270
- /**
271
- * The default timezone for the application.
272
- *
273
- * @defaultValue "America/New_York"
274
- * @category neutral
275
- */
276
- DEFAULT_TIMEZONE: string;
277
- /**
278
- * The default locale to be used in the application.
279
- *
280
- * @defaultValue "en_US"
281
- * @category neutral
282
- */
283
- DEFAULT_LOCALE: string;
284
- /**
285
- * The default lowest log level to accept. If `null`, the logger will reject all records.
286
- *
287
- * @defaultValue "info"
288
- *
289
- * @category neutral
290
- */
291
- LOG_LEVEL?: "error" | "warn" | "info" | "debug" | null;
292
- /**
293
- * An indicator that specifies the current runtime is a continuous integration environment.
294
- *
295
- * @title Continuous Integration
296
- * @alias CONTINUOUS_INTEGRATION
297
- * @category neutral
298
- */
299
- CI: boolean;
300
- /**
301
- * The unique identifier for the current run. This value is set by certain CI/CD systems.
302
- *
303
- * @readonly
304
- * @runtime
305
- * @hidden
306
- * @category node
307
- */
308
- readonly RUN_ID?: string;
309
- /**
310
- * The agola git reference. This value is set by certain CI/CD systems.
311
- *
312
- * @readonly
313
- * @runtime
314
- * @hidden
315
- * @category node
316
- */
317
- readonly AGOLA_GIT_REF?: string;
318
- /**
319
- * The appcircle build ID. This value is set by certain CI/CD systems.
320
- *
321
- * @readonly
322
- * @runtime
323
- * @hidden
324
- * @category node
325
- */
326
- readonly AC_APPCIRCLE?: string;
327
- /**
328
- * The appveyor build ID. This value is set by certain CI/CD systems.
329
- *
330
- * @readonly
331
- * @runtime
332
- * @hidden
333
- * @category node
334
- */
335
- readonly APPVEYOR?: string;
336
- /**
337
- * The codebuild build ID. This value is set by certain CI/CD systems.
338
- *
339
- * @readonly
340
- * @runtime
341
- * @hidden
342
- * @category node
343
- */
344
- readonly CODEBUILD?: string;
345
- /**
346
- * The task force build ID. This value is set by certain CI/CD systems.
347
- *
348
- * @readonly
349
- * @runtime
350
- * @hidden
351
- * @category node
352
- */
353
- readonly TF_BUILD?: string;
354
- /**
355
- * The bamboo plan key. This value is set by certain CI/CD systems.
356
- *
357
- * @readonly
358
- * @runtime
359
- * @hidden
360
- * @category node
361
- */
362
- readonly bamboo_planKey?: string;
363
- /**
364
- * The bitbucket commit. This value is set by certain CI/CD systems.
365
- *
366
- * @readonly
367
- * @runtime
368
- * @hidden
369
- * @category node
370
- */
371
- readonly BITBUCKET_COMMIT?: string;
372
- /**
373
- * The bitrise build ID. This value is set by certain CI/CD systems.
374
- *
375
- * @readonly
376
- * @runtime
377
- * @hidden
378
- * @category node
379
- */
380
- readonly BITRISE_IO?: string;
381
- /**
382
- * The buddy workspace ID. This value is set by certain CI/CD systems.
383
- *
384
- * @readonly
385
- * @runtime
386
- * @hidden
387
- * @category node
388
- */
389
- readonly BUDDY_WORKSPACE_ID?: string;
390
- /**
391
- * The buildkite build ID. This value is set by certain CI/CD systems.
392
- *
393
- * @readonly
394
- * @runtime
395
- * @hidden
396
- * @category node
397
- */
398
- readonly BUILDKITE?: string;
399
- /**
400
- * The circleci build ID. This value is set by certain CI/CD systems.
401
- *
402
- * @readonly
403
- * @runtime
404
- * @hidden
405
- * @category node
406
- */
407
- readonly CIRCLECI?: string;
408
- /**
409
- * The cirrus-ci build ID. This value is set by certain CI/CD systems.
410
- *
411
- * @readonly
412
- * @runtime
413
- * @hidden
414
- * @category node
415
- */
416
- readonly CIRRUS_CI?: string;
417
- /**
418
- * The cf build ID. This value is set by certain CI/CD systems.
419
- *
420
- * @readonly
421
- * @runtime
422
- * @hidden
423
- * @category node
424
- */
425
- readonly CF_BUILD_ID?: string;
426
- /**
427
- * The cm build ID. This value is set by certain CI/CD systems.
428
- *
429
- * @readonly
430
- * @runtime
431
- * @hidden
432
- * @category node
433
- */
434
- readonly CM_BUILD_ID?: string;
435
- /**
436
- * The ci name. This value is set by certain CI/CD systems.
437
- *
438
- * @readonly
439
- * @runtime
440
- * @hidden
441
- * @category node
442
- */
443
- readonly CI_NAME?: string;
444
- /**
445
- * The drone build ID. This value is set by certain CI/CD systems.
446
- *
447
- * @readonly
448
- * @runtime
449
- * @hidden
450
- * @category node
451
- */
452
- readonly DRONE?: string;
453
- /**
454
- * The dsari build ID. This value is set by certain CI/CD systems.
455
- *
456
- * @readonly
457
- * @runtime
458
- * @hidden
459
- * @category node
460
- */
461
- readonly DSARI?: string;
462
- /**
463
- * The earthly build ID. This value is set by certain CI/CD systems.
464
- *
465
- * @readonly
466
- * @runtime
467
- * @hidden
468
- * @category node
469
- */
470
- readonly EARTHLY_CI?: string;
471
- /**
472
- * The eas build ID. This value is set by certain CI/CD systems.
473
- *
474
- * @readonly
475
- * @runtime
476
- * @hidden
477
- * @category node
478
- */
479
- readonly EAS_BUILD?: string;
480
- /**
481
- * The gerrit project. This value is set by certain CI/CD systems.
482
- *
483
- * @readonly
484
- * @runtime
485
- * @hidden
486
- * @category node
487
- */
488
- readonly GERRIT_PROJECT?: string;
489
- /**
490
- * The gitea actions build ID. This value is set by certain CI/CD systems.
491
- *
492
- * @readonly
493
- * @runtime
494
- * @hidden
495
- * @category node
496
- */
497
- readonly GITEA_ACTIONS?: string;
498
- /**
499
- * The github actions build ID. This value is set by certain CI/CD systems.
500
- *
501
- * @readonly
502
- * @runtime
503
- * @hidden
504
- * @category node
505
- */
506
- readonly GITHUB_ACTIONS?: string;
507
- /**
508
- * The gitlab ci build ID. This value is set by certain CI/CD systems.
509
- *
510
- * @readonly
511
- * @runtime
512
- * @hidden
513
- * @category node
514
- */
515
- readonly GITLAB_CI?: string;
516
- /**
517
- * The go cd build ID. This value is set by certain CI/CD systems.
518
- *
519
- * @readonly
520
- * @runtime
521
- * @hidden
522
- * @category node
523
- */
524
- readonly GOCD?: string;
525
- /**
526
- * The builder output build ID. This value is set by certain CI/CD systems.
527
- *
528
- * @readonly
529
- * @runtime
530
- * @hidden
531
- * @category node
532
- */
533
- readonly BUILDER_OUTPUT?: string;
534
- /**
535
- * The harness build ID. This value is set by certain CI/CD systems.
536
- *
537
- * @readonly
538
- * @runtime
539
- * @hidden
540
- * @category node
541
- */
542
- readonly HARNESS_BUILD_ID?: string;
543
- /**
544
- * The jenkins url. This value is set by certain CI/CD systems.
545
- *
546
- * @readonly
547
- * @runtime
548
- * @hidden
549
- * @category node
550
- */
551
- readonly JENKINS_URL?: string;
552
- /**
553
- * The layerci build ID. This value is set by certain CI/CD systems.
554
- *
555
- * @readonly
556
- * @runtime
557
- * @hidden
558
- * @category node
559
- */
560
- readonly LAYERCI?: string;
561
- /**
562
- * The magnum build ID. This value is set by certain CI/CD systems.
563
- *
564
- * @readonly
565
- * @runtime
566
- * @hidden
567
- * @category node
568
- */
569
- readonly MAGNUM?: string;
570
- /**
571
- * The netlify build ID. This value is set by certain CI/CD systems.
572
- *
573
- * @readonly
574
- * @runtime
575
- * @hidden
576
- * @category node
577
- */
578
- readonly NETLIFY?: string;
579
- /**
580
- * The nevercode build ID. This value is set by certain CI/CD systems.
581
- *
582
- * @readonly
583
- * @runtime
584
- * @hidden
585
- * @category node
586
- */
587
- readonly NEVERCODE?: string;
588
- /**
589
- * The prow job ID. This value is set by certain CI/CD systems.
590
- *
591
- * @readonly
592
- * @runtime
593
- * @hidden
594
- * @category node
595
- */
596
- readonly PROW_JOB_ID?: string;
597
- /**
598
- * The release build ID. This value is set by certain CI/CD systems.
599
- *
600
- * @readonly
601
- * @runtime
602
- * @hidden
603
- * @category node
604
- */
605
- readonly RELEASE_BUILD_ID?: string;
606
- /**
607
- * The render build ID. This value is set by certain CI/CD systems.
608
- *
609
- * @readonly
610
- * @runtime
611
- * @hidden
612
- * @category node
613
- */
614
- readonly RENDER?: string;
615
- /**
616
- * The sailci build ID. This value is set by certain CI/CD systems.
617
- *
618
- * @readonly
619
- * @runtime
620
- * @hidden
621
- * @category node
622
- */
623
- readonly SAILCI?: string;
624
- /**
625
- * The hudson build ID. This value is set by certain CI/CD systems.
626
- *
627
- * @readonly
628
- * @runtime
629
- * @hidden
630
- * @category node
631
- */
632
- readonly HUDSON?: string;
633
- /**
634
- * The screwdriver build ID. This value is set by certain CI/CD systems.
635
- *
636
- * @readonly
637
- * @runtime
638
- * @hidden
639
- * @category node
640
- */
641
- readonly SCREWDRIVER?: string;
642
- /**
643
- * The semaphore build ID. This value is set by certain CI/CD systems.
644
- *
645
- * @readonly
646
- * @runtime
647
- * @hidden
648
- * @category node
649
- */
650
- readonly SEMAPHORE?: string;
651
- /**
652
- * The sourcehut build ID. This value is set by certain CI/CD systems.
653
- *
654
- * @readonly
655
- * @runtime
656
- * @hidden
657
- * @category node
658
- */
659
- readonly SOURCEHUT?: string;
660
- /**
661
- * The spaceship build ID. This value is set by certain CI/CD systems.
662
- *
663
- * @readonly
664
- * @runtime
665
- * @hidden
666
- * @category node
667
- */
668
- readonly SPACESHIP_CI?: string;
669
- /**
670
- * The strider build ID. This value is set by certain CI/CD systems.
671
- *
672
- * @readonly
673
- * @runtime
674
- * @hidden
675
- * @category node
676
- */
677
- readonly STRIDER?: string;
678
- /**
679
- * The task ID. This value is set by certain CI/CD systems.
680
- *
681
- * @readonly
682
- * @runtime
683
- * @hidden
684
- * @category node
685
- */
686
- readonly TASK_ID?: string;
687
- /**
688
- * The teamcity version. This value is set by certain CI/CD systems.
689
- *
690
- * @readonly
691
- * @runtime
692
- * @hidden
693
- * @category node
694
- */
695
- readonly TEAMCITY_VERSION?: string;
696
- /**
697
- * The travis build ID. This value is set by certain CI/CD systems.
698
- *
699
- * @readonly
700
- * @runtime
701
- * @hidden
702
- * @category node
703
- */
704
- readonly TRAVIS?: string;
705
- /**
706
- * The vela build ID. This value is set by certain CI/CD systems.
707
- *
708
- * @readonly
709
- * @runtime
710
- * @hidden
711
- * @category node
712
- */
713
- readonly VELA?: string;
714
- /**
715
- * The now builder build ID. This value is set by certain CI/CD systems.
716
- *
717
- * @readonly
718
- * @runtime
719
- * @hidden
720
- * @category node
721
- */
722
- readonly NOW_BUILDER?: string;
723
- /**
724
- * The appcenter build ID. This value is set by certain CI/CD systems.
725
- *
726
- * @readonly
727
- * @runtime
728
- * @hidden
729
- * @category node
730
- */
731
- readonly APPCENTER_BUILD_ID?: string;
732
- /**
733
- * The xcode project build ID. This value is set by certain CI/CD systems.
734
- *
735
- * @readonly
736
- * @runtime
737
- * @hidden
738
- * @category node
739
- */
740
- readonly CI_XCODE_PROJECT?: string;
741
- /**
742
- * The xcode server build ID. This value is set by certain CI/CD systems.
743
- *
744
- * @readonly
745
- * @runtime
746
- * @hidden
747
- * @category node
748
- */
749
- readonly XCS?: string;
750
- /**
751
- * The application's runtime data directory.
752
- *
753
- * @remarks
754
- * 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.
755
- *
756
- * @title Data Directory
757
- * @runtime
758
- * @category node
759
- */
760
- DATA_DIR?: string;
761
- /**
762
- * The application's configuration data directory.
763
- *
764
- * @remarks
765
- * 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.
766
- *
767
- * @title Configuration Directory
768
- * @runtime
769
- * @category node
770
- */
771
- CONFIG_DIR?: string;
772
- /**
773
- * The application's cached data directory.
774
- *
775
- * @remarks
776
- * 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.
777
- *
778
- * @title Cache Directory
779
- * @runtime
780
- * @category node
781
- */
782
- CACHE_DIR?: string;
783
- /**
784
- * The application's logging directory.
785
- *
786
- * @remarks
787
- * 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.
788
- *
789
- * @title Log Directory
790
- * @runtime
791
- * @category node
792
- */
793
- LOG_DIR?: string;
794
- /**
795
- * The application's temporary data directory.
796
- *
797
- * @remarks
798
- * 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.
799
- *
800
- * @title Temporary Directory
801
- * @runtime
802
- * @category node
803
- */
804
- TEMP_DIR?: string;
805
- /**
806
- * A variable that specifies the current user's local application data directory on Windows.
807
- *
808
- * @see https://www.advancedinstaller.com/appdata-localappdata-programdata.html
809
- *
810
- * @remarks
811
- * 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.
812
- *
813
- * @readonly
814
- * @runtime
815
- * @hidden
816
- * @category node
817
- */
818
- readonly LOCALAPPDATA?: string;
819
- /**
820
- * A variable that specifies the application data directory on Windows.
821
- *
822
- * @see https://www.advancedinstaller.com/appdata-localappdata-programdata.html
823
- *
824
- * @remarks
825
- * 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.
826
- *
827
- * @readonly
828
- * @runtime
829
- * @hidden
830
- * @category node
831
- */
832
- readonly APPDATA?: string;
833
- /**
834
- * A variable that specifies the data path in the home directory on Linux systems using the XDG base directory specification.
835
- *
836
- * @see https://gist.github.com/roalcantara/107ba66dfa3b9d023ac9329e639bc58c
837
- *
838
- * @remarks
839
- * 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.
840
- *
841
- * @readonly
842
- * @runtime
843
- * @hidden
844
- * @category node
845
- */
846
- readonly XDG_DATA_HOME?: string;
847
- /**
848
- * A variable that specifies the configuration path in the home directory on Linux systems using the XDG base directory specification.
849
- *
850
- * @see https://gist.github.com/roalcantara/107ba66dfa3b9d023ac9329e639bc58c
851
- *
852
- * @remarks
853
- * 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.
854
- *
855
- * @readonly
856
- * @runtime
857
- * @hidden
858
- * @category node
859
- */
860
- readonly XDG_CONFIG_HOME?: string;
861
- /**
862
- * A variable that specifies the cache path in the home directory on Linux systems using the XDG base directory specification.
863
- *
864
- * @see https://gist.github.com/roalcantara/107ba66dfa3b9d023ac9329e639bc58c
865
- *
866
- * @remarks
867
- * 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.
868
- *
869
- * @readonly
870
- * @runtime
871
- * @hidden
872
- * @category node
873
- */
874
- readonly XDG_CACHE_HOME?: string;
875
- /**
876
- * A variable that specifies the state directory on Linux systems using the XDG base directory specification.
877
- *
878
- * @see https://gist.github.com/roalcantara/107ba66dfa3b9d023ac9329e639bc58c
879
- *
880
- * @remarks
881
- * 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.
882
- *
883
- * @readonly
884
- * @runtime
885
- * @hidden
886
- * @category node
887
- */
888
- readonly XDG_STATE_HOME?: string;
889
- /**
890
- * A variable that specifies the runtime directory on Linux systems using the XDG base directory specification.
891
- *
892
- * @see https://gist.github.com/roalcantara/107ba66dfa3b9d023ac9329e639bc58c
893
- *
894
- * @remarks
895
- * 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.
896
- *
897
- * @readonly
898
- * @runtime
899
- * @hidden
900
- * @category node
901
- */
902
- readonly XDG_RUNTIME_DIR?: string;
903
- /**
904
- * A variable that specifies the [Devenv](https://devenv.sh/) runtime directory.
905
- *
906
- * @see https://devenv.sh/files-and-variables/#devenv_dotfile
907
- * @see https://nixos.org/
908
- *
909
- * @remarks
910
- * 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.
911
- *
912
- * @readonly
913
- * @runtime
914
- * @hidden
915
- * @category node
916
- */
917
- DEVENV_RUNTIME?: string;
918
- }
919
- /**
920
- * The base secrets configuration used by Powerlines applications
921
- *
922
- * @remarks
923
- * 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).
924
- */
925
- interface SecretsInterface {
926
- /**
927
- * The secret key used for encryption and decryption.
928
- *
929
- * @remarks
930
- * 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.
931
- *
932
- * @title Encryption Key
933
- */
934
- ENCRYPTION_KEY: string;
935
- }
936
- //#endregion
937
- export { EnvInterface, SecretsInterface };
938
- //# sourceMappingURL=env.d.cts.map