Adds template option to main CLI command

Author: philnash

README.md

@@ -38,20 +38,28 @@ create-twilio-function <name>
 
 Creates a new Twilio Function project
 
+Commands:
+  create-twilio-function <name>          Creates a new Twilio Function
+                                         project                    [default]
+  create-twilio-function list-templates  List the available templates you can
+                                         create a project with.
+
 Positionals:
-  name  Name of your project.                                           [string]
+  name  Name of your project.                                        [string]
 
 Options:
-  --account-sid, -a     The Account SID for your Twilio account         [string]
-  --auth-token, -t      Your Twilio account Auth Token                  [string]
-  --skip-credentials    Don't ask for Twilio account credentials or import them
-                        from the environment          [boolean] [default: false]
+  --account-sid, -a     The Account SID for your Twilio account      [string]
+  --auth-token, -t      Your Twilio account Auth Token               [string]
+  --skip-credentials    Don't ask for Twilio account credentials or import
+                        them from the environment  [boolean] [default: false]
   --import-credentials  Import credentials from the environment variables
                         TWILIO_ACCOUNT_SID and TWILIO_AUTH_TOKEN
-                                                      [boolean] [default: false]
-  -h, --help            Show help                                      [boolean]
-  -v, --version         Show version number                            [boolean]
-  --path                                                        [default: (cwd)]
+                                                   [boolean] [default: false]
+  --template            Initialize your new project with a template from
+                        github.com/twilio-labs/function-templates    [string]
+  -h, --help            Show help                                   [boolean]
+  -v, --version         Show version number                         [boolean]
+  --path                                                     [default: (cwd)]
 ```
 
 ## Contributing

src/command.js

@@ -23,6 +23,11 @@ const cliInfo = {
         'Import credentials from the environment variables TWILIO_ACCOUNT_SID and TWILIO_AUTH_TOKEN',
       type: 'boolean',
       default: false
+    },
+    template: {
+      describe:
+        'Initialize your new project with a template from github.com/twilio-labs/function-templates',
+      type: 'string'
     }
   }
 };

src/create-twilio-function.js

@@ -14,6 +14,7 @@ const {
 const successMessage = require('./create-twilio-function/success-message');
 const ora = require('ora');
 const boxen = require('boxen');
+const { downloadTemplate } = require('twilio-run/dist/templating/actions');
 
 async function createTwilioFunction(config) {
   const projectDir = `${config.path}/${config.name}`;
@@ -52,14 +53,19 @@ async function createTwilioFunction(config) {
   // Scaffold project
   const spinner = ora();
   spinner.start('Creating project directories and files');
-  // await createDirectory(projectDir, 'functions');
-  // await createDirectory(projectDir, 'assets');
+
   await createEnvFile(projectDir, {
     accountSid: config.accountSid,
     authToken: config.authToken
   });
   await createNvmrcFile(projectDir);
-  await createExampleFromTemplates(projectDir);
+  if (config.template) {
+    await createDirectory(projectDir, 'functions');
+    await createDirectory(projectDir, 'assets');
+    await downloadTemplate(config.template, '', projectDir);
+  } else {
+    await createExampleFromTemplates(projectDir);
+  }
   await createPackageJSON(projectDir, config.name);
   spinner.succeed();
 

tests/create-gitignore.test.js

@@ -9,6 +9,11 @@ const stat = promisify(fs.stat);
 
 beforeAll(async () => {
   await rimraf('./scratch');
+  nock.disableNetConnect();
+});
+
+afterAll(() => {
+  nock.enableNetConnect();
 });
 
 beforeEach(async () => {
@@ -20,6 +25,7 @@ beforeEach(async () => {
 
 afterEach(async () => {
   await rimraf('./scratch');
+  nock.cleanAll();
 });
 
 describe('createGitignore', () => {

tests/create-twilio-function.test.js

@@ -4,12 +4,13 @@ const {
 } = require('../src/create-twilio-function/install-dependencies');
 const inquirer = require('inquirer');
 const ora = require('ora');
-const boxen = require('boxen');
+const nock = require('nock');
 const fs = require('fs');
 const { promisify } = require('util');
 const rimraf = promisify(require('rimraf'));
 const mkdir = promisify(fs.mkdir);
 const stat = promisify(fs.stat);
+const readdir = promisify(fs.readdir);
 
 jest.mock('inquirer');
 jest.mock('ora');
@@ -30,6 +31,11 @@ console.log = jest.fn();
 
 beforeAll(async () => {
   await rimraf('./scratch');
+  nock.disableNetConnect();
+});
+
+afterAll(() => {
+  nock.enableNetConnect();
 });
 
 beforeEach(async () => {
@@ -38,10 +44,15 @@ beforeEach(async () => {
 
 afterEach(async () => {
   await rimraf('./scratch');
+  nock.cleanAll();
 });
 
 describe('createTwilioFunction', () => {
-  beforeEach(() => jest.clearAllMocks());
+  beforeEach(() => {
+    nock('https://raw.githubusercontent.com')
+      .get('/github/gitignore/master/Node.gitignore')
+      .reply(200, '*.log\n.env');
+  });
 
   test('it scaffolds a Twilio Function', async () => {
     inquirer.prompt = jest.fn(() =>
@@ -84,6 +95,96 @@ describe('createTwilioFunction', () => {
     expect(console.log).toHaveBeenCalledWith('success message');
   });
 
+  test('it scaffolds a Twilio Function with a template', async () => {
+    inquirer.prompt = jest.fn(() =>
+      Promise.resolve({
+        accountSid: 'test-sid',
+        authToken: 'test-auth-token'
+      })
+    );
+
+    const gitHubAPI = nock('https://api.github.com');
+    gitHubAPI
+      .get('/repos/twilio-labs/function-templates/contents/blank?ref=next')
+      .reply(200, [
+        {
+          name: 'functions'
+        },
+        {
+          name: '.env',
+          download_url:
+            'https://raw.githubusercontent.com/twilio-labs/function-templates/next/blank/.env'
+        }
+      ]);
+    gitHubAPI
+      .get(
+        '/repos/twilio-labs/function-templates/contents/blank/functions?ref=next'
+      )
+      .reply(200, [
+        {
+          name: 'blank.js',
+          download_url:
+            'https://raw.githubusercontent.com/twilio-labs/function-templates/next/blank/functions/blank.js'
+        }
+      ]);
+    const gitHubRaw = nock('https://raw.githubusercontent.com');
+    gitHubRaw
+      .get('/twilio-labs/function-templates/next/blank/functions/blank.js')
+      .reply(
+        200,
+        `exports.handler = function(context, event, callback) {
+  callback(null, {});
+};`
+      );
+    gitHubRaw
+      .get('/github/gitignore/master/Node.gitignore')
+      .reply(200, 'node_modules/');
+    gitHubRaw
+      .get('/twilio-labs/function-templates/next/blank/.env')
+      .reply(200, '');
+
+    const name = 'test-function';
+    await createTwilioFunction({
+      name,
+      path: './scratch',
+      template: 'blank'
+    });
+
+    const dir = await stat(`./scratch/${name}`);
+    expect(dir.isDirectory());
+    const env = await stat(`./scratch/${name}/.env`);
+    expect(env.isFile());
+    const nvmrc = await stat(`./scratch/${name}/.nvmrc`);
+    expect(nvmrc.isFile());
+
+    const packageJSON = await stat(`./scratch/${name}/package.json`);
+    expect(packageJSON.isFile());
+
+    const gitignore = await stat(`./scratch/${name}/.gitignore`);
+    expect(gitignore.isFile());
+
+    const functions = await stat(`./scratch/${name}/functions`);
+    expect(functions.isDirectory());
+
+    const assets = await stat(`./scratch/${name}/assets`);
+    expect(assets.isDirectory());
+
+    const exampleFiles = await readdir(`./scratch/${name}/functions`);
+    expect(exampleFiles).toEqual(
+      expect.not.arrayContaining(['hello-world.js'])
+    );
+
+    const templateFunction = await stat(`./scratch/${name}/functions/blank.js`);
+    expect(templateFunction.isFile());
+
+    const exampleAssets = await readdir(`./scratch/${name}/assets`);
+    expect(exampleAssets).toEqual(expect.not.arrayContaining(['index.html']));
+
+    expect(installDependencies).toHaveBeenCalledWith(`./scratch/${name}`);
+
+    expect(console.log).toHaveBeenCalledWith('success message');
+  });
+
   it("doesn't scaffold if the target folder name already exists", async () => {
     const name = 'test-function';
     await mkdir('./scratch/test-function');

tests/import-credentials.test.js

@@ -2,8 +2,6 @@ const importCredentials = require('../src/create-twilio-function/import-credenti
 const inquirer = require('inquirer');
 
 describe('importCredentials', () => {
-  beforeEach(() => jest.clearAllMocks());
-
   describe('if credentials are present in the env', () => {
     afterEach(() => {
       delete process.env.TWILIO_ACCOUNT_SID;

tests/list-templates.test.js

@@ -1,9 +1,29 @@
-const templateActions = require('twilio-run/dist/templating/actions');
 const listTemplates = require('../src/commands/list-templates');
+const ora = require('ora');
+const nock = require('nock');
 
-jest.mock('twilio-run/dist/templating/actions');
+jest.mock('ora');
+ora.mockImplementation(() => {
+  const spinner = {
+    start: () => spinner,
+    stop: () => spinner
+  };
+  return spinner;
+});
+
+beforeAll(() => {
+  nock.disableNetConnect();
+});
+
+afterAll(() => {
+  nock.enableNetConnect();
+});
 
 describe('listTemplates', () => {
+  afterEach(() => {
+    nock.cleanAll();
+  });
+
   it('gets templates from twilio-run and displays them', async () => {
     const consoleSpy = jest
       .spyOn(global.console, 'log')
@@ -13,7 +33,11 @@ describe('listTemplates', () => {
       id: 'test-template',
       description: 'A template to test with'
     };
-    templateActions.fetchListOfTemplates.mockResolvedValue([template]);
+    nock('https://raw.githubusercontent.com')
+      .get('/twilio-labs/function-templates/master/templates.json')
+      .reply(200, {
+        templates: [template]
+      });
 
     await listTemplates();
 

tests/prompt.test.js

@@ -4,8 +4,6 @@ const {
 const inquirer = require('inquirer');
 
 describe('promptForAccountDetails', () => {
-  beforeEach(() => jest.clearAllMocks());
-
   test(`should ask for an accountSid if not specified`, async () => {
     inquirer.prompt = jest.fn(() =>
       Promise.resolve({