Bring in ESLint with Airbnb formatting rules and apply to codebase.

Author: sblaurock

.eslintrc

@@ -0,0 +1,6 @@
+{
+  "extends": "airbnb/base",
+  "rules": {
+    "comma-dangle": 0
+  }
+}

README.md

@@ -1,5 +1,5 @@
 # pingdiff
-Detect differences across a supplied list of websites.
+Detect changes across a supplied list of websites.
 
 ### Setup
     npm install

app.js

@@ -1,55 +1,55 @@
-const jsdom = require('jsdom');
-const argv = require('yargs').argv;
-const fs = require('fs');
-const _ = require('lodash');
-const request = require('request');
-const jsonfile = require('jsonfile');
-const logger = require("./utils/logger");
+import jsdom from 'jsdom';
+import yargs from 'yargs';
+import fs from 'fs';
+import _ from 'lodash';
+import request from 'request';
+import jsonfile from 'jsonfile';
+import logger from './utils/logger';
 
 let multiplier = 0;
 let IFTTTParams = {};
-let IFTTTTimers = {};
-const { endpoints, interval, ifttt, random } = argv;
+const IFTTTTimers = {};
+const { endpoints, interval, ifttt, random } = yargs.argv;
 const options = {
-  selector: 'body :not(script)',
+  selector: 'body',
   jQuerySrc: 'http://code.jquery.com/jquery.js',
   defaultTimeout: 10,
   defaultRandom: 20
 };
 
 // Ensure we have required arguments
-if(!_.isString(endpoints) || !_.isInteger(interval) || interval < 0) {
-  console.error('--endpoints and --interval are required');
+if (!_.isString(endpoints) || !_.isInteger(interval) || interval < 0) {
+  logger.error('--endpoints and --interval are required');
   process.exit(1);
 }
 
 // Ensure list of endpoints is a file
-if(!fs.statSync(endpoints).isFile()) {
-  console.error('--endpoints should refer to a file (list of endpoints)');
+if (!fs.statSync(endpoints).isFile()) {
+  logger.error('--endpoints should refer to a file (list of endpoints)');
   process.exit(2);
 }
 
 // Ensure IFTTT configuration is valid
-if(ifttt) {
-  if(!fs.statSync(ifttt).isFile()) {
-    console.error('--ifttt should refer to a JSON file configuration');
+if (ifttt) {
+  if (!fs.statSync(ifttt).isFile()) {
+    logger.error('--ifttt should refer to a JSON file configuration');
     process.exit(5);
   }
 
   const { key, eventName, bodyKey } = IFTTTParams = jsonfile.readFileSync(ifttt);
 
-  if(!key || !eventName || !bodyKey || !_.isString(key) || !_.isString(eventName) || !_.isString(bodyKey)) {
-    console.error('--ifttt file is missing required data');
+  if (!_.isString(key) || !_.isString(eventName) || !_.isString(bodyKey)) {
+    logger.error('--ifttt file is missing required data');
     process.exit(6);
   }
 }
 
 // Ensure random argument is valid
-if(random) {
-  if(_.isBoolean(random)) {
+if (random) {
+  if (_.isBoolean(random)) {
     multiplier = options.defaultRandom;
-  } else if((_.isInteger(random) && (random < 0 || random > 99) || !_.isInteger(random))) {
-    console.error('--random must be an integer from 0 to 99');
+  } else if ((_.isInteger(random) && (random < 0 || random > 99) || !_.isInteger(random))) {
+    logger.error('--random must be an integer from 0 to 99');
     process.exit(7);
   } else {
     multiplier = random;
@@ -58,20 +58,20 @@ if(random) {
 
 // Make requests to endpoints
 const makeRequests = (urls, callback) => {
-  let responses = {};
+  const responses = {};
   let complete = 0;
 
   urls.forEach((url) => {
     jsdom.env({
-      url: url,
+      url,
       scripts: [options.jQuerySrc],
-      done: (err, window) => {
-        if(!window || !window.$ || err) {
-          console.error(`Resource data located at ${url} failed to load`);
+      done(err, window) {
+        if (!window || !window.$ || err) {
+          logger.error(`Resource data located at ${url} failed to load`);
         } else {
           const $ = window.$;
 
-          $(options.selector).each(function() {
+          $(options.selector).each(() => {
             const responseText = $(this).text().replace(/\W+/g, '');
 
             responses[url] = responseText;
@@ -80,7 +80,7 @@ const makeRequests = (urls, callback) => {
 
         complete++;
 
-        if(complete === urls.length) {
+        if (complete === urls.length) {
           callback(responses);
         }
       }
@@ -94,72 +94,73 @@ const postIFTTT = (data) => {
   const timeout = (_.isInteger(IFTTTParams.timeout) ? IFTTTParams.timeout : options.defaultTimeout);
 
   // Ensure enough time has passed since last time an event was dispatched
-  if(!IFTTTTimers[data] || now - IFTTTTimers[data] > timeout) {
-    let postData = {};
+  if (!IFTTTTimers[data] || now - IFTTTTimers[data] > timeout) {
+    const postData = {};
 
     postData[IFTTTParams.bodyKey] = data;
     IFTTTTimers[data] = now;
 
     request.post({
       url: `https://maker.ifttt.com/trigger/${IFTTTParams.eventName}/with/key/${IFTTTParams.key}`,
       form: postData
-    }, (err, response) => {
-      if(err) {
-        console.log('- IFTTT event dispatch failed');
+    }, (err) => {
+      if (err) {
+        logger.info('- IFTTT event dispatch failed');
       } else {
-        console.log('- IFTTT event dispatched');
+        logger.info('- IFTTT event dispatched');
       }
     });
   } else {
-    console.log('- IFTTT event ignored due to timeout');
+    logger.info('- IFTTT event ignored due to timeout');
   }
 };
 
 // Read endpoints file and create list of endpoints
 fs.readFile(endpoints, 'utf-8', (err, data) => {
-  if(err) {
-    console.error('--endpoints file could not be read');
+  if (err) {
+    logger.error('--endpoints file could not be read');
     process.exit(3);
   }
 
-  const endpointsList = _.remove(data.split('\n'), (item) => {
-    return _.isString(item) && !_.isEmpty(item);
-  });
+  let endpointsList = data.split('\n');
+
+  endpointsList = _.filter(endpointsList, (item) => _.isString(item) && !_.isEmpty(item));
 
-  if(!endpointsList.length) {
-    console.error('--endpoints file does not contain any endpoints');
+  if (!endpointsList.length) {
+    logger.error('--endpoints file does not contain any endpoints');
     process.exit(4);
   }
 
   // Cache initial endpoint responses
-  makeRequests(endpointsList, (responses) => {
-    const cache = responses;
+  makeRequests(endpointsList, (initialResponses) => {
+    const cache = initialResponses;
 
-    console.log(`${_.keys(responses).length} of ${endpointsList.length} responses cached`);
+    logger.info(`${_.keys(cache).length} of ${endpointsList.length} responses cached`);
 
     (function loop() {
-      const random = (Math.random() * multiplier) / 100;
+      // Apply randomness to timing
+      const rand = (Math.random() * multiplier) / 100;
       const plusOrMinus = (Math.random() < 0.5 ? -1 : 1);
-      const timer = Math.floor((interval + plusOrMinus * (random * interval)) * 1000);
+      const timer = Math.floor((interval + plusOrMinus * (rand * interval)) * 1000);
 
       setTimeout(() => {
         makeRequests(endpointsList, (responses) => {
           const differences = _.difference(_.values(responses), _.values(cache));
 
-          if(differences.length) {
+          if (differences.length) {
             differences.forEach((difference) => {
               const endpoint = _.invert(responses)[difference];
 
               cache[endpoint] = difference;
 
-              console.log(`Difference identified within ${endpoint}`);
+              logger.info(`Difference identified within ${endpoint}`);
 
-              if(ifttt) {
+              if (ifttt) {
                 postIFTTT(endpoint);
               }
             });
           } else {
-            console.log(`No differences identified for ${_.keys(responses).length} responses`)
+            logger.info(`No differences identified for ${_.keys(responses).length} responses`);
           }
 
           loop();

package.json

@@ -1,8 +1,8 @@
 {
   "name": "pingdiff",
   "version": "1.0.0",
-  "description": "",
-  "main": "app.js",
+  "description": "Detect changes across a supplied list of websites",
+  "main": "index.js",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/sblaurock/pingdiff.git"
@@ -11,6 +11,9 @@
   "bugs": {
     "url": "https://github.com/sblaurock/pingdiff/issues"
   },
+  "scripts": {
+    "lint": "eslint app.js"
+  },
   "homepage": "https://github.com/sblaurock/pingdiff#readme",
   "dependencies": {
     "babel-preset-es2015": "^6.6.0",
@@ -22,5 +25,9 @@
     "request": "^2.69.0",
     "winston": "^2.2.0",
     "yargs": "^4.3.2"
+  },
+  "devDependencies": {
+    "eslint": "^2.6.0",
+    "eslint-config-airbnb": "^6.2.0"
   }
 }

utils/logger.js

@@ -15,8 +15,4 @@ let logger = new winston.Logger({
   exitOnError: false
 });
 
-// Use logger in favor of native
-console.log = logger.info;
-console.error = logger.error;
-
 module.exports = logger;