Merge branch 'dlemstra-add-eslint'

Author: philnash

packages/create-twilio-function/.eslintrc.js

@@ -0,0 +1,14 @@
+module.exports = {
+  'extends': 'twilio',
+  'plugins': ['jest'],
+  'env': {
+    'jest/globals': true
+  },
+  'parserOptions': {
+    'ecmaVersion': 9,
+    'sourceType': 'module',
+  },
+  'rules': {
+      'no-console': 'off'
+  }
+}

packages/create-twilio-function/.gitattributes

@@ -0,0 +1,2 @@
+* text=auto eol=lf
+*.js text

packages/create-twilio-function/.travis.yml

@@ -5,3 +5,6 @@ node_js:
 os:
   - linux
   - windows
+script:
+  - npm test
+  - npm run lint

packages/create-twilio-function/package.json

@@ -5,7 +5,9 @@
   "bin": "./bin/create-twilio-function",
   "main": "./src/create-twilio-function.js",
   "scripts": {
-    "test": "jest"
+    "test": "jest",
+    "lint": "eslint src tests",
+    "lint:fix": "npm run lint -- --fix"
   },
   "keywords": [
     "twilio",
@@ -23,6 +25,13 @@
   },
   "license": "MIT",
   "devDependencies": {
+    "eslint": "^6.5.1",
+    "eslint-config-twilio": "^1.13.2",
+    "eslint-plugin-import": "^2.18.2",
+    "eslint-plugin-jest": "^22.17.0",
+    "eslint-plugin-node": "^10.0.0",
+    "eslint-plugin-promise": "^4.2.1",
+    "eslint-plugin-standard": "^4.0.1",
     "jest": "^24.5.0",
     "nock": "^11.3.4"
   },

packages/create-twilio-function/src/cli.js

@@ -1,7 +1,8 @@
 const yargs = require('yargs');
-const DefaultCommand = require('./command');
 const ListTemplateCommand = require('twilio-run/dist/commands/list-templates');
 
+const DefaultCommand = require('./command');
+
 function cli(cwd) {
   yargs.help();
   yargs.alias('h', 'help');

packages/create-twilio-function/src/command.js

@@ -8,45 +8,42 @@ const cliInfo = {
     'account-sid': {
       alias: 'a',
       describe: 'The Account SID for your Twilio account',
-      type: 'string'
+      type: 'string',
     },
     'auth-token': {
       alias: 't',
       describe: 'Your Twilio account Auth Token',
-      type: 'string'
+      type: 'string',
     },
     'skip-credentials': {
-      describe:
-        "Don't ask for Twilio account credentials or import them from the environment",
+      describe: "Don't ask for Twilio account credentials or import them from the environment",
       type: 'boolean',
-      default: false
+      default: false,
     },
     'import-credentials': {
-      describe:
-        'Import credentials from the environment variables TWILIO_ACCOUNT_SID and TWILIO_AUTH_TOKEN',
+      describe: 'Import credentials from the environment variables TWILIO_ACCOUNT_SID and TWILIO_AUTH_TOKEN',
       type: 'boolean',
-      default: false
+      default: false,
     },
     template: {
-      describe:
-        'Initialize your new project with a template from github.com/twilio-labs/function-templates',
-      type: 'string'
-    }
-  }
+      describe: 'Initialize your new project with a template from github.com/twilio-labs/function-templates',
+      type: 'string',
+    },
+  },
 };
 
-const builder = command => {
-  command.positional('name', {
+function builder(cmd) {
+  cmd.positional('name', {
     describe: 'Name of your project.',
-    type: 'string'
+    type: 'string',
   });
-  command.options(cliInfo.options);
-};
+  cmd.options(cliInfo.options);
+}
 
 module.exports = {
   command,
   describe,
   handler,
   cliInfo,
-  builder
+  builder,
 };

packages/create-twilio-function/src/create-twilio-function.js

@@ -1,27 +1,24 @@
-const {
-  promptForAccountDetails,
-  promptForProjectName
-} = require('./create-twilio-function/prompt');
+const { promisify } = require('util');
+const path = require('path');
+
+const ora = require('ora');
+const boxen = require('boxen');
+const rimraf = promisify(require('rimraf'));
+const { downloadTemplate } = require('twilio-run/dist/templating/actions');
+
+const { promptForAccountDetails, promptForProjectName } = require('./create-twilio-function/prompt');
 const validateProjectName = require('./create-twilio-function/validate-project-name');
 const {
   createDirectory,
   createEnvFile,
   createExampleFromTemplates,
   createPackageJSON,
-  createNvmrcFile
+  createNvmrcFile,
 } = require('./create-twilio-function/create-files');
 const createGitignore = require('./create-twilio-function/create-gitignore');
 const importCredentials = require('./create-twilio-function/import-credentials');
-const {
-  installDependencies
-} = require('./create-twilio-function/install-dependencies');
+const { installDependencies } = require('./create-twilio-function/install-dependencies');
 const successMessage = require('./create-twilio-function/success-message');
-const ora = require('ora');
-const boxen = require('boxen');
-const { downloadTemplate } = require('twilio-run/dist/templating/actions');
-const { promisify } = require('util');
-const rimraf = promisify(require('rimraf'));
-const path = require('path');
 
 async function cleanUpAndExit(projectDir, spinner, errorMessage) {
   spinner.fail(errorMessage);
@@ -48,13 +45,11 @@ async function createTwilioFunction(config) {
     switch (e.code) {
       case 'EEXIST':
         spinner.fail(
-          `A directory called '${config.name}' already exists. Please create your function in a new directory.`
+          `A directory called '${config.name}' already exists. Please create your function in a new directory.`,
         );
         break;
       case 'EACCES':
-        spinner.fail(
-          `You do not have permission to create files or directories in the path '${config.path}'.`
-        );
+        spinner.fail(`You do not have permission to create files or directories in the path '${config.path}'.`);
         break;
       default:
         spinner.fail(e.message);
@@ -68,14 +63,17 @@ async function createTwilioFunction(config) {
   if (Object.keys(accountDetails).length === 0) {
     accountDetails = await promptForAccountDetails(config);
   }
-  config = { ...accountDetails, ...config };
+  config = {
+    ...accountDetails,
+    ...config,
+  };
 
   // Scaffold project
   spinner.start('Creating project directories and files');
 
   await createEnvFile(projectDir, {
     accountSid: config.accountSid,
-    authToken: config.authToken
+    authToken: config.authToken,
   });
   await createNvmrcFile(projectDir);
   await createPackageJSON(projectDir, config.name);
@@ -88,11 +86,7 @@ async function createTwilioFunction(config) {
       await downloadTemplate(config.template, '', projectDir);
       spinner.succeed();
     } catch (err) {
-      await cleanUpAndExit(
-        projectDir,
-        spinner,
-        `The template "${config.template}" doesn't exist`
-      );
+      await cleanUpAndExit(projectDir, spinner, `The template "${config.template}" doesn't exist`);
       return;
     }
   } else {
@@ -118,14 +112,17 @@ async function createTwilioFunction(config) {
   } catch (err) {
     spinner.fail();
     console.log(
-      `There was an error installing the dependencies, but your project is otherwise complete in ./${config.name}`
+      `There was an error installing the dependencies, but your project is otherwise complete in ./${config.name}`,
     );
   }
 
   // Success message
 
   console.log(
-    boxen(await successMessage(config), { padding: 1, borderStyle: 'round' })
+    boxen(await successMessage(config), {
+      padding: 1,
+      borderStyle: 'round',
+    }),
   );
 }
 

packages/create-twilio-function/src/create-twilio-function/create-files.js

@@ -1,13 +1,15 @@
-const versions = require('./versions');
 const fs = require('fs');
+const path = require('path');
 const { promisify } = require('util');
+
+const versions = require('./versions');
+
 const mkdir = promisify(fs.mkdir);
 const writeFile = promisify(fs.writeFile);
 const readdir = promisify(fs.readdir);
 const copyFile = promisify(fs.copyFile);
 const { COPYFILE_EXCL } = fs.constants;
 const stat = promisify(fs.stat);
-const path = require('path');
 
 function createDirectory(pathName, dirName) {
   return mkdir(path.join(pathName, dirName));
@@ -21,21 +23,19 @@ function createPackageJSON(pathName, name) {
   const fullPath = path.join(pathName, 'package.json');
   const packageJSON = JSON.stringify(
     {
-      name: name,
+      name,
       version: '0.0.0',
       private: true,
       scripts: {
         test: 'echo "Error: no test specified" && exit 1',
         start: 'twilio-run',
-        deploy: 'twilio-run deploy'
+        deploy: 'twilio-run deploy',
       },
-      devDependencies: {
-        'twilio-run': versions.twilioRun
-      },
-      engines: { node: versions.node }
+      devDependencies: { 'twilio-run': versions.twilioRun },
+      engines: { node: versions.node },
     },
     null,
-    2
+    2,
   );
   return createFile(fullPath, packageJSON);
 }
@@ -44,28 +44,21 @@ function copyRecursively(src, dest) {
   return readdir(src).then(children => {
     return Promise.all(
       children.map(child =>
-        stat(path.join(src, child)).then(stat => {
-          if (stat.isDirectory()) {
+        stat(path.join(src, child)).then(stats => {
+          if (stats.isDirectory()) {
             return mkdir(path.join(dest, child)).then(() =>
-              copyRecursively(path.join(src, child), path.join(dest, child))
+              copyRecursively(path.join(src, child), path.join(dest, child)),
             );
           }
-          return copyFile(
-            path.join(src, child),
-            path.join(dest, child),
-            COPYFILE_EXCL
-          );
-        })
-      )
+          return copyFile(path.join(src, child), path.join(dest, child), COPYFILE_EXCL);
+        }),
+      ),
     );
   });
 }
 
 function createExampleFromTemplates(pathName) {
-  return copyRecursively(
-    path.join(__dirname, '..', '..', 'templates'),
-    pathName
-  );
+  return copyRecursively(path.join(__dirname, '..', '..', 'templates'), pathName);
 }
 
 function createEnvFile(pathName, { accountSid, authToken }) {
@@ -86,5 +79,5 @@ module.exports = {
   createPackageJSON,
   createExampleFromTemplates,
   createEnvFile,
-  createNvmrcFile
+  createNvmrcFile,
 };

packages/create-twilio-function/src/create-twilio-function/create-gitignore.js

@@ -1,14 +1,19 @@
 const fs = require('fs');
+const path = require('path');
 const { promisify } = require('util');
+
 const writeGitignore = promisify(require('gitignore').writeFile);
+
 const open = promisify(fs.open);
-const path = require('path');
 
 function createGitignore(dirPath) {
   const fullPath = path.join(dirPath, '.gitignore');
   return open(fullPath, 'wx').then(fd => {
-    const stream = fs.createWriteStream(null, { fd: fd });
-    return writeGitignore({ type: 'Node', file: stream });
+    const stream = fs.createWriteStream(null, { fd });
+    return writeGitignore({
+      type: 'Node',
+      file: stream,
+    });
   });
 }
 

packages/create-twilio-function/src/create-twilio-function/import-credentials.js

@@ -3,33 +3,31 @@ const inquirer = require('inquirer');
 const questions = [
   {
     type: 'confirm',
-    name: 'importCredentials',
-    message:
-      'Your account credentials have been found in your environment variables. Import them?',
-    default: true
-  }
+    name: 'importedCredentials',
+    message: 'Your account credentials have been found in your environment variables. Import them?',
+    default: true,
+  },
 ];
 
 async function importCredentials(config) {
-  if (config.skipCredentials) return {};
+  if (config.skipCredentials) {
+    return {};
+  }
 
   const credentials = {
     accountSid: process.env.TWILIO_ACCOUNT_SID,
-    authToken: process.env.TWILIO_AUTH_TOKEN
+    authToken: process.env.TWILIO_AUTH_TOKEN,
   };
-  if (
-    typeof credentials.accountSid === 'undefined' &&
-    typeof credentials.authToken === 'undefined'
-  ) {
+  if (typeof credentials.accountSid === 'undefined' && typeof credentials.authToken === 'undefined') {
     return {};
   }
 
-  if (config.importCredentials) {
+  if (config.importedCredentials) {
     return credentials;
   }
 
-  const { importCredentials } = await inquirer.prompt(questions);
-  return importCredentials ? credentials : {};
+  const { importedCredentials } = await inquirer.prompt(questions);
+  return importedCredentials ? credentials : {};
 }
 
 module.exports = importCredentials;