@ty-lerscott/conventional-commit

A Conventional Commit Formatter 💫🚀

Description

@ty-lerscott/conventional-commit is a delightful CLI tool that automatically formats your commits according to the Conventional Commit specification, ensuring consistency and reliability in your version control history 🌟✨

Installation

To install @ty-lerscott/conventional-commit globally, run:

> npm i @ty-lerscott/conventional-commit -g

Prerequisites

Make sure you have the following installed:

• Node.js version 18
• Git

Configuration

You can either use a conventional-commit.json file or a package.json file

package.json

"conventional": {
  "scope": "VALUE", // optional
  "prompt": false, // optional (default: true)
  "types": {
    "KEY": "VALUE", // optional
  }
}

The conventional object in your package.json file allows you to configure certain aspects of the Conventional Commit Formatter. Here's a breakdown of the available options:

• scope: This property can be used to specify a default scope for your commits.
• types: An object containing key-value pairs representing commit types and their descriptions.
• prompt: A Boolean indicating whether or not to prompt the user to approve the commit

Usage

There are two ways to use this cli tool, they do the same thing

> commit [option(s)]

or

> cc [option(s)]

Output

In its most simple usage, this will generate a commit message following the Conventional Commit format, making your version control workflow a breeze 🌈💻

> <type>(<scope>)!: <message>

Options

The following options are available when using @ty-lerscott/conventional-commit:

• -t, --type: The type of commit (e.g., feat, fix, chore).
• -m, --message: The commit message.
• -s, --scope: The context of the commit.
• -b, --break: This commit will be a breaking change
• -ns, --no-scope: If a default scope is specified in package.json, this removes the scope
• -np, --no-prompt: Disables commit message preview
• -h, --help: Displays help information about the CLI tool.
• -v, --version: Prints out the script's version

You can use these options to customize your commit messages and streamline your development process.

License

@ty-lerscott/conventional-commit is licensed under the MIT License.

Contributions

Contributions and feedback are welcome! Feel free to submit issues or pull requests on GitHub.

Credits

This project is maintained by @ty-lerscott.

Contact

For any inquiries, please contact [email protected].