# git-commit-parser

> Parse commit messages according to the AngularJS header format

Latest version **1.0.0** (published 2014-11-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install git-commit-parser
pnpm add git-commit-parser
yarn add git-commit-parser
bun add git-commit-parser
```

## 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 | 2014-11-22 |
| First published | 2014-11-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 8 |
| Author | Ben Drucker |
| Maintainers | bendrucker |
| Keywords | git, commit, message, parser |

## Links

- npm: https://www.npmjs.com/package/git-commit-parser
- Repository: https://github.com/bendrucker/git-commit-parser
- Issues: https://github.com/bendrucker/git-commit-parser/issues
- npm.io page: https://npm.io/package/git-commit-parser

## Dependencies (1)

- [chai](https://npm.io/package/chai.md) ^1.10.0

## Alternatives

- [babylon](https://npm.io/package/babylon.md) — 5.1M weekly downloads
- [csscolorparser](https://npm.io/package/csscolorparser.md) — 3.7M weekly downloads
- [expr-eval-fork](https://npm.io/package/expr-eval-fork.md) — 1.5M weekly downloads
- [@leeoniya/ufuzzy](https://npm.io/package/@leeoniya/ufuzzy.md) — 247.7K weekly downloads
- [xml-parser](https://npm.io/package/xml-parser.md) — 78.4K weekly downloads

## Recent versions

- 1.0.0 (latest) — 2014-11-22

## README

git-commit-parser [![Build Status](https://travis-ci.org/bendrucker/git-commit-parser.svg?branch=master)](https://travis-ci.org/bendrucker/git-commit-parser)
=================

Parse commit messages using a simplified version of the the [AngularJS style](https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit#).

## Install

```bash
$ npm install --save git-commit-parser
```

## API

#### `parser.parse(message)` -> `Object`

##### Input
```
feat(user): allow a user to log in

Allow a user to log in with username and password
```

#### Output:
```js
{
  header: {
    type: 'feat',
    scope: 'user',
    subject: 'allow a user to log in'
  },
  body: 'Allow a user to log in with username and password'
}
```

#### `header.toString()` -> `String`

Stringifies the header back to its original format

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