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

[Document list] How to expose its DLL? #11610

Closed
Reinmar opened this issue Apr 11, 2022 · 4 comments · Fixed by #11660
Closed

[Document list] How to expose its DLL? #11610

Reinmar opened this issue Apr 11, 2022 · 4 comments · Fixed by #11660
Assignees
Labels
package:list squad:core Issue to be handled by the Core team. type:task This issue reports a chore (non-production change) and other types of "todos".

Comments

@Reinmar
Copy link
Member

Reinmar commented Apr 11, 2022

Part of #11377.

The problem right now is that list's src/index.js exposes only the old list feature.

How can we expose document list's DLL?

Options:

Option 1. Add to ckeditor5-list/src/index.js

  • Pros:
    • KISS
    • Will motivate us to sunset old lists faster ;)
  • Cons:
    • Doubled size of the DLL (and you'll never use two of these features at once)
    • If we'll go this way, moving to opt 2 or 3 later on will be a BC

Option 2. Move entire DocLists to a new package

  • Pros:
    • Clean
    • Optimal size
  • Cons:
    • Both features depend on the same UI, so where would we keep it and how would we import it? Answer: we'd import from ckeditor5-list/src/....
    • What will we do once the old lists are sunset in the future?

Option 3. Create a new ckeditor5-document-list package just for the DLL

And have only src/index.js there. It'd import module directly from ckeditor5-list. We'd ignore the cross-package import rule there.

  • Pros:
    • Smart
    • Optimal size
    • No issue with sharing the same UI
  • Cons:
    • Slightly confusing (it's a workaround rather than a solution)
@Reinmar Reinmar added type:task This issue reports a chore (non-production change) and other types of "todos". package:list squad:core Issue to be handled by the Core team. labels Apr 11, 2022
@wimleers
Copy link

Sounds like this should be decided/fixed tomorrow since otherwise this crucial aspect of CKEditor 5 v34.0.0 will not be available to Drupal? 😅

@Reinmar
Copy link
Member Author

Reinmar commented Apr 11, 2022

Unfortunately, we'll not be able to fix it by tomorrow. I know that it blocks you from testing this feature straight from npm, but it wasn't enough time for us to process this.

The good news may be that with options 2 and 3 we don't have to wait till the next release.

@CKEditorBot CKEditorBot added the status:planned Set automatically when an issue lands in the "Sprint backlog" column. We will be working on it soon. label Apr 20, 2022
@Reinmar
Copy link
Member Author

Reinmar commented Apr 20, 2022

It's been an interesting discussion and it turns out that great majority of us are for the KISS option, so option 1. Let's do this and see if we can release a patched version ASAP.

@arkflpc arkflpc self-assigned this Apr 21, 2022
@CKEditorBot CKEditorBot added status:in-progress Set automatically when an issue lands in the "In progress" column. We are working on it. and removed status:planned Set automatically when an issue lands in the "Sprint backlog" column. We will be working on it soon. labels Apr 21, 2022
@arkflpc
Copy link
Contributor

arkflpc commented Apr 22, 2022

DLL grew from 65705 to 92104 bytes (18122 to 24631 gzipped).

@Reinmar Reinmar added this to the iteration 53 milestone Apr 24, 2022
@CKEditorBot CKEditorBot removed the status:in-progress Set automatically when an issue lands in the "In progress" column. We are working on it. label Apr 24, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
package:list squad:core Issue to be handled by the Core team. type:task This issue reports a chore (non-production change) and other types of "todos".
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants