Skip to content

Commit

Permalink
Add migration docs (#583)
Browse files Browse the repository at this point in the history
  • Loading branch information
tclindner authored Mar 5, 2022
1 parent efe459f commit 8562e23
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 0 deletions.
24 changes: 24 additions & 0 deletions website/docs/v5-to-v6.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
id: v5-to-v6
title: v5 to v6 Migration Guide
---

v6.0.0 Migration Guide

> FYI: v6 drops support for Node 10 and 12. If you need support for versions of Node that have reached EOL, please use v5.
## Rule definition change

[`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.

## TypeScript Support

v6 is completely written in TypeScript. The Node.js API is fully typed for easier development.

## Documentation site (website)

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`.

## Additional changes

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.
1 change: 1 addition & 0 deletions website/sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
"related-projects"
],
"Migration Guides": [
"v5-to-v6",
"v4-to-v5",
"v3-to-v4",
"v2-to-v3",
Expand Down

0 comments on commit 8562e23

Please sign in to comment.