https://github.com/jondotsoy/commit-help
Command helper to create commit
https://github.com/jondotsoy/commit-help
commit git
Last synced: about 2 months ago
JSON representation
Command helper to create commit
- Host: GitHub
- URL: https://github.com/jondotsoy/commit-help
- Owner: JonDotsoy
- Created: 2021-07-29T16:54:11.000Z (almost 4 years ago)
- Default Branch: development
- Last Pushed: 2021-08-03T14:55:27.000Z (almost 4 years ago)
- Last Synced: 2025-01-26T10:30:40.094Z (4 months ago)
- Topics: commit, git
- Language: TypeScript
- Homepage: https://npmjs.com/@jondotsoy/commit-help
- Size: 1.07 MB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Commit-Help
[](https://github.com/JonDotsoy/commit-help/actions/workflows/npm_publish.yml)
Features:
- Shell alias `feat`: helper to commit a feature `feat(scope): ` or `feat: `
- Shell alias `fix`: helper to commit a fix `fix(scope): ` or `fix: `
- Shell alias `refactor`: helper to commit a refactor `refactor(scope): ` or `refactor: `
- Auto detect scope from change files using the `.mmrc.json` file
**Example mmrc file:**
```json
{
"scopes": [
{
"name": "user",
"match": "$CWD/apps/user/**"
},
{
"name": "products",
"match": "$CWD/apps/products/**"
},
{
"name": "settings",
"match": "$CWD/configs/**"
}
]
}
```
## How to use
## How to install
```sh
npm install -g @jondotsoy/commit-help
```
and run add the next line to your shell config (.alias, .bashrc, .zshrc, etc):
```sh
eval $(commit-help -)
```
> You can use wthout install. Just add into your shell config:
>
> ```sh
> eval $(npx @jondotsoy/commit-help -)
> ```
>
> ⚠️ This can delay to the shell startup.