# conventional-committer

> Commit manager

Latest version **0.3.0** (published 2019-04-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install conventional-committer
pnpm add conventional-committer
yarn add conventional-committer
bun add conventional-committer
```

Provides the command `conventional-committer`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.3.0 |
| Published | 2019-04-10 |
| First published | 2019-04-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 106.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Daniel Welsh |
| Maintainers | wel-shy |
| Keywords | git, tool |

## Links

- npm: https://www.npmjs.com/package/conventional-committer
- Repository: https://github.com/wel-shy/committer
- Homepage: https://github.com/wel-shy/committer#readme
- Issues: https://github.com/wel-shy/committer/issues
- npm.io page: https://npm.io/package/conventional-committer

## Dependencies (5)

- [chalk](https://npm.io/package/chalk.md) ^2.4.2
- [inquirer](https://npm.io/package/inquirer.md) ^6.2.2
- [commander](https://npm.io/package/commander.md) ^2.20.0
- [@types/jest](https://npm.io/package/@types/jest.md) ^24.0.11
- [inquirer-autocomplete-prompt](https://npm.io/package/inquirer-autocomplete-prompt.md) ^1.0.1

## Alternatives

- [lodash.assign](https://npm.io/package/lodash.assign.md) — 2.3M weekly downloads
- [lodash.chunk](https://npm.io/package/lodash.chunk.md) — 1.8M weekly downloads
- [react-native-ios-utilities](https://npm.io/package/react-native-ios-utilities.md) — 138.5K weekly downloads
- [@technically/lodash](https://npm.io/package/@technically/lodash.md) — 50.9K weekly downloads
- [@fluid-topics/ft-icon](https://npm.io/package/@fluid-topics/ft-icon.md) — 20.6K weekly downloads

## Recent versions

- 0.3.0 (latest) — 2019-04-10
- 0.1.1 — 2019-04-05
- 0.1.0 — 2019-04-05

## README

# conventional-committer

[![Build Status](https://travis-ci.com/wel-shy/committer.svg?branch=master)](https://travis-ci.com/wel-shy/committer)
[![Coverage Status](https://coveralls.io/repos/github/wel-shy/committer/badge.svg?branch=dev)](https://coveralls.io/github/wel-shy/committer?branch=dev)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

Conventional Committer is a git commit formatter, it formats your commits into the [conventional commit](https://www.conventionalcommits.org/en/v1.0.0-beta.3/) style, but with extra information embedded:

```
<TYPE>([SCOPE]): <TITLE> <EMOJI>

[BODY] [ISSUE]
```

Where elements like `<*>` are required and elements like `[*]` are optional:

- `TYPE` is one of `build`, `ci`, `chore`, `docs`, `feat`, `fix`, `perf`, `refactor`, `revert`, `style`, `test`.
- `SCOPE` is the part of the project the commit changes.
- `TITLE` commit message.
- `EMOJI` see [gitmoji](https://gitmoji.carloscuesta.me/) for full list.
- `BODY` commit description
- `ISSUE` issue or PR commit is in reference to.

Emojis come from [gitmoji](https://gitmoji.carloscuesta.me/) and outline the commit type, so you can quickly see what the commit is in reference to. Committing in this style allows you to use tools like [conventional-changelog-cli](https://www.npmjs.com/package/conventional-changelog-cli) to generate changelogs, like this [project's](https://github.com/wel-shy/committer/blob/master/CHANGELOG.md).

## Install

```
npm install -g conventional-committer
```

## Use

To commit, run

```
conventional-committer
```

### Options

- Auto add untracked changes with a `-a` flag.
- Sign commits with `-s`, requires setting a gpg key for git.
- Push after commit with `-p`.

Options can be stacked, you can sign and push with `-sp` for example.

## Test

```
npm run test:local
```

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