More docs (#138)

* Update node api docs * Update cli docs * Add v4 migration guide * Bump deps for module and website * Add v4 docs * Add exception docs * Add v4 docs * Delete why.md
tclindner · Oct 6, 2019 · 66a006e · 66a006e
1 parent 7bd437c
commit 66a006e
Show file tree

Hide file tree

Showing 33 changed files with 1,440 additions and 16 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,30 +3,32 @@ All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
+
+## [4.0.0] - 2019-10-06
 ### Added
 - Added exception support to the following rules:
 
-  - [`no-absolute-version-dependencies`](https://github.com/tclindner/npm-package-json-lint/wiki/no-absolute-version-dependencies)
-  - [`no-absolute-version-devDependencies`](https://github.com/tclindner/npm-package-json-lint/wiki/no-absolute-version-devDependencies)
-  - [`no-caret-version-dependencies`](https://github.com/tclindner/npm-package-json-lint/wiki/no-caret-version-dependencies)
-  - [`no-caret-version-devDependencies`](https://github.com/tclindner/npm-package-json-lint/wiki/no-caret-version-devDependencies)
-  - [`no-tilde-version-dependencies`](https://github.com/tclindner/npm-package-json-lint/wiki/no-tilde-version-dependencies)
-  - [`no-tilde-version-devDependencies`](https://github.com/tclindner/npm-package-json-lint/wiki/no-tilde-version-devDependencies)
-  - [`prefer-absolute-version-dependencies`](https://github.com/tclindner/npm-package-json-lint/wiki/prefer-absolute-version-dependencies)
-  - [`prefer-absolute-version-devDependencies`](https://github.com/tclindner/npm-package-json-lint/wiki/prefer-absolute-version-devDependencies)
-  - [`prefer-caret-version-dependencies`](https://github.com/tclindner/npm-package-json-lint/wiki/prefer-caret-version-dependencies)
-  - [`prefer-caret-version-devDependencies`](https://github.com/tclindner/npm-package-json-lint/wiki/prefer-caret-version-devDependencies)
-  - [`prefer-no-version-zero-dependencies`](https://github.com/tclindner/npm-package-json-lint/wiki/prefer-no-version-zero-dependencies)
-  - [`prefer-no-version-zero-devDependencies`](https://github.com/tclindner/npm-package-json-lint/wiki/prefer-no-version-zero-devDependencies)
-  - [`prefer-tilde-version-dependencies`](https://github.com/tclindner/npm-package-json-lint/wiki/prefer-tilde-version-dependencies)
-  - [`prefer-tilde-version-devDependencies`](https://github.com/tclindner/npm-package-json-lint/wiki/prefer-tilde-version-devDependencies)
+  - [`no-absolute-version-dependencies`](https://npmpackagejsonlint.org/docs/en/rules/dependencies/no-absolute-version-dependencies)
+  - [`no-absolute-version-devDependencies`](https://npmpackagejsonlint.org/docs/en/rules/dependencies/no-absolute-version-devDependencies)
+  - [`no-caret-version-dependencies`](https://npmpackagejsonlint.org/docs/en/rules/dependencies/no-caret-version-dependencies)
+  - [`no-caret-version-devDependencies`](https://npmpackagejsonlint.org/docs/en/rules/dependencies/no-caret-version-devDependencies)
+  - [`no-tilde-version-dependencies`](https://npmpackagejsonlint.org/docs/en/rules/dependencies/no-tilde-version-dependencies)
+  - [`no-tilde-version-devDependencies`](https://npmpackagejsonlint.org/docs/en/rules/dependencies/no-tilde-version-devDependencies)
+  - [`prefer-absolute-version-dependencies`](https://npmpackagejsonlint.org/docs/en/rules/dependencies/prefer-absolute-version-dependencies)
+  - [`prefer-absolute-version-devDependencies`](https://npmpackagejsonlint.org/docs/en/rules/dependencies/prefer-absolute-version-devDependencies)
+  - [`prefer-caret-version-dependencies`](https://npmpackagejsonlint.org/docs/en/rules/dependencies/prefer-caret-version-dependencies)
+  - [`prefer-caret-version-devDependencies`](https://npmpackagejsonlint.org/docs/en/rules/dependencies/prefer-caret-version-devDependencies)
+  - [`prefer-no-version-zero-dependencies`](https://npmpackagejsonlint.org/docs/en/rules/dependencies/prefer-no-version-zero-dependencies)
+  - [`prefer-no-version-zero-devDependencies`](https://npmpackagejsonlint.org/docs/en/rules/dependencies/prefer-no-version-zero-devDependencies)
+  - [`prefer-tilde-version-dependencies`](https://npmpackagejsonlint.org/docs/en/rules/dependencies/prefer-tilde-version-dependencies)
+  - [`prefer-tilde-version-devDependencies`](https://npmpackagejsonlint.org/docs/en/rules/dependencies/prefer-tilde-version-devDependencies)
 
   > Addresses [#93](https://github.com/tclindner/npm-package-json-lint/issues/93)
 
-- New rule: [prefer-no-devDependencies](https://github.com/tclindner/npm-package-json-lint/wiki/prefer-no-devDependencies)]
+- New rule: [prefer-no-devDependencies](https://npmpackagejsonlint.org/docs/en/rules/disallowed-nodes/prefer-no-devdependencies)]. Thank you, @simison
 
 ### Changed
-- [`name-format`](https://github.com/tclindner/npm-package-json-lint/wiki/name-format) now checks the following things:
+- [`name-format`](https://npmpackagejsonlint.org/docs/en/rules/format/name-format) now checks the following things:
 
   - Name is lowercase
   - Name is less than 214 characters. This includes scope.

diff --git a/docs/rules/dependencies/no-absolute-version-dependencies.md b/docs/rules/dependencies/no-absolute-version-dependencies.md
@@ -15,6 +15,18 @@ Enabling this rule will result in an error being generated if one of the depende
 }
 ```
 
+With exceptions
+
+```json
+{
+  "rules": {
+    "no-absolute-version-dependencies": ["error", {
+      "exceptions": ["myModule"]
+    }]
+  }
+}
+```
+
 ## Rule Details
 
 ### *Incorrect* example(s)

diff --git a/docs/rules/dependencies/no-absolute-version-devDependencies.md b/docs/rules/dependencies/no-absolute-version-devDependencies.md
@@ -15,6 +15,18 @@ Enabling this rule will result in an error being generated if one of the depende
 }
 ```
 
+With exceptions
+
+```json
+{
+  "rules": {
+    "no-absolute-version-devDependencies": ["error", {
+      "exceptions": ["myModule"]
+    }]
+  }
+}
+```
+
 ## Rule Details
 
 ### *Incorrect* example(s)

diff --git a/docs/rules/dependencies/no-caret-version-dependencies.md b/docs/rules/dependencies/no-caret-version-dependencies.md
@@ -15,6 +15,18 @@ Enabling this rule will result in an error being generated if one of the depende
 }
 ```
 
+With exceptions
+
+```json
+{
+  "rules": {
+    "no-caret-version-dependencies": ["error", {
+      "exceptions": ["myModule"]
+    }]
+  }
+}
+```
+
 ## Rule Details
 
 ### *Incorrect* example(s)

diff --git a/docs/rules/dependencies/no-caret-version-devDependencies.md b/docs/rules/dependencies/no-caret-version-devDependencies.md
@@ -15,6 +15,18 @@ Enabling this rule will result in an error being generated if one of the depende
 }
 ```
 
+With exceptions
+
+```json
+{
+  "rules": {
+    "no-caret-version-devDependencies": ["error", {
+      "exceptions": ["myModule"]
+    }]
+  }
+}
+```
+
 ## Rule Details
 
 ### *Incorrect* example(s)

diff --git a/docs/rules/dependencies/no-tilde-version-dependencies.md b/docs/rules/dependencies/no-tilde-version-dependencies.md
@@ -15,6 +15,18 @@ Enabling this rule will result in an error being generated if one of the depende
 }
 ```
 
+With exceptions
+
+```json
+{
+  "rules": {
+    "no-tilde-version-dependencies": ["error", {
+      "exceptions": ["myModule"]
+    }]
+  }
+}
+```
+
 ## Rule Details
 
 ### *Incorrect* example(s)

diff --git a/docs/rules/dependencies/no-tilde-version-devDependencies.md b/docs/rules/dependencies/no-tilde-version-devDependencies.md
@@ -15,6 +15,18 @@ Enabling this rule will result in an error being generated if one of the depende
 }
 ```
 
+With exceptions
+
+```json
+{
+  "rules": {
+    "no-tilde-version-devDependencies": ["error", {
+      "exceptions": ["myModule"]
+    }]
+  }
+}
+```
+
 ## Rule Details
 
 ### *Incorrect* example(s)

diff --git a/docs/rules/dependencies/prefer-absolute-version-dependencies.md b/docs/rules/dependencies/prefer-absolute-version-dependencies.md
@@ -15,6 +15,18 @@ Enabling this rule will result in an error being generated if one of the depende
 }
 ```
 
+With exceptions
+
+```json
+{
+  "rules": {
+    "prefer-absolute-version-dependencies": ["error", {
+      "exceptions": ["myModule"]
+    }]
+  }
+}
+```
+
 ## Rule Details
 
 ### *Incorrect* example(s)

diff --git a/docs/rules/dependencies/prefer-absolute-version-devDependencies.md b/docs/rules/dependencies/prefer-absolute-version-devDependencies.md
@@ -15,6 +15,18 @@ Enabling this rule will result in an error being generated if one of the depende
 }
 ```
 
+With exceptions
+
+```json
+{
+  "rules": {
+    "prefer-absolute-version-devDependencies": ["error", {
+      "exceptions": ["myModule"]
+    }]
+  }
+}
+```
+
 ## Rule Details
 
 ### *Incorrect* example(s)

diff --git a/docs/rules/dependencies/prefer-caret-version-dependencies.md b/docs/rules/dependencies/prefer-caret-version-dependencies.md
@@ -15,6 +15,18 @@ Enabling this rule will result in an error being generated if one of the depende
 }
 ```
 
+With exceptions
+
+```json
+{
+  "rules": {
+    "prefer-caret-version-dependencies": ["error", {
+      "exceptions": ["myModule"]
+    }]
+  }
+}
+```
+
 ## Rule Details
 
 ### *Incorrect* example(s)

diff --git a/docs/rules/dependencies/prefer-caret-version-devDependencies.md b/docs/rules/dependencies/prefer-caret-version-devDependencies.md
@@ -15,6 +15,18 @@ Enabling this rule will result in an error being generated if one of the depende
 }
 ```
 
+With exceptions
+
+```json
+{
+  "rules": {
+    "prefer-caret-version-devDependencies": ["error", {
+      "exceptions": ["myModule"]
+    }]
+  }
+}
+```
+
 ## Rule Details
 
 ### *Incorrect* example(s)

diff --git a/docs/rules/dependencies/prefer-no-version-zero-dependencies.md b/docs/rules/dependencies/prefer-no-version-zero-dependencies.md
@@ -0,0 +1,54 @@
+---
+id: prefer-no-version-zero-dependencies
+title: prefer-no-version-zero-dependencies
+---
+
+Enabling this rule will result in an error being generated if one of the dependencies in `dependencies` has a major version of 0.
+
+## Example .npmpackagejsonlintrc configuration
+
+```json
+{
+  "rules": {
+    "prefer-no-version-zero-dependencies": "error"
+  }
+}
+```
+
+With exceptions
+
+```json
+{
+  "rules": {
+    "prefer-no-version-zero-dependencies": ["error", {
+      "exceptions": ["myModule"]
+    }]
+  }
+}
+```
+
+## Rule Details
+
+### *Incorrect* example(s)
+
+```json
+{
+  "devDependencies": {
+    "grunt-npm-package-json-lint": "^0.3.0"
+  }
+}
+```
+
+### *Correct* example(s)
+
+```json
+{
+  "devDependencies": {
+    "gulp-npm-package-json-lint": "^1.0.0"
+  }
+}
+```
+
+## History
+
+* Introduced in version 0.4.0
diff --git a/docs/rules/dependencies/prefer-no-version-zero-devDependencies.md b/docs/rules/dependencies/prefer-no-version-zero-devDependencies.md
@@ -15,6 +15,18 @@ Enabling this rule will result in an error being generated if one of the depende
 }
 ```
 
+With exceptions
+
+```json
+{
+  "rules": {
+    "prefer-no-version-zero-devDependencies": ["error", {
+      "exceptions": ["myModule"]
+    }]
+  }
+}
+```
+
 ## Rule Details
 
 ### *Incorrect* example(s)

diff --git a/docs/rules/dependencies/prefer-tilde-version-dependencies.md b/docs/rules/dependencies/prefer-tilde-version-dependencies.md
@@ -15,6 +15,18 @@ Enabling this rule will result in an error being generated if one of the depende
 }
 ```
 
+With exceptions
+
+```json
+{
+  "rules": {
+    "prefer-tilde-version-dependencies": ["error", {
+      "exceptions": ["myModule"]
+    }]
+  }
+}
+```
+
 ## Rule Details
 
 ### *Incorrect* example(s)

diff --git a/docs/rules/dependencies/prefer-tilde-version-devDependencies.md b/docs/rules/dependencies/prefer-tilde-version-devDependencies.md
@@ -15,6 +15,18 @@ Enabling this rule will result in an error being generated if one of the depende
 }
 ```
 
+With exceptions
+
+```json
+{
+  "rules": {
+    "prefer-tilde-version-devDependencies": ["error", {
+      "exceptions": ["myModule"]
+    }]
+  }
+}
+```
+
 ## Rule Details
 
 ### *Incorrect* example(s)

diff --git a/docs/rules/disallowed-nodes/prefer-no-devDependencies.md b/docs/rules/disallowed-nodes/prefer-no-devDependencies.md
@@ -15,6 +15,19 @@ Enabling this rule will result in an error being generated if `devDependencies`
 }
 ```
 
+With exceptions
+
+```json
+{
+  "rules": {
+    "prefer-no-devDependencies": ["error", {
+      "exceptions": ["myModule"]
+    }]
+  }
+}
+```
+
+
 ## Rule Details
 
 ### *Incorrect* example(s)

diff --git a/docs/v3-to-v4.md b/docs/v3-to-v4.md
@@ -11,4 +11,6 @@ v4.0.0 Migration Guide
 
 There is a new [Node.js API](api.md) available. Please see the docs.
 
+## Additional changes
+
 Please see the [release notes](https://github.com/tclindner/npm-package-json-lint/releases/tag/v4.0.0) for additional changes introduced in v4.0.0.