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

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

Merged
merged 8 commits into from Mar 8, 2023
Merged

Conversation

psmyrek
Copy link
Contributor

@psmyrek psmyrek commented Mar 7, 2023

Suggested merge commit message (convention)

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 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 in 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 name of the event and the typedoc-plugin-tag-event plugin was trying to guess which reflection should be the owner of this event. Now, the @eventName value must be a valid identifier (link) to the event owner, which can be a class or an interface, to which given event will be attached. The owner of every event must be explicitly defined. The identifier can be relative or absolute.


Additional information

For example – encountered issues, assumptions you had to make, other affected tickets, etc.

@coveralls
Copy link

coveralls commented Mar 7, 2023

Coverage Status

Coverage: 89.691%. Remained the same when pulling 7584e85 on ck/13553 into 2c124be on master.

@psmyrek psmyrek changed the title Ck/13553 Typedoc - event plugin should not guessing an event owner Mar 7, 2023
@psmyrek psmyrek requested a review from pomek March 7, 2023 13:13
Copy link
Member

@pomek pomek left a comment

Choose a reason for hiding this comment

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

LGTM.

@pomek pomek merged commit de7523a into master Mar 8, 2023
@pomek pomek deleted the ck/13553 branch March 8, 2023 10:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants