style: Add linting using eslint (#406)

LinusU · web-flow · commit 852d6f6e3f35 · 2016-12-28T23:34:37.000+01:00
* Fix error message concatenation

* Add linting using eslint

* Only run linting on Node.js 4.x and up
diff --git a/.eslintrc b/.eslintrc
@@ -0,0 +1,25 @@
+{
+  "extends": "standard",
+  "rules": {
+    "block-spacing": 0,
+    "brace-style": 0,
+    "comma-dangle": 0,
+    "indent": 0,
+    "key-spacing": 0,
+    "keyword-spacing": 0,
+    "no-duplicate-imports": 0,
+    "no-multiple-empty-lines": 0,
+    "no-path-concat": 0,
+    "no-throw-literal": 0,
+    "no-trailing-spaces": 0,
+    "no-unused-vars": 0,
+    "operator-linebreak": 0,
+    "padded-blocks": 0,
+    "quotes": 0,
+    "semi-spacing": 0,
+    "semi": 0,
+    "space-before-blocks": 0,
+    "space-before-function-paren": 0,
+    "space-infix-ops": 0
+  }
+}
diff --git a/.travis.yml b/.travis.yml
@@ -22,6 +22,8 @@ before_script:
 - npm prune
 - git version
 script:
+# Only run linting on Node.js 4.x and up
+- if [ $(node -pe 'process.version.match(/v(\d+)\./)[1] >= 4') == 'true' ]; then npm run lint; fi
 - npm run test
 - npm run check-coverage
 after_success:
diff --git a/package.json b/package.json
@@ -13,6 +13,7 @@
     "write-coverage": "nyc report --reporter=lcov",
     "semantic-release": "semantic-release pre && npm publish && semantic-release post",
     "start": "npm run test:watch",
+    "lint": "eslint --ignore-path .gitignore .",
     "test": "nyc --require babel-core/register _mocha -- test/tests/index.js",
     "test:watch": "nodemon -q --ignore test/.tmp/ --ignore test/artifacts/ --ignore coverage/ --exec \"npm run test\" --",
     "test:windows": "node ./test/tools/trigger-appveyor-tests.js"
@@ -22,7 +23,7 @@
       "path": "./node_modules/cz-conventional-changelog"
     },
     "ghooks": {
-      "pre-commit": "npm run test && npm run check-coverage"
+      "pre-commit": "npm run lint && npm run test && npm run check-coverage"
     }
   },
   "homepage": "https://github.com/commitizen/cz-cli",
@@ -54,6 +55,10 @@
     "babel-preset-stage-2": "6.17.0",
     "chai": "3.5.0",
     "codecov.io": "0.1.6",
+    "eslint": "3.12.2",
+    "eslint-config-standard": "6.2.1",
+    "eslint-plugin-promise": "3.4.0",
+    "eslint-plugin-standard": "2.0.1",
     "ghooks": "1.3.0",
     "in-publish": "^2.0.0",
     "mocha": "3.1.2",
diff --git a/src/cli/git-cz.js b/src/cli/git-cz.js
@@ -25,4 +25,4 @@ function bootstrap(environment = {}) {
     // This tells commitizen that it is not needed, just use git
     useGitStrategy(rawGitArgs, environment);
   }
-}
+}
diff --git a/src/cli/parsers.js b/src/cli/parsers.js
@@ -4,4 +4,4 @@ import * as gitCz from './parsers/git-cz';
 export {
   commitizen,
   gitCz
-};
+};
diff --git a/src/cli/parsers/commitizen.js b/src/cli/parsers/commitizen.js
@@ -18,4 +18,4 @@ function parse(rawGitArgs) {
    });
    
    return args;
-}
+}
diff --git a/src/cli/parsers/git-cz.js b/src/cli/parsers/git-cz.js
@@ -25,7 +25,7 @@ function parse(rawGitArgs) {
   for (let arg in args) {
 
     if (!args.hasOwnProperty(arg)) {
-      //The current property is not a direct property
+      // The current property is not a direct property
       continue;
     }
 
@@ -67,4 +67,4 @@ function parse(rawGitArgs) {
   } else {
     return output;
   }
-}
+}
diff --git a/src/cli/strategies.js b/src/cli/strategies.js
@@ -4,4 +4,4 @@ import gitCz from './strategies/git-cz';
 export {
   git,
   gitCz
-};
+};
diff --git a/src/cli/strategies/git.js b/src/cli/strategies/git.js
@@ -1,4 +1,4 @@
-import child_process from 'child_process';
+import childProcess from 'child_process';
 
 export default git;
 
@@ -10,7 +10,7 @@ function git(rawGitArgs, environment) {
   } else {
     var vanillaGitArgs = ["commit"].concat(rawGitArgs);
 
-    var child = child_process.spawn('git', vanillaGitArgs, {
+    var child = childProcess.spawn('git', vanillaGitArgs, {
       stdio: 'inherit'
     });
 
diff --git a/src/commitizen.js b/src/commitizen.js
@@ -12,4 +12,4 @@ export {
   configLoader,
   init,
   staging
-};
+};
diff --git a/src/commitizen/adapter.js b/src/commitizen/adapter.js
@@ -46,7 +46,7 @@ function addPathToAdapterConfig(sh, cliPath, repoPath, adapterNpmName) {
   let indent = detectIndent(packageJsonString).indent || '  ';
   let packageJsonContent = JSON.parse(packageJsonString);
   let newPackageJsonContent = '';
-  if(_.get(packageJsonContent,'config.commitizen.path') !== adapterNpmName) {
+  if(_.get(packageJsonContent, 'config.commitizen.path') !== adapterNpmName) {
     newPackageJsonContent = _.merge(packageJsonContent, commitizenAdapterConfig);
   }
   fs.writeFileSync(packageJsonPath, JSON.stringify(newPackageJsonContent, null, indent) + '\n');
@@ -139,7 +139,7 @@ function resolveAdapterPath(inboundAdapterPath) {
     // try to resolve the given path
     return require.resolve(absoluteAdapterPath);
   } catch (error) {
-    error.message = "Could not resolve " + absoluteAdapterPath, ". " + error.message;
+    error.message = "Could not resolve " + absoluteAdapterPath + ". " + error.message;
     throw error;
   }
 }
diff --git a/src/commitizen/cache.js b/src/commitizen/cache.js
@@ -41,4 +41,4 @@ function getCacheValueSync(cachePath, repoPath) {
   } catch(e) {
     return;
   }
-}
+}
diff --git a/src/commitizen/configLoader.js b/src/commitizen/configLoader.js
@@ -7,4 +7,4 @@ var configs = ['package.json', '.czrc', '.cz.json'];
 
 function load(config, cwd) {
   return loader(configs, config, cwd);
-}
+}
diff --git a/src/commitizen/init.js b/src/commitizen/init.js
@@ -128,4 +128,4 @@ function loadAdapterConfig() {
   } else {
     return;
   }
-}
+}
diff --git a/src/common/util.js b/src/common/util.js
@@ -78,7 +78,7 @@ function isString(str) {
   } else if (str === null) {
     return false;
   } else {
-    return Object.prototype.toString.call(str) == '[object String]';
+    return Object.prototype.toString.call(str) === '[object String]';
   }
 }
 
diff --git a/src/configLoader.js b/src/configLoader.js
@@ -8,4 +8,4 @@ export {
   getContent,
   getNormalizedConfig,
   loader
-};
+};
diff --git a/src/configLoader/findup.js b/src/configLoader/findup.js
@@ -31,4 +31,4 @@ function findup(patterns, options, fn) {
         lastpath = options.cwd;
         options.cwd = path.resolve(options.cwd, '..');
     } while (options.cwd !== lastpath);
-}
+}
diff --git a/src/configLoader/getNormalizedConfig.js b/src/configLoader/getNormalizedConfig.js
@@ -4,14 +4,14 @@ export default getNormalizedConfig;
 // settings that we're interested in
 function getNormalizedConfig(config, content) {
   
-  if(content && (config == 'package.json')) {
+  if(content && (config === 'package.json')) {
 
   // PACKAGE.JSON
 
     // Use the npm config key, be good citizens
     if(content.config && content.config.commitizen) {
       return content.config.commitizen;
-    } else if(content.czConfig)  { // Old method, will be deprecated in 3.0.0
+    } else if(content.czConfig) { // Old method, will be deprecated in 3.0.0
     
       // Suppress during test
       if(typeof global.it !== 'function')
@@ -25,4 +25,4 @@ function getNormalizedConfig(config, content) {
     return content;
   }
     
-}
+}
diff --git a/src/git.js b/src/git.js
@@ -8,4 +8,4 @@ export {
   commit,
   init,
   log
-};
+};
diff --git a/src/git/add.js b/src/git/add.js
@@ -6,4 +6,4 @@ export { addPath };
 function addPath(sh, repoPath) {
   sh.cd(repoPath);
   sh.exec('git add .');
-}
+}
diff --git a/src/git/log.js b/src/git/log.js
@@ -12,7 +12,6 @@ function log(repoPath, done) {
   }, function(error, stdout, stderr) {
     if (error) {
       throw error;
-      done();
     }
     done(stdout);
   });
diff --git a/src/index.js b/src/index.js
@@ -1,2 +1,2 @@
 var commitizen = require('./commitizen');
-module.exports = commitizen;
+module.exports = commitizen;
diff --git a/src/npm.js b/src/npm.js
@@ -1 +1 @@
-// this file left blank until npm init is implemented
+// this file left blank until npm init is implemented
diff --git a/test/tests/adapter.js b/test/tests/adapter.js
@@ -1,3 +1,5 @@
+/* eslint-env mocha */
+
 import {expect} from 'chai';
 import path from 'path';
 
diff --git a/test/tests/cli.js b/test/tests/cli.js
@@ -1,3 +1,5 @@
+/* eslint-env mocha */
+
 import {expect} from 'chai';
 import proxyquire from 'proxyquire';
 import * as sinon from 'sinon';
@@ -56,4 +58,4 @@ describe('git-cz', () => {
       });
     });
   });
-});
+});
diff --git a/test/tests/commit.js b/test/tests/commit.js
@@ -1,3 +1,5 @@
+/* eslint-env mocha */
+
 import {expect} from 'chai';
 import fs from 'fs';
 import os from 'os';
@@ -141,7 +143,7 @@ describe('commit', function() {
 
     some sizzurp`;
 
-    let dummyCommitMessage = (os.platform == 'win32') ? windowsCommitMessage : nixCommitMessage;
+    let dummyCommitMessage = (os.platform === 'win32') ? windowsCommitMessage : nixCommitMessage;
 
     // Describe a repo and some files to add and commit
     let repoConfig = {
diff --git a/test/tests/configLoader.js b/test/tests/configLoader.js
@@ -1,3 +1,5 @@
+/* eslint-env mocha */
+
 import path from 'path';
 import {expect} from 'chai';
 import {getContent, getNormalizedConfig} from '../../src/configLoader';
diff --git a/test/tests/index.js b/test/tests/index.js
@@ -4,4 +4,4 @@ import './commit';
 import './configLoader';
 import './init';
 import './staging';
-import './util';
+import './util';
diff --git a/test/tests/init.js b/test/tests/init.js
@@ -1,3 +1,5 @@
+/* eslint-env mocha */
+
 import {expect} from 'chai';
 import path from 'path';
 import fs from 'fs';
@@ -79,8 +81,8 @@ describe('init', function() {
 
     // Check resulting json
     let packageJson = util.getParsedPackageJsonFromPath(config.paths.endUserRepo);
-    expect(packageJson).not.to.have.deep.property('devDependencies','cz-jira-smart-commit');
-    expect(packageJson).to.have.deep.property('config.commitizen.path','./node_modules/cz-conventional-changelog');
+    expect(packageJson).not.to.have.deep.property('devDependencies', 'cz-jira-smart-commit');
+    expect(packageJson).to.have.deep.property('config.commitizen.path', './node_modules/cz-conventional-changelog');
     // TODO: Eventually may need to offer both path and package keys. package = npm package name
     // Path for local development
   });
diff --git a/test/tests/staging.js b/test/tests/staging.js
@@ -1,3 +1,5 @@
+/* eslint-env mocha */
+
 import {expect} from 'chai';
 import path from 'path';
 import fs from 'fs';
diff --git a/test/tests/util.js b/test/tests/util.js
@@ -1,3 +1,5 @@
+/* eslint-env mocha */
+
 import {expect} from 'chai';
 import {isArray, isFunction, isString} from '../../src/common/util';
 
@@ -8,7 +10,9 @@ describe('common util', function() {
     // Truthies
     expect(isArray([])).to.be.true;
     expect(isArray([1, 2, 3])).to.be.true;
+    // eslint-disable-next-line no-sparse-arrays
     expect(isArray([1, , 3])).to.be.true;
+    // eslint-disable-next-line no-array-constructor
     expect(isArray(new Array())).to.be.true;
     
     // Falsies
@@ -28,6 +32,7 @@ describe('common util', function() {
 
     // Truthies
     expect(isFunction(function(){})).to.be.true;
+    // eslint-disable-next-line no-new-func
     expect(isFunction(new Function())).to.be.true;
 
     // Falsies
@@ -53,6 +58,7 @@ describe('common util', function() {
       line
       string`
     )).to.be.true;
+    // eslint-disable-next-line no-new-wrappers
     expect(isString(new String())).to.be.true;
 
     // Falsies
@@ -67,4 +73,4 @@ describe('common util', function() {
     expect(isString(Symbol())).to.be.false;
     
   });  
-});
+});
diff --git a/test/tools/files.js b/test/tools/files.js
@@ -17,4 +17,4 @@ function writeFilesToPath(files, directoryPath) {
   _.forOwn(files, function(key, value) {
     fs.writeFileSync(path.resolve(directoryPath, files[value].filename), files[value].contents);
   }); 
-}
+}
diff --git a/test/tools/repo.js b/test/tools/repo.js
@@ -17,4 +17,4 @@ function createEmpty(sh, path) {
  */
 function createEndUser(sh, path) {
   createEmpty(sh, path);
-}
+}
diff --git a/test/tools/trigger-appveyor-tests.js b/test/tools/trigger-appveyor-tests.js
@@ -50,4 +50,4 @@ function ensureEnvironmentVariableIsSet(envName) {
     console.error('ERROR: The environment variable '+ envName + ' was not set and is required to run windows tests.');
     process.exit(1); 
   }
-}
+}

Original file line number	Diff line number	Diff line change
`@@ -25,4 +25,4 @@ function bootstrap(environment = {}) {`
`25`	`25`	`// This tells commitizen that it is not needed, just use git`
`26`	`26`	`useGitStrategy(rawGitArgs, environment);`
`27`	`27`	`}`
`28`		`-}`
	`28`	`+}`
-Original file line number
+Diff line change
    });
    return args;
 -}
 +}
Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ function parse(rawGitArgs) {`
`25`	`25`	`for (let arg in args) {`
`26`	`26`
`27`	`27`	`if (!args.hasOwnProperty(arg)) {`
`28`		`- //The current property is not a direct property`
	`28`	`+ // The current property is not a direct property`
`29`	`29`	`continue;`
`30`	`30`	`}`
`31`	`31`
`@@ -67,4 +67,4 @@ function parse(rawGitArgs) {`
`67`	`67`	`} else {`
`68`	`68`	`return output;`
`69`	`69`	`}`
`70`		`-}`
	`70`	`+}`