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.

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

add missing migration note for isEditor to NodeApi.isEditor #4017

Merged
merged 5 commits into from
Jan 22, 2025

Conversation

joshgillies
Copy link
Contributor

Checklist

  • yarn typecheck
  • yarn lint:fix
  • yarn test
  • yarn brl
  • yarn changeset
  • ui changelog

Copy link

codesandbox bot commented Jan 22, 2025

Review or Edit in CodeSandbox

Open the branch in Web EditorVS CodeInsiders

Open Preview

Copy link

changeset-bot bot commented Jan 22, 2025

⚠️ No Changeset found

Latest commit: 2556313

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

vercel bot commented Jan 22, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
plate ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 22, 2025 8:49am

@joshgillies
Copy link
Contributor Author

I note the internal API for isEditor was removed here #3952 in favor of the NodeApi.isEditor method. However during a recent migration from @udecode/plate@40 I found the migration guide misleading due to the following: `

- `isEditor` -> `editor.api.isEditor`

This PR aims to avoid confusion for anyone else doing the upgrade.

@zbeyens
Copy link
Member

zbeyens commented Jan 22, 2025

Good catch, could you instead update the changelog / BREAKING_CHANGES.md? There is no added value to make it overridable in editor.api.

@joshgillies
Copy link
Contributor Author

You mean change the BREAKING_CHANGES.md to:

- - `isEditor` -> `editor.api.isEditor` 
+ - `isEditor` -> `NodeApi.isEditor` 

@joshgillies joshgillies changed the title add missing editor.api.isEditor method add missing migration note for isEditor to NodeApi.isEditor Jan 22, 2025
@joshgillies
Copy link
Contributor Author

@zbeyens have update the breaking changes to reflect the updates. Let me know if there's anything else

@zbeyens
Copy link
Member

zbeyens commented Jan 22, 2025

Thanks! The changeset can be removed.

@joshgillies
Copy link
Contributor Author

No problem, thanks 😄

@zbeyens zbeyens merged commit e15590d into udecode:main Jan 22, 2025
1 of 2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants