Version Packages

[github-actions]

This PR was opened by the Changesets release GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to main, this PR will be updated.

Releases

[email protected]

Minor Changes

• #846 b5f14d9 Thanks @kamiazya! - Explicitly state that Node.js 16 or higher should be guaranteed to work with the latest TypeDoc

• #846 b5f14d9 Thanks @kamiazya! - Update CI/CD Workflow

Patch Changes

• #848 6cfbec8 Thanks @kamiazya! - Add Dependabot setting for GitHub Actions

• #846 b5f14d9 Thanks @kamiazya! - Migrate formater and linter to biome from eslint and prettier

• #846 b5f14d9 Thanks @kamiazya! - Add "provenance" flag to publishConfig in package.json

• #846 b5f14d9 Thanks @kamiazya! - Add typecheck script for TypeScript type checking

• #846 b5f14d9 Thanks @kamiazya! - Introduce Changeset.

• #855 e6a50a8 Thanks @dependabot! - Bump vite from 5.2.13 to 5.3.0

• #846 b5f14d9 Thanks @kamiazya! - Migrate package manager to pnpm from yarn

  • Setup pnpm workspace and ignore "example" in Changeset configuration

• #850 1bd966a Thanks @dependabot! - Bump @types/html-escaper from 3.0.0 to 3.0.2

• #846 b5f14d9 Thanks @kamiazya! - Update package.json exports

• #856 72cb8ae Thanks @kamiazya! - Update README for TypeDoc 0.24 and 0.25

• #846 b5f14d9 Thanks @kamiazya! - Migrate build and test tool to vite/vitest from rollup/jest

• #849 201c620 Thanks @kamiazya! - Add GitHub workflow to update copyright year in license file

• #853 0e81ccd Thanks @kamiazya! - Add Snapshot release workflows

  • New Features
    • Introduced snapshot release automation for pull requests using GitHub Actions.
    • Added new GitHub Action to perform snapshot releases based on specific comments.
    • Implemented a prerelease job in CI/CD workflow for automated next version releases.
  • Improvements
    • Added new configuration options for snapshots to support pre-release templates and calculated versions.
    • Improved GitHub Actions setup with an option to skip the checkout step for better performance.
  • Automation
    • Enhanced workflow automation including permission checks, artifact handling, and snapshot release validation.

• #851 58ac7bc Thanks @dependabot! - Bump actions/checkout from 4.1.6 to 4.1.7

• #846 b5f14d9 Thanks @kamiazya! - Update dependencies and configuration files

Summary by CodeRabbit

• New Features

  • Added compatibility with Node.js 16.
  • Introduced snapshot release automation and workflows for automated releases based on specific comments.
  • Added a "provenance" flag in publishConfig.

• Enhancements

  • Improved TypeScript type checking.
  • Updated CI/CD workflows.
  • Migrated formatting and linting tools to biome.
  • Improved GitHub Actions setup for better workflow automation.

• Dependency Updates

  • Bumped vite from 5.2.13 to 5.3.0.
  • Bumped @types/html-escaper from 3.0.0 to 3.0.2.
  • Bumped actions/checkout from 4.1.6 to 4.1.7.

• Documentation

  • Updated README for TypeDoc 0.24 and 0.25.
  • Reformatted keywords field in package.json for better readability.

[coderabbitai]

Walkthrough

The typedoc-plugin-mermaid has released version 1.11.0, bringing improved Node.js compatibility, CI/CD workflow updates, Dependabot settings, and enhanced tools for formatting, linting, and type checking. Other key updates include new snapshot release workflows, improved automation, revamped exports, and updates for TypeScript, Vite, and Vitest for better build and test processes.

Changes

File(s)/Area	Change Summary
CHANGELOG.md	Added a short summary of updates in version 1.11.0.
compatibility, dependencies, package.json	Explicitly stated Node.js 16 requirement and reformatted keywords; updated versions and dependency packages
CI/CD workflows, .github/workflows	Updated CI/CD workflows, Dependabot settings, added a new snapshot release workflow and automation features
linting, formatting, .biome/*	Migrated to Biome for linting and formatting from ESLint and Prettier
typescript, typecheck, package.json, tsconfig	Added TypeScript type checking script and related configurations
build, test, vite, vitest, package.json	Migrated build and test tools to Vite and Vitest from Rollup and Jest
README.md, docs	Updated documentation for TypeDoc 0.24 and 0.25
package.json	Added provenance flag to publishConfig, updated exports, and restructured for enhanced configuration options
dependencies, GitHub Actions	Bumped versions for dependencies and GitHub Actions including @types/html-escaper and actions/checkout

Poem

typedoc dances with mermaid's grace,
Bringing flows and graphs to trace,
With Node sixteen in the mix,
Enhanced workflows and type checks fix,
Snapshots bloom in comments' light,
Automation shines so bright,
A splendid update, pure delight! 🎉

---

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.

[kamiazya]

@coderabbitai full review

[coderabbitai]

Actions performed

Full review triggered.

[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 1bd966a and bdf8b5d.

Files selected for processing (2)

• CHANGELOG.md (1 hunks)
• package.json (2 hunks)

Additional context used

LanguageTool

CHANGELOG.md

[uncategorized] ~46-~46: Do not mix variants of the same word (‘pre-release’ and ‘prerelease’) within a single text. (EN_WORD_COHERENCY)
Context: ...ration options for snapshots to support pre-release templates and calculated versions. ...

---

[style] ~53-~53: Using many exclamation marks might seem excessive (in this case: 17 exclamation marks for a text that’s 5450 characters long) (EN_EXCESSIVE_EXCLAMATION)
Context: ...@kamiazya! - Update dependencies and configuration...

Additional comments not posted (21)

package.json (5)

3-3: Version update to 1.11.0 aligns with the PR objectives and changelog entries.

---

28-34: Refactoring of keywords for better readability is a good practice.

---

38-40: The "files" field correctly specifies the distribution directory.

---

38-38: Adding the "provenance" flag to publishConfig aligns with the changelog and enhances package security.

---

38-38: Migration to pnpm from yarn is noted in the changelog and is reflected correctly here.

CHANGELOG.md (16)

7-7: Explicit mention of Node.js 16 compatibility is crucial for users and aligns with the PR objectives.

---

9-9: Update of CI/CD workflow is documented, ensuring transparency and traceability.

---

13-13: Introduction of Dependabot for GitHub Actions enhances security by automating dependency updates.

---

15-15: Migration from eslint and prettier to biome should improve the consistency and efficiency of code formatting and linting.

---

17-17: Addition of the "provenance" flag in publishConfig enhances package traceability.

---

19-19: Adding a typecheck script is a proactive step towards ensuring type safety.

---

23-23: Bumping vite from 5.2.13 to 5.3.0 aligns with the dependency updates mentioned in the PR objectives.

---

25-27: Migration to pnpm and the setup of a workspace is well-documented, promoting better package management practices.

---

29-29: Bumping @types/html-escaper from 3.0.0 to 3.0.2 ensures type definitions are up-to-date, which is crucial for maintaining compatibility and reducing bugs.

---

31-31: Updating package.json exports ensures correct module resolution and encapsulation.

---

33-33: Documentation updates in the README for TypeDoc versions 0.24 and 0.25 provide clarity and support for users.

---

35-35: Migration from rollup/jest to vite/vitest for building and testing tools aligns with modern JavaScript ecosystem practices.

---

37-37: Adding a GitHub workflow to update the copyright year in the license file is a good practice for maintaining copyright compliance.

---

39-49: The introduction of snapshot release workflows and enhancements in GitHub Actions setup is a significant improvement in automation and CI/CD practices.

Tools

LanguageTool

[uncategorized] ~46-~46: Do not mix variants of the same word (‘pre-release’ and ‘prerelease’) within a single text. (EN_WORD_COHERENCY)
Context: ...ration options for snapshots to support pre-release templates and calculated versions. ...

---

51-51: Bumping actions/checkout from 4.1.6 to 4.1.7 ensures the use of the latest features and fixes in GitHub Actions.

---

53-53: Updating dependencies and configuration files is crucial for maintaining the health of the project.

Tools

LanguageTool

[style] ~53-~53: Using many exclamation marks might seem excessive (in this case: 17 exclamation marks for a text that’s 5450 characters long) (EN_EXCESSIVE_EXCLAMATION)
Context: ...@kamiazya! - Update dependencies and configuration...