# poppins-check-commit

> mary-poppins plugin for checking commit message format

Latest version **0.2.0** (published 2014-03-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install poppins-check-commit
pnpm add poppins-check-commit
yarn add poppins-check-commit
bun add poppins-check-commit
```

## 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.2.0 |
| Published | 2014-03-19 |
| First published | 2013-12-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Brian Ford |
| Maintainers | btford |
| Keywords | mary-poppins, poppins |

## Links

- npm: https://www.npmjs.com/package/poppins-check-commit
- Repository: https://github.com/btford/poppins-check-commit
- Issues: https://github.com/btford/poppins-check-commit/issues
- npm.io page: https://npm.io/package/poppins-check-commit

## Recent versions

- 0.2.0 (latest) — 2014-03-19
- 0.1.0 — 2014-02-05
- 0.0.2 — 2013-12-06
- 0.0.1 — 2013-12-06

## README

# poppins-check-commit

A [Mary Poppins](https://github.com/btford/mary-poppins) plugin for checking commit message format.
It was designed to enforce [this commit message format](https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit#), but it can be used with other conventions as well.
Requires the [`pr-checklist`](https://github.com/btford/poppins-pr-checklist) plugin.


## Install

`npm install poppins-check-commit`


## Configure

To use this plugin, you need to load it in your config file with `couldYouPlease`:


```javascript
// config.js
module.exports = function (poppins) {

  poppins.config = { /*...*/ };

  // pr checklist config
  poppins.couldYouPlease('pr-checklist');
  poppins.plugins.prChecklist.greeting = 'Hello';
  poppins.plugins.prChecklist.closing = 'Farewell';

  // check commit config
  poppins.couldYouPlease('check-commit');
};
```

## Options

Options are available on `popins.plugins.checkCommit`.
They should be fairly self-explanatory if you read [the plugin's source](https://github.com/btford/poppins-check-commit/blob/master/plugin.js).

### `popins.plugins.checkCommit.message`
String.
Defaults to `"PR's commit messages follow the [commit message format](https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit#)"`

### `popins.plugins.checkCommit.condition`
Function.
Returns promise that resolves to a bool as to whether or not the PR follows the guidelines.

### `popins.plugins.checkCommit.check`
Function.
Run on each commit to determine its validity.


## License
MIT

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