Skip to content

docs: add setup guide for bun #4488

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

Merged
merged 1 commit into from
Jun 30, 2025

Conversation

Marukome0743
Copy link
Contributor

Description

Add a new ‘bun’ section to the local setup guide for installing Husky and configuring a commitlint hook

Documentation:

  • Introduce a ‘bun’ guide showing how to install Husky and initialize its hooks
  • Show how to add a commitlint hook with bunx, including a Windows-specific command variation

Motivation and Context

#4383 added CLI instruction for Bun package manager.
However, the setup guide didn't updated.

Usage examples

bun add --dev husky
bunx husky install
# Add commit message linting to commit-msg hook
echo "bunx commitlint --edit \$1" > .husky/commit-msg
# Windows users should use ` to escape dollar signs
echo "bunx commitlint --edit `$1" > .husky/commit-msg

How Has This Been Tested?

I have tested on my local PC.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

Copy link

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

@escapedcat escapedcat merged commit 1e83ddf into conventional-changelog:master Jun 30, 2025
12 checks passed
@Marukome0743 Marukome0743 deleted the bun branch June 30, 2025 08:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants