Skip to content

docs: add missing double hyphen to npm husky command in setup guide #4490

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

Documentation:

  • Add missing -- flag to the npx commitlint command in the husky commit-msg hook example in the local-setup guide

Usage examples

npm install --save-dev husky

npx husky install

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

As an alternative you can create a script inside package.json

npm pkg set scripts.commitlint="commitlint --edit"
echo "npm run commitlint \${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.

@Marukome0743 Marukome0743 changed the title docs: add double hyphen to npm husky command in setup guide docs: add missing double hyphen to npm husky command in setup guide Jun 30, 2025
@escapedcat
Copy link
Member

🚀

@escapedcat escapedcat merged commit f65205b into conventional-changelog:master Jun 30, 2025
18 of 22 checks passed
@Marukome0743 Marukome0743 deleted the hyphen branch June 30, 2025 08:55
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