@karmaniverous/get-dotenv 3.0.1 → 3.0.3

package/README.md

@@ -79,7 +79,8 @@ Usage: getdotenv [options] [command]
 Base CLI. All options except delimiters follow dotenv-expand rules.
 
 Options:
-  -e, --env <string>            environment name
+  -e, --env <string>            target environment
+  --default-env <string>        default target environment (default: "dev")
   -p, --paths <string>          delimited list of paths to dotenv directory (default: "./")
   --paths-delimiter <string>    regex paths delimiter (default: "\\s+")
   -v, --vars <string>           delimited list KEY=VALUE pairs
@@ -193,6 +194,7 @@ GetDotenv CLI Options type
 | Name | Type | Description |
 | --- | --- | --- |
 | [cliInvocation] | <code>string</code> | cli invocation string (used for cli help) |
+| [defaultEnv] | <code>string</code> | default target environment |
 | [dotenvToken] | <code>string</code> | token indicating a dotenv file |
 | [dynamicPath] | <code>string</code> | path to file exporting an object keyed to dynamic variable functions |
 | [env] | <code>string</code> | target environment |

package/dist/default/lib/getCli.js

@@ -24,6 +24,7 @@ const booleanExpand = value => (0, _boolean.boolean)((0, _dotenvExpand.dotenvExp
  *
  * @typedef {Object} GetDotenvCliOptions
  * @property {string} [cliInvocation] - cli invocation string (used for cli help)
+ * @property {string} [defaultEnv] - default target environment
  * @property {string} [dotenvToken] - token indicating a dotenv file
  * @property {string} [dynamicPath] - path to file exporting an object keyed to dynamic variable functions
  * @property {string} [env] - target environment
@@ -84,6 +85,7 @@ const getCli = function () {
   let {
     cliInvocation = 'getdotenv',
     command,
+    defaultEnv = 'dev',
     dotenvToken,
     dynamicPath,
     env,
@@ -109,7 +111,9 @@ const getCli = function () {
   if (Array.isArray(paths)) paths = paths.join(' ');
   return new _commander.Command().name(cliInvocation)
   // .usage('[options] [command] [command options] [commad args]')
-  .description('Base CLI. All options except delimiters follow dotenv-expand rules.').enablePositionalOptions().passThroughOptions().option('-e, --env <string>', 'environment name', _dotenvExpand.dotenvExpand, env).option('-p, --paths <string>', 'delimited list of paths to dotenv directory', _dotenvExpand.dotenvExpand, paths).option('--paths-delimiter <string>', 'regex paths delimiter', pathsDelimiter).option('-v, --vars <string>', 'delimited list KEY=VALUE pairs', _dotenvExpand.dotenvExpand, vars).option('--vars-delimiter <string>', 'regex vars delimiter', varsDelimiter).option('--vars-assignor <string>', 'regex vars assignment operator', varsAssignor).option('-y, --dynamic-path <string>', 'dynamic variables path', _dotenvExpand.dotenvExpand, dynamicPath).option('-o, --output-path <string>', 'consolidated output file, follows dotenv-expand rules using loaded env vars', _dotenvExpand.dotenvExpand, outputPath).option('-n, --exclude-env [bool]', 'exclude environment-specific variables', booleanExpand, excludeEnv ?? false).option('-g, --exclude-global [bool]', 'exclude global & dynamic variables', booleanExpand, excludeGlobal ?? false).option('-r, --exclude-private [bool]', 'exclude private variables', booleanExpand, excludePrivate ?? false).option('-u, --exclude-public [bool]', 'exclude public variables', booleanExpand, excludePublic ?? false).option('-z, --exclude-dynamic [bool]', 'exclude dynamic variables', booleanExpand, excludeDynamic ?? false).option('-l, --log [bool]', 'console log extracted variables', booleanExpand, log ?? false).option('-x, --suppress-dotenv', 'suppress dotenv loading', booleanExpand, suppressDotenv ?? false).option('-c, --command <string>', 'shell command string', _dotenvExpand.dotenvExpand, command).option('-s, --shell <string>', 'execa shell option', _dotenvExpand.dotenvExpand, shell).option('--dotenv-token <string>', 'token indicating a dotenv file', _dotenvExpand.dotenvExpand, dotenvToken).option('--private-token <string>', 'token indicating private variables', _dotenvExpand.dotenvExpand, privateToken).addCommand(new _commander.Command().name('cmd').description('execute shell command string (default command)').configureHelp({
+  .description('Base CLI. All options except delimiters follow dotenv-expand rules.').enablePositionalOptions().passThroughOptions().option('-e, --env <string>', 'target environment', _dotenvExpand.dotenvExpand, env).option('--default-env <string>', 'default target environment', _dotenvExpand.dotenvExpand, defaultEnv).option('-p, --paths <string>', 'delimited list of paths to dotenv directory', _dotenvExpand.dotenvExpand, paths).option('--paths-delimiter <string>', 'regex paths delimiter', pathsDelimiter).option('-v, --vars <string>', 'delimited list KEY=VALUE pairs', _dotenvExpand.dotenvExpand, vars).option('--vars-delimiter <string>', 'regex vars delimiter', varsDelimiter).option('--vars-assignor <string>', 'regex vars assignment operator', varsAssignor).option('-y, --dynamic-path <string>', 'dynamic variables path', _dotenvExpand.dotenvExpand, dynamicPath).option('-o, --output-path <string>', 'consolidated output file, follows dotenv-expand rules using loaded env vars', _dotenvExpand.dotenvExpand, outputPath).option('-n, --exclude-env [bool]', 'exclude environment-specific variables', booleanExpand, excludeEnv ?? false).option('-g, --exclude-global [bool]', 'exclude global & dynamic variables', booleanExpand, excludeGlobal ?? false).option('-r, --exclude-private [bool]', 'exclude private variables', booleanExpand, excludePrivate ?? false).option('-u, --exclude-public [bool]', 'exclude public variables', booleanExpand, excludePublic ?? false).option('-z, --exclude-dynamic [bool]', 'exclude dynamic variables', booleanExpand, excludeDynamic ?? false).option('-l, --log [bool]', 'console log extracted variables', booleanExpand, log ?? false).option('-x, --suppress-dotenv', 'suppress dotenv loading', booleanExpand, suppressDotenv ?? false).option('-c, --command <string>', 'shell command string', _dotenvExpand.dotenvExpand, command).option('-s, --shell <string>', 'execa shell option', _dotenvExpand.dotenvExpand, shell).option('--dotenv-token <string>', 'token indicating a dotenv file', _dotenvExpand.dotenvExpand, dotenvToken).option('--private-token <string>', 'token indicating private variables', _dotenvExpand.dotenvExpand, privateToken).addCommand(new _commander.Command().name('cmd').description('execute shell command string')
+  // .description('execute shell command string (default command)')
+  .configureHelp({
     showGlobalOptions: true
   }).enablePositionalOptions().passThroughOptions().action(async (options, _ref) => {
     let {
@@ -120,9 +124,9 @@ const getCli = function () {
       stdio: 'inherit',
       shell: parent.opts().shell
     });
-  }), {
-    isDefault: true
-  }).hook('preSubcommand', async thisCommand => {
+  })
+  // { isDefault: true }
+  ).hook('preSubcommand', async thisCommand => {
     var _paths;
     // Inherit options from parent command.
     let options = {
@@ -136,6 +140,8 @@ const getCli = function () {
     // Get options.
     let {
       command,
+      defaultEnv,
+      env,
       paths,
       pathsDelimiter,
       suppressDotenv,
@@ -154,6 +160,7 @@ const getCli = function () {
       if ((0, _lodash2.default)(paths)) paths = (_paths2 = paths) === null || _paths2 === void 0 ? void 0 : _paths2.split(new RegExp(pathsDelimiter));
       var dotenv = await (0, _getDotenv.getDotenv)({
         ...rest,
+        env: env ?? defaultEnv,
         loadProcess: true,
         paths,
         vars

package/lib/getCli.js

@@ -17,6 +17,7 @@ const booleanExpand = (value) => boolean(dotenvExpand(value));
  *
  * @typedef {Object} GetDotenvCliOptions
  * @property {string} [cliInvocation] - cli invocation string (used for cli help)
+ * @property {string} [defaultEnv] - default target environment
  * @property {string} [dotenvToken] - token indicating a dotenv file
  * @property {string} [dynamicPath] - path to file exporting an object keyed to dynamic variable functions
  * @property {string} [env] - target environment
@@ -72,6 +73,7 @@ export const getCli = ({ defaultOptions = {}, preHook, postHook } = {}) => {
   let {
     cliInvocation = 'getdotenv',
     command,
+    defaultEnv = 'dev',
     dotenvToken,
     dynamicPath,
     env,
@@ -106,7 +108,13 @@ export const getCli = ({ defaultOptions = {}, preHook, postHook } = {}) => {
       )
       .enablePositionalOptions()
       .passThroughOptions()
-      .option('-e, --env <string>', 'environment name', dotenvExpand, env)
+      .option('-e, --env <string>', 'target environment', dotenvExpand, env)
+      .option(
+        '--default-env <string>',
+        'default target environment',
+        dotenvExpand,
+        defaultEnv
+      )
       .option(
         '-p, --paths <string>',
         'delimited list of paths to dotenv directory',
@@ -210,7 +218,8 @@ export const getCli = ({ defaultOptions = {}, preHook, postHook } = {}) => {
       .addCommand(
         new Command()
           .name('cmd')
-          .description('execute shell command string (default command)')
+          .description('execute shell command string')
+          // .description('execute shell command string (default command)')
           .configureHelp({ showGlobalOptions: true })
           .enablePositionalOptions()
           .passThroughOptions()
@@ -220,8 +229,8 @@ export const getCli = ({ defaultOptions = {}, preHook, postHook } = {}) => {
                 stdio: 'inherit',
                 shell: parent.opts().shell,
               });
-          }),
-        { isDefault: true }
+          })
+        // { isDefault: true }
       )
       .hook('preSubcommand', async (thisCommand) => {
         // Inherit options from parent command.
@@ -238,6 +247,8 @@ export const getCli = ({ defaultOptions = {}, preHook, postHook } = {}) => {
         // Get options.
         let {
           command,
+          defaultEnv,
+          env,
           paths,
           pathsDelimiter,
           suppressDotenv,
@@ -262,6 +273,7 @@ export const getCli = ({ defaultOptions = {}, preHook, postHook } = {}) => {
 
           var dotenv = await getDotenv({
             ...rest,
+            env: env ?? defaultEnv,
             loadProcess: true,
             paths,
             vars,

package/package.json

@@ -3,7 +3,7 @@
   "bin": {
     "getdotenv": "bin/getdotenv/index.js"
   },
-  "version": "3.0.1",
+  "version": "3.0.3",
   "publishConfig": {
     "access": "public"
   },