From 8562e236a5b74d7541d19e2e3a6ad7cedf05e398 Mon Sep 17 00:00:00 2001 From: Thomas Lindner <5178550+tclindner@users.noreply.github.com> Date: Sat, 5 Mar 2022 16:02:20 -0600 Subject: [PATCH] Add migration docs (#583) --- website/docs/v5-to-v6.md | 24 ++++++++++++++++++++++++ website/sidebars.json | 1 + 2 files changed, 25 insertions(+) create mode 100644 website/docs/v5-to-v6.md diff --git a/website/docs/v5-to-v6.md b/website/docs/v5-to-v6.md new file mode 100644 index 00000000..3b155bd8 --- /dev/null +++ b/website/docs/v5-to-v6.md @@ -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. diff --git a/website/sidebars.json b/website/sidebars.json index a737cb58..caff6e15 100644 --- a/website/sidebars.json +++ b/website/sidebars.json @@ -18,6 +18,7 @@ "related-projects" ], "Migration Guides": [ + "v5-to-v6", "v4-to-v5", "v3-to-v4", "v2-to-v3",