Skip to content

Commit 8562e23

Browse files
authored
Add migration docs (#583)
1 parent efe459f commit 8562e23

File tree

2 files changed

+25
-0
lines changed

2 files changed

+25
-0
lines changed

website/docs/v5-to-v6.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
id: v5-to-v6
3+
title: v5 to v6 Migration Guide
4+
---
5+
6+
v6.0.0 Migration Guide
7+
8+
> FYI: v6 drops support for Node 10 and 12. If you need support for versions of Node that have reached EOL, please use v5.
9+
10+
## Rule definition change
11+
12+
[`name-format`](https://npmpackagejsonlint.org/docs/en/rules/format/name-format) was updated the use `validate-npm-package-name`. See [#537](https://github.com/tclindner/npm-package-json-lint/pull/537) for more details.
13+
14+
## TypeScript Support
15+
16+
v6 is completely written in TypeScript. The Node.js API is fully typed for easier development.
17+
18+
## Documentation site (website)
19+
20+
The website has been upgraded to Docusaurus v2 (beta). Versioning support has been removed in this release. All docs can now be found in `/website/docs`.
21+
22+
## Additional changes
23+
24+
Please see the [release notes](https://github.com/tclindner/npm-package-json-lint/releases/tag/v6.0.0) for additional changes introduced in v6.0.0.

website/sidebars.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
"related-projects"
1919
],
2020
"Migration Guides": [
21+
"v5-to-v6",
2122
"v4-to-v5",
2223
"v3-to-v4",
2324
"v2-to-v3",

0 commit comments

Comments
 (0)