serverless-dotenv-plugin - npm Package Compare versions

Comparing version 2.3.2 to 2.4.2

examples/simple-express-app/README.md

@@ -12,3 +12,11 @@ ### Example Express App
 ```
+> NODE_ENV=production sls deploy
+```
+or
+```
 > sls deploy --env production
 ```
+or
+```
+> sls deploy --stage production
+```

index.js

@@ -21,11 +21,3 @@ 'use strict'
   getEnvironment(options) {
-    if (process.env.NODE_ENV) {
-      return process.env.NODE_ENV
-    }
-
-    if (options.env) {
-      return options.env
-    }
-
-    return 'development'
+    return process.env.NODE_ENV || options.env || options.stage || 'development'
   }
@@ -32,0 +24,0 @@

package.json

 {
   "name": "serverless-dotenv-plugin",
-  "version": "2.3.2",
+  "version": "2.4.2",
   "description": "Preload environment variables with dotenv into serverless.",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -42,10 +42,13 @@ # serverless-dotenv-plugin [![npm version](https://img.shields.io/npm/v/serverless-dotenv-plugin.svg?style=flat)](https://www.npmjs.com/package/serverless-dotenv-plugin)
 
-When you deploy with `NODE_ENV` set: `NODE_ENV=production sls deploy` the plugin will look for a file named `.env.production`. If it doesn't exist it will default to `.env`. If for some reason you can't set NODE_ENV, you could always just pass it in as an option: `sls deploy --env production`. If `NODE_ENV` or `--env` is not set, it will default to `development`.
+When you deploy with `NODE_ENV` set: `NODE_ENV=production sls deploy` the plugin will look for a file named `.env.production`. If it doesn't exist it will default to `.env`. If for some reason you can't set NODE_ENV, you could always just pass it in as an option: `sls deploy --env production` or `sls deploy --stage production`. If `NODE_ENV`, `--env` or `--stage` is not set, it will default to `development`.
 
-| Valid .env file names | Description                                                                                         |
-| --------------------- | --------------------------------------------------------------------------------------------------- |
-| .env                  | Default file name when no other files are specified or found.                                       |
-| .env.development      | If NODE_ENV or --env **is not set**, will try to load `.env.development`. If not found, load `.env` |
-| .env.{ENV}            | If NODE_ENV or --env **is set**, will try to load `.env.{env}`. If not found, load `.env`           |
+The precedence between the options is the following:
+`NODE_ENV` **>** `--env` **>** `--stage`
 
+| Valid .env file names | Description                                                                                                  |
+| --------------------- | ------------------------------------------------------------------------------------------------------------ |
+| .env                  | Default file name when no other files are specified or found.                                                |
+| .env.development      | If NODE_ENV or --env or --stage **is not set**, will try to load `.env.development`. If not found, load `.env` |
+| .env.{ENV}            | If NODE_ENV or --env or --stage **is set**, will try to load `.env.{env}`. If not found, load `.env`         |
+
 ### Plugin options
@@ -52,0 +55,0 @@

No alert changes

Improved metrics

Total package byte prevSize

28743

increased by0.71%

Number of lines in readme file

130

increased by2.36%

Number of low supply chain risk alerts

3

decreased by-25%

Worsened metrics

Number of downloads

167682

decreased by-3.71%

Lines of code

540

decreased by-1.1%

No dependency changes