https://github.com/bsorrentino/ai-conventional-commit
This simple utility make a commit description compliant with conventional commit standard using AI
https://github.com/bsorrentino/ai-conventional-commit
Last synced: 30 days ago
JSON representation
This simple utility make a commit description compliant with conventional commit standard using AI
- Host: GitHub
- URL: https://github.com/bsorrentino/ai-conventional-commit
- Owner: bsorrentino
- License: mit
- Created: 2023-07-30T18:11:15.000Z (about 2 years ago)
- Default Branch: develop
- Last Pushed: 2023-08-02T10:29:15.000Z (about 2 years ago)
- Last Synced: 2025-03-12T15:35:51.564Z (7 months ago)
- Language: JavaScript
- Size: 32.2 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## AI COMMIT
This simple utility make a commit description compliant witn [conventional commit] standard
### Features
* If update concerns **one staging file** or such file is provided by command line using `-c` argument, **it is put automatically as scope of commit**
* Period is translated as new line in result message
* use postfix `as ` to define commit topic
* use postfix `scope ` to define commit scope.
### Examples
| text | result | staging file (-c argument)
--- | --- | ---
| `add password hashing as auth` | `feat(auth): add password hashing` |
| `update README.md`| `docs: update readme.md` |
| `update`| `docs(README.md): update` |README.md |
| `add jsdoc from AI(cody) as docs` | `docs(index.mjs): add jsdoc from AI(cody)` | index.mjs
[conventional commit]: https://www.conventionalcommits.org/en/v1.0.0/