search

kamiazya / typedoc-plugin-mermaid

A plugin for TypeDoc that generates graphs for mermaid.js diagrams by @mermaid annotation.
https://www.npmjs.com/package/typedoc-plugin-mermaid
MIT License
27 stars 9 forks source link

Update dependencies and configuration files #846

Closed kamiazya closed 2 months ago

kamiazya commented 2 months ago

This pull request updates the dependencies and configuration files of the project.

It includes changes such as:

Summary by CodeRabbit

changeset-bot[bot] commented 2 months ago

🦋 Changeset detected

Latest commit: ef811a5a534ec39b2fbf649b9d0f32041f5ec900

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[bot] commented 2 months ago

Walkthrough

The changes introduce multiple updates and enhancements to the typedoc-plugin-mermaid package, including migrating tools, updating configurations, refining CI/CD workflows, and improving code quality and build processes. These updates streamline development, enhance compatibility with Node.js 16+, and ensure robust CI/CD practices.

Changes

File/Path Summary
.changeset/README.md Added documentation for @changesets/cli tool.
.changeset/*.md Introduced patches and updates for typedoc-plugin-mermaid, including tool migrations and type checks.
.changeset/config.json Added configuration settings for changelogs and repository information.
.github/actions/setup/action.yaml Introduced a setup action for CI/CD workflows.
.github/workflows/cicd.yaml Added a CI/CD workflow with jobs for linting, type checking, building, testing, and releasing.
.node-version Specified Node.js version as 20.
biome.json Added configuration for Biome tool.
example/package.json Updated dependencies and set package as private.
example/tsconfig.json Removed exclusion of node_modules.
example/typedoc.json Updated paths for entryPoints and plugin.
package.json Updated main file paths, scripts, dependencies, and added new dev dependencies.
pnpm-workspace.yaml Configured workspace for two packages.
src/index.ts Updated import statement for MermaidPlugin.
src/plugin.ts Rearranged imports and updated method parameter names.
test/plugin.test.ts Refactored initialization of MermaidPlugin within a beforeAll block.
tsconfig.json Modified include and exclude sections for alignment.
vite.config.ts Configured Vite for building the library with specified entry points and formats.

Poem

In the realm of code so bright,
Changes dance in pure delight.
Tools now migrate, scripts refine,
CI/CD workflows align.
Node.js stands tall, version twenty,
With Biome's touch, fixes plenty.
Typedoc sings with Mermaid's charm,
In this update, there's no alarm.
🌟✨🐇

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.