Skip to content

blackxored/conventional-commits-print-scopes

Repository files navigation

conventional-commits-print-scopes

Semantically Released Build Status Code Coverage version downloads Styled with Prettier AirBnB style guide

MIT License All Contributors PRs Welcome Commitizen friendly Code of Conduct

Watch on GitHub Star on GitHub Tweet

Small utility to print all scopes from a repository that follows Conventional Commits or Angular-like commit conventions.

Why

When you're contributing to a new repository that follows the Conventional Commits specification, or alternatively, the Angular one, is sometimes difficult to figure out which scopes previous contributors have used. While you could leave that to the maintainer, this utility makes it easier to learn which scopes are used in a particular repository, so you can format your commit message accordingly.

Installing / Getting Started

npm install -g conventional-commits-print-scopes
cd <repo>
conventional-commits-print-scopes

Example output:

navigation
auth
native
system
core
...

Developing

Built With

Pre-requisites

Setting up Dev

Here's a brief intro about what a developer must do in order to start developing the project further:

git clone https://github.com/blackxored/conventional-commits-print-scopes
cd conventional-commits-print-scopes
yarn

Versioning

We use SemVer for versioning. In addition, it's automatic via semantic-release, and our commit convention.

For the versions available, see the Releases on this repository.

Tests

yarn test

Style guide

We base our code style on AirBnB's style guide and we check with ESLint and automatically format our code with Prettier.

License

This project is licensed under the MIT License - see the license file for details.

Contributing

If you're interested in contributing to this project in any form, please read our Contribution Guidelines.

Code of Conduct

We've adopted a Code of Conduct that we expect project participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.

Contributors

Thanks goes to these people (emoji key):


Adrian Perez

💻 📖 ⚠️

This project follows the all-contributors specification. Contributions of any kind welcome!

About

Print all scopes from a conventional-commits repo

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published