Add ESLint (#187)

CvBlixen · jrf0110 · commit 1351b48b3dc0 · 2018-10-31T23:52:52.000-05:00
* Add minimal ESLint

* Add lint to Travis

* Enable no-unused-vars

* Enable no-console

* Make everything pass no-unused-vars rule

* Enable ESLint rule no-inner-declarations

* Enable no-undef

* Enable no-useless-escape
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -0,0 +1,14 @@
+module.exports = {
+  root: true,
+  env: {
+    node: true,
+    mocha: true,
+  },
+  parserOptions: {
+    ecmaVersion: 2018
+  },  
+  extends: 'eslint:recommended',
+  rules: {
+    "no-unused-vars": ["error", {args: "none"}],
+  }  
+};
diff --git a/.travis.yml b/.travis.yml
@@ -1,3 +1,6 @@
 language: node_js
 node_js:
   - "lts/*"
+script:
+  - npm run lint
+  - npm test
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,3 @@
+{
+  "editor.formatOnSave": false
+}
diff --git a/helpers/conditional.js b/helpers/conditional.js
@@ -25,8 +25,6 @@ function getValueInequalityOperator(value) {
  * @param value  {Mixed}   - What the column should be equal to
  */
 conditionals.add('$equals', function(column, value, values, collection, original){
-  var equator = '=';
-
   return column + ' ' + getValueEqualityOperator(value) + ' ' + value;
 });
 
diff --git a/helpers/query/action.js b/helpers/query/action.js
@@ -1,7 +1,6 @@
 
 var helpers = require('../../lib/query-helpers');
 var actionsHelpers = require('../../lib/action-helpers');
-var utils = require('../../lib/utils');
 
 helpers.register('action', function(actions, values, query){
 
diff --git a/helpers/query/alias.js b/helpers/query/alias.js
@@ -8,8 +8,6 @@
  */
 
 var helpers = require('../../lib/query-helpers');
-var actions = require('../../lib/action-helpers');
-var utils = require('../../lib/utils');
 
 helpers.register('alias', function(alias, values, query){
   query.__defaultTable = query.alias;
diff --git a/helpers/query/cascade.js b/helpers/query/cascade.js
@@ -1,6 +1,5 @@
 
 var helpers = require('../../lib/query-helpers');
-var utils   = require('../../lib/utils');
 
 helpers.register('cascade', function(cascade, values, query){
   return cascade ? 'cascade' : null;
diff --git a/helpers/query/column-constraint.js b/helpers/query/column-constraint.js
@@ -10,7 +10,6 @@
 // [ DEFERRABLE | NOT DEFERRABLE ] [ INITIALLY DEFERRED | INITIALLY IMMEDIATE ]
 
 var helpers     = require('../../lib/query-helpers');
-var conditional = require('../../lib/condition-builder');
 var columnDefs  = require('../../lib/column-def-helpers');
 var utils       = require('../../lib/utils');
 
diff --git a/helpers/query/conflict.js b/helpers/query/conflict.js
@@ -32,6 +32,7 @@ helpers.register( 'conflict', function( conflict, values, query ){
     // Or get more specific
     } else {
       if ( conflict.target.column ){
+        // eslint-disable-next-line no-console
         console.log('conflict.target.column is deprecated. Use an array of columns on conflict.target.columns instead');
         conflict.target.columns = [ conflict.target.column ];
       }
diff --git a/helpers/query/function.js b/helpers/query/function.js
@@ -1,6 +1,5 @@
 
 var helpers = require('../../lib/query-helpers');
-var utils   = require('../../lib/utils');
 
 helpers.register('function', function(fn, values, query){
   return fn;
diff --git a/helpers/query/group-by.js b/helpers/query/group-by.js
@@ -1,6 +1,5 @@
 
 var helpers = require('../../lib/query-helpers');
-var utils   = require('../../lib/utils');
 
 helpers.register('groupBy', function(groupBy, values, query){
   if (!Array.isArray(groupBy) && typeof groupBy != 'string')
diff --git a/helpers/query/if-exists.js b/helpers/query/if-exists.js
@@ -1,6 +1,5 @@
 
 var helpers = require('../../lib/query-helpers');
-var utils   = require('../../lib/utils');
 
 helpers.register('ifExists', function(ifExists, values, query){
   return ifExists ? 'if exists' : null;
diff --git a/helpers/query/if-not-exists.js b/helpers/query/if-not-exists.js
@@ -1,6 +1,5 @@
 
 var helpers = require('../../lib/query-helpers');
-var utils   = require('../../lib/utils');
 
 helpers.register('ifNotExists', function(ifNotExists, values, query){
   return ifNotExists ? 'if not exists' : null;
diff --git a/helpers/query/only.js b/helpers/query/only.js
@@ -1,6 +1,5 @@
 
 var helpers = require('../../lib/query-helpers');
-var utils = require('../../lib/utils');
 
 helpers.register('only', function(only, values, query){
   if (only) return "only";
diff --git a/helpers/query/over.js b/helpers/query/over.js
@@ -1,6 +1,5 @@
 
 var helpers = require('../../lib/query-helpers');
-var utils = require('../../lib/utils');
 
 helpers.register('over', function(over, values, query) {
   if (over === null) return '';
diff --git a/helpers/query/returning.js b/helpers/query/returning.js
@@ -1,6 +1,5 @@
 
 var helpers = require('../../lib/query-helpers');
-var utils = require('../../lib/utils');
 
 helpers.register('returning', function(returning, values, query){
   if ( !Array.isArray(returning) ) throw new Error('Invalid returning input in query properties');
diff --git a/helpers/query/updates.js b/helpers/query/updates.js
@@ -4,8 +4,6 @@ var utils = require('../../lib/utils');
 var queryBuilder = require('../../lib/query-builder');
 
 queryTypes.register('updates', function($updates, values, query){
-  var output = "set ";
-
   var result = Object.keys( $updates ).map( function( key ){
     if (updateHelpers.has(key)){
       return updateHelpers.get(key).fn($updates[key], values, query.__defaultTable);
diff --git a/helpers/query/values.js b/helpers/query/values.js
@@ -18,8 +18,7 @@ helpers.register('values', function(values, valuesArray, query){
   };
 
   for ( var i = 0, l = values.length; i < l; ++i ) {
-    function hasValue (key) { return values[i][key] !== undefined; }
-    Object.keys( values[i] ).filter( hasValue ).forEach( checkKeys );
+    Object.keys( values[i] ).filter( key => values[i][key] !== undefined ).forEach( checkKeys );
   }
 
   var allValues = values.map( function( value ) {
diff --git a/jsconfig.json b/jsconfig.json
@@ -0,0 +1,6 @@
+{
+  "compilerOptions": {
+    "target": "es2018"
+  },
+  "exclude": ["node_modules"]
+}
diff --git a/lib/normalize.js b/lib/normalize.js
@@ -2,8 +2,8 @@
 // When condition builder is checking sub-objects, one of the
 // steps is to make sure we're not traversing a buffer
 if ( typeof Buffer === 'undefined' ){
-  window.Buffer = function(){};
-  window.Buffer.isBuffer = function(){
+  window.Buffer = function(){}; // eslint-disable-line no-undef
+  window.Buffer.isBuffer = function(){ // eslint-disable-line no-undef
     return false;
   };
 }
diff --git a/lib/utils.js b/lib/utils.js
@@ -13,7 +13,6 @@ utils.parameterize = function(value, values){
 };
 
 utils.quoteColumn = utils.quoteObject = function(field, collection){
-  var period;
   var rest = Array.prototype.slice.call( arguments, 1 );
   var split;
 
@@ -76,11 +75,11 @@ utils.quoteColumn = utils.quoteObject = function(field, collection){
 
   // No periods specified in field, use explicit `table[, schema[, database] ]`
   else if (field.indexOf('.') === -1)
-    return '"' + ( rest.reverse() ).concat( field.replace( /\"/g, '' ) ).join('"."') + '"';
+    return '"' + ( rest.reverse() ).concat( field.replace( /"/g, '' ) ).join('"."') + '"';
 
   // Otherwise, a `.` was in there, just quote whatever was specified
   else
-    return '"' + field.replace( /\"/g, '' ).split('.').join('"."') + '"';
+    return '"' + field.replace( /"/g, '' ).split('.').join('"."') + '"';
 };
 
 utils.quoteValue = function(value){
diff --git a/package.json b/package.json
@@ -7,7 +7,8 @@
     "test": "test"
   },
   "scripts": {
-    "test": "./node_modules/.bin/mocha -R spec"
+    "test": "./node_modules/.bin/mocha -R spec",
+    "lint": "./node_modules/.bin/eslint . ./**/*.js"
   },
   "repository": {
     "type": "git",
@@ -23,6 +24,7 @@
   "author": "John Fawcett",
   "license": "BSD",
   "devDependencies": {
+    "eslint": "^5.8.0",
     "mocha": "~5.2.0"
   }
 }
diff --git a/test/conditions.js b/test/conditions.js
@@ -566,7 +566,7 @@ describe('Conditions', function(){
     , table: 'users'
     , where: {
         id: {
-	  'true': 'true',
+    'true': 'true',
           $nin: [1, 2, undefined, null, null, 3]
         }
       }
diff --git a/test/select.js b/test/select.js
@@ -962,7 +962,7 @@ describe('Built-In Query Types', function(){
 
     it ('should throw "for" helper requires type', function() {
       assert.throws(function() {
-        var query = builder.sql({
+        builder.sql({
           type: 'select'
         , table: 'foo'
         , for: { noWait: true }
diff --git a/yarn-error.log b/yarn-error.log
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+{`
	`2`	`+ "editor.formatOnSave": false`
	`3`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -32,6 +32,7 @@ helpers.register( 'conflict', function( conflict, values, query ){`
`32`	`32`	`// Or get more specific`
`33`	`33`	`} else {`
`34`	`34`	`if ( conflict.target.column ){`
	`35`	`+ // eslint-disable-next-line no-console`
`35`	`36`	`console.log('conflict.target.column is deprecated. Use an array of columns on conflict.target.columns instead');`
`36`	`37`	`conflict.target.columns = [ conflict.target.column ];`
`37`	`38`	`}`