Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: unfined defineNuxtPlugin migration guide for nuxt bridge #22433 #23036

Merged
merged 3 commits into from Nov 13, 2023
Merged

docs: unfined defineNuxtPlugin migration guide for nuxt bridge #22433 #23036

merged 3 commits into from Nov 13, 2023

Conversation

adrienZ
Copy link
Sponsor Contributor

@adrienZ adrienZ commented Sep 6, 2023

🔗 Linked issue

#22433

❓ Type of change

  • 📖 Documentation (updates to the documentation, readme or JSdoc annotations)
  • 🐞 Bug fix (a non-breaking change that fixes an issue)
  • 👌 Enhancement (improving an existing functionality like performance)
  • ✨ New feature (a non-breaking change that adds functionality)
  • 🧹 Chore (updates to the build process or auxiliary tools and libraries)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

📝 Checklist

  • I have linked an issue or discussion.
  • I have updated the documentation accordingly.

@stackblitz
Copy link

stackblitz bot commented Sep 6, 2023

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

@nuxt-studio
Copy link

nuxt-studio bot commented Sep 6, 2023 •
edited

✅ Live Preview ready!

Name Edit Preview Latest Commit
Nuxt Docs Edit on Studio ↗︎ View Live Preview e4f5811

@adrienZ adrienZ force-pushed the docs/unfined-definenuxtplugin-docs branch 2 times, most recently from 6fb8dba to 73a4d88 Compare September 6, 2023 09:33
@adrienZ adrienZ force-pushed the docs/unfined-definenuxtplugin-docs branch from 73a4d88 to e4f5811 Compare September 6, 2023 09:34
wattanx
wattanx approved these changes Sep 6, 2023
View reviewed changes
Copy link
Collaborator

@wattanx wattanx left a comment

Choose a reason for hiding this comment

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

Thank you ❤️

@wattanx wattanx self-requested a review September 6, 2023 12:27
wattanx
wattanx reviewed Sep 6, 2023
View reviewed changes
Copy link
Collaborator

@wattanx wattanx left a comment

Choose a reason for hiding this comment

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

Sorry, A description of the defineNuxtPlugin compatible with Nuxt 3 can be found at https://nuxt.com/docs/bridge/plugins-and-middleware.

What is explained here is how to migrate from @nuxtjs/composition-api to Nuxt Bridge's capi.legacy.

wattanx
wattanx requested changes Sep 6, 2023
View reviewed changes
Copy link
Collaborator

@wattanx wattanx left a comment •
edited

Choose a reason for hiding this comment

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

I have approve it by mistake.(I don't know how to cancel approve. 😢 )

@adrienZ
Copy link
Sponsor Contributor Author

adrienZ commented Sep 6, 2023

Sorry, A description of the defineNuxtPlugin compatible with Nuxt 3 can be found at https://nuxt.com/docs/bridge/plugins-and-middleware.

What is explained here is how to migrate from @nuxtjs/composition-api to Nuxt Bridge's capi.legacy.

i'm confused is this synthax from nuxt/bridge readme (https://github.com/nuxt/bridge#new-plugins-format-optional) not available anymore ? the defineNuxtPlugin has been removed from nuxt bridge then ?

@wattanx
Copy link
Collaborator

wattanx commented Sep 6, 2023 •
edited

No, it has not been deleted.
There is no need to change to defineNuxtPlugin If you just delete @nuxtjs/composition-api.(When migrating to Nuxt 3, you will need to migrate to the new defineNuxtPlugin.)
So the migration to defineNuxtPlugin is described on a separate page.(Because of the possible difficulties in migrating to the new defineNuxtPlugin.)

@danielroe
Copy link
Member

Maybe, instead of making this change to the code example, we could add a note after the example that there is a new defineNuxtPlugin and link to the page where it is explained?

@wattanx
Copy link
Collaborator

wattanx commented Sep 28, 2023

Maybe, instead of making this change to the code example, we could add a note after the example that there is a new defineNuxtPlugin and link to the page where it is explained?

I think that suggestion is a good one.

wattanx
wattanx approved these changes Nov 12, 2023
View reviewed changes
Copy link
Collaborator

@wattanx wattanx left a comment

Choose a reason for hiding this comment

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

looks good to me!

@danielroe danielroe merged commit 36798e8 into nuxt:main Nov 13, 2023
4 checks passed
@github-actions github-actions bot mentioned this pull request Nov 13, 2023
Merged
manniL pushed a commit that referenced this pull request Dec 11, 2023
@adrienZ @manniL
docs: mention new defineNuxtPlugin syntax in bridge migration (#23036)
63f5f26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@danielroe danielroe danielroe approved these changes

@wattanx wattanx wattanx approved these changes

Assignees
No one assigned
Labels
3.x documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@adrienZ @wattanx @danielroe