Skip to content

Fix: Crashed when CKEditor 4 objects were in toolbar config #10

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

fsbraun
Copy link
Member

@fsbraun fsbraun commented Mar 26, 2025

Setting:

   'toolbar_CMS': [
        {'name': 'clipboard', 'items': ['Undo', 'Redo', '-', 'Cut', 'Copy', 'Paste', 'PasteText']},
        {'name': 'editing', 'items': ['Find', '-', 'Scayt']},        
        ['cmsplugins', '-','Anchor'], # 'ShowBlocks'],        
        ['Maximize', ''],
        '/',
        ['Bold', 'Italic', 'Underline', '-', 'Subscript', 'Superscript', '-', 'RemoveFormat', 'FontSize', 'TextColor', 'BGColor'],
        ['JustifyLeft', 'JustifyCenter', 'JustifyRight', 'JustifyBlock'],       
        ['NumberedList', 'BulletedList', '-', 'Outdent', 'Indent', '-', 'HorizontalRule', '-', 'Table'],
         #['Link', 'Unlink'],['Image'],
        ['Source']
    ],

image

Copy link
Contributor

sourcery-ai bot commented Mar 26, 2025

Reviewer's Guide by Sourcery

This pull request fixes a crash that occurred when CKEditor 4 objects were present in the toolbar configuration. The fix involves updating the toolbar building logic to correctly handle different types of toolbar items, including arrays and items with a nested 'items' property. Additionally, a type check was added to ensure that block items are strings before being added to the block toolbar in inline mode.

Sequence diagram for building toolbars

sequenceDiagram
  participant CmsCKEditor5Plugin
  participant toolbarConfig

  CmsCKEditor5Plugin->>toolbarConfig: buildToolbars(toolbarConfig)
  loop For each item in toolbarConfig
    alt item is array or item.items is array
      CmsCKEditor5Plugin->>CmsCKEditor5Plugin: buildToolbars(item or item.items)
    else item is a block item and inline mode
      CmsCKEditor5Plugin->>CmsCKEditor5Plugin: Add item to blockToolbar if item is string
    else
      CmsCKEditor5Plugin->>CmsCKEditor5Plugin: Add item to topToolbar or blockToolbar
    end
  end
Loading

Updated class diagram for CmsCKEditor5Plugin

classDiagram
  class CmsCKEditor5Plugin {
    -_blockItems
    +init()
    +buildToolbars(toolbarConfig)
  }
  note for CmsCKEditor5Plugin "Fixes a crash when CKEditor 4 objects were in toolbar config"
Loading

File-Level Changes

Change Details Files
Updated toolbar building logic to handle CKEditor 4 objects in the toolbar configuration.
  • Modified the condition to check if a toolbar item is an array or has an 'items' property that is an array.
  • Updated the buildToolbars function call to handle both array items and items with a nested 'items' property.
private/js/cms.ckeditor5.js
Added a type check to ensure block toolbar items are strings in inline mode.
  • Added a check to ensure that the item is a string before checking if it is a block item and adding it to the block toolbar.
private/js/cms.ckeditor5.js

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @fsbraun - I've reviewed your changes - here's some feedback:

Overall Comments:

  • The condition Array.isArray[item.items] looks wrong, did you mean Array.isArray(item.items)?
  • The ternary operator Array.isArray[item] ? item : item.items also looks wrong, did you mean Array.isArray(item) ? item : item.items?
Here's what I looked at during the review
  • 🟡 General issues: 2 issues found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

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.

1 participant