commit-pr-generator
v0.0.3
Published
commit-pr-generator is a tool that simplifies the creation of commit messages and pull requests following the Conventional Commits format. It automatically generates relevant content using the output of git diff, including emojis, and allows users to dire
Downloads
217
Readme
commit-pr-generator
commit-pr-generator is a CLI tool designed to simplify the creation of commit messages and pull request descriptions. It automates the process by formatting the content based on git diff
outputs and Conventional Commits, and optionally copies the text to your clipboard or opens an AI platform to help finalize your text.
Screenshots
Features
- Automated Commit and PR Drafts: Generates commit messages and pull request descriptions based on Conventional Commits.
- Excludes Unwanted Files: Filters out common files and directories (e.g.,
node_modules
,.env
) ingit diff
. - Clipboard Integration: Copies the generated content directly to your clipboard.
- Platform Selection: Option to open preferred AI platforms (e.g., ChatGPT, Gemini) to finalize the generated text.
Installation
Ensure you have Node.js installed, then install npm package:
npm install commit-pr-generator
or install as a global package
npm install -g commit-pr-generator
Usage
Run the script with the following command:
commit-pr-generator <repo-path>
repo-path
(optional): The path to the Git repository. If omitted, the current directory will be used.
Leave in blank path if you are in a git repository
commit-pr-generator <repo-path>
Example
commit-pr-generator /path/to/your/repo
The script will:
- Generate draft commit messages and PR descriptions.
- Copy the output to your clipboard.
- Prompt you to open an AI platform or exit.
Requirements
- Node.js (v14+)
- Git
- Packages:
inquirer
,open
,clipboardy
,robotjs
License
This project is licensed under the MIT License. See the LICENSE file for details.
Contributing
Contributions are welcome! Feel free to submit a pull request or open an issue for suggestions and improvements.