Skip to content

docs: how to run CLI for development #3836

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
Jan 3, 2024

Conversation

abitrolly
Copy link
Contributor

@abitrolly abitrolly commented Jan 3, 2024

Description

Explain how to run commitlint from the source code.

Motivation and Context

I could not find a way to test new rule from a command line using cloned source code. This should be it. yarn install doesn't make commitlint available.

Is there a better way?

How Has This Been Tested?

Manually yarn run commitlint.

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.

@escapedcat
Copy link
Member

Hm, good point.
I usually use this: echo "#123 - test commit" | ./@commitlint/cli/cli.js.
But I guess echo "#123 - test commit" | yarn run commitlint does just the same.

@escapedcat escapedcat merged commit 3ee4c28 into conventional-changelog:master Jan 3, 2024
@escapedcat
Copy link
Member

Thanks!

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