Use eslint & prettier, add precommit hook (#1152)

.eslintrc.json

@@ -0,0 +1,19 @@
+{
+  "env": {
+    "node": true
+  },
+  "extends": ["eslint:recommended", "prettier"],
+  "globals": {},
+  "rules": {
+    "indent": [
+      2,
+      2,
+      {
+        "SwitchCase": 1,
+        "VariableDeclarator": 2
+      }
+    ],
+    "no-eq-null": 0,
+    "no-proto": 2
+  }
+}

.travis.yml

@@ -1,15 +1,11 @@
 language: node_js
 node_js:
   - "stable"
-  - "unstable"
+  - "8"
   - "6"
-  - "4"
-  - "0.12"
 script: make travis-test
 matrix:
   fast_finish: true
-  allow_failures:
-    - node_js: unstable
   include:
     - env: BENCHMARK=true
       script: "node benchmark/benchmark.js --regex '^(?!.*highmem)'"

CONTRIBUTING.md

@@ -3,16 +3,16 @@
 Thanks for your interest in contributing to the project! Here's a rundown of
 how we'd like to work with you:
 
-1. File an issue on GitHub describing the contribution you'd like to make. This
-   will help us to get you started on the right foot.
-2. Create a single commit that addresses the issue:
-    1. Follow the project's code style (see below)
-    2. Add enough unit tests to "prove" that your patch is correct
-    3. Update the project documentation as needed (see below)
-    4. Describe your approach with as much detail as necessary in the git
-       commit message
-3. Open a pull request, and reference the initial issue in the pull request
-   message.
+1.  File an issue on GitHub describing the contribution you'd like to make. This
+    will help us to get you started on the right foot.
+2.  Create a single commit that addresses the issue:
+    1.  Follow the project's code style (see below)
+    2.  Add enough unit tests to "prove" that your patch is correct
+    3.  Update the project documentation as needed (see below)
+    4.  Describe your approach with as much detail as necessary in the git
+        commit message
+3.  Open a pull request, and reference the initial issue in the pull request
+    message.
 
 # Documentation
 
@@ -22,26 +22,16 @@ care to note aspects that make Cheerio distinct.
 
 # Code Style
 
-This section is by no means complete. For undocumented stylistic choices,
-please try to maintain consistency with the code base.
-
-- Single quotes: `'`
-- Whitespace
-  - Two-space "soft" tabs
-  - Once space following control flow statements (`if (condition) {` rather
-    than `if(condition) {`)
-  - Remove trailing spaces
-  - [End each file with a newline
-    character.](https://github.com/editorconfig/editorconfig/wiki/Newline-at-End-of-File-Support)
-- Terminate every statement with a semicolon
-- Private functionality (for re-using functionality that isn't part of the
-  jQuery API)
-  - *Static methods*: If the functionality does not require a reference to a
-    Cheerio instance, simply define a named function within the module it is
-    needed.
-  - *Instance methods*: If the functionality requires a reference to a Cheerio
-    instance, informally define the method as "private" using the following
-    conventions:
-    - Define the method as a function on the Cheerio prototype
-    - Prefix the method name with an underscore (`_`) character
-    - Include `@api private` in the code comment the documents the method
+Please make sure commit hooks are run, which will enforce the code style.
+
+When implementing private functionality that isn't part of the jQuery API, please opt for:
+
+* _Static methods_: If the functionality does not require a reference to a
+  Cheerio instance, simply define a named function within the module it is
+  needed.
+* _Instance methods_: If the functionality requires a reference to a Cheerio
+  instance, informally define the method as "private" using the following
+  conventions:
+  * Define the method as a function on the Cheerio prototype
+  * Prefix the method name with an underscore (`_`) character
+  * Include `@api private` in the code comment the documents the method

Makefile

@@ -2,7 +2,7 @@ REPORTER = dot
 XYZ = node_modules/.bin/xyz --message 'Release X.Y.Z' --tag X.Y.Z --repo git@github.com:cheeriojs/cheerio.git --script scripts/prepublish
 
 lint:
-	@./node_modules/.bin/jshint lib/ test/
+	@./node_modules/.bin/eslint .
 
 test: lint
 	@./node_modules/.bin/mocha --recursive --reporter $(REPORTER)

benchmark/.eslintrc.json

@@ -0,0 +1,5 @@
+{
+  "rules": {
+    "no-console": 0
+  }
+}

benchmark/benchmark.js

@@ -16,10 +16,14 @@ if (process.argv.indexOf('--cheerio-only') >= 0) {
 }
 
 suites.add('Select all', 'jquery.html', {
-  test: function($) { $('*').length; }
+  test: function($) {
+    $('*').length;
+  }
 });
 suites.add('Select some', 'jquery.html', {
-  test: function($) { $('li').length; }
+  test: function($) {
+    $('li').length;
+  }
 });
 
 /*
@@ -75,7 +79,7 @@ suites.add('manipulation - replaceWith', 'jquery.html', {
   setup: function($) {
     $('body').append('<div id="foo">');
   },
-  test: function($, $lis) {
+  test: function($) {
     $('#foo').replaceWith('<div id="foo">');
   }
 });
@@ -107,12 +111,14 @@ suites.add('manipulation - html render', 'jquery.html', {
 });
 suites.add('manipulation - html independent', 'jquery.html', {
   setup: function() {
-    return '<div class="foo"><div id="bar">bat<hr>baz</div> </div>'
-        + '<div class="foo"><div id="bar">bat<hr>baz</div> </div>'
-        + '<div class="foo"><div id="bar">bat<hr>baz</div> </div>'
-        + '<div class="foo"><div id="bar">bat<hr>baz</div> </div>'
-        + '<div class="foo"><div id="bar">bat<hr>baz</div> </div>'
-        + '<div class="foo"><div id="bar">bat<hr>baz</div> </div>';
+    return (
+      '<div class="foo"><div id="bar">bat<hr>baz</div> </div>' +
+      '<div class="foo"><div id="bar">bat<hr>baz</div> </div>' +
+      '<div class="foo"><div id="bar">bat<hr>baz</div> </div>' +
+      '<div class="foo"><div id="bar">bat<hr>baz</div> </div>' +
+      '<div class="foo"><div id="bar">bat<hr>baz</div> </div>' +
+      '<div class="foo"><div id="bar">bat<hr>baz</div> </div>'
+    );
   },
   test: function($, content) {
     $(content).html();
@@ -128,7 +134,6 @@ suites.add('manipulation - text', 'jquery.html', {
   }
 });
 
-
 /*
  * Traversing Tests
  */
@@ -261,7 +266,6 @@ suites.add('traversing - Eq', 'jquery.html', {
   }
 });
 
-
 /*
  * Attributes Tests
  */

benchmark/suite.js

@@ -6,11 +6,14 @@ var jsdom = require('jsdom');
 var cheerio = require('..');
 
 var documentDir = path.join(__dirname, 'documents');
-var jQuerySrc = path.join(__dirname, '../node_modules/jquery/dist/jquery.slim.js');
+var jQuerySrc = path.join(
+  __dirname,
+  '../node_modules/jquery/dist/jquery.slim.js'
+);
 var filterRe = /./;
 var cheerioOnly = false;
 
-var Suites = module.exports = function() {};
+var Suites = (module.exports = function() {});
 
 Suites.prototype.filter = function(str) {
   filterRe = new RegExp(str, 'i');
@@ -21,15 +24,14 @@ Suites.prototype.cheerioOnly = function() {
 };
 
 Suites.prototype.add = function(name, fileName, options) {
-  var markup, suite, testFn;
+  var markup, suite;
   if (!filterRe.test(name)) {
     return;
   }
   markup = fs.readFileSync(path.join(documentDir, fileName), 'utf8');
   suite = new Benchmark.Suite(name);
-  testFn = options.test;
 
-  suite.on('start', function(event) {
+  suite.on('start', function() {
     console.log('Test: ' + name + ' (file: ' + fileName + ')');
   });
   suite.on('cycle', function(event) {

lib/api/attributes.js

@@ -13,18 +13,18 @@ var $ = require('../static'),
       some: require('lodash/some')
     },
 
-  // Lookup table for coercing string data-* attributes to their corresponding
-  // JavaScript primitives
-  primitives = {
-    null: null,
-    true: true,
-    false: false
-  },
+    // Lookup table for coercing string data-* attributes to their corresponding
+    // JavaScript primitives
+    primitives = {
+      null: null,
+      true: true,
+      false: false
+    },
 
-  // Attributes that are booleans
-  rboolean = /^(?:autofocus|autoplay|async|checked|controls|defer|disabled|hidden|loop|multiple|open|readonly|required|scoped|selected)$/i,
-  // Matches strings that look like JSON objects or arrays
-  rbrace = /^(?:\{[\w\W]*\}|\[[\w\W]*\])$/;
+    // Attributes that are booleans
+    rboolean = /^(?:autofocus|autoplay|async|checked|controls|defer|disabled|hidden|loop|multiple|open|readonly|required|scoped|selected)$/i,
+    // Matches strings that look like JSON objects or arrays
+    rbrace = /^(?:\{[\w\W]*\}|\[[\w\W]*\])$/;
 
 
 var getAttr = function(elem, name) {
@@ -94,10 +94,10 @@ var getProp = function (el, name) {
   if (!el || !isTag(el)) return;
 
   return hasOwn.call(el, name)
-      ? el[name]
-      : rboolean.test(name)
-          ? getAttr(el, name) !== undefined
-          : getAttr(el, name);
+    ? el[name]
+    : rboolean.test(name)
+      ? getAttr(el, name) !== undefined
+      : getAttr(el, name);
 };
 
 var setProp = function (el, name, value) {
@@ -201,7 +201,7 @@ var readData = function(el, name) {
       } else if (rbrace.test(value)) {
         try {
           value = JSON.parse(value);
-        } catch(e){ }
+        } catch(e){ /* ignore */ }
       }
 
       el.data[jsName] = value;
@@ -252,19 +252,16 @@ exports.val = function(value) {
     case 'textarea':
       return this.text(value);
     case 'input':
-      switch (this.attr('type')) {
-        case 'radio':
-          if (querying) {
-            return this.attr('value');
-          } else {
-            this.attr('value', value);
-            return this;
-          }
-          break;
-        default:
-          return this.attr('value', value);
+      if (this.attr('type') === 'radio') {
+        if (querying) {
+          return this.attr('value');
+        }
+
+        this.attr('value', value);
+        return this;
       }
-      return;
+
+      return this.attr('value', value);
     case 'select':
       var option = this.find('option:selected'),
           returnValue;
@@ -452,11 +449,11 @@ exports.toggleClass = function(value, stateVal) {
   if (!value || typeof value !== 'string') return this;
 
   var classNames = value.split(rspace),
-    numClasses = classNames.length,
-    state = typeof stateVal === 'boolean' ? stateVal ? 1 : -1 : 0,
-    numElements = this.length,
-    elementClasses,
-    index;
+      numClasses = classNames.length,
+      state = typeof stateVal === 'boolean' ? stateVal ? 1 : -1 : 0,
+      numElements = this.length,
+      elementClasses,
+      index;
 
   for (var i = 0; i < numElements; i++) {
     // If selected element isn't a tag, move on