Adds success message to the end of the process with next steps.

Author: philnash

package.json

@@ -28,6 +28,8 @@
     "rimraf": "^2.6.3"
   },
   "dependencies": {
+    "boxen": "^3.0.0",
+    "chalk": "^2.4.2",
     "gitignore": "^0.6.0",
     "inquirer": "^6.2.2",
     "ora": "^3.2.0",

src/create-twilio-function.js

@@ -10,7 +10,9 @@ const importCredentials = require('./create-twilio-function/import-credentials')
 const {
   installDependencies
 } = require('./create-twilio-function/install-dependencies');
+const successMessage = require('./create-twilio-function/success-message');
 const ora = require('ora');
+const boxen = require('boxen');
 
 async function createTwilioFunction(config) {
   const projectDir = `${config.path}/${config.name}`;
@@ -55,6 +57,12 @@ async function createTwilioFunction(config) {
   spinner.start('Installing dependencies');
   await installDependencies(projectDir);
   spinner.succeed();
+
+  // Success message
+
+  console.log(
+    boxen(await successMessage(config), { padding: 1, borderStyle: 'round' })
+  );
 }
 
 module.exports = createTwilioFunction;

src/create-twilio-function/success-message.js

@@ -0,0 +1,21 @@
+const { getPackageManager } = require('pkg-install');
+const chalk = require('chalk');
+
+async function successMessage(config) {
+  const packageManager = await getPackageManager({ cwd: process.cwd() });
+  return chalk`{green Success!}
+
+  Created {bold ${config.name}} at ${config.path}
+
+  Inside that directory, you can run the following command:
+
+  {blue ${packageManager} start}
+    Serves all functions in the ./functions subdirectory
+
+  Get started by running:
+
+  {blue cd ${config.name}}
+  {blue ${packageManager} start}`;
+}
+
+module.exports = successMessage;

tests/create-twilio-function.test.js

@@ -4,6 +4,7 @@ const {
 } = require('../src/create-twilio-function/install-dependencies');
 const inquirer = require('inquirer');
 const ora = require('ora');
+const boxen = require('boxen');
 const fs = require('fs');
 const { promisify } = require('util');
 const rimraf = promisify(require('rimraf'));
@@ -12,17 +13,20 @@ const stat = promisify(fs.stat);
 
 jest.mock('inquirer');
 jest.mock('ora');
+jest.mock('boxen', () => {
+  return () => 'success message';
+});
 ora.mockImplementation(() => {
   const spinner = {
     start: () => spinner,
     succeed: () => spinner
   };
   return spinner;
 });
-
 jest.mock('../src/create-twilio-function/install-dependencies.js', () => {
   return { installDependencies: jest.fn() };
 });
+console.log = jest.fn();
 
 beforeAll(async () => {
   await rimraf('./scratch');
@@ -46,6 +50,7 @@ describe('createTwilioFunction', () => {
         authToken: 'test-auth-token'
       })
     );
+
     const name = 'test-function';
     await createTwilioFunction({ name, path: './scratch' });
 
@@ -70,6 +75,8 @@ describe('createTwilioFunction', () => {
     expect(example.isFile());
 
     expect(installDependencies).toHaveBeenCalledWith(`./scratch/${name}`);
+
+    expect(console.log).toHaveBeenCalledWith('success message');
   });
 
   it("doesn't scaffold if the target folder name already exists", async () => {
@@ -79,9 +86,10 @@ describe('createTwilioFunction', () => {
 
     await createTwilioFunction({ name, path: './scratch' });
 
-    expect.assertions(2);
+    expect.assertions(3);
 
     expect(console.error).toHaveBeenCalledTimes(1);
+    expect(console.log).not.toHaveBeenCalled();
 
     try {
       await stat(`./scratch/${name}/package.json`);

tests/success-message.test.js

@@ -0,0 +1,22 @@
+const pkgInstall = require('pkg-install');
+const chalk = require('chalk');
+const successMessage = require('../src/create-twilio-function/success-message');
+
+jest.mock('pkg-install');
+
+describe('successMessage', () => {
+  test('creates a success message based on the package manager', async () => {
+    pkgInstall.getPackageManager.mockResolvedValue('yarn');
+    const config = {
+      name: 'test-function',
+      path: './test-path'
+    };
+    const message = await successMessage(config);
+    expect(message).toEqual(expect.stringContaining('yarn start'));
+    expect(message).toEqual(
+      expect.stringContaining(
+        chalk`Created {bold ${config.name}} at ${config.path}`
+      )
+    );
+  });
+});