Skip to content

Commit 66a006e

Browse files
authored
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
1 parent 7bd437c commit 66a006e

33 files changed

+1440
-16
lines changed

CHANGELOG.md

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -3,30 +3,32 @@ All notable changes to this project will be documented in this file.
33
This project adheres to [Semantic Versioning](http://semver.org/).
44

55
## [Unreleased]
6+
7+
## [4.0.0] - 2019-10-06
68
### Added
79
- Added exception support to the following rules:
810

9-
- [`no-absolute-version-dependencies`](https://github.com/tclindner/npm-package-json-lint/wiki/no-absolute-version-dependencies)
10-
- [`no-absolute-version-devDependencies`](https://github.com/tclindner/npm-package-json-lint/wiki/no-absolute-version-devDependencies)
11-
- [`no-caret-version-dependencies`](https://github.com/tclindner/npm-package-json-lint/wiki/no-caret-version-dependencies)
12-
- [`no-caret-version-devDependencies`](https://github.com/tclindner/npm-package-json-lint/wiki/no-caret-version-devDependencies)
13-
- [`no-tilde-version-dependencies`](https://github.com/tclindner/npm-package-json-lint/wiki/no-tilde-version-dependencies)
14-
- [`no-tilde-version-devDependencies`](https://github.com/tclindner/npm-package-json-lint/wiki/no-tilde-version-devDependencies)
15-
- [`prefer-absolute-version-dependencies`](https://github.com/tclindner/npm-package-json-lint/wiki/prefer-absolute-version-dependencies)
16-
- [`prefer-absolute-version-devDependencies`](https://github.com/tclindner/npm-package-json-lint/wiki/prefer-absolute-version-devDependencies)
17-
- [`prefer-caret-version-dependencies`](https://github.com/tclindner/npm-package-json-lint/wiki/prefer-caret-version-dependencies)
18-
- [`prefer-caret-version-devDependencies`](https://github.com/tclindner/npm-package-json-lint/wiki/prefer-caret-version-devDependencies)
19-
- [`prefer-no-version-zero-dependencies`](https://github.com/tclindner/npm-package-json-lint/wiki/prefer-no-version-zero-dependencies)
20-
- [`prefer-no-version-zero-devDependencies`](https://github.com/tclindner/npm-package-json-lint/wiki/prefer-no-version-zero-devDependencies)
21-
- [`prefer-tilde-version-dependencies`](https://github.com/tclindner/npm-package-json-lint/wiki/prefer-tilde-version-dependencies)
22-
- [`prefer-tilde-version-devDependencies`](https://github.com/tclindner/npm-package-json-lint/wiki/prefer-tilde-version-devDependencies)
11+
- [`no-absolute-version-dependencies`](https://npmpackagejsonlint.org/docs/en/rules/dependencies/no-absolute-version-dependencies)
12+
- [`no-absolute-version-devDependencies`](https://npmpackagejsonlint.org/docs/en/rules/dependencies/no-absolute-version-devDependencies)
13+
- [`no-caret-version-dependencies`](https://npmpackagejsonlint.org/docs/en/rules/dependencies/no-caret-version-dependencies)
14+
- [`no-caret-version-devDependencies`](https://npmpackagejsonlint.org/docs/en/rules/dependencies/no-caret-version-devDependencies)
15+
- [`no-tilde-version-dependencies`](https://npmpackagejsonlint.org/docs/en/rules/dependencies/no-tilde-version-dependencies)
16+
- [`no-tilde-version-devDependencies`](https://npmpackagejsonlint.org/docs/en/rules/dependencies/no-tilde-version-devDependencies)
17+
- [`prefer-absolute-version-dependencies`](https://npmpackagejsonlint.org/docs/en/rules/dependencies/prefer-absolute-version-dependencies)
18+
- [`prefer-absolute-version-devDependencies`](https://npmpackagejsonlint.org/docs/en/rules/dependencies/prefer-absolute-version-devDependencies)
19+
- [`prefer-caret-version-dependencies`](https://npmpackagejsonlint.org/docs/en/rules/dependencies/prefer-caret-version-dependencies)
20+
- [`prefer-caret-version-devDependencies`](https://npmpackagejsonlint.org/docs/en/rules/dependencies/prefer-caret-version-devDependencies)
21+
- [`prefer-no-version-zero-dependencies`](https://npmpackagejsonlint.org/docs/en/rules/dependencies/prefer-no-version-zero-dependencies)
22+
- [`prefer-no-version-zero-devDependencies`](https://npmpackagejsonlint.org/docs/en/rules/dependencies/prefer-no-version-zero-devDependencies)
23+
- [`prefer-tilde-version-dependencies`](https://npmpackagejsonlint.org/docs/en/rules/dependencies/prefer-tilde-version-dependencies)
24+
- [`prefer-tilde-version-devDependencies`](https://npmpackagejsonlint.org/docs/en/rules/dependencies/prefer-tilde-version-devDependencies)
2325

2426
> Addresses [#93](https://github.com/tclindner/npm-package-json-lint/issues/93)
2527
26-
- New rule: [prefer-no-devDependencies](https://github.com/tclindner/npm-package-json-lint/wiki/prefer-no-devDependencies)]
28+
- New rule: [prefer-no-devDependencies](https://npmpackagejsonlint.org/docs/en/rules/disallowed-nodes/prefer-no-devdependencies)]. Thank you, @simison
2729

2830
### Changed
29-
- [`name-format`](https://github.com/tclindner/npm-package-json-lint/wiki/name-format) now checks the following things:
31+
- [`name-format`](https://npmpackagejsonlint.org/docs/en/rules/format/name-format) now checks the following things:
3032

3133
- Name is lowercase
3234
- Name is less than 214 characters. This includes scope.

docs/rules/dependencies/no-absolute-version-dependencies.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,18 @@ Enabling this rule will result in an error being generated if one of the depende
1515
}
1616
```
1717

18+
With exceptions
19+
20+
```json
21+
{
22+
"rules": {
23+
"no-absolute-version-dependencies": ["error", {
24+
"exceptions": ["myModule"]
25+
}]
26+
}
27+
}
28+
```
29+
1830
## Rule Details
1931

2032
### *Incorrect* example(s)

docs/rules/dependencies/no-absolute-version-devDependencies.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,18 @@ Enabling this rule will result in an error being generated if one of the depende
1515
}
1616
```
1717

18+
With exceptions
19+
20+
```json
21+
{
22+
"rules": {
23+
"no-absolute-version-devDependencies": ["error", {
24+
"exceptions": ["myModule"]
25+
}]
26+
}
27+
}
28+
```
29+
1830
## Rule Details
1931

2032
### *Incorrect* example(s)

docs/rules/dependencies/no-caret-version-dependencies.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,18 @@ Enabling this rule will result in an error being generated if one of the depende
1515
}
1616
```
1717

18+
With exceptions
19+
20+
```json
21+
{
22+
"rules": {
23+
"no-caret-version-dependencies": ["error", {
24+
"exceptions": ["myModule"]
25+
}]
26+
}
27+
}
28+
```
29+
1830
## Rule Details
1931

2032
### *Incorrect* example(s)

docs/rules/dependencies/no-caret-version-devDependencies.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,18 @@ Enabling this rule will result in an error being generated if one of the depende
1515
}
1616
```
1717

18+
With exceptions
19+
20+
```json
21+
{
22+
"rules": {
23+
"no-caret-version-devDependencies": ["error", {
24+
"exceptions": ["myModule"]
25+
}]
26+
}
27+
}
28+
```
29+
1830
## Rule Details
1931

2032
### *Incorrect* example(s)

docs/rules/dependencies/no-tilde-version-dependencies.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,18 @@ Enabling this rule will result in an error being generated if one of the depende
1515
}
1616
```
1717

18+
With exceptions
19+
20+
```json
21+
{
22+
"rules": {
23+
"no-tilde-version-dependencies": ["error", {
24+
"exceptions": ["myModule"]
25+
}]
26+
}
27+
}
28+
```
29+
1830
## Rule Details
1931

2032
### *Incorrect* example(s)

docs/rules/dependencies/no-tilde-version-devDependencies.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,18 @@ Enabling this rule will result in an error being generated if one of the depende
1515
}
1616
```
1717

18+
With exceptions
19+
20+
```json
21+
{
22+
"rules": {
23+
"no-tilde-version-devDependencies": ["error", {
24+
"exceptions": ["myModule"]
25+
}]
26+
}
27+
}
28+
```
29+
1830
## Rule Details
1931

2032
### *Incorrect* example(s)

docs/rules/dependencies/prefer-absolute-version-dependencies.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,18 @@ Enabling this rule will result in an error being generated if one of the depende
1515
}
1616
```
1717

18+
With exceptions
19+
20+
```json
21+
{
22+
"rules": {
23+
"prefer-absolute-version-dependencies": ["error", {
24+
"exceptions": ["myModule"]
25+
}]
26+
}
27+
}
28+
```
29+
1830
## Rule Details
1931

2032
### *Incorrect* example(s)

docs/rules/dependencies/prefer-absolute-version-devDependencies.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,18 @@ Enabling this rule will result in an error being generated if one of the depende
1515
}
1616
```
1717

18+
With exceptions
19+
20+
```json
21+
{
22+
"rules": {
23+
"prefer-absolute-version-devDependencies": ["error", {
24+
"exceptions": ["myModule"]
25+
}]
26+
}
27+
}
28+
```
29+
1830
## Rule Details
1931

2032
### *Incorrect* example(s)

docs/rules/dependencies/prefer-caret-version-dependencies.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,18 @@ Enabling this rule will result in an error being generated if one of the depende
1515
}
1616
```
1717

18+
With exceptions
19+
20+
```json
21+
{
22+
"rules": {
23+
"prefer-caret-version-dependencies": ["error", {
24+
"exceptions": ["myModule"]
25+
}]
26+
}
27+
}
28+
```
29+
1830
## Rule Details
1931

2032
### *Incorrect* example(s)

0 commit comments

Comments
 (0)