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

[TS] EditorConfig misses licenseKey ('licenseKey' does not exist in type 'EditorConfig') #13906

Closed
mmichaelis opened this issue Apr 18, 2023 · 2 comments · Fixed by #13918
Closed
Assignees
Labels
domain:ts squad:core Issue to be handled by the Core team. type:bug This issue reports a buggy (incorrect) behavior.

Comments

@mmichaelis
Copy link

📝 Provide detailed reproduction steps (if any)

  1. Follow the setup of ClassicEditor as, for example, given in Overview - CKEditor 5 Documentation.

✔️ Expected result

Given the licenseKey as option, it compiles successfully.

❌ Actual result

It fails to compile as licenseKey is not part of EditorConfig.

More Notes

Possibly related to:

Also note, that this is a migration issue, when coming from typings at DefinitelyTyped, where EditorConfig had a licenseKey:

(I think in previous versions, it even got marked as "required" property, why we still have it in our code.)

Workaround for us

We don't need the licenseKey (yet) and may safely skip it.

📃 Other details

  • Browser: Chrome
  • OS: Windows
  • First affected CKEditor version: 37.0.1
  • Installed CKEditor plugins: irrelevant (we don't have any plugins by default, that require a license)

If you'd like to see this fixed sooner, add a 👍 reaction to this post.

@mmichaelis mmichaelis added the type:bug This issue reports a buggy (incorrect) behavior. label Apr 18, 2023
mmichaelis added a commit to CoreMedia/ckeditor-plugins that referenced this issue Apr 18, 2023
This is not a required property (it possibly once was for first
typings from DefinitelyTyped). And: The property is currently not
available in typings from CKEditor: ckeditor/ckeditor5#13906

See-also: ckeditor/ckeditor5#13906
@Witoso Witoso added domain:ts squad:core Issue to be handled by the Core team. labels Apr 19, 2023
@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 19, 2023
@Witoso
Copy link
Member

Witoso commented Apr 19, 2023

Thanks for the report and catching that. Some of our premium plugins are augmenting this config but for backward compatibility, we will add it to the main EditorConfig.

@Witoso Witoso changed the title [TS] EditorConfig misses licenseKey [TS] EditorConfig misses licenseKey ('licenseKey' does not exist in type 'EditorConfig') Apr 19, 2023
@Witoso
Copy link
Member

Witoso commented Apr 19, 2023

While we work on a fix and release, the workaround is to either:

  • Remove licenseKey if you don't need it.
  • Add module augmentation:
    declare module "@ckeditor/ckeditor5-core" {
      interface EditorConfig {
        licenseKey?: string;
      }
    }

@filipsobol filipsobol self-assigned this Apr 19, 2023
@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 19, 2023
arkflpc added a commit that referenced this issue Apr 19, 2023
…itorconfig

Fix (core): Add `licenseKey` property to `EditorConfig` interface. Closes #13906.
@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 19, 2023
@CKEditorBot CKEditorBot added this to the iteration 63 milestone Apr 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
domain:ts squad:core Issue to be handled by the Core team. type:bug This issue reports a buggy (incorrect) behavior.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants