Skip to content

docs: add multi JavaScript package manager and code groups to guides #4501

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
Jul 1, 2025

Conversation

Marukome0743
Copy link
Contributor

Description

Group shell command examples into code-group blocks and add Yarn, pnpm, Bun, and Deno variants across the use-prompt and local-setup guides.

Documentation:

  • Wrap initialization, installation, commit, and linting commands in code-group sections for npm, Yarn, pnpm, Bun, and Deno in use-prompt.md
  • Add corresponding code-group examples for running commitlint and testing hooks in local-setup.md with npm, Yarn, pnpm, Bun, and Deno

Motivation and Context

I hope these changes will help other developers that use yarn, pnpm, bun and deno easily set up commitlint.

Usage examples

npx commitlint --from HEAD~1 --to HEAD --verbose
yarn commitlint --from HEAD~1 --to HEAD --verbose
pnpm dlx commitlint --from HEAD~1 --to HEAD --verbose
bunx commitlint --from HEAD~1 --to HEAD --verbose
deno task --eval commitlint --from HEAD~1 --to HEAD --verbose

How Has This Been Tested?

yarn docs-dev

yarn docs-build

yarn docs-preview

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

codesandbox-ci bot commented Jul 1, 2025

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.

```

```sh [pnpm]
pnpm dlx commitlint --from HEAD~1 --to HEAD --verbose
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe pnpm commitlint and bun commitlint also work same as yarn commitlint.

Copy link
Contributor Author

@Marukome0743 Marukome0743 Jul 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@escapedcat Oh sorry, I have updated now after merged.

May I recreate PR of update pnpm commitlint and bun commitlint ?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, sorry, I thought this was already covered, my bad! Sure, please open another PR. No rush.

@escapedcat
Copy link
Member

code-group FTW!

@escapedcat escapedcat merged commit 8155043 into conventional-changelog:master Jul 1, 2025
12 checks passed
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.

3 participants