node, start: Support .env (#774)

This is a minor convenience over repeated `ENVIRONMENT=local` prefixes.
seek-oss · Feb 20, 2022 · 2e4081a · 2e4081a
1 parent 342a539
commit 2e4081a
Show file tree

Hide file tree

Showing 15 changed files with 178 additions and 197 deletions.
diff --git a/.changeset/early-humans-cheat.md b/.changeset/early-humans-cheat.md
@@ -0,0 +1,5 @@
+---
+"skuba": minor
+---
+
+node, start: Load environment variables from `.env` file
diff --git a/package.json b/package.json
@@ -12,6 +12,7 @@
     "@types/node": ">=14.18",
     "chalk": "^4.1.0",
     "concurrently": "^7.0.0",
+    "dotenv": "^16.0.0",
     "ejs": "^3.1.6",
     "enquirer": "^2.3.6",
     "eslint": "^7.27.0",

diff --git a/src/cli/configure/analysis/__snapshots__/project.test.ts.snap b/src/cli/configure/analysis/__snapshots__/project.test.ts.snap
@@ -137,7 +137,7 @@ export default Jest.mergePreset({
     \\"build\\": \\"skuba build\\",
     \\"format\\": \\"skuba format\\",
     \\"lint\\": \\"skuba lint\\",
-    \\"start\\": \\"ENVIRONMENT=local skuba start\\",
+    \\"start\\": \\"skuba start\\",
     \\"test\\": \\"skuba test --coverage\\",
     \\"test:watch\\": \\"skuba test --watch\\"
   },

diff --git a/src/cli/configure/modules/package.test.ts b/src/cli/configure/modules/package.test.ts
@@ -27,7 +27,7 @@ describe('packageModule', () => {
         build: 'skuba build',
         format: 'skuba format',
         lint: 'skuba lint',
-        start: 'ENVIRONMENT=local skuba start',
+        start: 'skuba start',
         test: 'skuba test --coverage',
         'test:watch': 'skuba test --watch',
       },

diff --git a/src/cli/configure/modules/package.ts b/src/cli/configure/modules/package.ts
@@ -24,7 +24,7 @@ export const packageModule = async ({
       build: type === 'package' ? 'skuba build-package' : 'skuba build',
       format: 'skuba format',
       lint: 'skuba lint',
-      ...(type === 'package' ? {} : { start: 'ENVIRONMENT=local skuba start' }),
+      ...(type === 'package' ? {} : { start: 'skuba start' }),
       test: 'skuba test --coverage',
       'test:watch': 'skuba test --watch',
     },

diff --git a/src/cli/node.ts b/src/cli/node.ts
@@ -26,6 +26,8 @@ export const node = async () => {
       'node',
       ...args.node,
       '--require',
+      'dotenv/config',
+      '--require',
       'tsconfig-paths/register',
       '--require',
       'ts-node/register/transpile-only',
@@ -38,7 +40,7 @@ export const node = async () => {
   return tsNode
     .createRepl({
       service: tsNode.register({
-        require: ['tsconfig-paths/register'],
+        require: ['dotenv/config', 'tsconfig-paths/register'],
         transpileOnly: true,
       }),
     })

diff --git a/src/cli/start.ts b/src/cli/start.ts
@@ -13,9 +13,7 @@ export const start = async () => {
     getPort(),
   ]);
 
-  if (!args.entryPoint) {
-    args.entryPoint = await getEntryPointFromManifest();
-  }
+  args.entryPoint ??= await getEntryPointFromManifest();
 
   const execProcess = createExec({
     env: {
@@ -28,6 +26,8 @@ export const start = async () => {
     'ts-node-dev',
     ...args.node,
     '--require',
+    'dotenv/config',
+    '--require',
     'tsconfig-paths/register',
     '--respawn',
     '--transpile-only',

diff --git a/template/express-rest-api/.env b/template/express-rest-api/.env
@@ -0,0 +1 @@
+ENVIRONMENT=local
diff --git a/template/express-rest-api/package.json b/template/express-rest-api/package.json
@@ -21,7 +21,7 @@
     "build": "skuba build",
     "format": "skuba format",
     "lint": "skuba lint",
-    "start": "ENVIRONMENT=local skuba start --port <%- port %>",
+    "start": "skuba start --port <%- port %>",
     "start:debug": "yarn start --inspect-brk",
     "test": "skuba test",
     "test:ci": "skuba test --coverage",

diff --git a/template/greeter/package.json b/template/greeter/package.json
@@ -15,7 +15,7 @@
     "build": "skuba build",
     "format": "skuba format",
     "lint": "skuba lint",
-    "start": "ENVIRONMENT=local skuba start",
+    "start": "skuba start",
     "start:debug": "yarn start --inspect-brk",
     "test": "skuba test",
     "test:ci": "skuba test --coverage",

diff --git a/template/koa-rest-api/.env b/template/koa-rest-api/.env
@@ -0,0 +1 @@
+ENVIRONMENT=local
diff --git a/template/koa-rest-api/package.json b/template/koa-rest-api/package.json
@@ -41,7 +41,7 @@
     "build": "skuba build",
     "format": "skuba format",
     "lint": "skuba lint",
-    "start": "ENVIRONMENT=local skuba start --port <%- port %>",
+    "start": "skuba start --port <%- port %>",
     "start:debug": "yarn start --inspect-brk",
     "test": "skuba test",
     "test:ci": "skuba test --coverage",

diff --git a/template/lambda-sqs-worker/.env b/template/lambda-sqs-worker/.env
@@ -0,0 +1 @@
+ENVIRONMENT=local
diff --git a/template/lambda-sqs-worker/package.json b/template/lambda-sqs-worker/package.json
@@ -29,7 +29,7 @@
     "format": "skuba format",
     "lint": "skuba lint",
     "smoke": "serverless invoke --data '{}' --function Worker",
-    "start": "ENVIRONMENT=local skuba start --port <%- port %>",
+    "start": "skuba start --port <%- port %>",
     "start:debug": "yarn start --inspect-brk",
     "test": "skuba test",
     "test:ci": "skuba test --coverage",