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

Check if DLL can be exposed in ckeditor5 main repository #8578

Closed
jodator opened this issue Dec 3, 2020 · 1 comment
Closed

Check if DLL can be exposed in ckeditor5 main repository #8578

jodator opened this issue Dec 3, 2020 · 1 comment
Assignees
Labels
domain:dx This issue reports a developer experience problem or possible improvement. type:task This issue reports a chore (non-production change) and other types of "todos".

Comments

@jodator
Copy link
Contributor

jodator commented Dec 3, 2020

Provide a description of the task

At this point, I think that we need to validate the last problem, which is - where to expose those paths (questions 2 & 3 in #8517 (comment)). The idea is to add a bigger reason for the ckeditor5 package. It would also make imports a bit more sane, in that term that it would provide imports as:

import { Plugin } from 'ckeditor5/core';

At the time of writing this issue, the #8517 issue branch uses ckeditor5-dll to provide DLL build. The imports paths look like below:

import { Plugin } from '@ckeditor/ckeditor5-core/core`

This is because we would like to keep the ability to have imports to work the same way as in today's build using direct imports.

This of course requires an entry file in each package that exports public-public API:

// file `core.js` in the `ckeditor5-core` package direclyt (not in /src).
export { default as Plugin } from './src/plugin';
export { default as Command } from './src/command';
export { default as Editor } from './src/editor/editor';

This is also duplicated by the core.js file inside ckeditor5-dll package:

export * from '@ckeditor/ckeditor5-core/core';

Things to validate when moving those files from ckeditor5-dll to ckeditor5:

  • Does the DLL is built the same way?
  • I think that we need to change from where we're importing stuff. So every import form @ckeditor/ckeditor5-feature should be changed to ckeditor5/feature.
  • Do the yarn/npm workspace handle cyclic import?
    •  We put every package to the ckeditor5/packages but every package might also require one ckeditor5 instead of the current mix of packages (mostly uitls, ui & core).
  • Do the test, manual tests, and docs works?

I do not consider this as a blocker to the main task, rather as an improvement.

@jodator jodator added type:task This issue reports a chore (non-production change) and other types of "todos". domain:dx This issue reports a developer experience problem or possible improvement. squad:dx labels Dec 3, 2020
@jodator jodator added this to the iteration 39 milestone Dec 3, 2020
@jodator jodator self-assigned this Dec 7, 2020
pomek added a commit that referenced this issue Dec 8, 2020
Internal: Move DLL definition to main CKEditor5 package. Closes #8578.
@pomek
Copy link
Member

pomek commented Dec 8, 2020

Closed with 80790e6.

@jodator jodator closed this as completed Dec 8, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
domain:dx This issue reports a developer experience problem or possible improvement. type:task This issue reports a chore (non-production change) and other types of "todos".
Projects
None yet
Development

No branches or pull requests

2 participants