Skip to content

docs: changed husky install to husky init for v9 #4491

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

Update local setup documentation to use husky init for v9 installations and retain husky install instructions for v8 or lower across npm, yarn, pnpm, and deno workflows.

Documentation:

  • Add npx husky init, yarn husky init, pnpm husky init, and deno task --eval husky init commands for husky@v9 setup
  • Annotate npx husky install, yarn husky install, pnpm husky install, and deno task --eval husky install as applicable to husky@v8 or lower

Motivation and Context

At #4356, husky init is replaced with husky install.
However, [email protected] introduced the husky init command.

This is now easier than ever.
It's just a single line that does the same as above.
No need to read the docs to get started anymore.

Usage examples

npx husky init

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
Copy link
Member

Awesome, thanks!

@escapedcat escapedcat merged commit 493129b into conventional-changelog:master Jun 30, 2025
12 checks passed
@Marukome0743 Marukome0743 deleted the husky branch June 30, 2025 08:23
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