@karmaniverous/get-dotenv 4.5.2 → 5.0.0-0

package/package.json

@@ -1,139 +1,228 @@
-{
-  "author": "Jason Williscroft",
-  "bin": {
-    "getdotenv": "./dist/getdotenv.cli.mjs"
-  },
-  "bugs": {
-    "url": "https://github.com/karmaniverous/get-dotenv/issues"
-  },
-  "dependencies": {
-    "commander": "^12.1.0",
-    "dotenv": "^16.4.5",
-    "execa": "^9.3.0",
-    "fs-extra": "^11.2.0",
-    "globby": "<14",
-    "lodash": "^4.17.21",
-    "nanoid": "^5.0.7",
-    "pkg-dir": "^8.0.0",
-    "tslog": "^4.9.3"
-  },
-  "description": "Process dotenv files in an arbitrary location & optionally populate environment variables.",
-  "devDependencies": {
-    "@commander-js/extra-typings": "^12.1.0",
-    "@eslint/js": "^9.7.0",
-    "@rollup/plugin-alias": "^5.1.0",
-    "@rollup/plugin-commonjs": "^26.0.1",
-    "@rollup/plugin-json": "^6.1.0",
-    "@rollup/plugin-node-resolve": "^15.2.3",
-    "@rollup/plugin-terser": "^0.4.4",
-    "@rollup/plugin-typescript": "^11.1.6",
-    "@types/chai": "^4.3.16",
-    "@types/eslint__js": "^8.42.3",
-    "@types/eslint-config-prettier": "^6.11.3",
-    "@types/eslint-plugin-mocha": "^10.4.0",
-    "@types/fs-extra": "^11.0.4",
-    "@types/lodash": "^4.17.7",
-    "@types/mocha": "^10.0.7",
-    "@types/node": "^20.14.11",
-    "auto-changelog": "^2.4.0",
-    "chai": "^5.1.1",
-    "cross-env": "^7.0.3",
-    "eslint": "^8.57.0",
-    "eslint-config-prettier": "^9.1.0",
-    "eslint-plugin-mocha": "^10.4.3",
-    "eslint-plugin-simple-import-sort": "^12.1.1",
-    "eslint-plugin-tsdoc": "^0.2.17",
-    "fs-extra": "^11.2.0",
-    "jsdom-global": "^3.0.2",
-    "knip": "^5.26.0",
-    "lefthook": "^1.7.2",
-    "mocha": "^10.6.0",
-    "nyc": "^17.0.0",
-    "prettier": "^3.3.3",
-    "release-it": "^17.6.0",
-    "rimraf": "^5.0.9",
-    "rollup": "^4.18.1",
-    "rollup-plugin-dts": "^6.1.1",
-    "source-map-support": "^0.5.21",
-    "ts-node": "^10.9.2",
-    "tslib": "^2.6.3",
-    "typescript": "^5.5.3",
-    "typescript-eslint": "^7.16.1"
-  },
-  "exports": {
-    ".": {
-      "import": {
-        "types": "./dist/index.d.mts",
-        "default": "./dist/index.mjs"
-      },
-      "require": {
-        "types": "./dist/index.d.cts",
-        "default": "./dist/index.cjs"
-      }
-    }
-  },
-  "files": [
-    "dist"
-  ],
-  "homepage": "https://github.com/karmaniverous/get-dotenv#readme",
-  "keywords": [
-    "cli",
-    "configuration",
-    "developer-tools",
-    "development-environment",
-    "devops",
-    "dotenv-management",
-    "environment-variables",
-    "json",
-    "nodejs",
-    "typescript"
-  ],
-  "license": "BSD-3-Clause",
-  "main": "./lib/index.js",
-  "name": "@karmaniverous/get-dotenv",
-  "publishConfig": {
-    "access": "public"
-  },
-  "release-it": {
-    "git": {
-      "changelog": "npx auto-changelog --stdout --commit-limit false -u --template https://raw.githubusercontent.com/release-it/release-it/main/templates/changelog-compact.hbs",
-      "commitMessage": "chore: release v${version}",
-      "requireBranch": "main"
-    },
-    "github": {
-      "release": true
-    },
-    "hooks": {
-      "after:init": [
-        "npm run lint",
-        "npm run test",
-        "npm run build"
-      ],
-      "after:release": [
-        "git switch -c release/${version}",
-        "git push -u origin release/${version}",
-        "git switch ${branchName}"
-      ]
-    },
-    "npm": {
-      "publish": true
-    }
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/karmaniverous/get-dotenv"
-  },
-  "scripts": {
-    "build": "rimraf dist && rollup --config rollup.config.ts --configPlugin @rollup/plugin-typescript",
-    "cli": "node dist/getdotenv.cli.mjs",
-    "knip": "knip",
-    "lint": "eslint src/** && prettier -c src",
-    "lint:fix": "eslint --fix src/** && prettier --write src",
-    "release": "release-it",
-    "release:pre": "vc -c \"release-it --no-git.requireBranch --github.prerelease --preRelease\"",
-    "test": "cross-env LOG_LEVEL=debug nyc mocha"
-  },
-  "type": "module",
-  "types": "dist/index.d.ts",
-  "version": "4.5.2"
-}
+{
+  "author": "Jason Williscroft",
+  "auto-changelog": {
+    "output": "CHANGELOG.md",
+    "unreleased": true,
+    "commitLimit": false,
+    "hideCredit": true
+  },
+  "bin": {
+    "getdotenv": "./dist/getdotenv.cli.mjs"
+  },
+  "bugs": {
+    "url": "https://github.com/karmaniverous/get-dotenv/issues"
+  },
+  "dependencies": {
+    "commander": "^14.0.1",
+    "dotenv": "^17.2.2",
+    "execa": "^9.6.0",
+    "fs-extra": "^11.3.2",
+    "globby": "^14",
+    "nanoid": "^5.1.5",
+    "package-directory": "^8.1.0",
+    "yaml": "^2.8.1",
+    "zod": "^4.1.9"
+  },
+  "description": "Process dotenv files in an arbitrary location & optionally populate environment variables.",
+  "devDependencies": {
+    "@dotenvx/dotenvx": "^1.50.1",
+    "@eslint/js": "^9.36.0",
+    "@rollup/plugin-alias": "^5.1.1",
+    "@rollup/plugin-commonjs": "^28.0.6",
+    "@rollup/plugin-json": "^6.1.0",
+    "@rollup/plugin-node-resolve": "^16.0.1",
+    "@rollup/plugin-typescript": "^12.1.4",
+    "@types/fs-extra": "^11.0.4",
+    "@types/node": "^22",
+    "@vitest/eslint-plugin": "^1.3.6",
+    "@vitest/coverage-v8": "^3.2.4",
+    "auto-changelog": "^2.5.0",
+    "esbuild": "^0.25.10",
+    "eslint": "^9.36.0",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-jsonc": "^2.20.1",
+    "eslint-plugin-prettier": "^5.5.4",
+    "eslint-plugin-simple-import-sort": "^12.1.1",
+    "eslint-plugin-tsdoc": "^0.4.0",
+    "fs-extra": "^11.3.2",
+    "globals": "^16.4.0",
+    "jsonc-eslint-parser": "^2.4.0",
+    "knip": "^5.63.1",
+    "npm-packlist": "^10.0.1",
+    "lefthook": "^1.13.1",
+    "prettier": "^3.6.2",
+    "release-it": "^19.0.5",
+    "rimraf": "^6.0.1",
+    "rollup": "^4.52.0",
+    "rollup-plugin-dts": "^6.2.3",
+    "tslib": "^2.8.1",
+    "tsx": "^4.20.5",
+    "typedoc": "^0.28.13",
+    "typedoc-plugin-mdn-links": "^5.0.9",
+    "typedoc-plugin-replace-text": "^4.2.0",
+    "typescript": "^5.9.2",
+    "typescript-eslint": "^8.44.0",
+    "vite-tsconfig-paths": "^5.1.4",
+    "vitest": "^3.2.4"
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./cliHost": {
+      "import": {
+        "types": "./dist/cliHost.d.mts",
+        "default": "./dist/cliHost.mjs"
+      },
+      "require": {
+        "types": "./dist/cliHost.d.cts",
+        "default": "./dist/cliHost.cjs"
+      }
+    },
+    "./plugins/aws": {
+      "import": {
+        "types": "./dist/plugins-aws.d.mts",
+        "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",
+        "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",
+        "default": "./dist/plugins-init.mjs"
+      },
+      "require": {
+        "types": "./dist/plugins-init.d.cts",
+        "default": "./dist/plugins-init.cjs"
+      }
+    },
+    "./config": {
+      "import": {
+        "types": "./dist/config.d.mts",
+        "default": "./dist/config.mjs"
+      },
+      "require": {
+        "types": "./dist/config.d.cts",
+        "default": "./dist/config.cjs"
+      }
+    },
+    "./env/overlay": {
+      "import": {
+        "types": "./dist/env-overlay.d.mts",
+        "default": "./dist/env-overlay.mjs"
+      },
+      "require": {
+        "types": "./dist/env-overlay.d.cts",
+        "default": "./dist/env-overlay.cjs"
+      }
+    }
+  },
+  "files": [
+    "dist",
+    "getdotenv.config.json",
+    "templates"
+  ],
+  "homepage": "https://github.com/karmaniverous/get-dotenv#readme",
+  "keywords": [
+    "cli",
+    "configuration",
+    "developer-tools",
+    "development-environment",
+    "devops",
+    "dotenv-management",
+    "environment-variables",
+    "json",
+    "nodejs",
+    "typescript"
+  ],
+  "license": "BSD-3-Clause",
+  "main": "dist/index.cjs",
+  "name": "@karmaniverous/get-dotenv",
+  "peerDependencies": {
+    "esbuild": "*"
+  },
+  "peerDependenciesMeta": {
+    "esbuild": {
+      "optional": true
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "release-it": {
+    "git": {
+      "changelog": "npx auto-changelog --stdout --template https://raw.githubusercontent.com/release-it/release-it/main/templates/changelog-compact.hbs",
+      "commitMessage": "chore: release v${version}",
+      "requireBranch": "main"
+    },
+    "github": {
+      "release": true
+    },
+    "hooks": {
+      "after:init": [
+        "npm run lint",
+        "npm run test",
+        "npm run build",
+        "npm run verify:package",
+        "npm run verify:tarball"
+      ],
+      "after:release": [
+        "git switch -c release/${version}",
+        "git push -u origin release/${version}",
+        "git switch ${branchName}"
+      ]
+    },
+    "npm": {
+      "publish": true
+    }
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/karmaniverous/get-dotenv"
+  },
+  "scripts": {
+    "build": "rimraf dist && rollup --config rollup.config.ts --configPlugin @rollup/plugin-typescript",
+    "cli": "tsx src/cli/getdotenv",
+    "cli:dist": "node dist/getdotenv.cli.mjs",
+    "changelog": "auto-changelog",
+    "docs": "typedoc",
+    "pack:dry": "npm pack --dry-run",
+    "knip": "knip",
+    "lint": "eslint . eslint.config.ts",
+    "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 --coverage",
+    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "verify:package": "node tools/verify-package.js",
+    "verify:smoke": "node tools/smoke.js",
+    "verify:tarball": "node tools/verify-tarball.js"
+  },
+  "type": "module",
+  "types": "dist/index.d.ts",
+  "version": "5.0.0-0"
+}

package/templates/cli/ts/index.ts

@@ -0,0 +1,9 @@
+import { GetDotenvCli } from '@karmaniverous/get-dotenv/cliHost';
+import type { Command } from 'commander';
+
+import { helloPlugin } from './plugins/hello';
+
+const program: Command = new GetDotenvCli('__CLI_NAME__').use(helloPlugin());
+
+await (program as unknown as GetDotenvCli).resolveAndLoad();
+await program.parseAsync();

package/templates/cli/ts/plugins/hello.ts

@@ -0,0 +1,17 @@
+import { definePlugin } from '@karmaniverous/get-dotenv/cliHost';
+
+export const helloPlugin = () =>
+  definePlugin({
+    id: 'hello',
+    setup(cli) {
+      cli
+        .ns('hello')
+        .description('Say hello with current dotenv context')
+        .action(async () => {
+          const ctx = cli.getCtx?.();
+          const name = '__CLI_NAME__';
+
+          console.log(`[${name}] dotenv keys:`, Object.keys(ctx?.dotenv ?? {}));
+        });
+    },
+  });

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

@@ -0,0 +1,15 @@
+export default {
+  dotenvToken: '.env',
+  privateToken: 'local',
+  paths: './',
+  vars: { APP_SETTING: 'app_value' },
+  envVars: { dev: { ENV_SETTING: 'dev_value' } },
+  dynamic: {
+    GREETING: ({ APP_SETTING = '' }) => `Hello ${APP_SETTING}`,
+    // Example: env-aware dynamic value. The second argument receives the
+    // selected environment (if any); tailor behavior per environment.
+    // For example, with env='dev' this yields "for-dev"; when env is not
+    // provided, this returns an empty string.
+    ENV_TAG: (_vars, env) => (env ? `for-${env}` : ''),
+  },
+};

package/templates/config/json/local/getdotenv.config.local.json

@@ -0,0 +1,7 @@
+{
+  "vars": { "APP_SECRET": "secret_value" },
+  "envVars": {
+    "dev": { "ENV_SECRET": "dev_secret" },
+    "test": { "ENV_SECRET": "test_secret" }
+  }
+}

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

@@ -0,0 +1,12 @@
+{
+  "dotenvToken": ".env",
+  "privateToken": "local",
+  "paths": "./",
+  "vars": {
+    "APP_SETTING": "app_value"
+  },
+  "envVars": {
+    "dev": { "ENV_SETTING": "dev_value" },
+    "test": { "ENV_SETTING": "test_value" }
+  }
+}

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

@@ -0,0 +1,13 @@
+{
+  "dotenvToken": ".env",
+  "privateToken": "local",
+  "paths": "./",
+  "loadProcess": true,
+  "log": false,
+  "vars": {
+    "APP_NAME": "my-app"
+  },
+  "envVars": {
+    "dev": { "DEV_ONLY": "1" }
+  }
+}

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

@@ -0,0 +1,16 @@
+export default {
+  dotenvToken: '.env',
+  privateToken: 'local',
+  paths: './',
+  vars: { APP_SETTING: 'app_value' },
+  envVars: { dev: { ENV_SETTING: 'dev_value' } },
+  dynamic: {
+    GREETING: ({ APP_SETTING = '' }) => `${APP_SETTING}-ts`,
+    // Example: env-aware dynamic value. The second argument receives the
+    // selected environment (if any); tailor behavior per environment.
+    // For example, with env='dev' this yields "for-dev"; when env is not
+    // provided, this returns an empty string.
+    ENV_TAG: (_vars: Record<string, string | undefined>, env?: string) =>
+      env ? `for-${env}` : '',
+  },
+};

package/templates/config/yaml/local/getdotenv.config.local.yaml

@@ -0,0 +1,7 @@
+vars:
+  APP_SECRET: "secret_value"
+envVars:
+  dev:
+    ENV_SECRET: "dev_secret"
+  test:
+    ENV_SECRET: "test_secret"

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

@@ -0,0 +1,10 @@
+dotenvToken: ".env"
+privateToken: "local"
+paths: "./"
+vars:
+  APP_SETTING: "app_value"
+envVars:
+  dev:
+    ENV_SETTING: "dev_value"
+  test:
+    ENV_SETTING: "test_value"