malas-commit 🚀

malas-commit: The ultimate tool for developers who need automated, meaningful commit messages without the hassle! This fast and efficient NPM package uses the Groq API to generate smart, context-aware commit messages in seconds. Perfect for boosting productivity in your Git workflows.

Why Malas Commit?

The word malas in Indonesian means lazy. Often, developers feel lazy or lack motivation to come up with commit messages that are both clear and concise. Malas Commit automates this task for you!

Definition of "Malas":

1. Indonesian (ma.las):
   • a. Not willing to work on something: orang yang malas itu lebih senang mengemis daripada bekerja (The lazy person prefers begging to working).
   • a. Not eager or reluctant to do something: malas rasanya mengunjungi rapat seperti itu (feeling too lazy to attend such a meeting).

Features

• Easy Configuration: Quickly set up and get started with your API key and preferred configuration.
• Automated Commit Messages: No more thinking about commit messages! Generate them instantly.
• Global Installation: Install once, use everywhere.
• Simple Command: Generate messages with a single command.

Requirement

You should have a GROQ_APIKEY (for free, just sign up).

You can obtain it from GROQ Console.

Installation

To install the package globally, run the following command:

npm i malas-commit -g

Set GROQ_APIKEY:

malas setConfig GROQ_APIKEY <your-groq-apikey>

How to use

malas

OR

malas-commit

Configuration

You can configure malas-commit by creating a ~/.malas-commit.json file in the home_dir. Here is an example configuration:

{
  "GROQ_APIKEY": "<your-groq-apikey>",
  "COMMIT_PROMPT": "<your-custom-promt>" // Leave it blank if you use default prompt instead
}

Known Issues

• Yes/No Prompt Bug: When the user selects "no" at a yes/no prompt, the command still proceeds as if "yes" was selected. This bug needs fixing to properly exit or halt the process if "no" is chosen.

• Auto-generated Pull Request Descriptions: We plan to add an auto-generated pull request description feature. This will automatically generate pull request descriptions in Markdown format based on changes in the project.

To-Do List

• [x] Fix the bug where the process still runs after selecting "no" in the yes/no prompt.
• [x] Implement error handling for failed network requests.
• [ ] Refactor the code for better readability.
• [ ] Write unit tests for the new features.
• [ ] Add an auto-generated pull request description generator related to changes using Markdown format code.

Contributing

We welcome contributions! Please read our contributing guidelines to get started.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Acknowledgements

Special thanks to all the contributors and the open-source community for their support.