-
-
Notifications
You must be signed in to change notification settings - Fork 3.7k
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
Unified button and command naming convention #8394
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's call it half-time review but for now I think that you could:
- Fix the changes in the
CHANGELOG.md
files. - Update the docs (see comment).
After @Reinmar yay/no we should finish this PR if changes are needed.
Additionally, you can also rewrite the merge message as for now it is too mangled (all the changes in one line). If you don't have an idea about this we can think about that later, after all the changes. For start, I would split the massage for each plugin:
etc. Also, we need to list all the breaking changes for the renamed classes, for instance:
|
After this half-time review all requested changes have been done:
|
Oh dear :D Yup, I didn't think about this. So, I'm for changing it so it's consistent. If we touch anything, let's touch everything. However, I'm leaning towards postponing this change til January's release. I have a feeling that we'll have a lot of breaking changes in it, or at least significant conceptual changes, so the rename would be less of a PITA there. |
Since many buttons and commands are available as aliases, we don't introduce many minor/major breaking changes. Hence, I'd like to propose a little bit different merge massage:
@psmyrek, WDYT? |
In toolbar buttons there is also There is no such thing like In commands there is also Renamed files:
|
Suggested merge commit message (convention)
Other: Unified buttons, and commands naming convention. Old values are available as aliases. Read more about those changes in the Code style guide. Closes #8033.
Changes in toolbar buttons (before → after):
imageUpload
→uploadImage
imageResize
→resizeImage
imageInsert
→insertImage
imageResize:*
→resizeImage:*
Changes in command names:
imageInsert
→insertImage
imageUpload
→uploadImage
imageResize
→resizeImage
forwardDelete
→deleteForward
todoListCheck
→checkTodoList
MAJOR BREAKING CHANGE (list): The following module
list/todolistcheckedcommand~TodoListCheckCommand
has been moved tolist/checktodolistcommand~CheckTodoListCommand
.MAJOR BREAKING CHANGE (image): The following modules have been moved (before → after)
image/image/imageinsertcommand~ImageInsertCommand
→image/image/insertimagecommand~InsertImageCommand
image/imageresize/imageresizecommand~ImageResizeCommand
→image/imageresize/resizeimagecommand~ResizeImageCommand
image/imageupload/imageuploadcommand~ImageUploadCommand
→image/imageupload/uploadimagecommand~UploadImageCommand
Additional information
ADR has been created: https://github.com/cksource/ckeditor5-internal/pull/426