@karmaniverous/get-dotenv 4.0.0-0 → 4.0.0-1

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.
@@ -89,6 +89,16 @@ const dotenvExpandAll = (values = {}, { ref = process.env, progressive = false,
89
89
  });
90
90
  return acc;
91
91
  }, {});
92
+ /**
93
+ * Recursively expands environment variables in a string using `process.env` as
94
+ * the expansion reference. Variables may be presented with optional default as
95
+ * `$VAR[:default]` or `${VAR[:default]}`. Unknown variables will expand to an
96
+ * empty string.
97
+ *
98
+ * @param value - The string to expand.
99
+ * @returns The expanded string.
100
+ */
101
+ const dotenvExpandFromProcessEnv = (value) => dotenvExpand(value, process.env);
92
102
 
93
103
  var commonjsGlobal = typeof globalThis !== 'undefined' ? globalThis : typeof window !== 'undefined' ? window : typeof global !== 'undefined' ? global : typeof self !== 'undefined' ? self : {};
94
104
 
@@ -26342,10 +26352,6 @@ const getDotenv = async (options = {}) => {
26342
26352
 
26343
26353
  // Discover platform.
26344
26354
  const platform = require$$2.platform();
26345
- /**
26346
- * `dotenvExpand` function reduced to initial argument (applies default to `ref` argument).
26347
- */
26348
- const dotenvExpandDefault = (value) => dotenvExpand(value);
26349
26355
  /**
26350
26356
  * Generate a Commander CLI Command for get-dotenv.
26351
26357
  */
@@ -26363,15 +26369,15 @@ const generateGetDotenvCli = ({ logger = console, preHook, postHook, ...cliOptio
26363
26369
  .description(description)
26364
26370
  .enablePositionalOptions()
26365
26371
  .passThroughOptions()
26366
- .option('-e, --env <string>', `target environment (dotenv-expanded)`, dotenvExpandDefault, env)
26372
+ .option('-e, --env <string>', `target environment (dotenv-expanded)`, dotenvExpandFromProcessEnv, env)
26367
26373
  .option('-v, --vars <string>', `extra variables expressed as delimited key-value pairs (dotenv-expanded): ${[
26368
26374
  ['KEY1', 'VAL1'],
26369
26375
  ['KEY2', 'VAL2'],
26370
26376
  ]
26371
26377
  .map((v) => v.join(varsAssignor))
26372
- .join(varsDelimiter)}`, dotenvExpandDefault)
26373
- .option('-c, --command <string>', 'shell command string (dotenv-expanded)', dotenvExpandDefault)
26374
- .option('-o, --output-path <string>', 'consolidated output file (dotenv-expanded)', dotenvExpandDefault, outputPath)
26378
+ .join(varsDelimiter)}`, dotenvExpandFromProcessEnv)
26379
+ .option('-c, --command <string>', 'shell command string (dotenv-expanded)', dotenvExpandFromProcessEnv)
26380
+ .option('-o, --output-path <string>', 'consolidated output file (dotenv-expanded)', dotenvExpandFromProcessEnv, outputPath)
26375
26381
  .addOption(new Option('-p, --load-process', `load variables to process.env ON${loadProcess ? ' (default)' : ''}`).conflicts('loadProcessOff'))
26376
26382
  .addOption(new Option('-P, --load-process-off', `load variables to process.env OFF${!loadProcess ? ' (default)' : ''}`).conflicts('loadProcess'))
26377
26383
  .addOption(new Option('-a, --exclude-all', `exclude all dotenv variables from loading ON${excludeAll ? ' (default)' : ''}`).conflicts('excludeAllOff'))
@@ -26390,13 +26396,13 @@ const generateGetDotenvCli = ({ logger = console, preHook, postHook, ...cliOptio
26390
26396
  .addOption(new Option('-L, --log-off', `console log loaded variables OFF${!log ? ' (default)' : ''}`).conflicts('log'))
26391
26397
  .addOption(new Option('-d, --debug', `debug mode ON${debug ? ' (default)' : ''}`).conflicts('debugOff'))
26392
26398
  .addOption(new Option('-D, --debug-off', `debug mode OFF${!debug ? ' (default)' : ''}`).conflicts('debug'))
26393
- .option('--default-env <string>', 'default target environment', dotenvExpandDefault, defaultEnv)
26394
- .option('--dotenv-token <string>', 'dotenv-expanded token indicating a dotenv file', dotenvExpandDefault, dotenvToken)
26395
- .option('--dynamic-path <string>', 'dynamic variables path', dotenvExpandDefault, dynamicPath)
26396
- .option('--paths <string>', 'dotenv-expanded delimited list of paths to dotenv directory', dotenvExpandDefault, paths)
26399
+ .option('--default-env <string>', 'default target environment', dotenvExpandFromProcessEnv, defaultEnv)
26400
+ .option('--dotenv-token <string>', 'dotenv-expanded token indicating a dotenv file', dotenvExpandFromProcessEnv, dotenvToken)
26401
+ .option('--dynamic-path <string>', 'dynamic variables path', dotenvExpandFromProcessEnv, dynamicPath)
26402
+ .option('--paths <string>', 'dotenv-expanded delimited list of paths to dotenv directory', dotenvExpandFromProcessEnv, paths)
26397
26403
  .option('--paths-delimiter <string>', 'paths delimiter string', pathsDelimiter)
26398
26404
  .option('--paths-delimiter-pattern <string>', 'paths delimiter regex pattern', pathsDelimiterPattern)
26399
- .option('--private-token <string>', 'dotenv-expanded token indicating private variables', dotenvExpandDefault, privateToken)
26405
+ .option('--private-token <string>', 'dotenv-expanded token indicating private variables', dotenvExpandFromProcessEnv, privateToken)
26400
26406
  .option('--vars-delimiter <string>', 'vars delimiter string', varsDelimiter)
26401
26407
  .option('--vars-delimiter-pattern <string>', 'vars delimiter regex pattern', varsDelimiterPattern)
26402
26408
  .option('--vars-assignor <string>', 'vars assignment operator string', varsAssignor)
package/dist/index.cjs CHANGED
@@ -91,6 +91,16 @@ const dotenvExpandAll = (values = {}, { ref = process.env, progressive = false,
91
91
  });
92
92
  return acc;
93
93
  }, {});
94
+ /**
95
+ * Recursively expands environment variables in a string using `process.env` as
96
+ * the expansion reference. Variables may be presented with optional default as
97
+ * `$VAR[:default]` or `${VAR[:default]}`. Unknown variables will expand to an
98
+ * empty string.
99
+ *
100
+ * @param value - The string to expand.
101
+ * @returns The expanded string.
102
+ */
103
+ const dotenvExpandFromProcessEnv = (value) => dotenvExpand(value, process.env);
94
104
 
95
105
  var commonjsGlobal = typeof globalThis !== 'undefined' ? globalThis : typeof window !== 'undefined' ? window : typeof global !== 'undefined' ? global : typeof self !== 'undefined' ? self : {};
96
106
 
@@ -26344,10 +26354,6 @@ const getDotenv = async (options = {}) => {
26344
26354
 
26345
26355
  // Discover platform.
26346
26356
  const platform = require$$2.platform();
26347
- /**
26348
- * `dotenvExpand` function reduced to initial argument (applies default to `ref` argument).
26349
- */
26350
- const dotenvExpandDefault = (value) => dotenvExpand(value);
26351
26357
  /**
26352
26358
  * Generate a Commander CLI Command for get-dotenv.
26353
26359
  */
@@ -26365,15 +26371,15 @@ const generateGetDotenvCli = ({ logger = console, preHook, postHook, ...cliOptio
26365
26371
  .description(description)
26366
26372
  .enablePositionalOptions()
26367
26373
  .passThroughOptions()
26368
- .option('-e, --env <string>', `target environment (dotenv-expanded)`, dotenvExpandDefault, env)
26374
+ .option('-e, --env <string>', `target environment (dotenv-expanded)`, dotenvExpandFromProcessEnv, env)
26369
26375
  .option('-v, --vars <string>', `extra variables expressed as delimited key-value pairs (dotenv-expanded): ${[
26370
26376
  ['KEY1', 'VAL1'],
26371
26377
  ['KEY2', 'VAL2'],
26372
26378
  ]
26373
26379
  .map((v) => v.join(varsAssignor))
26374
- .join(varsDelimiter)}`, dotenvExpandDefault)
26375
- .option('-c, --command <string>', 'shell command string (dotenv-expanded)', dotenvExpandDefault)
26376
- .option('-o, --output-path <string>', 'consolidated output file (dotenv-expanded)', dotenvExpandDefault, outputPath)
26380
+ .join(varsDelimiter)}`, dotenvExpandFromProcessEnv)
26381
+ .option('-c, --command <string>', 'shell command string (dotenv-expanded)', dotenvExpandFromProcessEnv)
26382
+ .option('-o, --output-path <string>', 'consolidated output file (dotenv-expanded)', dotenvExpandFromProcessEnv, outputPath)
26377
26383
  .addOption(new Option('-p, --load-process', `load variables to process.env ON${loadProcess ? ' (default)' : ''}`).conflicts('loadProcessOff'))
26378
26384
  .addOption(new Option('-P, --load-process-off', `load variables to process.env OFF${!loadProcess ? ' (default)' : ''}`).conflicts('loadProcess'))
26379
26385
  .addOption(new Option('-a, --exclude-all', `exclude all dotenv variables from loading ON${excludeAll ? ' (default)' : ''}`).conflicts('excludeAllOff'))
@@ -26392,13 +26398,13 @@ const generateGetDotenvCli = ({ logger = console, preHook, postHook, ...cliOptio
26392
26398
  .addOption(new Option('-L, --log-off', `console log loaded variables OFF${!log ? ' (default)' : ''}`).conflicts('log'))
26393
26399
  .addOption(new Option('-d, --debug', `debug mode ON${debug ? ' (default)' : ''}`).conflicts('debugOff'))
26394
26400
  .addOption(new Option('-D, --debug-off', `debug mode OFF${!debug ? ' (default)' : ''}`).conflicts('debug'))
26395
- .option('--default-env <string>', 'default target environment', dotenvExpandDefault, defaultEnv)
26396
- .option('--dotenv-token <string>', 'dotenv-expanded token indicating a dotenv file', dotenvExpandDefault, dotenvToken)
26397
- .option('--dynamic-path <string>', 'dynamic variables path', dotenvExpandDefault, dynamicPath)
26398
- .option('--paths <string>', 'dotenv-expanded delimited list of paths to dotenv directory', dotenvExpandDefault, paths)
26401
+ .option('--default-env <string>', 'default target environment', dotenvExpandFromProcessEnv, defaultEnv)
26402
+ .option('--dotenv-token <string>', 'dotenv-expanded token indicating a dotenv file', dotenvExpandFromProcessEnv, dotenvToken)
26403
+ .option('--dynamic-path <string>', 'dynamic variables path', dotenvExpandFromProcessEnv, dynamicPath)
26404
+ .option('--paths <string>', 'dotenv-expanded delimited list of paths to dotenv directory', dotenvExpandFromProcessEnv, paths)
26399
26405
  .option('--paths-delimiter <string>', 'paths delimiter string', pathsDelimiter)
26400
26406
  .option('--paths-delimiter-pattern <string>', 'paths delimiter regex pattern', pathsDelimiterPattern)
26401
- .option('--private-token <string>', 'dotenv-expanded token indicating private variables', dotenvExpandDefault, privateToken)
26407
+ .option('--private-token <string>', 'dotenv-expanded token indicating private variables', dotenvExpandFromProcessEnv, privateToken)
26402
26408
  .option('--vars-delimiter <string>', 'vars delimiter string', varsDelimiter)
26403
26409
  .option('--vars-delimiter-pattern <string>', 'vars delimiter regex pattern', varsDelimiterPattern)
26404
26410
  .option('--vars-assignor <string>', 'vars assignment operator string', varsAssignor)
@@ -26495,5 +26501,6 @@ const generateGetDotenvCli = ({ logger = console, preHook, postHook, ...cliOptio
26495
26501
 
26496
26502
  exports.dotenvExpand = dotenvExpand;
26497
26503
  exports.dotenvExpandAll = dotenvExpandAll;
26504
+ exports.dotenvExpandFromProcessEnv = dotenvExpandFromProcessEnv;
26498
26505
  exports.generateGetDotenvCli = generateGetDotenvCli;
26499
26506
  exports.getDotenv = getDotenv;
package/dist/index.d.cts CHANGED
@@ -148,6 +148,16 @@ declare const dotenvExpandAll: (values?: ProcessEnv, { ref, progressive, }?: {
148
148
  ref?: ProcessEnv;
149
149
  progressive?: boolean;
150
150
  }) => Record<string, string | undefined>;
151
+ /**
152
+ * Recursively expands environment variables in a string using `process.env` as
153
+ * the expansion reference. Variables may be presented with optional default as
154
+ * `$VAR[:default]` or `${VAR[:default]}`. Unknown variables will expand to an
155
+ * empty string.
156
+ *
157
+ * @param value - The string to expand.
158
+ * @returns The expanded string.
159
+ */
160
+ declare const dotenvExpandFromProcessEnv: (value: string | undefined) => string | undefined;
151
161
 
152
162
  /**
153
163
  * GetDotenv CLI Pre-hook Callback function type. Mutates inbound options &
@@ -231,4 +241,4 @@ declare const generateGetDotenvCli: ({ logger, preHook, postHook, ...cliOptionsC
231
241
  */
232
242
  declare const getDotenv: (options?: GetDotenvOptions) => Promise<ProcessEnv>;
233
243
 
234
- export { type GetDotenvDynamic, type GetDotenvOptions, type ProcessEnv, dotenvExpand, dotenvExpandAll, generateGetDotenvCli, getDotenv };
244
+ export { type GetDotenvDynamic, type GetDotenvOptions, type ProcessEnv, dotenvExpand, dotenvExpandAll, dotenvExpandFromProcessEnv, generateGetDotenvCli, getDotenv };
package/dist/index.d.mts CHANGED
@@ -148,6 +148,16 @@ declare const dotenvExpandAll: (values?: ProcessEnv, { ref, progressive, }?: {
148
148
  ref?: ProcessEnv;
149
149
  progressive?: boolean;
150
150
  }) => Record<string, string | undefined>;
151
+ /**
152
+ * Recursively expands environment variables in a string using `process.env` as
153
+ * the expansion reference. Variables may be presented with optional default as
154
+ * `$VAR[:default]` or `${VAR[:default]}`. Unknown variables will expand to an
155
+ * empty string.
156
+ *
157
+ * @param value - The string to expand.
158
+ * @returns The expanded string.
159
+ */
160
+ declare const dotenvExpandFromProcessEnv: (value: string | undefined) => string | undefined;
151
161
 
152
162
  /**
153
163
  * GetDotenv CLI Pre-hook Callback function type. Mutates inbound options &
@@ -231,4 +241,4 @@ declare const generateGetDotenvCli: ({ logger, preHook, postHook, ...cliOptionsC
231
241
  */
232
242
  declare const getDotenv: (options?: GetDotenvOptions) => Promise<ProcessEnv>;
233
243
 
234
- export { type GetDotenvDynamic, type GetDotenvOptions, type ProcessEnv, dotenvExpand, dotenvExpandAll, generateGetDotenvCli, getDotenv };
244
+ export { type GetDotenvDynamic, type GetDotenvOptions, type ProcessEnv, dotenvExpand, dotenvExpandAll, dotenvExpandFromProcessEnv, generateGetDotenvCli, getDotenv };
package/dist/index.d.ts CHANGED
@@ -148,6 +148,16 @@ declare const dotenvExpandAll: (values?: ProcessEnv, { ref, progressive, }?: {
148
148
  ref?: ProcessEnv;
149
149
  progressive?: boolean;
150
150
  }) => Record<string, string | undefined>;
151
+ /**
152
+ * Recursively expands environment variables in a string using `process.env` as
153
+ * the expansion reference. Variables may be presented with optional default as
154
+ * `$VAR[:default]` or `${VAR[:default]}`. Unknown variables will expand to an
155
+ * empty string.
156
+ *
157
+ * @param value - The string to expand.
158
+ * @returns The expanded string.
159
+ */
160
+ declare const dotenvExpandFromProcessEnv: (value: string | undefined) => string | undefined;
151
161
 
152
162
  /**
153
163
  * GetDotenv CLI Pre-hook Callback function type. Mutates inbound options &
@@ -231,4 +241,4 @@ declare const generateGetDotenvCli: ({ logger, preHook, postHook, ...cliOptionsC
231
241
  */
232
242
  declare const getDotenv: (options?: GetDotenvOptions) => Promise<ProcessEnv>;
233
243
 
234
- export { type GetDotenvDynamic, type GetDotenvOptions, type ProcessEnv, dotenvExpand, dotenvExpandAll, generateGetDotenvCli, getDotenv };
244
+ export { type GetDotenvDynamic, type GetDotenvOptions, type ProcessEnv, dotenvExpand, dotenvExpandAll, dotenvExpandFromProcessEnv, generateGetDotenvCli, getDotenv };
package/dist/index.mjs CHANGED
@@ -88,6 +88,16 @@ const dotenvExpandAll = (values = {}, { ref = process.env, progressive = false,
88
88
  });
89
89
  return acc;
90
90
  }, {});
91
+ /**
92
+ * Recursively expands environment variables in a string using `process.env` as
93
+ * the expansion reference. Variables may be presented with optional default as
94
+ * `$VAR[:default]` or `${VAR[:default]}`. Unknown variables will expand to an
95
+ * empty string.
96
+ *
97
+ * @param value - The string to expand.
98
+ * @returns The expanded string.
99
+ */
100
+ const dotenvExpandFromProcessEnv = (value) => dotenvExpand(value, process.env);
91
101
 
92
102
  var commonjsGlobal = typeof globalThis !== 'undefined' ? globalThis : typeof window !== 'undefined' ? window : typeof global !== 'undefined' ? global : typeof self !== 'undefined' ? self : {};
93
103
 
@@ -26341,10 +26351,6 @@ const getDotenv = async (options = {}) => {
26341
26351
 
26342
26352
  // Discover platform.
26343
26353
  const platform = require$$2.platform();
26344
- /**
26345
- * `dotenvExpand` function reduced to initial argument (applies default to `ref` argument).
26346
- */
26347
- const dotenvExpandDefault = (value) => dotenvExpand(value);
26348
26354
  /**
26349
26355
  * Generate a Commander CLI Command for get-dotenv.
26350
26356
  */
@@ -26362,15 +26368,15 @@ const generateGetDotenvCli = ({ logger = console, preHook, postHook, ...cliOptio
26362
26368
  .description(description)
26363
26369
  .enablePositionalOptions()
26364
26370
  .passThroughOptions()
26365
- .option('-e, --env <string>', `target environment (dotenv-expanded)`, dotenvExpandDefault, env)
26371
+ .option('-e, --env <string>', `target environment (dotenv-expanded)`, dotenvExpandFromProcessEnv, env)
26366
26372
  .option('-v, --vars <string>', `extra variables expressed as delimited key-value pairs (dotenv-expanded): ${[
26367
26373
  ['KEY1', 'VAL1'],
26368
26374
  ['KEY2', 'VAL2'],
26369
26375
  ]
26370
26376
  .map((v) => v.join(varsAssignor))
26371
- .join(varsDelimiter)}`, dotenvExpandDefault)
26372
- .option('-c, --command <string>', 'shell command string (dotenv-expanded)', dotenvExpandDefault)
26373
- .option('-o, --output-path <string>', 'consolidated output file (dotenv-expanded)', dotenvExpandDefault, outputPath)
26377
+ .join(varsDelimiter)}`, dotenvExpandFromProcessEnv)
26378
+ .option('-c, --command <string>', 'shell command string (dotenv-expanded)', dotenvExpandFromProcessEnv)
26379
+ .option('-o, --output-path <string>', 'consolidated output file (dotenv-expanded)', dotenvExpandFromProcessEnv, outputPath)
26374
26380
  .addOption(new Option('-p, --load-process', `load variables to process.env ON${loadProcess ? ' (default)' : ''}`).conflicts('loadProcessOff'))
26375
26381
  .addOption(new Option('-P, --load-process-off', `load variables to process.env OFF${!loadProcess ? ' (default)' : ''}`).conflicts('loadProcess'))
26376
26382
  .addOption(new Option('-a, --exclude-all', `exclude all dotenv variables from loading ON${excludeAll ? ' (default)' : ''}`).conflicts('excludeAllOff'))
@@ -26389,13 +26395,13 @@ const generateGetDotenvCli = ({ logger = console, preHook, postHook, ...cliOptio
26389
26395
  .addOption(new Option('-L, --log-off', `console log loaded variables OFF${!log ? ' (default)' : ''}`).conflicts('log'))
26390
26396
  .addOption(new Option('-d, --debug', `debug mode ON${debug ? ' (default)' : ''}`).conflicts('debugOff'))
26391
26397
  .addOption(new Option('-D, --debug-off', `debug mode OFF${!debug ? ' (default)' : ''}`).conflicts('debug'))
26392
- .option('--default-env <string>', 'default target environment', dotenvExpandDefault, defaultEnv)
26393
- .option('--dotenv-token <string>', 'dotenv-expanded token indicating a dotenv file', dotenvExpandDefault, dotenvToken)
26394
- .option('--dynamic-path <string>', 'dynamic variables path', dotenvExpandDefault, dynamicPath)
26395
- .option('--paths <string>', 'dotenv-expanded delimited list of paths to dotenv directory', dotenvExpandDefault, paths)
26398
+ .option('--default-env <string>', 'default target environment', dotenvExpandFromProcessEnv, defaultEnv)
26399
+ .option('--dotenv-token <string>', 'dotenv-expanded token indicating a dotenv file', dotenvExpandFromProcessEnv, dotenvToken)
26400
+ .option('--dynamic-path <string>', 'dynamic variables path', dotenvExpandFromProcessEnv, dynamicPath)
26401
+ .option('--paths <string>', 'dotenv-expanded delimited list of paths to dotenv directory', dotenvExpandFromProcessEnv, paths)
26396
26402
  .option('--paths-delimiter <string>', 'paths delimiter string', pathsDelimiter)
26397
26403
  .option('--paths-delimiter-pattern <string>', 'paths delimiter regex pattern', pathsDelimiterPattern)
26398
- .option('--private-token <string>', 'dotenv-expanded token indicating private variables', dotenvExpandDefault, privateToken)
26404
+ .option('--private-token <string>', 'dotenv-expanded token indicating private variables', dotenvExpandFromProcessEnv, privateToken)
26399
26405
  .option('--vars-delimiter <string>', 'vars delimiter string', varsDelimiter)
26400
26406
  .option('--vars-delimiter-pattern <string>', 'vars delimiter regex pattern', varsDelimiterPattern)
26401
26407
  .option('--vars-assignor <string>', 'vars assignment operator string', varsAssignor)
@@ -26490,4 +26496,4 @@ const generateGetDotenvCli = ({ logger = console, preHook, postHook, ...cliOptio
26490
26496
  });
26491
26497
  };
26492
26498
 
26493
- export { dotenvExpand, dotenvExpandAll, generateGetDotenvCli, getDotenv };
26499
+ export { dotenvExpand, dotenvExpandAll, dotenvExpandFromProcessEnv, generateGetDotenvCli, getDotenv };
package/package.json CHANGED
@@ -75,7 +75,6 @@
75
75
  ],
76
76
  "homepage": "https://github.com/karmaniverous/get-dotenv#readme",
77
77
  "keywords": [
78
- "async-programming",
79
78
  "cli",
80
79
  "configuration",
81
80
  "developer-tools",
@@ -85,11 +84,7 @@
85
84
  "environment-variables",
86
85
  "json",
87
86
  "nodejs",
88
- "programming",
89
- "software-development",
90
- "sync-programming",
91
- "typescript",
92
- "yaml"
87
+ "typescript"
93
88
  ],
94
89
  "license": "BSD-3-Clause",
95
90
  "main": "./lib/index.js",
@@ -135,5 +130,5 @@
135
130
  },
136
131
  "type": "module",
137
132
  "types": "dist/index.d.ts",
138
- "version": "4.0.0-0"
133
+ "version": "4.0.0-1"
139
134
  }