serverless-plugin-env-stage-config 1.0.0 → 1.2.0

package/README.md

@@ -26,6 +26,13 @@ name: my-service
 
 useDotenv: true
 
+resources:
+  Resources:
+    MyQueue:
+      Type: AWS::SQS::Queue
+      Properties:
+        QueueName: some-queue
+
 provider:
   name: aws
 
@@ -37,12 +44,13 @@ functions:
   run-something:
     handler: handler.run
     environment:
+      QUEUE_URL: ${esc:QUEUE_URL}
       SECRET_TOKEN: ${esc:SECRET_TOKEN}
 ```
 
 ## Local stages
 
-In a local environment, the variables resolved with the `esc:` prefix will be equivalent to using `env:`. Using `useDotenv: true` alongside a `.env` file will alow you to define your environement variables in the environement.
+In a local environment, the variables resolved with the `esc:` prefix will be equivalent to using `env:`. Using `useDotenv: true` alongside a `.env` file will alow you to define your environement variables.
 
 The support local stages are:
 - local
@@ -57,13 +65,16 @@ For example, if you’re using AWS SSM Parameter Store, you could create the fol
 
 ```yaml
 MYSQL_HOST: ${ssm:/my-service/prod/MYSQL_HOST~true}
+QUEUE_URL: !Ref MyQueue
 SECRET_TOKEN: ${ssm:/my-service/prod/SECRET_TOKEN~true}
 ```
 
 Any variable that is not included in the `serverless.env.prod.yml` file will produce a warning and fallback to using `env:`.
 In this case, you will get the following warning:
 
-> Serverless: env-stage-config: WARNING: the MYSQL_PORT variable is not defined in serverless.env.prod.yml, defaulting to ${env:MYSQL_PORT}.
+> Serverless: env-stage-config: WARNING: the MYSQL_PORT variable is not defined in serverless.env.prod.yml, defaulting to ${env:MYSQL_PORT, null}.
+
+If a variable is not defined in the stage environment configuration file, or the environment (`process.env`), it will default to `null`.
 
 ## License
 

package/index.js

@@ -1,11 +1,12 @@
 const path = require('path')
 const {readFileSync} = require('fs')
 const yaml = require('js-yaml')
+const cloudformationSchema = require('@serverless/utils/cloudformation-schema')
 
 const developmentStages = new Set([
   'local',
   'development',
-  'dev'
+  'dev',
 ])
 
 class EnvStageConfigServerlessPlugin {
@@ -16,16 +17,16 @@ class EnvStageConfigServerlessPlugin {
 
     this.configurationVariablesSources = {
       esc: {
-        resolve: this.resolveConfigVariable.bind(this)
-      }
+        resolve: this.resolveConfigVariable.bind(this),
+      },
     }
 
     if (!developmentStages.has(this.stage)) {
-      this.stageVariables = yaml.load(
-        readFileSync(
-          path.join(this.serverless.serviceDir, `serverless.env.${this.stage}.yml`)
-        )
-      )
+      const stageConfigYaml = readFileSync(path.join(this.serverless.serviceDir, `serverless.env.${this.stage}.yml`))
+
+      this.stageVariables = yaml.load(stageConfigYaml, {
+        schema: cloudformationSchema,
+      })
     }
   }
 
@@ -33,19 +34,19 @@ class EnvStageConfigServerlessPlugin {
     if (this.stageVariables) {
       if (address in this.stageVariables) {
         return {
-          value: this.stageVariables[address]
+          value: this.stageVariables[address],
         }
       }
 
       this.serverless.cli.log(
-        `env-stage-config: WARNING: the ${address} variable is not defined in serverless.env.${this.stage}.yml, defaulting to \${env:${address}}.`,
+        `env-stage-config: WARNING: the ${address} variable is not defined in serverless.env.${this.stage}.yml, defaulting to \${env:${address}, null}.`,
         null,
-        {color: 'orange'}
+        {color: 'orange'},
       )
     }
 
     return {
-      value: `\${env:${address}}`
+      value: `\${env:${address}, null}`,
     }
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "serverless-plugin-env-stage-config",
-  "version": "1.0.0",
+  "version": "1.2.0",
   "author": "Bertrand Marron <bertrand.marron@gmail.com>",
   "description": "Serverless plugin to define environment variables files for stages",
   "main": "index.js",
@@ -20,29 +20,22 @@
     "serverless-plugin"
   ],
   "dependencies": {
+    "@serverless/utils": "^6.0.0",
     "js-yaml": "^4.1.0"
   },
   "devDependencies": {
-    "@semantic-release/git": "^9.0.0",
-    "semantic-release": "^17.4.4",
-    "xo": "^0.39.1"
+    "@bizon/semantic-release-config": "^1.0.1",
+    "semantic-release": "^19.0.2",
+    "xo": "^0.47.0"
   },
   "xo": {
     "semicolon": false,
-    "space": 2
+    "space": 2,
+    "rules": {
+      "unicorn/prefer-module": "off"
+    }
   },
   "release": {
-    "plugins": [
-      "@semantic-release/commit-analyzer",
-      "@semantic-release/release-notes-generator",
-      "@semantic-release/github",
-      "@semantic-release/npm",
-      [
-        "@semantic-release/git",
-        {
-          "message": "chore(release): ${nextRelease.gitTag}"
-        }
-      ]
-    ]
+    "extends": "@bizon/semantic-release-config"
   }
 }