changelog-wizard

changelog-wizard is a CLI tool designed to help developers generate conventional commit messages effortlessly. This tool streamlines the process of creating standardized commit messages by prompting users to select commit types and add descriptions in a structured format.

Features

• Choose from common commit types (e.g., fix, feature, docs, style, etc.)
• Customize commit messages with user name and branch name
• Prompts users to add descriptions for commits
• Enforces conventional commit message format for better readability and changelog generation

Installation

Install changelog-wizard globally using npm or yarn:

Using npm

npm install -g changelog-wizard

Using yarn

yarn global add changelog-wizard

Usage

Basic Usage

To use changelog-wizard, simply run the following command in your terminal:

changelog-wizard

You will be prompted to:

1. Choose a commit type (e.g., fix, feature, docs, etc.)
2. Enter a description for the commit message

Shortcut Commands

You can also specify the commit type directly by adding it as an argument. This skips the commit type selection prompt:

changelog-wizard fix

Commit Types

Supported commit types include:

• fix: A bug fix for the user, not a fix to a build script
• feature: A new feature for the user, not a new feature for build scripts
• docs: Documentation changes
• style: Code style changes (e.g., formatting, missing semicolons)
• refactor: Code restructuring without affecting functionality
• test: Adding or updating tests; no production code change
• chore: Updates to build tasks, package manager configs, etc.

Example

Run the command:

changelog-wizard fix

You’ll see a prompt asking for a description. Enter your description:

Commit message: fix: Correct typo in authentication logic

Contributing

Feel free to submit issues and pull requests. Contributions are welcome to improve the tool!