feat: introduce config file functionality (#15)

With this change we are starting to allow .twilio-functions for more than just storing some build
outcomes. It supprts grouping configs by environment, command or project or nested combinations of
these

fix: #15

Author: dkundel

__tests__/runtime/cli/config.test.ts renamed to __tests__/config/start.test.ts

@@ -3,8 +3,9 @@ import {
   getInspectInfo,
   getPort,
   getUrl,
-  WrappedStartCliFlags,
-} from '../../../src/runtime/cli/config';
+  StartCliConfig,
+  StartCliFlags,
+} from '../../src/config/start';
 
 jest.mock('ngrok', () => {
   return {
@@ -20,32 +21,26 @@ jest.mock('ngrok', () => {
 describe('getUrl', () => {
   test('returns localhost if ngrok is not passed', async () => {
     const config = ({
-      flags: {
-        ngrok: undefined,
-      },
-    } as unknown) as WrappedStartCliFlags;
+      ngrok: undefined,
+    } as unknown) as StartCliFlags;
 
     const url = await getUrl(config, 3000);
     expect(url).toBe('http://localhost:3000');
   });
 
   test('calls ngrok if ngrok is defined', async () => {
     const config = ({
-      flags: {
-        ngrok: '',
-      },
-    } as unknown) as WrappedStartCliFlags;
+      ngrok: '',
+    } as unknown) as StartCliFlags;
 
     const url = await getUrl(config, 3000);
     expect(url).toBe('https://random.ngrok.io');
   });
 
   test('calls ngrok with custom subdomain if passed', async () => {
     const config = ({
-      flags: {
-        ngrok: 'dom',
-      },
-    } as unknown) as WrappedStartCliFlags;
+      ngrok: 'dom',
+    } as unknown) as StartCliFlags;
 
     const url = await getUrl(config, 3000);
     expect(url).toBe('https://dom.ngrok.io');
@@ -69,10 +64,8 @@ describe('getPort', () => {
 
   test('returns default 3000 if nothing is passed', () => {
     const config = ({
-      flags: {
-        port: undefined,
-      },
-    } as unknown) as WrappedStartCliFlags;
+      port: undefined,
+    } as unknown) as StartCliFlags;
 
     delete process.env.PORT;
     const port = getPort(config);
@@ -81,10 +74,8 @@ describe('getPort', () => {
 
   test('checks for process.env.PORT and returns number', () => {
     const config = ({
-      flags: {
-        port: undefined,
-      },
-    } as unknown) as WrappedStartCliFlags;
+      port: undefined,
+    } as unknown) as StartCliFlags;
 
     process.env.PORT = '9999';
     const port = getPort(config);
@@ -94,10 +85,8 @@ describe('getPort', () => {
 
   test('port passed via flag takes preference', () => {
     const config = ({
-      flags: {
-        port: 1234,
-      },
-    } as unknown) as WrappedStartCliFlags;
+      port: 1234,
+    } as unknown) as StartCliFlags;
 
     process.env.PORT = '9999';
     const port = getPort(config);
@@ -107,10 +96,8 @@ describe('getPort', () => {
 
   test('handles strings and returns number', () => {
     const config = ({
-      flags: {
-        port: '8080',
-      },
-    } as unknown) as WrappedStartCliFlags;
+      port: '8080',
+    } as unknown) as StartCliFlags;
 
     process.env.PORT = '9999';
     const port = getPort(config);
@@ -138,79 +125,65 @@ describe('getBaseDirectory', () => {
 
   test('handles current working directory if none is passed', () => {
     const config = ({
-      flags: {
-        dir: undefined,
-        cwd: undefined,
-      },
-    } as unknown) as WrappedStartCliFlags;
+      dir: undefined,
+      cwd: undefined,
+    } as unknown) as StartCliFlags;
 
     const result = getBaseDirectory(config);
     expect(result).toBe('/home');
   });
 
   test('supports dir argument', () => {
     const config = ({
-      flags: {
-        dir: '/usr/local',
-        cwd: undefined,
-      },
-    } as unknown) as WrappedStartCliFlags;
+      dir: '/usr/local',
+      cwd: undefined,
+    } as unknown) as StartCliFlags;
 
     const result = getBaseDirectory(config);
     expect(result).toBe('/usr/local');
   });
 
   test('prefers cwd over dir argument', () => {
     const config = ({
-      flags: {
-        dir: '/usr/local',
-        cwd: '/usr/bin',
-      },
-    } as unknown) as WrappedStartCliFlags;
+      dir: '/usr/local',
+      cwd: '/usr/bin',
+    } as unknown) as StartCliFlags;
 
     const result = getBaseDirectory(config);
     expect(result).toBe('/usr/bin');
   });
 
   test('handles relative path for dir', () => {
     let config = ({
-      flags: {
-        dir: 'demo',
-        cwd: undefined,
-      },
-    } as unknown) as WrappedStartCliFlags;
+      dir: 'demo',
+      cwd: undefined,
+    } as unknown) as StartCliFlags;
 
     let result = getBaseDirectory(config);
     expect(result).toBe('/home/demo');
 
     config = ({
-      flags: {
-        dir: '../demo',
-        cwd: undefined,
-      },
-    } as unknown) as WrappedStartCliFlags;
+      dir: '../demo',
+      cwd: undefined,
+    } as unknown) as StartCliFlags;
 
     result = getBaseDirectory(config);
     expect(result).toBe('/demo');
   });
 
   test('handles relative path for cwd', () => {
     let config = ({
-      flags: {
-        dir: undefined,
-        cwd: 'demo',
-      },
-    } as unknown) as WrappedStartCliFlags;
+      dir: undefined,
+      cwd: 'demo',
+    } as unknown) as StartCliFlags;
 
     let result = getBaseDirectory(config);
     expect(result).toBe('/home/demo');
 
     config = ({
-      flags: {
-        dir: undefined,
-        cwd: '../demo',
-      },
-    } as unknown) as WrappedStartCliFlags;
+      dir: undefined,
+      cwd: '../demo',
+    } as unknown) as StartCliFlags;
 
     result = getBaseDirectory(config);
     expect(result).toBe('/demo');
@@ -220,59 +193,49 @@ describe('getBaseDirectory', () => {
 describe('getInspectInfo', () => {
   test('returns undefined if nothing is passed', () => {
     const config = ({
-      flags: {
-        inspect: undefined,
-        inspectBrk: undefined,
-      },
-    } as unknown) as WrappedStartCliFlags;
+      inspect: undefined,
+      inspectBrk: undefined,
+    } as unknown) as StartCliFlags;
 
     const result = getInspectInfo(config);
     expect(result).toBeUndefined();
   });
 
   test('handles present but empty inspect flag', () => {
     const config = ({
-      flags: {
-        inspect: '',
-        inspectBrk: undefined,
-      },
-    } as unknown) as WrappedStartCliFlags;
+      inspect: '',
+      inspectBrk: undefined,
+    } as unknown) as StartCliFlags;
 
     const result = getInspectInfo(config);
     expect(result).toEqual({ hostPort: '', break: false });
   });
 
   test('handles present but empty inspectBrk flag', () => {
     const config = ({
-      flags: {
-        inspect: undefined,
-        inspectBrk: '',
-      },
-    } as unknown) as WrappedStartCliFlags;
+      inspect: undefined,
+      inspectBrk: '',
+    } as unknown) as StartCliFlags;
 
     const result = getInspectInfo(config);
     expect(result).toEqual({ hostPort: '', break: true });
   });
 
   test('handles passed port in inspect flag', () => {
     const config = ({
-      flags: {
-        inspect: '9999',
-        inspectBrk: undefined,
-      },
-    } as unknown) as WrappedStartCliFlags;
+      inspect: '9999',
+      inspectBrk: undefined,
+    } as unknown) as StartCliFlags;
 
     const result = getInspectInfo(config);
     expect(result).toEqual({ hostPort: '9999', break: false });
   });
 
   test('handles passed port in inspect flag', () => {
     const config = ({
-      flags: {
-        inspect: undefined,
-        inspectBrk: '1234',
-      },
-    } as unknown) as WrappedStartCliFlags;
+      inspect: undefined,
+      inspectBrk: '1234',
+    } as unknown) as StartCliFlags;
 
     const result = getInspectInfo(config);
     expect(result).toEqual({ hostPort: '1234', break: true });

__tests__/runtime/integration.test.ts

@@ -1,12 +1,11 @@
 jest.unmock('twilio');
 
+import { Express } from 'express';
+import { readdirSync } from 'fs';
+import { basename, resolve } from 'path';
 import request from 'supertest';
+import { StartCliConfig } from '../../src/config/start';
 import { createServer } from '../../src/runtime/server';
-import { resolve, basename } from 'path';
-import cheerio from 'cheerio';
-import { readdirSync } from 'fs';
-import { Response as ExpressResponse, Express } from 'express';
-import { StartCliConfig } from '../../src/runtime/cli/config';
 
 const TEST_DIR = resolve(__dirname, '../../fixtures');
 

__tests__/runtime/route.test.ts

@@ -5,7 +5,7 @@ import {
 } from 'express';
 import { Response as MockResponse } from 'jest-express/lib/response';
 import { twiml } from 'twilio';
-import { StartCliConfig } from '../../src/runtime/cli/config';
+import { StartCliConfig } from '../../src/config/start';
 import { Response } from '../../src/runtime/internal/response';
 import {
   constructContext,