@karmaniverous/get-dotenv 6.0.0-0 → 6.0.0

package/package.json

@@ -13,58 +13,61 @@
     "url": "https://github.com/karmaniverous/get-dotenv/issues"
   },
   "dependencies": {
-    "commander": "^14.0.1",
+    "@commander-js/extra-typings": "^14.0.0",
+    "commander": "^14.0.2",
     "dotenv": "^17.2.3",
-    "execa": "^9.6.0",
+    "execa": "^9.6.1",
     "fs-extra": "^11.3.2",
-    "globby": "^15",
+    "globby": "^16",
     "nanoid": "^5.1.6",
     "package-directory": "^8.1.0",
-    "yaml": "^2.8.1",
-    "zod": "^4.1.12"
+    "yaml": "^2.8.2",
+    "zod": "^4.1.13"
   },
   "description": "Process dotenv files in an arbitrary location & optionally populate environment variables.",
   "devDependencies": {
-    "@dotenvx/dotenvx": "^1.51.0",
-    "@eslint/js": "^9.38.0",
-    "@rollup/plugin-alias": "^5.1.1",
-    "@rollup/plugin-commonjs": "^28.0.8",
+    "@aws-sdk/client-sts": "^3.948.0",
+    "@dotenvx/dotenvx": "^1.51.2",
+    "@eslint/js": "^9.39.2",
+    "@rollup/plugin-alias": "^6.0.0",
+    "@rollup/plugin-commonjs": "^29.0.0",
     "@rollup/plugin-json": "^6.1.0",
     "@rollup/plugin-node-resolve": "^16.0.3",
-    "@rollup/plugin-typescript": "^12.1.4",
+    "@rollup/plugin-typescript": "^12.3.0",
     "@types/fs-extra": "^11.0.4",
-    "@types/node": "^24",
-    "@vitest/coverage-v8": "^3.2.4",
-    "@vitest/eslint-plugin": "^1.3.23",
+    "@types/node": "^25",
+    "@vitest/coverage-v8": "^4.0.15",
+    "@vitest/eslint-plugin": "^1.5.2",
     "auto-changelog": "^2.5.0",
     "cross-env": "^10.1.0",
-    "esbuild": "^0.25.11",
-    "eslint": "^9.38.0",
+    "esbuild": "^0.27.1",
+    "eslint": "^9.39.2",
     "eslint-config-prettier": "^10.1.8",
     "eslint-plugin-jsonc": "^2.21.0",
     "eslint-plugin-prettier": "^5.5.4",
     "eslint-plugin-simple-import-sort": "^12.1.1",
-    "eslint-plugin-tsdoc": "^0.4.0",
+    "eslint-plugin-tsdoc": "^0.5.0",
     "fs-extra": "^11.3.2",
-    "globals": "^16.4.0",
-    "jsonc-eslint-parser": "^2.4.1",
-    "knip": "^5.66.1",
-    "lefthook": "^2.0.0",
-    "npm-packlist": "^10.0.2",
-    "prettier": "^3.6.2",
-    "release-it": "^19.0.5",
-    "rimraf": "^6.0.1",
-    "rollup": "^4.52.5",
-    "rollup-plugin-dts": "^6.2.3",
+    "globals": "^16.5.0",
+    "jsonc-eslint-parser": "^2.4.2",
+    "knip": "^5.73.4",
+    "lefthook": "^2.0.11",
+    "npm-packlist": "^10.0.3",
+    "prettier": "^3.7.4",
+    "release-it": "^19.1.0",
+    "rimraf": "^6.1.2",
+    "rollup": "^4.53.3",
+    "rollup-plugin-copy": "^3.5.0",
+    "rollup-plugin-dts": "^6.3.0",
     "tslib": "^2.8.1",
-    "tsx": "^4.20.6",
-    "typedoc": "^0.28.14",
+    "tsx": "^4.21.0",
+    "typedoc": "^0.28.15",
     "typedoc-plugin-mdn-links": "^5.0.10",
     "typedoc-plugin-replace-text": "^4.2.0",
     "typescript": "^5.9.3",
-    "typescript-eslint": "^8.46.1",
+    "typescript-eslint": "^8.49.0",
     "vite-tsconfig-paths": "^5.1.4",
-    "vitest": "^3.2.4"
+    "vitest": "^4.0.15"
   },
   "engines": {
     "node": ">=20"
@@ -72,102 +75,62 @@
   "exports": {
     ".": {
       "import": {
-        "types": "./dist/index.d.mts",
+        "types": "./dist/index.d.ts",
         "default": "./dist/index.mjs"
-      },
-      "require": {
-        "types": "./dist/index.d.cts",
-        "default": "./dist/index.cjs"
+      }
+    },
+    "./cli": {
+      "import": {
+        "types": "./dist/cli.d.ts",
+        "default": "./dist/cli.mjs"
       }
     },
     "./cliHost": {
       "import": {
-        "types": "./dist/cliHost.d.mts",
+        "types": "./dist/cliHost.d.ts",
         "default": "./dist/cliHost.mjs"
-      },
-      "require": {
-        "types": "./dist/cliHost.d.cts",
-        "default": "./dist/cliHost.cjs"
       }
     },
     "./plugins": {
       "import": {
-        "types": "./dist/plugins.d.mts",
+        "types": "./dist/plugins.d.ts",
         "default": "./dist/plugins.mjs"
-      },
-      "require": {
-        "types": "./dist/plugins.d.cts",
-        "default": "./dist/plugins.cjs"
       }
     },
     "./plugins/aws": {
       "import": {
-        "types": "./dist/plugins-aws.d.mts",
+        "types": "./dist/plugins-aws.d.ts",
         "default": "./dist/plugins-aws.mjs"
-      },
-      "require": {
-        "types": "./dist/plugins-aws.d.cts",
-        "default": "./dist/plugins-aws.cjs"
       }
     },
     "./plugins/batch": {
       "import": {
-        "types": "./dist/plugins-batch.d.mts",
+        "types": "./dist/plugins-batch.d.ts",
         "default": "./dist/plugins-batch.mjs"
-      },
-      "require": {
-        "types": "./dist/plugins-batch.d.cts",
-        "default": "./dist/plugins-batch.cjs"
       }
     },
     "./plugins/init": {
       "import": {
-        "types": "./dist/plugins-init.d.mts",
+        "types": "./dist/plugins-init.d.ts",
         "default": "./dist/plugins-init.mjs"
-      },
-      "require": {
-        "types": "./dist/plugins-init.d.cts",
-        "default": "./dist/plugins-init.cjs"
       }
     },
     "./plugins/cmd": {
       "import": {
-        "types": "./dist/plugins-cmd.d.mts",
+        "types": "./dist/plugins-cmd.d.ts",
         "default": "./dist/plugins-cmd.mjs"
-      },
-      "require": {
-        "types": "./dist/plugins-cmd.d.cts",
-        "default": "./dist/plugins-cmd.cjs"
-      }
-    },
-    "./plugins/demo": {
-      "import": {
-        "types": "./dist/plugins-demo.d.mts",
-        "default": "./dist/plugins-demo.mjs"
-      },
-      "require": {
-        "types": "./dist/plugins-demo.d.cts",
-        "default": "./dist/plugins-demo.cjs"
       }
     },
     "./config": {
       "import": {
-        "types": "./dist/config.d.mts",
+        "types": "./dist/config.d.ts",
         "default": "./dist/config.mjs"
-      },
-      "require": {
-        "types": "./dist/config.d.cts",
-        "default": "./dist/config.cjs"
       }
     },
     "./env/overlay": {
       "import": {
-        "types": "./dist/env-overlay.d.mts",
+        "types": "./dist/env-overlay.d.ts",
         "default": "./dist/env-overlay.mjs"
-      },
-      "require": {
-        "types": "./dist/env-overlay.d.cts",
-        "default": "./dist/env-overlay.cjs"
       }
     }
   },
@@ -190,7 +153,7 @@
     "typescript"
   ],
   "license": "BSD-3-Clause",
-  "main": "dist/index.cjs",
+  "main": "dist/index.mjs",
   "name": "@karmaniverous/get-dotenv",
   "peerDependencies": {
     "esbuild": "*"
@@ -229,7 +192,8 @@
       ]
     },
     "npm": {
-      "publish": true
+      "publish": false,
+      "skipChecks": true
     }
   },
   "repository": {
@@ -248,7 +212,6 @@
     "lint:fix": "eslint --fix . eslint.config.ts",
     "release": "dotenvx run -f .env.local -- release-it",
     "release:pre": "dotenvx run -f .env.local -- release-it --no-git.requireBranch --github.prerelease --preRelease",
-    "stan:docs": "typedoc --emit none",
     "test": "vitest run",
     "typecheck": "tsc -p tsconfig.json --noEmit",
     "verify:types": "node tools/verify-types.js",
@@ -259,5 +222,5 @@
   },
   "type": "module",
   "types": "dist/index.d.ts",
-  "version": "6.0.0-0"
+  "version": "6.0.0"
 }

package/templates/cli/index.ts

@@ -0,0 +1,26 @@
+#!/usr/bin/env node
+
+import { createCli } from '@karmaniverous/get-dotenv/cli';
+
+import {
+  awsPlugin,
+  awsWhoamiPlugin,
+  batchPlugin,
+  cmdPlugin,
+  initPlugin,
+} from '@/src/plugins';
+
+import { helloPlugin } from './plugins/hello';
+
+await createCli({
+  alias: 'mycli',
+  compose: (program) =>
+    program
+      .use(
+        cmdPlugin({ asDefault: true, optionAlias: '-c, --cmd <command...>' }),
+      )
+      .use(batchPlugin())
+      .use(awsPlugin().use(awsWhoamiPlugin()))
+      .use(initPlugin())
+      .use(helloPlugin()),
+})();

package/templates/cli/plugins/hello.ts

@@ -0,0 +1,43 @@
+import {
+  definePlugin,
+  getRootCommand,
+} from '@karmaniverous/get-dotenv/cliHost';
+import { z } from 'zod';
+
+const HelloConfigSchema = z.object({
+  loud: z.boolean().optional().default(false),
+  color: z.string().optional(),
+});
+
+export const helloPlugin = () => {
+  const plugin = definePlugin({
+    ns: 'hello',
+    configSchema: HelloConfigSchema,
+    setup(cli) {
+      cli
+        .ns('hello')
+        .description('Say hello with current dotenv context')
+        .addOption(
+          plugin.createPluginDynamicOption(
+            cli,
+            '--loud',
+            (_bag, cfg) =>
+              `print greeting in ALL CAPS${cfg.loud ? ' (default)' : ''}`,
+          ),
+        )
+        .action(() => {
+          const ctx = cli.getCtx();
+          // Derive CLI name from the true root command using a typed helper.
+          const rootName = getRootCommand(cli).name();
+
+          const cfg = plugin.readConfig(cli);
+          const keys = Object.keys(ctx.dotenv);
+          const label = cfg.loud
+            ? `[${rootName}] DOTENV KEYS (${String(keys.length)}):`
+            : `[${rootName}] dotenv keys (${String(keys.length)}):`;
+          console.log(label, keys.join(', '));
+        });
+    },
+  });
+  return plugin;
+};

package/templates/config/js/getdotenv.config.js

@@ -1,7 +1,12 @@
 export default {
-  dotenvToken: '.env',
-  privateToken: 'local',
-  paths: './',
+  // Help-time root defaults (example):
+  // rootOptionDefaults: {
+  //   redact: true,
+  //   // redactPatterns: ['API_KEY', 'SECRET'],
+  // },
+  // Help-time visibility (example): hide selected root flags in -h
+  // rootOptionVisibility: { capture: false },
+
   vars: { APP_SETTING: 'app_value' },
   envVars: { dev: { ENV_SETTING: 'dev_value' } },
   dynamic: {
@@ -12,4 +17,4 @@ export default {
     // provided, this returns an empty string.
     ENV_TAG: (_vars, env) => (env ? `for-${env}` : ''),
   },
-};
+};

package/templates/config/json/public/getdotenv.config.json

@@ -1,7 +1,4 @@
 {
-  "dotenvToken": ".env",
-  "privateToken": "local",
-  "paths": "./",
   "vars": {
     "APP_SETTING": "app_value"
   },

package/templates/config/public/getdotenv.config.json

@@ -1,9 +1,4 @@
 {
-  "dotenvToken": ".env",
-  "privateToken": "local",
-  "paths": "./",
-  "loadProcess": true,
-  "log": false,
   "vars": {
     "APP_NAME": "my-app"
   },

package/templates/config/ts/getdotenv.config.ts

@@ -1,7 +1,19 @@
-export default {
-  dotenvToken: '.env',
-  privateToken: 'local',
-  paths: './',
+import { defineGetDotenvConfig } from '@karmaniverous/get-dotenv/core';
+
+type Vars = {
+  APP_SETTING?: string;
+  ENV_SETTING?: string;
+};
+
+export default defineGetDotenvConfig<Vars>({
+  // Help-time root defaults (example):
+  // rootOptionDefaults: {
+  //   redact: true,
+  //   // redactPatterns: ['API_KEY', 'SECRET'],
+  // },
+  // Help-time visibility (example): hide selected root flags in -h
+  // rootOptionVisibility: { capture: false },
+
   vars: { APP_SETTING: 'app_value' },
   envVars: { dev: { ENV_SETTING: 'dev_value' } },
   dynamic: {
@@ -13,4 +25,4 @@ export default {
     ENV_TAG: (_vars: Record<string, string | undefined>, env?: string) =>
       env ? `for-${env}` : '',
   },
-};
+});

package/templates/config/yaml/public/getdotenv.config.yaml

@@ -1,6 +1,3 @@
-dotenvToken: ".env"
-privateToken: "local"
-paths: "./"
 vars:
   APP_SETTING: "app_value"
 envVars: