Merge pull request #52 from apiaryio/honzajavorek/lint

Add ESLint

Author: honzajavorek

.eslintrc.js

@@ -0,0 +1,12 @@
+module.exports = {
+  extends: 'airbnb-base',
+  env: {
+    'mocha': true,
+    'node': true
+  },
+  rules: {
+    // Using 'console' is perfectly okay for a Node.js CLI tool and avoiding
+    // it only brings unnecessary complexity
+    'no-console': 'off',
+  }
+};

cli/copyFeatures.js

@@ -15,4 +15,4 @@ module.exports = function copyFeatures(srcDir, dstDir, transformBasename = basen
     const featurePath = path.join(dstDir, transformBasename(featureBasename));
     fs.writeFileSync(featurePath, featureContent, { encoding: 'utf-8' });
   });
-}
+};

cli/index.js

@@ -7,15 +7,15 @@ const run = require('./run');
 const copyFeatures = require('./copyFeatures');
 
 
-PROJECT_DIR = process.cwd();
-NODE_MODULES_DIR = path.join(PROJECT_DIR, 'node_modules');
+const PROJECT_DIR = process.cwd();
+const NODE_MODULES_DIR = path.join(PROJECT_DIR, 'node_modules');
 
-FEATURES_SRC_DIR = path.join(NODE_MODULES_DIR, 'dredd-hooks-template', 'features');
-FEATURES_DIR = path.join(PROJECT_DIR, 'features');
-STEPS_DIR = path.join(FEATURES_SRC_DIR, 'support');
+const FEATURES_SRC_DIR = path.join(NODE_MODULES_DIR, 'dredd-hooks-template', 'features');
+const FEATURES_DIR = path.join(PROJECT_DIR, 'features');
+const STEPS_DIR = path.join(FEATURES_SRC_DIR, 'support');
 
-NODE_BIN = process.execPath;
-CUCUMBER_BIN = path.join(NODE_MODULES_DIR, '.bin', 'cucumber-js');
+const NODE_BIN = process.execPath;
+const CUCUMBER_BIN = path.join(NODE_MODULES_DIR, '.bin', 'cucumber-js');
 
 
 function init() {
@@ -49,13 +49,13 @@ function upgrade() {
 
   // halt in case the project already depends on the latest version
   if (currentVersion === version) {
-    console.log(`The test suite template is up to date!`);
+    console.log('The test suite template is up to date!');
     return;
   }
 
   // upgrade the package
-  const package = `dredd-hooks-template@${version}`;
-  run('npm', ['install', package, '--save-dev'], { cwd: PROJECT_DIR });
+  const pkg = `dredd-hooks-template@${version}`;
+  run('npm', ['install', pkg, '--save-dev'], { cwd: PROJECT_DIR });
 
   // copy '*.feature' files from the upgraded 'dredd-hooks-template' package
   // to the project, but don't overwrite the existing feature files, add these
@@ -80,6 +80,6 @@ if (process.argv.length > 3) {
   } else {
     process.exitCode = 1;
     console.error('Available commands: init, test, upgrade');
-    console.error('See https://github.com/apiaryio/dredd-hooks-template README')
+    console.error('See https://github.com/apiaryio/dredd-hooks-template README');
   }
 }

cli/run.js

@@ -7,7 +7,7 @@ const { spawnSync } = require('child_process');
  */
 module.exports = function run(command, args, options) {
   const proc = spawnSync(command, args, { ...options, stdio: 'inherit' });
-  if (proc.error) throw error;
+  if (proc.error) throw proc.error;
   if (proc.status) throw new Error(`'${[command].concat(args).join(' ')}' failed`);
   return proc;
 };

features/support/steps.js

@@ -7,41 +7,48 @@ const fs = require('fs-extra');
 const net = require('net');
 const which = require('which');
 const kill = require('tree-kill');
-const { Given, When, Then, Before, After } = require('cucumber');
+const {
+  Given,
+  When,
+  Then,
+  Before,
+  After,
+} = require('cucumber');
 
-DREDD_BIN = path.join(process.cwd(), 'node_modules', '.bin', 'dredd');
 
+const DREDD_BIN = path.join(process.cwd(), 'node_modules', '.bin', 'dredd');
 
-Before(function () {
+
+Before(function hook() {
   this.dir = fs.mkdtempSync(path.join(os.tmpdir(), 'dredd-hooks-template-'));
   this.env = { ...process.env };
   this.commands = [];
   this.dataSent = '';
 });
 
-After(async function () {
+After(async function hook() {
   fs.remove(this.dir);
   await util.promisify(kill)(this.proc.pid);
 });
 
 
-Given(/^I have "([^"]+)" command installed$/, function (match) {
+Given(/^I have "([^"]+)" command installed$/, (match) => {
   const command = match === 'dredd'
     ? DREDD_BIN
     : match;
   which.sync(command); // throws if the command is not found
 });
 
-Given(/^a file named "([^"]+)" with:$/, function (filename, content) {
+Given(/^a file named "([^"]+)" with:$/, function step(filename, content) {
   fs.writeFileSync(path.join(this.dir, filename), content);
 });
 
-Given(/^I set the environment variables to:$/, function (env) {
+Given(/^I set the environment variables to:$/, function step(env) {
   this.env = { ...this.env, ...env.rowsHash() };
 });
 
 
-When(/^I run `([^`]+)`$/, function (match) {
+When(/^I run `([^`]+)`$/, function step(match) {
   const command = match.replace(/^dredd(?= )/, DREDD_BIN);
   this.proc = childProcess.spawnSync(command, [], {
     shell: true,
@@ -50,16 +57,16 @@ When(/^I run `([^`]+)`$/, function (match) {
   });
 });
 
-When(/^I run `([^`]+)` interactively$/, function (command) {
+When(/^I run `([^`]+)` interactively$/, function step(command) {
   this.proc = childProcess.spawn(command, [], {
     shell: true,
     cwd: this.dir,
     env: this.env,
   });
 });
 
-When('I wait for output to contain {string}', function (output, callback) {
-  const proc = this.proc;
+When('I wait for output to contain {string}', function step(output, callback) {
+  const { proc } = this;
 
   function read(data) {
     if (data.toString().includes(output)) {
@@ -73,38 +80,38 @@ When('I wait for output to contain {string}', function (output, callback) {
   proc.stderr.on('data', read);
 });
 
-When('I connect to the server', async function () {
+When('I connect to the server', async function step() {
   this.socket = new net.Socket();
   const connect = util.promisify(this.socket.connect.bind(this.socket));
   await connect(61321, '127.0.0.1');
 });
 
-When('I send a JSON message to the socket:', function (message) {
+When('I send a JSON message to the socket:', function step(message) {
   this.socket.write(message);
   this.dataSent += message;
 });
 
-When('I send a newline character as a message delimiter to the socket', function () {
+When('I send a newline character as a message delimiter to the socket', function step() {
   this.socket.write('\n');
 });
 
 
-Then('the exit status should be {int}', function (status) {
+Then('the exit status should be {int}', function step(status) {
   expect(this.proc.status).to.equal(status);
 });
 
-Then('the output should contain:', function (output) {
+Then('the output should contain:', function step(output) {
   expect(this.proc.stdout.toString() + this.proc.stderr.toString()).to.contain(output);
 });
 
-Then('it should start listening on localhost port {int}', async function (port) {
+Then('it should start listening on localhost port {int}', async function step(port) {
   this.socket = new net.Socket();
   const connect = util.promisify(this.socket.connect.bind(this.socket));
   await connect(port, '127.0.0.1'); // throws if there's an issue
   this.socket.end();
 });
 
-Then('I should receive the same response', function (callback) {
+Then('I should receive the same response', function step(callback) {
   this.socket.on('data', (data) => {
     const dataReceived = JSON.parse(data.toString());
     const dataSent = JSON.parse(this.dataSent);
@@ -113,6 +120,6 @@ Then('I should receive the same response', function (callback) {
   });
 });
 
-Then('I should be able to gracefully disconnect', function () {
+Then('I should be able to gracefully disconnect', function step() {
   this.socket.end();
 });