Skip to content
This repository was archived by the owner on Apr 6, 2023. It is now read-only.

docs: initial compatibility table and migration guide#208

Closed
danielroe wants to merge 2 commits intomainfrom
docs/compatibility
Closed

docs: initial compatibility table and migration guide#208
danielroe wants to merge 2 commits intomainfrom
docs/compatibility

Conversation

@danielroe
Copy link
Member

@danielroe danielroe commented Jun 11, 2021

this will need to be updated as we go

Note that this implements the nuxt/nuxt#11061 issue - and we can update the docs accordingly as part of any future PRs/feature improvements.

TODO:

  • add more modules to module table

@danielroe danielroe added the documentation Improvements or additions to documentation label Jun 11, 2021
@danielroe danielroe requested a review from pi0 June 11, 2021 13:04
- "nuxt-vite": "latest"
},
"devDependencies": {
+ "nuxt3": "latest"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure to follow the purpose of this guide. Using nuxt2 and 3 dependencies in the same project??

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is as nice idea to tell how prepare your nuxt2 projects for nuxt3 without risking unstable software but I guess it should not involve nuxt3 or wp5 but official compat features like nitro or app compostables.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(This was meant to be a guide for how to migrate a nuxt2 project to nuxt3.)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's WAY early to write this guide (also we can discuss about some approaches. having two incompatible deps on same project is probably not best...)

```


5. Upgrade any webpack-ecosystem packages (loaders, plugins, etc.) to their webpack5 equivalents. For example, `sass-loader` can be upgraded to v12.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It will break nuxt2 using latest loaders. And no point for nuxt3..


### Work in progress

* [`@nuxt/content`](https://github.com/nuxt/content/)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since this might be a rolling update, let's rethink about possible module tracking solutions :) (it would probably be nicer if we include such meta in nuxt/modules yml files or directly fetch from their pkg)


2. Upgrade your dependencies to the latest version supported by Nuxt 2, ensuring at each stage that your project is still working as intended.
1. Install `core-js@3`.
2. Install and enable [`nuxt-postcss8`](https://github.com/nuxt/postcss8) to migrate to PostCSS 8.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since both corejs3 and postcss8 are planned for 2.16, it would probably be easier to omit from docs here and instead recommend upgrading to latest 2.x with proper upgrade guides in 2.x website (nuxt/website-v2#1434)


| Name | Description | Nuxt 2 | Nuxt 3 | Migration steps required |
| --------------------- | ------------------ | ------ | ------ | -------------------------------------------------------------------------------------------------------------------- |
| `app.vue` | | ❌ | ✅ | Move `layouts/default.vue` (if present) to `~/app.vue` and rename the `<nuxt />` component to `<nuxt-page />` |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's keep it evolving in #191 to have better idea how it looks like. Probably for description, we can use actual sections with detailed step-by-step guide and tips.

@pi0 pi0 added the pending label Jun 14, 2021
@danielroe danielroe removed their assignment Jun 15, 2021
@pi0 pi0 force-pushed the main branch 4 times, most recently from 1aeb417 to ee8eaef Compare July 29, 2021 14:13
@pi0
Copy link
Member

pi0 commented Aug 30, 2021

Moving to #459

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

3.x documentation Improvements or additions to documentation pending

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants