Feature/improve alphabetical rule message (#37)

* Closes #33

Improved the message when prefer-alphabetical-dependencies,
prefer-alphabetical-devDependencies,
prefer-alphabetical-bundledDependencies,
prefer-alphabetical-optionalDependencies, or
prefer-alphabetical-peerDependencies are triggered. Now failing
dependency is communicated as well as the dependency it must be placed
after.

* Bump dips

Author: tclindner

CHANGELOG.md

@@ -11,6 +11,10 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Removed
 
+## [2.4.0] - 2017-05-23
+### Changed
+- Improved the message when prefer-alphabetical-dependencies, prefer-alphabetical-devDependencies, prefer-alphabetical-bundledDependencies, prefer-alphabetical-optionalDependencies, or prefer-alphabetical-peerDependencies are triggered. Now failing dependency is communicated as well as the dependency it must be placed after.
+
 ## [2.3.0] - 2017-04-22
 ### Added
 - New rule: [prefer-alphabetical-dependencies](https://github.com/tclindner/npm-package-json-lint/wiki/prefer-alphabetical-dependencies)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "npm-package-json-lint",
-  "version": "2.3.0",
+  "version": "2.4.0",
   "description": "CLI app for linting package.json files.",
   "keywords": [
     "lint",
@@ -51,9 +51,9 @@
     "grunt-jscs": "^3.0.1",
     "grunt-jsonlint": "^1.1.0",
     "grunt-mocha-test": "^0.13.2",
-    "mocha": "^3.2.0",
+    "mocha": "^3.4.1",
     "should": "^11.2.1",
-    "sinon": "^2.1.0",
+    "sinon": "^2.3.0",
     "time-grunt": "^1.4.0"
   },
   "engines": {

src/rules/prefer-alphabetical-bundledDependencies.js

@@ -4,12 +4,14 @@ const isInAlphabeticalOrder = require('./../validators/alphabetical-sort').isInA
 const LintIssue = require('./../LintIssue');
 const lintId = 'prefer-alphabetical-bundledDependencies';
 const nodeName = 'bundledDependencies';
-const message = 'Your bundledDependencies are not in alphabetical order. Please update the order.';
+const message = 'Your bundledDependencies are not in alphabetical order.';
 const ruleType = 'bundledDependencies-alphabetical-order';
 
 const lint = function(packageJsonData, lintType) {
-  if (!isInAlphabeticalOrder(packageJsonData, nodeName)) {
-    return new LintIssue(lintId, lintType, nodeName, message);
+  const result = isInAlphabeticalOrder(packageJsonData, nodeName);
+
+  if (!result.status) {
+    return new LintIssue(lintId, lintType, nodeName, `${message} Please move ${result.data.invalidNode} after ${result.data.validNode}.`);
   }
 
   return true;

src/rules/prefer-alphabetical-dependencies.js

@@ -4,12 +4,14 @@ const isInAlphabeticalOrder = require('./../validators/alphabetical-sort').isInA
 const LintIssue = require('./../LintIssue');
 const lintId = 'prefer-alphabetical-dependencies';
 const nodeName = 'dependencies';
-const message = 'Your dependencies are not in alphabetical order. Please update the order.';
+const message = 'Your dependencies are not in alphabetical order.';
 const ruleType = 'dependencies-alphabetical-order';
 
 const lint = function(packageJsonData, lintType) {
-  if (!isInAlphabeticalOrder(packageJsonData, nodeName)) {
-    return new LintIssue(lintId, lintType, nodeName, message);
+  const result = isInAlphabeticalOrder(packageJsonData, nodeName);
+
+  if (!result.status) {
+    return new LintIssue(lintId, lintType, nodeName, `${message} Please move ${result.data.invalidNode} after ${result.data.validNode}.`);
   }
 
   return true;

src/rules/prefer-alphabetical-devDependencies.js

@@ -4,12 +4,14 @@ const isInAlphabeticalOrder = require('./../validators/alphabetical-sort').isInA
 const LintIssue = require('./../LintIssue');
 const lintId = 'prefer-alphabetical-devDependencies';
 const nodeName = 'devDependencies';
-const message = 'Your devDependencies are not in alphabetical order. Please update the order.';
+const message = 'Your devDependencies are not in alphabetical order.';
 const ruleType = 'devDependencies-alphabetical-order';
 
 const lint = function(packageJsonData, lintType) {
-  if (!isInAlphabeticalOrder(packageJsonData, nodeName)) {
-    return new LintIssue(lintId, lintType, nodeName, message);
+  const result = isInAlphabeticalOrder(packageJsonData, nodeName);
+
+  if (!result.status) {
+    return new LintIssue(lintId, lintType, nodeName, `${message} Please move ${result.data.invalidNode} after ${result.data.validNode}.`);
   }
 
   return true;

src/rules/prefer-alphabetical-optionalDependencies.js

@@ -4,12 +4,14 @@ const isInAlphabeticalOrder = require('./../validators/alphabetical-sort').isInA
 const LintIssue = require('./../LintIssue');
 const lintId = 'prefer-alphabetical-optionalDependencies';
 const nodeName = 'optionalDependencies';
-const message = 'Your optionalDependencies are not in alphabetical order. Please update the order.';
+const message = 'Your optionalDependencies are not in alphabetical order.';
 const ruleType = 'optionalDependencies-alphabetical-order';
 
 const lint = function(packageJsonData, lintType) {
-  if (!isInAlphabeticalOrder(packageJsonData, nodeName)) {
-    return new LintIssue(lintId, lintType, nodeName, message);
+  const result = isInAlphabeticalOrder(packageJsonData, nodeName);
+
+  if (!result.status) {
+    return new LintIssue(lintId, lintType, nodeName, `${message} Please move ${result.data.invalidNode} after ${result.data.validNode}.`);
   }
 
   return true;

src/rules/prefer-alphabetical-peerDependencies.js

@@ -4,12 +4,14 @@ const isInAlphabeticalOrder = require('./../validators/alphabetical-sort').isInA
 const LintIssue = require('./../LintIssue');
 const lintId = 'prefer-alphabetical-peerDependencies';
 const nodeName = 'peerDependencies';
-const message = 'Your peerDependencies are not in alphabetical order. Please update the order.';
+const message = 'Your peerDependencies are not in alphabetical order.';
 const ruleType = 'peerDependencies-alphabetical-order';
 
 const lint = function(packageJsonData, lintType) {
-  if (!isInAlphabeticalOrder(packageJsonData, nodeName)) {
-    return new LintIssue(lintId, lintType, nodeName, message);
+  const result = isInAlphabeticalOrder(packageJsonData, nodeName);
+
+  if (!result.status) {
+    return new LintIssue(lintId, lintType, nodeName, `${message} Please move ${result.data.invalidNode} after ${result.data.validNode}.`);
   }
 
   return true;

src/validators/alphabetical-sort.js

@@ -1,33 +1,48 @@
 'use strict';
 
 // jscs:disable requireSpacesInForStatement, requireSpacesInForStatement
+const increment = 1;
 
 /**
  * Determines whether an array is in alphabetical order
  * @param  {object} packageJsonData Valid JSON
  * @param  {string} nodeName        Name of a node in the package.json file
- * @return {boolean}                True if the node is in alphabetical order or is missing. False if it is not.
+ * @return {object}                 Object containing the status and the dependencies that are out of order, if applicable
  */
 const isInAlphabeticalOrder = function(packageJsonData, nodeName) {
   if (!packageJsonData.hasOwnProperty(nodeName)) {
-    return true;
+    return {
+      status: true,
+      data: {
+        invalidNode: null,
+        validNode: null
+      }
+    };
   }
 
   let isValid = true;
-  const increment = 1;
+  let data = {
+    invalidNode: null,
+    validNode: null
+  };
   const nodeKeysOriginal = Object.keys(packageJsonData[nodeName]);
-  let nodeKeysSorted = Object.keys(packageJsonData[nodeName]);
-
-  nodeKeysSorted = nodeKeysSorted.sort();
+  const nodeKeysSorted = Object.keys(packageJsonData[nodeName]).sort();
 
   for (let keyIndex = 0;keyIndex <= nodeKeysOriginal.length;keyIndex += increment) {
     if (nodeKeysOriginal[keyIndex] !== nodeKeysSorted[keyIndex]) {
       isValid = false;
+      data = {
+        invalidNode: nodeKeysOriginal[keyIndex],
+        validNode: nodeKeysSorted[keyIndex]
+      };
       break;
     }
   }
 
-  return isValid;
+  return {
+    status: isValid,
+    data
+  };
 };
 
 module.exports.isInAlphabeticalOrder = isInAlphabeticalOrder;

tests/unit/rules/prefer-alphabetical-bundledDependencies.js

@@ -22,7 +22,7 @@ describe('prefer-alphabetical-bundledDependencies Unit Tests', function() {
       response.lintId.should.equal('prefer-alphabetical-bundledDependencies');
       response.lintType.should.equal('error');
       response.node.should.equal('bundledDependencies');
-      response.lintMessage.should.equal('Your bundledDependencies are not in alphabetical order. Please update the order.');
+      response.lintMessage.should.equal('Your bundledDependencies are not in alphabetical order. Please move semver after chalk.');
     });
   });
 

tests/unit/rules/prefer-alphabetical-dependencies.js

@@ -22,7 +22,7 @@ describe('prefer-alphabetical-dependencies Unit Tests', function() {
       response.lintId.should.equal('prefer-alphabetical-dependencies');
       response.lintType.should.equal('error');
       response.node.should.equal('dependencies');
-      response.lintMessage.should.equal('Your dependencies are not in alphabetical order. Please update the order.');
+      response.lintMessage.should.equal('Your dependencies are not in alphabetical order. Please move semver after chalk.');
     });
   });