@karmaniverous/get-dotenv 3.1.19 → 4.0.0-0

package/package.json

@@ -1,100 +1,139 @@
 {
-  "name": "@karmaniverous/get-dotenv",
+  "author": "Jason Williscroft",
   "bin": {
-    "getdotenv": "bin/getdotenv/index.js"
-  },
-  "version": "3.1.19",
-  "publishConfig": {
-    "access": "public"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/karmaniverous/get-dotenv"
+    "getdotenv": "./dist/getdotenv.cli.mjs"
   },
-  "author": "Jason G. Williscroft",
   "bugs": {
     "url": "https://github.com/karmaniverous/get-dotenv/issues"
   },
-  "description": "Process dotenv files in an arbitrary location & optionally populate environment variables.",
-  "homepage": "https://github.com/karmaniverous/get-dotenv#readme",
-  "keywords": [
-    "dotenv-management",
-    "environment-variables",
-    "configuration",
-    "devops",
-    "developer-tools",
-    "json",
-    "yaml",
-    "cli",
-    "async-programming",
-    "nodejs",
-    "javascript",
-    "development-environment",
-    "software-development",
-    "programming",
-    "sync-programming"
-  ],
-  "license": "BSD-3-Clause",
   "dependencies": {
     "commander": "^12.0.0",
     "dotenv": "^16.4.5",
     "execa": "^8.0.1",
     "fs-extra": "^11.2.0",
-    "lodash.frompairs": "^4.0.1",
-    "lodash.pick": "^4.4.0",
-    "lodash.pickby": "^4.6.0",
+    "lodash": "^4.17.21",
     "nanoid": "^5.0.6",
-    "pkg-dir": "^8.0.0"
+    "pkg-dir": "^8.0.0",
+    "tslog": "^4.9.2"
   },
+  "description": "Process dotenv files in an arbitrary location & optionally populate environment variables.",
   "devDependencies": {
-    "@babel/cli": "^7.24.1",
-    "@babel/core": "^7.24.3",
-    "@babel/eslint-parser": "^7.24.1",
-    "@babel/preset-env": "^7.24.3",
-    "@babel/register": "^7.23.7",
-    "@types/node": "^20.11.30",
+    "@commander-js/extra-typings": "^12.0.1",
+    "@eslint/js": "^9.1.1",
+    "@rollup/plugin-alias": "^5.1.0",
+    "@rollup/plugin-commonjs": "^25.0.7",
+    "@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.14",
+    "@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.0",
+    "@types/mocha": "^10.0.6",
+    "@types/node": "^20.12.7",
+    "auto-changelog": "^2.4.0",
     "chai": "^5.1.0",
-    "concat-md": "^0.5.1",
+    "cross-env": "^7.0.3",
     "eslint": "^8.57.0",
-    "eslint-plugin-mocha": "^10.4.1",
-    "eslint-plugin-promise": "^6.1.1",
-    "jsdoc-to-markdown": "^8.0.1",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-mocha": "^10.4.3",
+    "eslint-plugin-simple-import-sort": "^12.1.0",
+    "eslint-plugin-tsdoc": "^0.2.17",
+    "fs-extra": "^11.2.0",
+    "jsdom-global": "^3.0.2",
+    "lefthook": "^1.6.10",
     "mocha": "^10.4.0",
-    "release-it": "^17.1.1"
+    "nyc": "^15.1.0",
+    "prettier": "^3.2.5",
+    "release-it": "^17.2.0",
+    "rimraf": "^5.0.5",
+    "rollup": "^4.16.4",
+    "rollup-plugin-dts": "^6.1.0",
+    "source-map-support": "^0.5.21",
+    "ts-node": "^10.9.2",
+    "tslib": "^2.6.2",
+    "typescript": "^5.4.5",
+    "typescript-eslint": "^7.7.1"
   },
   "exports": {
     ".": {
-      "import": "./lib/index.js",
-      "require": "./dist/default/lib/index.js"
+      "import": {
+        "default": "./dist/index.mjs",
+        "types": "./dist/index.d.mts"
+      },
+      "require": {
+        "default": "./dist/index.cjs",
+        "types": "./dist/index.d.cts"
+      }
     }
   },
+  "files": [
+    "dist"
+  ],
+  "homepage": "https://github.com/karmaniverous/get-dotenv#readme",
+  "keywords": [
+    "async-programming",
+    "cli",
+    "configuration",
+    "developer-tools",
+    "development-environment",
+    "devops",
+    "dotenv-management",
+    "environment-variables",
+    "json",
+    "nodejs",
+    "programming",
+    "software-development",
+    "sync-programming",
+    "typescript",
+    "yaml"
+  ],
+  "license": "BSD-3-Clause",
   "main": "./lib/index.js",
-  "mocha": {
-    "exclude": [
-      "./dist/**",
-      "./node_modules/**"
-    ],
-    "require": [
-      "@babel/register"
-    ],
-    "spec": "./**/*.test.!(*.*)"
+  "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 main"
+      ]
+    },
     "npm": {
       "publish": true
     }
   },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/karmaniverous/get-dotenv"
+  },
   "scripts": {
-    "cli": "node ./bin/getdotenv",
-    "build": "babel lib -d dist/default/lib --delete-dir-on-start --config-file ./dist/default/.babelrc",
-    "doc": "jsdoc2md -c doc/jsdoc.config.json -f lib/**/*.* -t doc/api-template.hbs > doc/3-api.jsdoc2.md && concat-md doc --hide-anchor-links > README.md",
-    "lint": "eslint lib/** bin/**",
-    "prerelease": "npm run lint && npm run test && npm run build && npm run doc",
+    "build": "rimraf dist && rollup --config rollup.config.ts --configPlugin @rollup/plugin-typescript",
+    "lint": "eslint src/** && prettier -c src",
+    "lint:fix": "eslint --fix src/** && prettier --write src",
     "release": "release-it",
-    "test": "mocha"
+    "test": "cross-env LOG_LEVEL=debug nyc mocha"
   },
-  "type": "module"
+  "type": "module",
+  "types": "dist/index.d.ts",
+  "version": "4.0.0-0"
 }

package/bin/getdotenv/index.js

@@ -1,8 +0,0 @@
-#!/usr/bin/env node
-
-// lib imports
-import { getDotenvCli } from '../../lib/getDotenvCli.js';
-
-const cli = getDotenvCli();
-
-await cli.parseAsync();

package/dist/default/lib/dotenvExpand.js

@@ -1,67 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.dotenvExpandAll = exports.dotenvExpand = void 0;
-// like String.prototype.search but returns the last index
-const _searchLast = (str, rgx) => {
-  const matches = Array.from(str.matchAll(rgx));
-  return matches.length > 0 ? matches.slice(-1)[0].index : -1;
-};
-const _interpolate = (envValue, ref) => {
-  // find the last unescaped dollar sign in the
-  // value so that we can evaluate it
-  const lastUnescapedDollarSignIndex = _searchLast(envValue, /(?!(?<=\\))\$/g);
-
-  // If we couldn't match any unescaped dollar sign
-  // let's return the string as is
-  if (lastUnescapedDollarSignIndex === -1) return envValue;
-
-  // This is the right-most group of variables in the string
-  const rightMostGroup = envValue.slice(lastUnescapedDollarSignIndex);
-
-  /**
-   * This finds the inner most variable/group divided
-   * by variable name and default value (if present)
-   * (
-   *   (?!(?<=\\))\$        // only match dollar signs that are not escaped
-   *   {?                   // optional opening curly brace
-   *     ([\w]+)            // match the variable name
-   *     (?::-([^}\\]*))?   // match an optional default value
-   *   }?                   // optional closing curly brace
-   * )
-   */
-  const matchGroup = /((?!(?<=\\))\${?([\w]+)(?::-([^}\\]*))?}?)/;
-  const match = rightMostGroup.match(matchGroup);
-  if (match != null) {
-    const [, group, variableName, defaultValue] = match;
-    return _interpolate(envValue.replace(group, ref[variableName] || defaultValue || ''), ref);
-  }
-  return envValue;
-};
-const _resolveEscapeSequences = value => {
-  return value.replace(/\\\$/g, '$');
-};
-const dotenvExpand = function (value) {
-  let ref = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : process.env;
-  if (!value || value === 'undefined') return;
-  const result = _resolveEscapeSequences(_interpolate(value, ref));
-  return result.length ? result : undefined;
-};
-exports.dotenvExpand = dotenvExpand;
-const dotenvExpandAll = _ref => {
-  let {
-    vars = {},
-    progressive = false,
-    ref = process.env
-  } = _ref;
-  return Object.keys(vars).reduce((acc, key) => {
-    acc[key] = dotenvExpand(vars[key], {
-      ...ref,
-      ...(progressive ? acc : {})
-    });
-    return acc;
-  }, {});
-};
-exports.dotenvExpandAll = dotenvExpandAll;

package/dist/default/lib/getDotenv.js

@@ -1,228 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.getDotenvSync = exports.getDotenv = void 0;
-var _fsExtra = _interopRequireDefault(require("fs-extra"));
-var _lodash = _interopRequireDefault(require("lodash.pickby"));
-var _path = _interopRequireDefault(require("path"));
-var _nanoid = require("nanoid");
-var _dotenvExpand = require("./dotenvExpand.js");
-var _options = require("./options.js");
-var _readDotenv = require("./readDotenv.js");
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-// npm imports
-
-// lib imports
-
-const pruneVars = (getdotenvDefaultOptions, options) => (0, _lodash.default)({
-  ...(getdotenvDefaultOptions.vars ?? {}),
-  ...(options.vars ?? {})
-}, v => v?.length);
-
-/**
- * get-dotenv options type
- *
- * @typedef {Object} GetDotenvOptions
- * @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
- * @property {bool} [excludeDynamic] - exclude dynamic variables
- * @property {bool} [excludeEnv] - exclude environment-specific variables
- * @property {bool} [excludeGlobal] - exclude global & dynamic variables
- * @property {bool} [excludePrivate] - exclude private variables
- * @property {bool} [excludePublic] - exclude public variables
- * @property {bool} [loadProcess] - load dotenv to process.env
- * @property {bool} [log] - log result to logger
- * @property {function} [logger] - logger object (defaults to console)
- * @property {string} [outputPath] - if populated, writes consolidated .env file to this path (follows {@link https://github.com/motdotla/dotenv-expand/blob/master/tests/.env dotenv-expand rules})
- * @property {string[]} [paths] - array of input directory paths
- * @property {string} [privateToken] - token indicating private variables
- * @property {object} [vars] - explicit variables to include
- */
-
-/**
- * Asynchronously process dotenv files of the form .env[.<ENV>][.<PRIVATE_TOKEN>]
- *
- * @async
- * @function getDotenv
- *
- * @param {GetDotenvOptions} [options] - options object
- *
- * @returns {Promise<object>} The combined parsed dotenv object.
- */
-const getDotenv = async function () {
-  let options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-  // Apply defaults.
-  let {
-    defaultEnv,
-    dotenvToken,
-    dynamicPath,
-    env,
-    excludeDynamic,
-    excludeEnv,
-    excludeGlobal,
-    excludePrivate,
-    excludePublic,
-    loadProcess,
-    log,
-    logger = console,
-    outputPath,
-    paths,
-    privateToken
-  } = {
-    ..._options.getdotenvDefaultOptions,
-    ...options
-  };
-  const vars = pruneVars(_options.getdotenvDefaultOptions, options);
-
-  // Read .env files.
-  const loaded = await paths.reduce(async (e, p) => {
-    let publicGlobal = excludePublic || excludeGlobal ? {} : (0, _readDotenv.readDotenv)(_path.default.resolve(p, dotenvToken));
-    let publicEnv = excludePublic || excludeEnv ? {} : (0, _readDotenv.readDotenv)(_path.default.resolve(p, `${dotenvToken}.${env ?? defaultEnv}`));
-    let privateGlobal = excludePrivate || excludeGlobal ? {} : (0, _readDotenv.readDotenv)(_path.default.resolve(p, `${dotenvToken}.${privateToken}`));
-    let privateEnv = excludePrivate || excludeEnv ? {} : (0, _readDotenv.readDotenv)(_path.default.resolve(p, `${dotenvToken}.${env ?? defaultEnv}.${privateToken}`));
-    [e, publicGlobal, publicEnv, privateGlobal, privateEnv] = await Promise.all([e, publicGlobal, publicEnv, privateGlobal, privateEnv]);
-    return {
-      ...e,
-      ...publicGlobal,
-      ...publicEnv,
-      ...privateGlobal,
-      ...privateEnv
-    };
-  }, {});
-  const outputKey = (0, _nanoid.nanoid)();
-  const dotenv = (0, _dotenvExpand.dotenvExpandAll)({
-    vars: {
-      ...loaded,
-      ...vars,
-      ...(outputPath ? {
-        [outputKey]: outputPath
-      } : {})
-    },
-    progressive: true
-  });
-
-  // Process dynamic variables.
-  if (dynamicPath && !excludeDynamic && (await _fsExtra.default.exists(dynamicPath))) {
-    const dynamic = new Function(`return ${(await _fsExtra.default.readFile(dynamicPath)).toString()}`)()(dotenv);
-    Object.keys(dynamic).forEach(key => {
-      Object.assign(dotenv, {
-        [key]: typeof dynamic[key] === 'function' ? dynamic[key](dotenv) : dynamic[key]
-      });
-    });
-  }
-
-  // Write output file.
-  if (outputPath) {
-    outputPath = dotenv[outputKey];
-    delete dotenv[outputKey];
-    await _fsExtra.default.writeFile(outputPath, Object.keys(dotenv).reduce((contents, key) => {
-      const value = dotenv[key] ?? '';
-      return `${contents}${key}=${value.includes('\n') ? `"${value}"` : value}\n`;
-    }, ''), {
-      encoding: 'utf-8'
-    });
-  }
-
-  // Log result.
-  if (log) logger.log(dotenv);
-
-  // Load process.env.
-  if (loadProcess) Object.assign(process.env, dotenv);
-  return dotenv;
-};
-
-/**
- * Synchronously process dotenv files of the form .env[.<ENV>][.<PRIVATETOKEN>]
- *
- * @function getDotenvSync
- *
- * @param {GetDotenvOptions} [options] - options object
- *
- * @returns {Object} The combined parsed dotenv object.
- */
-exports.getDotenv = getDotenv;
-const getDotenvSync = function () {
-  let options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-  // Apply defaults.
-  let {
-    defaultEnv,
-    dotenvToken,
-    dynamicPath,
-    env,
-    excludeDynamic,
-    excludeEnv,
-    excludeGlobal,
-    excludePrivate,
-    excludePublic,
-    loadProcess,
-    log,
-    logger = console,
-    outputPath,
-    paths,
-    privateToken
-  } = {
-    ..._options.getdotenvDefaultOptions,
-    ...options
-  };
-  const vars = pruneVars(_options.getdotenvDefaultOptions, options);
-
-  // Read .env files.
-  const loaded = paths.reduce((e, p) => {
-    let publicGlobal = excludePublic || excludeGlobal ? {} : (0, _readDotenv.readDotenvSync)(_path.default.resolve(p, dotenvToken));
-    let publicEnv = excludePublic || excludeEnv ? {} : (0, _readDotenv.readDotenvSync)(_path.default.resolve(p, `${dotenvToken}.${env ?? defaultEnv}`));
-    let privateGlobal = excludePrivate || excludeGlobal ? {} : (0, _readDotenv.readDotenvSync)(_path.default.resolve(p, `${dotenvToken}.${privateToken}`));
-    let privateEnv = excludePrivate || excludeEnv ? {} : (0, _readDotenv.readDotenvSync)(_path.default.resolve(p, `${dotenvToken}.${env ?? defaultEnv}.${privateToken}`));
-    return {
-      ...e,
-      ...publicGlobal,
-      ...publicEnv,
-      ...privateGlobal,
-      ...privateEnv
-    };
-  }, {});
-  const outputKey = (0, _nanoid.nanoid)();
-  const dotenv = (0, _dotenvExpand.dotenvExpandAll)({
-    vars: {
-      ...loaded,
-      ...vars,
-      ...(outputPath ? {
-        [outputKey]: outputPath
-      } : {})
-    },
-    progressive: true
-  });
-
-  // Process dynamic variables.
-  if (dynamicPath && !excludeDynamic && _fsExtra.default.existsSync(dynamicPath)) {
-    const dynamic = new Function(`return ${_fsExtra.default.readFileSync(dynamicPath).toString()}`)()(dotenv);
-    Object.keys(dynamic).forEach(key => {
-      Object.assign(dotenv, {
-        [key]: typeof dynamic[key] === 'function' ? dynamic[key](dotenv) : dynamic[key]
-      });
-    });
-  }
-
-  // Write output file.
-  if (outputPath) {
-    outputPath = dotenv[outputKey];
-    delete dotenv[outputKey];
-    _fsExtra.default.writeFileSync(outputPath, Object.keys(dotenv).reduce((contents, key) => {
-      const value = dotenv[key] ?? '';
-      return `${contents}${key}=${value.includes('\n') ? `"${value}"` : value}\n`;
-    }, ''), {
-      encoding: 'utf-8'
-    });
-  }
-
-  // Log result.
-  if (log) logger.log(dotenv);
-
-  // Load process.env.
-  if (loadProcess) Object.assign(process.env, dotenv);
-  return dotenv;
-};
-exports.getDotenvSync = getDotenvSync;