# commitify

> Easy git commit message with meaning

Latest version **1.0.0** (published 2018-10-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install commitify
pnpm add commitify
yarn add commitify
bun add commitify
```

Provides the command `commitify`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2018-10-24 |
| First published | 2018-01-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 5.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Udi Talias |
| Maintainers | uditalias |
| Keywords | git, commit, commit-message, cli-tool, git-workflow |

## Links

- npm: https://www.npmjs.com/package/commitify
- Repository: https://github.com/uditalias/commitify
- Homepage: https://github.com/uditalias/commitify#readme
- Issues: https://github.com/uditalias/commitify/issues
- npm.io page: https://npm.io/package/commitify

## Dependencies (3)

- [chalk](https://npm.io/package/chalk.md) 2.4.1
- [fs-extra](https://npm.io/package/fs-extra.md) 7.0.0
- [inquirer](https://npm.io/package/inquirer.md) 6.2.0

## Recent versions

- 1.0.0 (latest) — 2018-10-24
- 0.0.6 — 2018-02-01
- 0.0.5 — 2018-02-01
- 0.0.4 — 2018-01-25
- 0.0.3 — 2018-01-24
- 0.0.2 — 2018-01-24
- 0.0.1 — 2018-01-24

## README

## **Commitify**
[![npm version](https://badge.fury.io/js/commitify.svg)](https://badge.fury.io/js/commitify)

### Easy git commit message with meaning
#

#### Install
```sh
npm install -g commitify
```

#### Usage
Inside any git repo:
```sh
$ commitify

? Do you want to add changes before commit (`git add .`)? Yes
? Choose commit type: fix
? Choose commit scope: client
? Enter commit message: this is a bug fix
? Do you want to push your commit? Yes
```

That will push a new commit with the message:  
`fix(client): this is a bug fix`

#### Options
You can extend the list of the commit types and scopes ([example here](.commitifyrc)).  
Create a `.commitifyrc` file in your project root in the format:

```json
{
    "types": [
        "custom"
    ],
    "scopes": [
        "custom"
    ]
}
```

MIT License

---
_Source: https://npm.io/package/commitify · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._