From 66a006e4af657a310e09d6bedb861eb903c32c46 Mon Sep 17 00:00:00 2001 From: tclindner Date: Sun, 6 Oct 2019 12:44:01 -0500 Subject: [PATCH] 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 --- CHANGELOG.md | 34 +++--- .../no-absolute-version-dependencies.md | 12 ++ .../no-absolute-version-devDependencies.md | 12 ++ .../no-caret-version-dependencies.md | 12 ++ .../no-caret-version-devDependencies.md | 12 ++ .../no-tilde-version-dependencies.md | 12 ++ .../no-tilde-version-devDependencies.md | 12 ++ .../prefer-absolute-version-dependencies.md | 12 ++ ...prefer-absolute-version-devDependencies.md | 12 ++ .../prefer-caret-version-dependencies.md | 12 ++ .../prefer-caret-version-devDependencies.md | 12 ++ .../prefer-no-version-zero-dependencies.md | 54 +++++++++ .../prefer-no-version-zero-devDependencies.md | 12 ++ .../prefer-tilde-version-dependencies.md | 12 ++ .../prefer-tilde-version-devDependencies.md | 12 ++ .../prefer-no-devDependencies.md | 13 +++ docs/v3-to-v4.md | 2 + .../no-absolute-version-dependencies.md | 105 ++++++++++++++++++ .../no-absolute-version-devDependencies.md | 105 ++++++++++++++++++ .../no-caret-version-dependencies.md | 105 ++++++++++++++++++ .../no-caret-version-devDependencies.md | 105 ++++++++++++++++++ .../no-tilde-version-dependencies.md | 105 ++++++++++++++++++ .../no-tilde-version-devDependencies.md | 105 ++++++++++++++++++ .../prefer-absolute-version-dependencies.md | 101 +++++++++++++++++ ...prefer-absolute-version-devDependencies.md | 101 +++++++++++++++++ .../prefer-caret-version-dependencies.md | 60 ++++++++++ .../prefer-caret-version-devDependencies.md | 60 ++++++++++ .../prefer-no-version-zero-dependencies.md | 55 +++++++++ .../prefer-no-version-zero-devDependencies.md | 55 +++++++++ .../prefer-tilde-version-dependencies.md | 60 ++++++++++ .../prefer-tilde-version-devDependencies.md | 60 ++++++++++ .../prefer-no-devDependencies.md | 13 +++ .../versioned_docs/version-4.0.0/v3-to-v4.md | 2 + 33 files changed, 1440 insertions(+), 16 deletions(-) create mode 100644 docs/rules/dependencies/prefer-no-version-zero-dependencies.md create mode 100644 website/versioned_docs/version-4.0.0/rules/dependencies/no-absolute-version-dependencies.md create mode 100644 website/versioned_docs/version-4.0.0/rules/dependencies/no-absolute-version-devDependencies.md create mode 100644 website/versioned_docs/version-4.0.0/rules/dependencies/no-caret-version-dependencies.md create mode 100644 website/versioned_docs/version-4.0.0/rules/dependencies/no-caret-version-devDependencies.md create mode 100644 website/versioned_docs/version-4.0.0/rules/dependencies/no-tilde-version-dependencies.md create mode 100644 website/versioned_docs/version-4.0.0/rules/dependencies/no-tilde-version-devDependencies.md create mode 100644 website/versioned_docs/version-4.0.0/rules/dependencies/prefer-absolute-version-dependencies.md create mode 100644 website/versioned_docs/version-4.0.0/rules/dependencies/prefer-absolute-version-devDependencies.md create mode 100644 website/versioned_docs/version-4.0.0/rules/dependencies/prefer-caret-version-dependencies.md create mode 100644 website/versioned_docs/version-4.0.0/rules/dependencies/prefer-caret-version-devDependencies.md create mode 100644 website/versioned_docs/version-4.0.0/rules/dependencies/prefer-no-version-zero-dependencies.md create mode 100644 website/versioned_docs/version-4.0.0/rules/dependencies/prefer-no-version-zero-devDependencies.md create mode 100644 website/versioned_docs/version-4.0.0/rules/dependencies/prefer-tilde-version-dependencies.md create mode 100644 website/versioned_docs/version-4.0.0/rules/dependencies/prefer-tilde-version-devDependencies.md diff --git a/CHANGELOG.md b/CHANGELOG.md index 661f8499..b3efd6e7 100644 --- 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 index 205d9d1c..71687458 100644 --- 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 index c29811a6..7261cd99 100644 --- 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 index 40703e4e..ae717291 100644 --- 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 index 9afc77da..48b01e68 100644 --- 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 index 3ab22d82..5ce9950f 100644 --- 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 index 71e0ada2..77e8b795 100644 --- 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 index a4c2ca0f..b9cf9039 100644 --- 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 index 2cf293a2..dfe2cb31 100644 --- 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 index 55afa952..01c6a079 100644 --- 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 index bb09df3c..26179acb 100644 --- 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 new file mode 100644 index 00000000..2dceba26 --- /dev/null +++ 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 index f877bef7..8bd21499 100644 --- 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 index ec860724..39354085 100644 --- 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 index cc5901e4..305ba3e8 100644 --- 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 index be31a46b..0533614d 100644 --- 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 index 0f370ac6..13b59c5e 100644 --- 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. diff --git a/website/versioned_docs/version-4.0.0/rules/dependencies/no-absolute-version-dependencies.md b/website/versioned_docs/version-4.0.0/rules/dependencies/no-absolute-version-dependencies.md new file mode 100644 index 00000000..6bef8e75 --- /dev/null +++ b/website/versioned_docs/version-4.0.0/rules/dependencies/no-absolute-version-dependencies.md @@ -0,0 +1,105 @@ +--- +id: version-4.0.0-no-absolute-version-dependencies +title: no-absolute-version-dependencies +original_id: no-absolute-version-dependencies +--- + +Enabling this rule will result in an error being generated if one of the dependencies in `dependencies` uses absolute versions. + +## Example .npmpackagejsonlintrc configuration + +```json +{ + "rules": { + "no-absolute-version-dependencies": "error" + } +} +``` + +With exceptions + +```json +{ + "rules": { + "no-absolute-version-dependencies": ["error", { + "exceptions": ["myModule"] + }] + } +} +``` + +## Rule Details + +### *Incorrect* example(s) + +```json +{ + "dependencies": { + "grunt-npm-package-json-lint": "0.3.0" + } +} +``` + +```json +{ + "dependencies": { + "grunt-npm-package-json-lint": "=0.3.0" + } +} +``` + +### *Correct* example(s) + +```json +{ + "dependencies": { + "gulp-npm-package-json-lint": "^0.3.0" + } +} +``` + +```json +{ + "dependencies": { + "gulp-npm-package-json-lint": "~0.3.0" + } +} +``` + +```json +{ + "dependencies": { + "gulp-npm-package-json-lint": ">=0.3.0" + } +} +``` + +```json +{ + "dependencies": { + "gulp-npm-package-json-lint": "<=0.3.0" + } +} +``` + +```json +{ + "dependencies": { + "gulp-npm-package-json-lint": "*" + } +} +``` + +## Shorthand for disabling the rule in .npmpackagejsonlintrc configuration + +```json +{ + "rules": { + "no-absolute-version-dependencies": "off" + } +} +``` + +## History + +* Introduced in version 3.2.0 diff --git a/website/versioned_docs/version-4.0.0/rules/dependencies/no-absolute-version-devDependencies.md b/website/versioned_docs/version-4.0.0/rules/dependencies/no-absolute-version-devDependencies.md new file mode 100644 index 00000000..e0f12f3b --- /dev/null +++ b/website/versioned_docs/version-4.0.0/rules/dependencies/no-absolute-version-devDependencies.md @@ -0,0 +1,105 @@ +--- +id: version-4.0.0-no-absolute-version-devDependencies +title: no-absolute-version-devDependencies +original_id: no-absolute-version-devDependencies +--- + +Enabling this rule will result in an error being generated if one of the dependencies in `devDependencies` uses absolute versions. + +## Example .npmpackagejsonlintrc configuration + +```json +{ + "rules": { + "no-absolute-version-devDependencies": "error" + } +} +``` + +With exceptions + +```json +{ + "rules": { + "no-absolute-version-devDependencies": ["error", { + "exceptions": ["myModule"] + }] + } +} +``` + +## Rule Details + +### *Incorrect* example(s) + +```json +{ + "devDependencies": { + "grunt-npm-package-json-lint": "0.3.0" + } +} +``` + +```json +{ + "devDependencies": { + "grunt-npm-package-json-lint": "=0.3.0" + } +} +``` + +### *Correct* example(s) + +```json +{ + "devDependencies": { + "gulp-npm-package-json-lint": "^0.3.0" + } +} +``` + +```json +{ + "devDependencies": { + "gulp-npm-package-json-lint": "~0.3.0" + } +} +``` + +```json +{ + "devDependencies": { + "gulp-npm-package-json-lint": ">=0.3.0" + } +} +``` + +```json +{ + "devDependencies": { + "gulp-npm-package-json-lint": "<=0.3.0" + } +} +``` + +```json +{ + "devDependencies": { + "gulp-npm-package-json-lint": "*" + } +} +``` + +## Shorthand for disabling the rule in .npmpackagejsonlintrc configuration + +```json +{ + "rules": { + "no-absolute-version-devDependencies": "off" + } +} +``` + +## History + +* Introduced in version 3.2.0 diff --git a/website/versioned_docs/version-4.0.0/rules/dependencies/no-caret-version-dependencies.md b/website/versioned_docs/version-4.0.0/rules/dependencies/no-caret-version-dependencies.md new file mode 100644 index 00000000..04cbaff3 --- /dev/null +++ b/website/versioned_docs/version-4.0.0/rules/dependencies/no-caret-version-dependencies.md @@ -0,0 +1,105 @@ +--- +id: version-4.0.0-no-caret-version-dependencies +title: no-caret-version-dependencies +original_id: no-caret-version-dependencies +--- + +Enabling this rule will result in an error being generated if one of the dependencies in `dependencies` uses caret versions. + +## Example .npmpackagejsonlintrc configuration + +```json +{ + "rules": { + "no-caret-version-dependencies": "error" + } +} +``` + +With exceptions + +```json +{ + "rules": { + "no-caret-version-dependencies": ["error", { + "exceptions": ["myModule"] + }] + } +} +``` + +## Rule Details + +### *Incorrect* example(s) + +```json +{ + "dependencies": { + "gulp-npm-package-json-lint": "^0.3.0" + } +} +``` + +### *Correct* example(s) + +```json +{ + "dependencies": { + "gulp-npm-package-json-lint": "~0.3.0" + } +} +``` + +```json +{ + "dependencies": { + "gulp-npm-package-json-lint": ">=0.3.0" + } +} +``` + +```json +{ + "dependencies": { + "gulp-npm-package-json-lint": "<=0.3.0" + } +} +``` + +```json +{ + "dependencies": { + "gulp-npm-package-json-lint": "*" + } +} +``` + +```json +{ + "dependencies": { + "grunt-npm-package-json-lint": "0.3.0" + } +} +``` + +```json +{ + "dependencies": { + "grunt-npm-package-json-lint": "=0.3.0" + } +} +``` + +## Shorthand for disabling the rule in .npmpackagejsonlintrc configuration + +```json +{ + "rules": { + "no-caret-version-dependencies": "off" + } +} +``` + +## History + +* Introduced in version 3.2.0 diff --git a/website/versioned_docs/version-4.0.0/rules/dependencies/no-caret-version-devDependencies.md b/website/versioned_docs/version-4.0.0/rules/dependencies/no-caret-version-devDependencies.md new file mode 100644 index 00000000..515cb4a7 --- /dev/null +++ b/website/versioned_docs/version-4.0.0/rules/dependencies/no-caret-version-devDependencies.md @@ -0,0 +1,105 @@ +--- +id: version-4.0.0-no-caret-version-devDependencies +title: no-caret-version-devDependencies +original_id: no-caret-version-devDependencies +--- + +Enabling this rule will result in an error being generated if one of the dependencies in `devDependencies` uses caret versions. + +## Example .npmpackagejsonlintrc configuration + +```json +{ + "rules": { + "no-caret-version-devDependencies": "error" + } +} +``` + +With exceptions + +```json +{ + "rules": { + "no-caret-version-devDependencies": ["error", { + "exceptions": ["myModule"] + }] + } +} +``` + +## Rule Details + +### *Incorrect* example(s) + +```json +{ + "devDependencies": { + "gulp-npm-package-json-lint": "^0.3.0" + } +} +``` + +### *Correct* example(s) + +```json +{ + "devDependencies": { + "gulp-npm-package-json-lint": "~0.3.0" + } +} +``` + +```json +{ + "devDependencies": { + "gulp-npm-package-json-lint": ">=0.3.0" + } +} +``` + +```json +{ + "devDependencies": { + "gulp-npm-package-json-lint": "<=0.3.0" + } +} +``` + +```json +{ + "devDependencies": { + "gulp-npm-package-json-lint": "*" + } +} +``` + +```json +{ + "devDependencies": { + "grunt-npm-package-json-lint": "0.3.0" + } +} +``` + +```json +{ + "devDependencies": { + "grunt-npm-package-json-lint": "=0.3.0" + } +} +``` + +## Shorthand for disabling the rule in .npmpackagejsonlintrc configuration + +```json +{ + "rules": { + "no-caret-version-devDependencies": "off" + } +} +``` + +## History + +* Introduced in version 3.2.0 diff --git a/website/versioned_docs/version-4.0.0/rules/dependencies/no-tilde-version-dependencies.md b/website/versioned_docs/version-4.0.0/rules/dependencies/no-tilde-version-dependencies.md new file mode 100644 index 00000000..42d997bf --- /dev/null +++ b/website/versioned_docs/version-4.0.0/rules/dependencies/no-tilde-version-dependencies.md @@ -0,0 +1,105 @@ +--- +id: version-4.0.0-no-tilde-version-dependencies +title: no-tilde-version-dependencies +original_id: no-tilde-version-dependencies +--- + +Enabling this rule will result in an error being generated if one of the dependencies in `dependencies` uses tilde versions. + +## Example .npmpackagejsonlintrc configuration + +```json +{ + "rules": { + "no-tilde-version-dependencies": "error" + } +} +``` + +With exceptions + +```json +{ + "rules": { + "no-tilde-version-dependencies": ["error", { + "exceptions": ["myModule"] + }] + } +} +``` + +## Rule Details + +### *Incorrect* example(s) + +```json +{ + "dependencies": { + "gulp-npm-package-json-lint": "~0.3.0" + } +} +``` + +### *Correct* example(s) + +```json +{ + "dependencies": { + "gulp-npm-package-json-lint": "^0.3.0" + } +} +``` + +```json +{ + "dependencies": { + "gulp-npm-package-json-lint": ">=0.3.0" + } +} +``` + +```json +{ + "dependencies": { + "gulp-npm-package-json-lint": "<=0.3.0" + } +} +``` + +```json +{ + "dependencies": { + "gulp-npm-package-json-lint": "*" + } +} +``` + +```json +{ + "dependencies": { + "grunt-npm-package-json-lint": "0.3.0" + } +} +``` + +```json +{ + "dependencies": { + "grunt-npm-package-json-lint": "=0.3.0" + } +} +``` + +## Shorthand for disabling the rule in .npmpackagejsonlintrc configuration + +```json +{ + "rules": { + "no-tilde-version-dependencies": "off" + } +} +``` + +## History + +* Introduced in version 3.2.0 diff --git a/website/versioned_docs/version-4.0.0/rules/dependencies/no-tilde-version-devDependencies.md b/website/versioned_docs/version-4.0.0/rules/dependencies/no-tilde-version-devDependencies.md new file mode 100644 index 00000000..5b976a1a --- /dev/null +++ b/website/versioned_docs/version-4.0.0/rules/dependencies/no-tilde-version-devDependencies.md @@ -0,0 +1,105 @@ +--- +id: version-4.0.0-no-tilde-version-devDependencies +title: no-tilde-version-devDependencies +original_id: no-tilde-version-devDependencies +--- + +Enabling this rule will result in an error being generated if one of the dependencies in `devDependencies` uses tilde versions. + +## Example .npmpackagejsonlintrc configuration + +```json +{ + "rules": { + "no-tilde-version-devDependencies": "error" + } +} +``` + +With exceptions + +```json +{ + "rules": { + "no-tilde-version-devDependencies": ["error", { + "exceptions": ["myModule"] + }] + } +} +``` + +## Rule Details + +### *Incorrect* example(s) + +```json +{ + "devDependencies": { + "gulp-npm-package-json-lint": "~0.3.0" + } +} +``` + +### *Correct* example(s) + +```json +{ + "devDependencies": { + "gulp-npm-package-json-lint": "^0.3.0" + } +} +``` + +```json +{ + "devDependencies": { + "gulp-npm-package-json-lint": ">=0.3.0" + } +} +``` + +```json +{ + "devDependencies": { + "gulp-npm-package-json-lint": "<=0.3.0" + } +} +``` + +```json +{ + "devDependencies": { + "gulp-npm-package-json-lint": "*" + } +} +``` + +```json +{ + "devDependencies": { + "grunt-npm-package-json-lint": "0.3.0" + } +} +``` + +```json +{ + "devDependencies": { + "grunt-npm-package-json-lint": "=0.3.0" + } +} +``` + +## Shorthand for disabling the rule in .npmpackagejsonlintrc configuration + +```json +{ + "rules": { + "no-tilde-version-devDependencies": "off" + } +} +``` + +## History + +* Introduced in version 3.2.0 diff --git a/website/versioned_docs/version-4.0.0/rules/dependencies/prefer-absolute-version-dependencies.md b/website/versioned_docs/version-4.0.0/rules/dependencies/prefer-absolute-version-dependencies.md new file mode 100644 index 00000000..940bc749 --- /dev/null +++ b/website/versioned_docs/version-4.0.0/rules/dependencies/prefer-absolute-version-dependencies.md @@ -0,0 +1,101 @@ +--- +id: version-4.0.0-prefer-absolute-version-dependencies +title: prefer-absolute-version-dependencies +original_id: prefer-absolute-version-dependencies +--- + +Enabling this rule will result in an error being generated if one of the dependencies in `dependencies` is does not use an absolute version range. + +## Example .npmpackagejsonlintrc configuration + +```json +{ + "rules": { + "prefer-absolute-version-dependencies": "error" + } +} +``` + +With exceptions + +```json +{ + "rules": { + "prefer-absolute-version-dependencies": ["error", { + "exceptions": ["myModule"] + }] + } +} +``` + +## Rule Details + +### *Incorrect* example(s) + +```json +{ + "dependencies": { + "grunt-npm-package-json-lint": "~0.3.0" + } +} +``` + +```json +{ + "dependencies": { + "grunt-npm-package-json-lint": "^0.3.0" + } +} +``` + +```json +{ + "dependencies": { + "grunt-npm-package-json-lint": "0.3.*" + } +} +``` + +```json +{ + "dependencies": { + "grunt-npm-package-json-lint": ">0.3.0" + } +} +``` + +```json +{ + "dependencies": { + "grunt-npm-package-json-lint": "<0.3.0" + } +} +``` + +### *Correct* example(s) + +```json +{ + "dependencies": { + "gulp-npm-package-json-lint": "0.3.0" + } +} +``` + +```json +{ + "dependencies": { + "gulp-npm-package-json-lint": "=0.3.0" + } +} +``` + +## Related + +* [prefer-caret-version-dependencies](prefer-caret-version-dependencies.md) +* [prefer-tilde-version-dependencies](prefer-tilde-version-dependencies.md) + +## History + +* Enhanced in version 2.5.0. No longer requires the version to be prefixed with an equals sign, = +* Introduced in version 2.4.0 diff --git a/website/versioned_docs/version-4.0.0/rules/dependencies/prefer-absolute-version-devDependencies.md b/website/versioned_docs/version-4.0.0/rules/dependencies/prefer-absolute-version-devDependencies.md new file mode 100644 index 00000000..88e90c64 --- /dev/null +++ b/website/versioned_docs/version-4.0.0/rules/dependencies/prefer-absolute-version-devDependencies.md @@ -0,0 +1,101 @@ +--- +id: version-4.0.0-prefer-absolute-version-devDependencies +title: prefer-absolute-version-devDependencies +original_id: prefer-absolute-version-devDependencies +--- + +Enabling this rule will result in an error being generated if one of the dependencies in `devDependencies` is does not use an absolute version range. + +## Example .npmpackagejsonlintrc configuration + +```json +{ + "rules": { + "prefer-absolute-version-devDependencies": "error" + } +} +``` + +With exceptions + +```json +{ + "rules": { + "prefer-absolute-version-devDependencies": ["error", { + "exceptions": ["myModule"] + }] + } +} +``` + +## Rule Details + +### *Incorrect* example(s) + +```json +{ + "devDependencies": { + "grunt-npm-package-json-lint": "~0.3.0" + } +} +``` + +```json +{ + "devDependencies": { + "grunt-npm-package-json-lint": "^0.3.0" + } +} +``` + +```json +{ + "devDependencies": { + "grunt-npm-package-json-lint": "0.3.*" + } +} +``` + +```json +{ + "devDependencies": { + "grunt-npm-package-json-lint": ">0.3.0" + } +} +``` + +```json +{ + "devDependencies": { + "grunt-npm-package-json-lint": "<0.3.0" + } +} +``` + +### *Correct* example(s) + +```json +{ + "devDependencies": { + "gulp-npm-package-json-lint": "0.3.0" + } +} +``` + +```json +{ + "devDependencies": { + "gulp-npm-package-json-lint": "=0.3.0" + } +} +``` + +## Related + +* [prefer-caret-version-devDependencies](prefer-caret-version-devDependencies.md) +* [prefer-tilde-version-devDependencies](prefer-tilde-version-devDependencies.md) + +## History + +* Enhanced in version 2.5.0. No longer requires the version to be prefixed with an equals sign, = +* Introduced in version 2.4.0 diff --git a/website/versioned_docs/version-4.0.0/rules/dependencies/prefer-caret-version-dependencies.md b/website/versioned_docs/version-4.0.0/rules/dependencies/prefer-caret-version-dependencies.md new file mode 100644 index 00000000..c1fb6636 --- /dev/null +++ b/website/versioned_docs/version-4.0.0/rules/dependencies/prefer-caret-version-dependencies.md @@ -0,0 +1,60 @@ +--- +id: version-4.0.0-prefer-caret-version-dependencies +title: prefer-caret-version-dependencies +original_id: prefer-caret-version-dependencies +--- + +Enabling this rule will result in an error being generated if one of the dependencies in `dependencies` is does not use a caret version range. + +## Example .npmpackagejsonlintrc configuration + +```json +{ + "rules": { + "prefer-caret-version-dependencies": "error" + } +} +``` + +With exceptions + +```json +{ + "rules": { + "prefer-caret-version-dependencies": ["error", { + "exceptions": ["myModule"] + }] + } +} +``` + +## Rule Details + +### *Incorrect* example(s) + +```json +{ + "dependencies": { + "grunt-npm-package-json-lint": "~0.3.0" + } +} +``` + +### *Correct* example(s) + +```json +{ + "dependencies": { + "gulp-npm-package-json-lint": "^0.3.0" + } +} +``` + +## Related + +* [prefer-absolute-version-dependencies](prefer-absolute-version-dependencies.md) +* [prefer-tilde-version-dependencies](prefer-tilde-version-dependencies.md) + +## History + +* Introduced in version 0.4.0 diff --git a/website/versioned_docs/version-4.0.0/rules/dependencies/prefer-caret-version-devDependencies.md b/website/versioned_docs/version-4.0.0/rules/dependencies/prefer-caret-version-devDependencies.md new file mode 100644 index 00000000..7c9b0d41 --- /dev/null +++ b/website/versioned_docs/version-4.0.0/rules/dependencies/prefer-caret-version-devDependencies.md @@ -0,0 +1,60 @@ +--- +id: version-4.0.0-prefer-caret-version-devDependencies +title: prefer-caret-version-devDependencies +original_id: prefer-caret-version-devDependencies +--- + +Enabling this rule will result in an error being generated if one of the dependencies in `devDependencies` is does not use a caret version range. + +## Example .npmpackagejsonlintrc configuration + +```json +{ + "rules": { + "prefer-caret-version-devDependencies": "error" + } +} +``` + +With exceptions + +```json +{ + "rules": { + "prefer-caret-version-devDependencies": ["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": "^0.3.0" + } +} +``` + +## Related + +* [prefer-absolute-version-devDependencies](prefer-absolute-version-devDependencies.md) +* [prefer-tilde-version-devDependencies](prefer-tilde-version-devDependencies.md) + +## History + +* Introduced in version 0.4.0 diff --git a/website/versioned_docs/version-4.0.0/rules/dependencies/prefer-no-version-zero-dependencies.md b/website/versioned_docs/version-4.0.0/rules/dependencies/prefer-no-version-zero-dependencies.md new file mode 100644 index 00000000..cabafa60 --- /dev/null +++ b/website/versioned_docs/version-4.0.0/rules/dependencies/prefer-no-version-zero-dependencies.md @@ -0,0 +1,55 @@ +--- +id: version-4.0.0-prefer-no-version-zero-dependencies +title: prefer-no-version-zero-dependencies +original_id: 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/website/versioned_docs/version-4.0.0/rules/dependencies/prefer-no-version-zero-devDependencies.md b/website/versioned_docs/version-4.0.0/rules/dependencies/prefer-no-version-zero-devDependencies.md new file mode 100644 index 00000000..6cf0777a --- /dev/null +++ b/website/versioned_docs/version-4.0.0/rules/dependencies/prefer-no-version-zero-devDependencies.md @@ -0,0 +1,55 @@ +--- +id: version-4.0.0-prefer-no-version-zero-devDependencies +title: prefer-no-version-zero-devDependencies +original_id: prefer-no-version-zero-devDependencies +--- + +Enabling this rule will result in an error being generated if one of the dependencies in `devDependencies` has a major version of 0. + +## Example .npmpackagejsonlintrc configuration + +```json +{ + "rules": { + "prefer-no-version-zero-devDependencies": "error" + } +} +``` + +With exceptions + +```json +{ + "rules": { + "prefer-no-version-zero-devDependencies": ["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/website/versioned_docs/version-4.0.0/rules/dependencies/prefer-tilde-version-dependencies.md b/website/versioned_docs/version-4.0.0/rules/dependencies/prefer-tilde-version-dependencies.md new file mode 100644 index 00000000..8b4a007f --- /dev/null +++ b/website/versioned_docs/version-4.0.0/rules/dependencies/prefer-tilde-version-dependencies.md @@ -0,0 +1,60 @@ +--- +id: version-4.0.0-prefer-tilde-version-dependencies +title: prefer-tilde-version-dependencies +original_id: prefer-tilde-version-dependencies +--- + +Enabling this rule will result in an error being generated if one of the dependencies in `dependencies` is does not use a tilde version range. + +## Example .npmpackagejsonlintrc configuration + +```json +{ + "rules": { + "prefer-tilde-version-dependencies": "error" + } +} +``` + +With exceptions + +```json +{ + "rules": { + "prefer-tilde-version-dependencies": ["error", { + "exceptions": ["myModule"] + }] + } +} +``` + +## Rule Details + +### *Incorrect* example(s) + +```json +{ + "dependencies": { + "grunt-npm-package-json-lint": "^0.3.0" + } +} +``` + +### *Correct* example(s) + +```json +{ + "dependencies": { + "gulp-npm-package-json-lint": "~0.3.0" + } +} +``` + +## Related + +* [prefer-absolute-version-dependencies](prefer-absolute-version-dependencies.md) +* [prefer-caret-version-dependencies](prefer-caret-version-dependencies.md) + +## History + +* Introduced in version 0.4.0 diff --git a/website/versioned_docs/version-4.0.0/rules/dependencies/prefer-tilde-version-devDependencies.md b/website/versioned_docs/version-4.0.0/rules/dependencies/prefer-tilde-version-devDependencies.md new file mode 100644 index 00000000..ed72a771 --- /dev/null +++ b/website/versioned_docs/version-4.0.0/rules/dependencies/prefer-tilde-version-devDependencies.md @@ -0,0 +1,60 @@ +--- +id: version-4.0.0-prefer-tilde-version-devDependencies +title: prefer-tilde-version-devDependencies +original_id: prefer-tilde-version-devDependencies +--- + +Enabling this rule will result in an error being generated if one of the dependencies in `devDependencies` is does not use a tilde version range. + +## Example .npmpackagejsonlintrc configuration + +```json +{ + "rules": { + "prefer-tilde-version-devDependencies": "error" + } +} +``` + +With exceptions + +```json +{ + "rules": { + "prefer-tilde-version-devDependencies": ["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": "~0.3.0" + } +} +``` + +## Related + +* [prefer-absolute-version-devDependencies](prefer-absolute-version-devDependencies.md) +* [prefer-caret-version-devDependencies](prefer-caret-version-devDependencies.md) + +## History + +* Introduced in version 0.4.0 diff --git a/website/versioned_docs/version-4.0.0/rules/disallowed-nodes/prefer-no-devDependencies.md b/website/versioned_docs/version-4.0.0/rules/disallowed-nodes/prefer-no-devDependencies.md index 003a271d..4db24267 100644 --- a/website/versioned_docs/version-4.0.0/rules/disallowed-nodes/prefer-no-devDependencies.md +++ b/website/versioned_docs/version-4.0.0/rules/disallowed-nodes/prefer-no-devDependencies.md @@ -16,6 +16,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/website/versioned_docs/version-4.0.0/v3-to-v4.md b/website/versioned_docs/version-4.0.0/v3-to-v4.md index 7d959b52..ce538216 100644 --- a/website/versioned_docs/version-4.0.0/v3-to-v4.md +++ b/website/versioned_docs/version-4.0.0/v3-to-v4.md @@ -12,4 +12,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.