4.2.0 (#166)

* Bump version

* Add no-repeated-dependencies rule

Closes #155

* Add wildcard support for no-restricted-dependencies and no-restricted-devDependencies

Closes #154

* Add prefer-alphabetical-scripts rule

Closes #153

* 4.2.0 of docs

* Update dependency-audit.js

* Update to dependency

* Change to wild card for tests

Author: tclindner

docs/rules.md

@@ -87,6 +87,8 @@ Rules allow npm-package-json-lint to be fully customizable. npm-package-json-lin
 
 > Generates an error if dependencies fail to meet the rules requirements
 
+* [no-repeated-dependencies](rules/dependencies/no-repeated-dependencies.md)
+
 * dependencies
   * [no-absolute-version-dependencies](rules/dependencies/no-absolute-version-dependencies.md)
   * [no-caret-version-dependencies](rules/dependencies/no-caret-version-dependencies.md)
@@ -117,6 +119,12 @@ Rules allow npm-package-json-lint to be fully customizable. npm-package-json-lin
 * peerDependencies
   * [prefer-alphabetical-peerDependencies](rules/dependencies/prefer-alphabetical-peerDependencies.md)
 
+## Scripts rules
+
+> Generates an error if scripts fail to meet the rules requirements
+
+* [prefer-alphabetical-scripts](rules/scripts/prefer-alphabetical-scripts.md)
+
 ## Format rules
 
 > Generates an error if node's value fails to meet the format requirements

docs/rules/dependencies/no-repeated-dependencies.md

@@ -0,0 +1,49 @@
+---
+id: no-repeated-dependencies
+title: no-repeated-dependencies
+---
+
+Enabling this rule will result in an error being generated if a dependency exists in both `dependencies` and `devDependencies`.
+
+## Example .npmpackagejsonlintrc configuration
+
+```json
+{
+  "rules": {
+    "no-repeated-dependencies": "error"
+  }
+}
+```
+
+## Rule Details
+
+### *Incorrect* example(s)
+
+```json
+{
+  "dependencies": {
+    "grunt-npm-package-json-lint": "^0.3.0"
+  },
+  "devDependencies": {
+    "grunt-npm-package-json-lint": "^0.3.0"
+  }
+}
+```
+
+
+### *Correct* example(s)
+
+```json
+{
+  "dependencies": {
+    "gulp-npm-package-json-lint": "^0.3.0"
+  },
+  "devDependencies": {
+    "grunt-npm-package-json-lint": "^0.3.0"
+  }
+}
+```
+
+## History
+
+* Introduced in version 4.2.0

docs/rules/dependencies/no-restricted-dependencies.md

@@ -11,7 +11,8 @@ Enabling this rule will result in an error being generated if one of the depende
 {
   "rules": {
     "no-restricted-dependencies": ["error", [
-      "grunt-npm-package-json-lint"
+      "grunt-npm-package-json-lint",
+      "@types/*"
     ]]
   }
 }
@@ -29,6 +30,15 @@ Enabling this rule will result in an error being generated if one of the depende
 }
 ```
 
+```json
+{
+  "devDependencies": {
+    "@types/node": "^0.3.0"
+  }
+}
+```
+
+
 ### *Correct* example(s)
 
 ```json
@@ -51,5 +61,6 @@ Enabling this rule will result in an error being generated if one of the depende
 
 ## History
 
+* Allow for wildcard dependency restrictions. Add `*` to the end of the dependency string to indicate a wildcard search. This will result in a lint issue if the dependency starts with the string before the `*`. Added in 4.2.0.
 * Renamed from dependencies-invalid-dependencies to no-restricted-dependencies in version 1.0.0
 * Introduced in version 0.1.0

docs/rules/dependencies/no-restricted-devDependencies.md

@@ -11,7 +11,8 @@ Enabling this rule will result in an error being generated if one of the depende
 {
   "rules": {
     "no-restricted-devDependencies": ["error", [
-      "grunt-npm-package-json-lint"
+      "grunt-npm-package-json-lint",
+      "@types/*"
     ]]
   }
 }
@@ -29,6 +30,14 @@ Enabling this rule will result in an error being generated if one of the depende
 }
 ```
 
+```json
+{
+  "devDependencies": {
+    "@types/node": "^0.3.0"
+  }
+}
+```
+
 ### *Correct* example(s)
 
 ```json
@@ -51,5 +60,6 @@ Enabling this rule will result in an error being generated if one of the depende
 
 ## History
 
+* Allow for wildcard dependency restrictions. Add `*` to the end of the dependency string to indicate a wildcard search. This will result in a lint issue if the dependency starts with the string before the `*`. Added in 4.2.0.
 * Renamed from devDependencies-invalid-dependencies to no-restricted-devDependencies in version 1.0.0
 * Introduced in version 0.1.0

docs/rules/scripts/prefer-alphabetical-scripts.md

@@ -0,0 +1,46 @@
+---
+id: prefer-alphabetical-scripts
+title: prefer-alphabetical-scripts
+---
+
+Enabling this rule will result in an error being generated if the scripts in `scripts` are not in alphabetical order.
+
+## Example .npmpackagejsonlintrc configuration
+
+```json
+{
+  "rules": {
+    "prefer-alphabetical-scripts": "error"
+  }
+}
+```
+
+## Rule Details
+
+### *Incorrect* example(s)
+
+```json
+{
+  "scripts": {
+    "build": "build script",
+    "test": "jest",
+    "start": "node index.js"
+  }
+}
+```
+
+### *Correct* example(s)
+
+```json
+{
+  "scripts": {
+    "build": "build script",
+    "start": "node index.js",
+    "test": "jest"
+  }
+}
+```
+
+## History
+
+* Introduced in version 4.2.0

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "npm-package-json-lint",
-  "version": "4.1.1",
+  "version": "4.2.0",
   "description": "Configurable linter for package.json files.",
   "keywords": [
     "lint",

package.json

@@ -0,0 +1,40 @@
+const {exists} = require('../validators/property');
+const LintIssue = require('./../LintIssue');
+
+const lintId = 'no-repeated-dependencies';
+const ruleType = 'standard';
+
+const dependenciesNode = 'dependencies';
+const devDependenciesNode = 'devDependencies';
+
+const lint = (packageJsonData, severity) => {
+  if (!exists(packageJsonData, dependenciesNode)) {
+    return true;
+  }
+
+  if (!exists(packageJsonData, devDependenciesNode)) {
+    return true;
+  }
+
+  const dependencies = Object.keys(packageJsonData[dependenciesNode]);
+  const devDependencies = Object.keys(packageJsonData[devDependenciesNode]);
+
+  /* eslint-disable-next-line no-restricted-syntax */
+  for (const dependency of dependencies) {
+    if (devDependencies.includes(dependency)) {
+      return new LintIssue(
+        lintId,
+        severity,
+        `${dependenciesNode}|${devDependenciesNode}`,
+        `${dependency} exists in both ${dependenciesNode} and ${devDependenciesNode}. Please remove it from one of the dependency lists.`
+      );
+    }
+  }
+
+  return true;
+};
+
+module.exports = {
+  lint,
+  ruleType
+};

src/rules/no-repeated-dependencies.js

@@ -0,0 +1,32 @@
+const {isInAlphabeticalOrder} = require('./../validators/alphabetical-sort');
+const {exists} = require('../validators/property');
+const LintIssue = require('./../LintIssue');
+
+const lintId = 'prefer-alphabetical-scripts';
+const nodeName = 'scripts';
+const message = 'Your scripts are not in alphabetical order.';
+const ruleType = 'standard';
+
+const lint = (packageJsonData, severity) => {
+  if (!exists(packageJsonData, nodeName)) {
+    return true;
+  }
+
+  const result = isInAlphabeticalOrder(packageJsonData, nodeName);
+
+  if (!result.status) {
+    return new LintIssue(
+      lintId,
+      severity,
+      nodeName,
+      `${message} Please move ${result.data.invalidNode} after ${result.data.validNode}.`
+    );
+  }
+
+  return true;
+};
+
+module.exports = {
+  lint,
+  ruleType
+};

src/rules/prefer-alphabetical-scripts.js

@@ -7,19 +7,25 @@ const hasExceptions = config => {
 
 /**
  * Determines whether or not the package has a given dependency
- * @param  {object} packageJsonData         Valid JSON
- * @param  {string} nodeName                Name of a node in the package.json file
- * @param  {string} depsToCheckFor  An array of packages to check for
- * @return {boolean}                        True if the package has a dependency. False if it is not or the node is missing.
+ * @param  {object} packageJsonData  Valid JSON
+ * @param  {string} nodeName         Name of a node in the package.json file
+ * @param  {string} depsToCheckFor   An array of packages to check for
+ * @return {boolean}                 True if the package has a dependency. False if it is not or the node is missing.
  */
 const hasDependency = (packageJsonData, nodeName, depsToCheckFor) => {
   if (!packageJsonData.hasOwnProperty(nodeName)) {
     return false;
   }
 
   for (const dependencyName in packageJsonData[nodeName]) {
-    if (depsToCheckFor.includes(dependencyName)) {
-      return true;
+    for (const depToCheckFor of depsToCheckFor) {
+      if (depToCheckFor === dependencyName) {
+        return true;
+      }
+
+      if (depToCheckFor.endsWith('*') && dependencyName.startsWith(depToCheckFor.substring(0, depToCheckFor.length - 1))) {
+        return true;
+      }
     }
   }