Skip to content

Replace typeDocExperimentalTagFixer() with TypeDoc's cascadedModifierTags option#1345

Merged
pomek merged 1 commit intomasterfrom
ck/20039
Apr 7, 2026
Merged

Replace typeDocExperimentalTagFixer() with TypeDoc's cascadedModifierTags option#1345
pomek merged 1 commit intomasterfrom
ck/20039

Conversation

@pomek
Copy link
Copy Markdown
Member

@pomek pomek commented Apr 3, 2026

🚀 Summary

  • Remove the typeDocExperimentalTagFixer() plugin introduced in v55.4.0.
  • Configure TypeDoc's built-in cascadedModifierTags option to exclude @experimental, preventing it from cascading to class members that do not explicitly declare it.
  • Add a test in ckeditor5-dev-docs verifying that @experimental is absent from the cascadedModifierTags config passed to TypeDoc.
  • Update the typedoc-plugins README and changelog entry accordingly.

📌 Related issues


💡 Additional information

  • The native cascadedModifierTags option is a simpler and more reliable solution than the custom plugin — TypeDoc handles the filtering itself before the @experimental tag ever reaches the output.

Copy link
Copy Markdown

@cursor cursor bot left a comment

Choose a reason for hiding this comment

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

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Fix All in Cursor

Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.

@pomek
Copy link
Copy Markdown
Member Author

pomek commented Apr 3, 2026

  • Input:
    image

  • Output:
    image

    image

@pomek pomek requested a review from psmyrek April 3, 2026 11:06
@psmyrek
Copy link
Copy Markdown
Contributor

psmyrek commented Apr 3, 2026

Btw, have you checked this option? 😅

@pomek
Copy link
Copy Markdown
Member Author

pomek commented Apr 3, 2026

WFM. Changes in progress.

@pomek pomek changed the title Preserve explicit @experimental tags without inline notices Replace typeDocExperimentalTagFixer() with TypeDoc's cascadedModifierTags option Apr 3, 2026
@pomek pomek force-pushed the ck/20039 branch 2 times, most recently from 42de05f to b58c941 Compare April 3, 2026 12:20
@pomek
Copy link
Copy Markdown
Member Author

pomek commented Apr 3, 2026

@psmyrek, WFM. Ready to review.

…5.4.0) with TypeDoc's built-in `cascadedModifierTags` option to prevent the `@experimental` modifier tag from cascading to class members that do not explicitly declare it.
@pomek
Copy link
Copy Markdown
Member Author

pomek commented Apr 3, 2026

Results:

image image

@pomek pomek merged commit 6b7ed78 into master Apr 7, 2026
6 of 8 checks passed
@pomek pomek deleted the ck/20039 branch April 7, 2026 06:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

@experimental without inline notice is stripped from API docs members

2 participants