Update typedoc to 0.26

[kamiazya]

This pull request updates the typedoc version to 0.26.

The changes include adding a new file tsdoc.json and updating the package.json file to include the new version of typedoc. Additionally, the src/plugin.ts file has been modified to fix an issue with the onEndPage event.

Summary by CodeRabbit

• New Features

  • Added support for the @mermaid tag in TSDoc comments using the typedoc-plugin-mermaid plugin.
  • Introduced a tsdoc.json configuration file for TSDoc documentation.

• Bug Fixes

  • Simplified event handling logic in the MermaidPlugin class for improved performance.

• Documentation

  • Updated the README with instructions for using the @mermaid tag and setting up TSDoc configuration.

• Chores

  • Updated the typedoc version in devDependencies to ^0.26.3.

[changeset-bot]

🦋 Changeset detected

Latest commit: d5e3de5

The changes in this PR will be included in the next version bump.

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[coderabbitai]

Warning

Rate limit exceeded

@kamiazya has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 12 minutes and 48 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between a3adc67 and d5e3de5.

Walkthrough

This update introduces several improvements across the project. It upgrades the typedoc dependency to version ^0.26.3 and includes a new tsdoc.json configuration file for TSDoc documentation. Enhancements were made to the MermaidPlugin class for better event handling, and the documentation was updated to guide the usage of the new @mermaid tag with the TypDoc plugin. The package.json was also adjusted to reflect these updates appropriately.

Changes

Files	Change Summary
example/package.json	Updated typedoc version in devDependencies from ^0.25.13 to ^0.26.3.
example/tsdoc.json, tsdoc.json	Introduced new TSDoc JSON configuration file with a tag definition for @mermaid.
package.json	Added tsdoc.json mapping, included it in the files array, and updated typedoc versions.
src/plugin.ts	Adjusted event handling in MermaidPlugin class for better parameter passing and registration.
README.md	Added instructions for using the @mermaid tag in tsdoc comments with the TypDoc plugin.

Poem

🐇
In the world of docs, where code and words align,
A mermaid tag now joins, with update divine.
Typedoc shines bright, in version fresh and new,
A plugin's flow refined, improving all we do.
Configuration smooth, our journey's set anew,
Hopping through the changes, here's a toast to you!
🐇

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between b1b10d3 and 1ddcfb9.

Files ignored due to path filters (1)

• pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml

Files selected for processing (5)

• example/package.json (1 hunks)
• example/tsdoc.json (1 hunks)
• package.json (3 hunks)
• src/plugin.ts (2 hunks)
• tsdoc.json (1 hunks)

Files skipped from review due to trivial changes (3)

• example/package.json
• example/tsdoc.json
• tsdoc.json

Additional comments not posted (5)

package.json (4)

12-13: LGTM! Added tsdoc.json to exports.

This change ensures that the tsdoc.json file is included in the package exports, making it available for other modules to import.

---

40-41: LGTM! Added tsdoc.json to files.

This change ensures that the tsdoc.json file is included in the package when it is published.

---

58-58: LGTM! Updated typedoc version range in peerDependencies.

This change ensures compatibility with the latest version of typedoc.

---

66-66: LGTM! Updated typedoc version in devDependencies.

This change updates the development dependency to the latest version of typedoc.

src/plugin.ts (1)

96-97: LGTM! Simplified event registration for PageEvent.END.

This change improves the readability and maintainability of the code.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 1ddcfb9 and a3adc67.

Files selected for processing (1)

• README.md (1 hunks)

Files skipped from review due to trivial changes (1)

• README.md