UNPKG

env-cmd

Version:

Executes a command using the environment variables in an env file

144 lines (101 loc) 7.37 kB
# Changelog ## 10.1.0 - **Feature**: Added support for expanding vars using the `-x` flag. Note: only supports `$var` syntax - **Feature**: Added support for `--silent` flag that ignores env-cmd errors and missing files and only terminates on caught signals - **Feature**: Added a new `--verbose` flag that prints additional debugging info to `console.info` - **Upgrade**: Updated dependency `commander` to `v4` - **Upgrade**: Updated devDependencies `sinon`, `nyc`, and `ts-standard` - **Fix**: Handle case where the termination signal is the termination code ## 10.0.1 - **Fix**: Fixed bug introduced by strict equal checking for `undefined` when the value was `null`. This bug caused most executions of `env-cmd` to fail with an error, when in fact no error had occurred. ## 10.0.0 - **BREAKING**: Typescript now targets ES2017 - **Fix**: Default RC files will now properly be searched - **Change**: Fixed some documentation issues - **Change**: Use `ts-standard` instead of `eslint` for linting ## 9.0.3 - **Fix**: Use global flag on regex when parsing and preserving newline characters in env values (thanks to MaximTovstashev) ## 9.0.2 - **Fix**: CLI will now exit with non-zero error code when an error is encountered (thanks to blagh) ## 9.0.1 - **BREAKING**: Fixed major bug that required passing `--` in order to pass flags to the command. Normally I release major breaking changes as major versions, but this was a bug and no documentation anywhere states using `--` as intended or official behavior. - **Change**: Fixed some documentation issues - **Change**: `npm run lint` command now includes calling `tsc` to check for typescript errors ## 9.0.0 - ***BREAKING***: Converted project to Typescript - ***BREAKING***: Changes to all option flags, see docs for new options - ***BREAKING***: Dropping support for node v4 and v6 - **Change**: Updated all dependencies - **Change**: Update package-lock.json file - **Feature**: Added support for asynchronous .env and .rc files - **Feature**: Added support for a programmatic API - **Feature**: Added --use-shell option (thanks to nidkil) - **Fix**: Keep newline (`\n`) characters intact when parsing env files - **Change**: Added node v10 and v12 to build automation - **Change**: Updated Readme file to reflect new options and CLI changes ## 8.0.2 - **Change**: Updated dependencies and packages.json to fix `npm audit` concerns. ## 8.0.1 - **Bug**: Properly propagate child process exit signals and codes to parent process ## 8.0.0 - ***BREAKING***: Stripe out spaces around the `key` and `value` in an env file. In order to include a beginning/ending space in an env var value, you need to surround the value in double or single quotes. `ENV = " Value"` - **Bug**: Fixed some bugs around how the parent process and spawn processes are killed - **Change**: Updated a number of core libraries: `cross-spawn`, `coveralls`, `istanbul -> nyc`, `mocha`, `proxyquire`, `sinon`, `standard` ## 7.0.0 - ***BREAKING***: The `.env` file path resolving has been changed to allow for absolute pathing, relative pathing, and `~` home directory pathing. Please see Readme.md for more info about how the new pathing conventions work. ## 6.0.0 - ***BREAKING***: Fallback to default `.env` file behavior is no longer the default behavior. You must specify `--fallback` option for that behavior now. - ***BREAKING***: A specific node version has been set in package.json. Current minimum version is `>=4.0.0`. *Note: the implied minimum version before this release was always `4.0.0`, but now it is explicitly set and could produce warnings by npm if included in projects that utilizes a node version that is less than `4.0.0`.* - **Feature**: Added `--fallback` option to allow for falling back to the default `.env` file if the provided `.env` file is not found. - **Feature**: Added ability to select multiple environments from the `.env-cmdrc` file. The environments override each other like this: `development,production` where `production` vars override `development` vars if they share the same vars. - **Bug**: `env-cmd` no longer crashes when it cannot find the provided `.env` file. Instead, it will execute as normal, but without included any custom env vars. *Note: it will still include system and shell vars.* ## 5.1.0 - **Feature**: Added new option `--no-override` that when passed will make it so that the env file vars will not overwrite already defined env vars on `process.env` or in the shell - **Updated Dev-Dependencies**: `standard >= 10.0.0`, `sinon >= 2.0.0` ## 5.0.0 - ***BREAKING***: Inline comments are no longer allowed in `.env` files (full line comments are still allowed) - ***BREAKING***: `.env` file no longer supports the `env var` format (only `env=var` is allowed now) - ***BREAKING***: Double Quotes are no longer needed when using special symbols (such as `#`) in the value portion of an env var - **Feature**: if the given env file cannot be found, it will auto default to searching the execution directory for a file called `.env` and use that as a fallback. See README for why this is helpful. (special thanks to Alexander Praetorius) ## 4.0.0 - ***BREAKING***: In order to use double quotes as part of the env value, you must now surround those double quotes with an additional set of quotes: So `ENV1="value"` -> `ENV1=""value""` (this only applies to double quotes, single quotes continue to work as normal) - **Bug**: Fixed bug in the comment stripper function that would remove env values that included a `#`. Now, in order to use a `#` in a env value, you have to surround that env value in double quotes: `ENV="Some#Value"`. - **Bug**: Fixed a major bug with the `.env-cmdrc` file that would not add system env vars back in after reading the `.env-cmdrc` file. This meant that system vars like `PATH` would not exist when running the command. ## 3.0.0 - **Feature**: Added ability to use an `.env-cmdrc` file to hold multiple configs - **Feature**: Added ability to pass in a regular `.js` file exporting an object for your env file (special thanks to Jon Scheiding!) - **Change**: Updated core `cross-spawn` lib to 5.0.1 ## 2.2.0 - **Feature**: Added support for .json env files (special thanks to Eric Lanehart!) ## 2.1.0 - **Feature**: Added support for `key value` mapping in env vars file - **Feature**: Added support for inline comments `ENV=VALUE # inline comment` - **Change**: Will now ignore invalid lines in env vars file instead of throwing an error - **Change**: Migrated all the parsing over to regex since the file format is simple enough right now to support that - **Bug**: Removed old test cases for the `-e/--env` flags that were not needed anymore ## 2.0.0 - ***BREAKING***: Removed the `-e` and `--env` flags. Now it just expects the first arg to `env-cmd` to be the relative path to the env file: `env-cmd env_file command carg1 carg2` - **Change:** `ParseEnvFile` is now more properly named `ParseEnvString` - **Feature:** `ParseEnvString` will ignore comment lines (lines starting with `#`) - **Feature:** `ParseEnvString` will ignore empty lines in env file - **Bug:** `ParseEnvString` will extract the last line even if no newline (`\n`) exists on it ## 1.0.1 - Fixed badges - Added .npmignore - Added help text to be printed out on certain errors - Handled uncaught errors nicely ## 1.0.0 - Initial release