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.

Sign up for GitHub

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

Jump to bottom

Typedoc - event plugin should not guessing an event owner #13553

Closed
pomek opened this issue Feb 24, 2023 · 1 comment · Fixed by ckeditor/ckeditor5-dev#853
Closed

Typedoc - event plugin should not guessing an event owner #13553

pomek opened this issue Feb 24, 2023 · 1 comment · Fixed by ckeditor/ckeditor5-dev#853
Assignees
@psmyrek
Labels
package:dev squad:devops Issue to be handled by the Devops team. type:task This issue reports a chore (non-production change) and other types of "todos".
Milestone
iteration 61 (v37...

Comments

@pomek
Copy link
Member

pomek commented Feb 24, 2023

Provide a description of the task

As in the title, we should not guess anything. Instead, the integrator should point to an owner class that emits a given event.

Related: #13534 (comment).
@pomek pomek added type:task This issue reports a chore (non-production change) and other types of "todos". squad:devops Issue to be handled by the Devops team. package:dev labels Feb 24, 2023
@pomek
Copy link
Member Author

pomek commented Mar 1, 2023

Scope

@CKEditorBot CKEditorBot added status:planned Set automatically when an issue lands in the "Sprint backlog" column. We will be working on it soon. and removed status:planned Set automatically when an issue lands in the "Sprint backlog" column. We will be working on it soon. labels Mar 1, 2023
@psmyrek psmyrek self-assigned this Mar 6, 2023
@CKEditorBot CKEditorBot added the status:in-progress Set automatically when an issue lands in the "In progress" column. We are working on it. label Mar 6, 2023
@psmyrek psmyrek mentioned this issue Mar 7, 2023
Merged
pomek added a commit to ckeditor/ckeditor5-dev that referenced this issue Mar 8, 2023
@pomek
Merge pull request #853 from ckeditor/ck/13553
de7523a 
Other (typedoc-plugins): Changed the way events are defined. The value of the `@eventName` tag must be a valid identifier (link) to a class or an interface to which a given event should be attached. Closes ckeditor/ckeditor5#13553.

Other (typedoc-plugins): Extended the scope of the `typedoc-plugin-event-inheritance-fixer` plugin. So far, only inherited events in classes and the `Observable` interface have been checked. Now, support for inherited events has been added to all interfaces, so all derived classes and interfaces will contain all inherited events.

Feature (typedoc-plugins): Added support for multiple `@eventName` tags defined for one exported type. One exported type can now be used to create multiple events, even in different (not related to each other) classes or interfaces.

Internal (typedoc-plugins): Added all TypeDoc plugins (as paths to the plugin source) to the export from the package. This makes it easier to use them when creating a TypeDoc instance.

MAJOR BREAKING CHANGE (typedoc-plugins): Changed the way events are defined. Previously, the value from the `@eventName` tag was simply the event's name, and the `typedoc-plugin-tag-event` plugin was trying to guess which reflection should be the owner of this event. The `@eventName` value must be a valid identifier (link) to the event owner, which can be a class or an interface to which a given event will be attached. The owner of every event must be explicitly defined. The identifier can be relative or absolute.
@CKEditorBot CKEditorBot removed the status:in-progress Set automatically when an issue lands in the "In progress" column. We are working on it. label Mar 8, 2023
@CKEditorBot CKEditorBot added this to the iteration 61 milestone Mar 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@psmyrek psmyrek

Labels
package:dev squad:devops Issue to be handled by the Devops team. type:task This issue reports a chore (non-production change) and other types of "todos".
Projects
None yet
Milestone
iteration 61 (v37.0.0)
Development

Successfully merging a pull request may close this issue.

Typedoc - event plugin should not guessing an event owner ckeditor/ckeditor5-dev
3 participants
@pomek @CKEditorBot @psmyrek