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

[lexical-markdown] Breaking Change: rename 'multilineElement' to 'multiline-element' #6617

Merged
merged 2 commits into from
Sep 11, 2024

Conversation

potatowagon
Copy link
Contributor

Description

to be consistent with other types like text-match, text-format

Test plan

see automated tests

Copy link

vercel bot commented Sep 10, 2024

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

Name Status Preview Comments Updated (UTC)
lexical ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 10, 2024 2:04pm
lexical-playground ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 10, 2024 2:04pm

@facebook-github-bot facebook-github-bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Sep 10, 2024
Copy link

github-actions bot commented Sep 10, 2024

size-limit report 📦

Path Size
lexical - cjs 29.61 KB (0%)
lexical - esm 29.49 KB (0%)
@lexical/rich-text - cjs 38.07 KB (0%)
@lexical/rich-text - esm 31.3 KB (0%)
@lexical/plain-text - cjs 36.72 KB (0%)
@lexical/plain-text - esm 28.65 KB (0%)
@lexical/react - cjs 39.89 KB (0%)
@lexical/react - esm 32.79 KB (0%)

@potatowagon potatowagon marked this pull request as draft September 10, 2024 13:54
@@ -432,7 +432,7 @@ export function transformersByType(transformers: Array<Transformer>): Readonly<{

return {
element: (byType.element || []) as Array<ElementTransformer>,
multilineElement: (byType.multilineElement ||
multilineElement: (byType['multiline-element'] ||
Copy link
Contributor Author

Choose a reason for hiding this comment

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

im not sure of the historical reason why kebab case was originally chosen as the type name convention.

im open to switching everything to lowerCamelCase if theres a compelling reason

@etrepum etrepum added the extended-tests Run extended e2e tests on a PR label Sep 10, 2024
Copy link
Collaborator

@etrepum etrepum left a comment

Choose a reason for hiding this comment

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

This looks fine to me, I don't see a compelling reason to use kebab convention other than backwards compatibility and consistency. We don't export these constants so I think we are kinda stuck with the existing value for text-format.

@potatowagon potatowagon added this pull request to the merge queue Sep 11, 2024
Merged via the queue into main with commit 5c82b38 Sep 11, 2024
45 of 46 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. extended-tests Run extended e2e tests on a PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants