Merge e0a0094 into 13994c5

CHANGELOG.md

@@ -8,6 +8,10 @@ included in this log but can be reviewed on GitHub:
 
 ## Unreleased
 
+## 3.5.x
+
+* feat: now logs when incompatible configs are set. ([#124](https://github.com/neverendingqs/serverless-dotenv-plugin/pull/124))
+
 ## 3.4.x
 
 * feat: new option to expect specific env vars to be set. ([#118](https://github.com/neverendingqs/serverless-dotenv-plugin/pull/118))

index.js

@@ -47,7 +47,13 @@ class ServerlessPlugin {
    * @returns {string[]}
    */
   resolveEnvFileNames(env) {
+    const basePath = (this.config && this.config.basePath) || ''
+
     if (this.config && this.config.path) {
+      if (basePath) {
+        this.log('DOTENV (WARNING): if "path" is set, "basePath" is ignored.')
+      }
+
       if (Array.isArray(this.config.path)) {
         return this.config.path
       }
@@ -65,9 +71,6 @@ class ServerlessPlugin {
       `.env`,
     ]
 
-    const basePath =
-      this.config && this.config.basePath ? this.config.basePath : ''
-
     const filesNames = dotenvFiles.map((file) => basePath + file)
 
     return filesNames.filter((fileName) => fs.existsSync(fileName))
@@ -116,6 +119,10 @@ class ServerlessPlugin {
     const exclude = (this.config && this.config.exclude) || []
 
     if (include.length > 0) {
+      if (exclude) {
+        this.log('DOTENV (WARNING): if "include" is set, "exclude" is ignored.')
+      }
+
       Object.keys(envVars)
         .filter((key) => !include.includes(key))
         .forEach((key) => {

test/index.js

@@ -142,6 +142,17 @@ describe('ServerlessPlugin', function () {
 
         this.plugin.resolveEnvFileNames('env').should.deep.equal(path)
       })
+
+      it('logs an error if basePath is also set', function () {
+        const path = '.env.unittest'
+        this.serverless.service.custom.dotenv.basePath = 'base/path/'
+        this.serverless.service.custom.dotenv.path = path
+
+        this.plugin.resolveEnvFileNames('env').should.deep.equal([path])
+        this.serverless.cli.log.should.have.been.calledWith(
+          sinon.match(/basePath/),
+        )
+      })
     })
 
     describe('with default dotenv paths', function () {
@@ -437,6 +448,10 @@ describe('ServerlessPlugin', function () {
         env1: envVars.env1,
         env2: envVars.env2,
       })
+
+      this.serverless.cli.log.should.have.been.calledWith(
+        sinon.match(/exclude/),
+      )
     })
 
     it('does not use `dotenv-expand` when `variableExpansion` is set to `false`', function () {