chore: update jshint and move it to an npm script (shelljs#454)

nfischer · ariporad · commit 2e87f14c0773 · 2016-06-07T16:57:42.000-07:00
diff --git a/.jshintignore b/.jshintignore
@@ -0,0 +1,2 @@
+test/resources/
+node_modules/
diff --git a/.jshintrc b/.jshintrc
@@ -3,5 +3,10 @@
   "sub": true,
   "undef": true,
   "unused": true,
+  "futurehostile": true,
+  "latedef": "nofunc",
+  "nocomma": true,
+  "nonbsp": true,
+  "notypeof": true,
   "node": true
-}
+}
diff --git a/.npmignore b/.npmignore
@@ -4,6 +4,7 @@ tmp/
 .documentup.json
 .gitignore
 .jshintrc
+.jshintignore
 .lgtm
 .travis.yml
 .gitattributes
diff --git a/package.json b/package.json
@@ -24,8 +24,10 @@
   "homepage": "http://github.com/shelljs/shelljs",
   "main": "./shell.js",
   "scripts": {
+    "posttest": "npm run lint",
     "test": "node scripts/run-tests",
     "gendocs": "node scripts/generate-docs",
+    "lint": "jshint .",
     "changelog": "bash scripts/changelog.sh"
   },
   "bin": {
@@ -38,7 +40,7 @@
   },
   "devDependencies": {
     "coffee-script": "^1.10.0",
-    "jshint": "~2.1.11"
+    "jshint": "^2.9.2"
   },
   "optionalDependencies": {},
   "engines": {
diff --git a/scripts/run-tests.js b/scripts/run-tests.js
@@ -1,35 +1,9 @@
 #!/usr/bin/env node
-/* globals cd, echo, exec, exit, ls, pwd, test */
+/* globals cd, echo, exec, exit, ls */
 require('../global');
-var common = require('../src/common');
 
 var failed = false;
 
-//
-// Lint
-//
-var JSHINT_BIN = 'node_modules/jshint/bin/jshint';
-cd(__dirname + '/..');
-
-if (!test('-f', JSHINT_BIN)) {
-  echo('JSHint not found. Run `npm install` in the root dir first.');
-  exit(1);
-}
-
-var jsfiles = common.expand([pwd() + '/*.js',
-                             pwd() + '/scripts/*.js',
-                             pwd() + '/src/*.js',
-                             pwd() + '/test/*.js'
-                            ]).join(' ');
-// Perform linting on all javascript files
-if (exec(JSON.stringify(process.execPath)+' '+pwd()+'/'+JSHINT_BIN+' '+jsfiles).code !== 0) {
-  failed = true;
-  echo('*** JSHINT FAILED! (return code != 0)');
-} else {
-  echo('All JSHint tests passed');
-}
-echo();
-
 //
 // Unit tests
 //
diff --git a/src/common.js b/src/common.js
@@ -87,7 +87,7 @@ exports.error = error;
 //@
 //@ Turns a regular string into a string-like object similar to what each
 //@ command returns. This has special methods, like `.to()` and `.toEnd()`
-var ShellString = function (stdout, stderr, code) {
+function ShellString(stdout, stderr, code) {
   var that;
   if (stdout instanceof Array) {
     that = stdout;
@@ -106,7 +106,7 @@ var ShellString = function (stdout, stderr, code) {
     that[cmd] = function() {return shell[cmd].apply(that.stdout, arguments);};
   });
   return that;
-};
+}
 
 exports.ShellString = ShellString;
 
diff --git a/test/common.js b/test/common.js
@@ -26,33 +26,35 @@ assert.throws(function () {
 // Valids
 //
 
+var result;
+
 // single file, array syntax
-var result = common.expand(['resources/file1.txt']);
+result = common.expand(['resources/file1.txt']);
 assert.equal(shell.error(), null);
 assert.deepEqual(result, ['resources/file1.txt']);
 
 // multiple file, glob syntax, * for file name
-var result = common.expand(['resources/file*.txt']);
+result = common.expand(['resources/file*.txt']);
 assert.equal(shell.error(), null);
 assert.deepEqual(result.sort(), ['resources/file1.txt', 'resources/file2.txt'].sort());
 
 // multiple file, glob syntax, * for directory name
-var result = common.expand(['*/file*.txt']);
+result = common.expand(['*/file*.txt']);
 assert.equal(shell.error(), null);
 assert.deepEqual(result.sort(), ['resources/file1.txt', 'resources/file2.txt'].sort());
 
 // multiple file, glob syntax, ** for directory name
-var result = common.expand(['**/file*.js']);
+result = common.expand(['**/file*.js']);
 assert.equal(shell.error(), null);
 assert.deepEqual(result.sort(), ["resources/file1.js","resources/file2.js","resources/ls/file1.js","resources/ls/file2.js"].sort());
 
 // broken links still expand
-var result = common.expand(['resources/b*dlink']);
+result = common.expand(['resources/b*dlink']);
 assert.equal(shell.error(), null);
 assert.deepEqual(result, ['resources/badlink']);
 
 // common.parseOptions (normal case)
-var result = common.parseOptions('-Rf', {
+result = common.parseOptions('-Rf', {
   'R': 'recursive',
   'f': 'force',
   'r': 'reverse'
@@ -62,7 +64,7 @@ assert.ok(result.force === true);
 assert.ok(result.reverse === false);
 
 // common.parseOptions (with mutually-negating options)
-var result = common.parseOptions('-f', {
+result = common.parseOptions('-f', {
   'n': 'no_force',
   'f': '!no_force',
   'R': 'recursive'
@@ -72,7 +74,7 @@ assert.ok(result.no_force === false);
 assert.ok(result.force === undefined); // this key shouldn't exist
 
 // common.parseOptions (the last of the conflicting options should hold)
-var result = common.parseOptions('-fn', {
+result = common.parseOptions('-fn', {
   'n': 'no_force',
   'f': '!no_force',
   'R': 'recursive'
@@ -82,7 +84,7 @@ assert.ok(result.no_force === true);
 assert.ok(result.force === undefined); // this key shouldn't exist
 
 // common.parseOptions using an object to hold options
-var result = common.parseOptions({'-v': 'some text here'}, {
+result = common.parseOptions({'-v': 'some text here'}, {
   'v': 'value',
   'f': 'force',
   'r': 'reverse'
diff --git a/test/grep.js b/test/grep.js
@@ -12,7 +12,9 @@ shell.mkdir('tmp');
 // Invalids
 //
 
-var result = shell.grep();
+var result;
+
+result = shell.grep();
 assert.ok(shell.error());
 assert.equal(result.code, 2);
 
@@ -39,60 +41,60 @@ assert.equal(result.code, 2);
 // Valids
 //
 
-var result = shell.grep('line', 'resources/a.txt');
+result = shell.grep('line', 'resources/a.txt');
 assert.equal(shell.error(), null);
 assert.equal(result.split('\n').length - 1, 4);
 
-var result = shell.grep('-v', 'line', 'resources/a.txt');
+result = shell.grep('-v', 'line', 'resources/a.txt');
 assert.equal(shell.error(), null);
 assert.equal(result.split('\n').length - 1, 8);
 
-var result = shell.grep('line one', 'resources/a.txt');
+result = shell.grep('line one', 'resources/a.txt');
 assert.equal(shell.error(), null);
 assert.equal(result, 'This is line one\n');
 
 // multiple files
-var result = shell.grep(/test/, 'resources/file1.txt', 'resources/file2.txt');
+result = shell.grep(/test/, 'resources/file1.txt', 'resources/file2.txt');
 assert.equal(shell.error(), null);
 assert.equal(result, 'test1\ntest2\n');
 
 // multiple files, array syntax
-var result = shell.grep(/test/, ['resources/file1.txt', 'resources/file2.txt']);
+result = shell.grep(/test/, ['resources/file1.txt', 'resources/file2.txt']);
 assert.equal(shell.error(), null);
 assert.equal(result, 'test1\ntest2\n');
 
 // multiple files, glob syntax, * for file name
-var result = shell.grep(/test/, 'resources/file*.txt');
+result = shell.grep(/test/, 'resources/file*.txt');
 assert.equal(shell.error(), null);
 assert.ok(result == 'test1\ntest2\n' || result == 'test2\ntest1\n');
 
 // multiple files, glob syntax, * for directory name
-var result = shell.grep(/test/, '*/file*.txt');
+result = shell.grep(/test/, '*/file*.txt');
 assert.equal(shell.error(), null);
 assert.ok(result == 'test1\ntest2\n' || result == 'test2\ntest1\n');
 
 // multiple files, glob syntax, ** for directory name
-var result = shell.grep(/test/, '**/file*.js');
+result = shell.grep(/test/, '**/file*.js');
 assert.equal(shell.error(), null);
 assert.equal(result, 'test\ntest\ntest\ntest\n');
 
 // one file, * in regex
-var result = shell.grep(/alpha*beta/, 'resources/grep/file');
+result = shell.grep(/alpha*beta/, 'resources/grep/file');
 assert.equal(shell.error(), null);
 assert.equal(result, 'alphaaaaaaabeta\nalphbeta\n');
 
 // one file, * in string-regex
-var result = shell.grep('alpha*beta', 'resources/grep/file');
+result = shell.grep('alpha*beta', 'resources/grep/file');
 assert.equal(shell.error(), null);
 assert.equal(result, 'alphaaaaaaabeta\nalphbeta\n');
 
 // one file, * in regex, make sure * is not globbed
-var result = shell.grep(/l*\.js/, 'resources/grep/file');
+result = shell.grep(/l*\.js/, 'resources/grep/file');
 assert.equal(shell.error(), null);
 assert.equal(result, 'this line ends in.js\nlllllllllllllllll.js\n');
 
 // one file, * in string-regex, make sure * is not globbed
-var result = shell.grep('l*\\.js', 'resources/grep/file');
+result = shell.grep('l*\\.js', 'resources/grep/file');
 assert.equal(shell.error(), null);
 assert.equal(result, 'this line ends in.js\nlllllllllllllllll.js\n');
 
diff --git a/test/pwd.js b/test/pwd.js
@@ -19,7 +19,7 @@ assert.ok(!_pwd.stderr);
 assert.equal(_pwd, path.resolve('.'));
 
 shell.cd('tmp');
-var _pwd = shell.pwd();
+_pwd = shell.pwd();
 assert.equal(_pwd.code, 0);
 assert.ok(!_pwd.stderr);
 assert.equal(shell.error(), null);
diff --git a/test/rm.js b/test/rm.js
@@ -13,7 +13,10 @@ shell.mkdir('tmp');
 // Invalids
 //
 
-var result = shell.rm();
+var contents;
+var result;
+
+result = shell.rm();
 assert.ok(shell.error());
 assert.equal(result.code, 1);
 assert.equal(result.stderr, 'rm: no paths given');
@@ -123,7 +126,7 @@ assert.equal(fs.existsSync('tmp/.hidden'), true);
 result = shell.rm('-rf', 'tmp/*');
 assert.equal(shell.error(), null);
 assert.equal(result.code, 0);
-var contents = fs.readdirSync('tmp');
+contents = fs.readdirSync('tmp');
 assert.equal(contents.length, 1);
 assert.equal(contents[0], '.hidden'); // shouldn't remove hiddden if no .* given
 
@@ -139,7 +142,7 @@ assert.equal(fs.existsSync('tmp/.hidden'), true);
 result = shell.rm('-rf', 'tmp/*', 'tmp/.*');
 assert.equal(shell.error(), null);
 assert.equal(result.code, 0);
-var contents = fs.readdirSync('tmp');
+contents = fs.readdirSync('tmp');
 assert.equal(contents.length, 0);
 
 // recursive dir removal - array-syntax
@@ -154,7 +157,7 @@ assert.equal(fs.existsSync('tmp/.hidden'), true);
 result = shell.rm('-rf', ['tmp/*', 'tmp/.*']);
 assert.equal(shell.error(), null);
 assert.equal(result.code, 0);
-var contents = fs.readdirSync('tmp');
+contents = fs.readdirSync('tmp');
 assert.equal(contents.length, 0);
 
 // removal of a read-only file (unforced)
diff --git a/test/sed.js b/test/sed.js
diff --git a/test/set.js b/test/set.js
diff --git a/test/to.js b/test/to.js
diff --git a/test/toEnd.js b/test/toEnd.js
diff --git a/test/touch.js b/test/touch.js
