# messagelint

> A commit message formatter

Latest version **1.0.6** (published 2017-09-01) · MIT license · 0 weekly downloads

## Install

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

Provides the command `messagelint`.

## 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.6 |
| Published | 2017-09-01 |
| First published | 2017-08-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 13 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Martin Hartt |
| Maintainers | martinhartt |
| Keywords | commit, lint, better |

## Links

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

## Dependencies (13)

- [mz](https://npm.io/package/mz.md) ^2.6.0
- [chai](https://npm.io/package/chai.md) ^4.1.1
- [execa](https://npm.io/package/execa.md) ^0.8.0
- [mocha](https://npm.io/package/mocha.md) ^3.5.0
- [ts-node](https://npm.io/package/ts-node.md) ^3.3.0
- [@types/mz](https://npm.io/package/@types/mz.md) 0.0.31
- [commander](https://npm.io/package/commander.md) ^2.11.0
- [compromise](https://npm.io/package/compromise.md) ^10.7.2
- [typescript](https://npm.io/package/typescript.md) ^2.4.2
- [@types/chai](https://npm.io/package/@types/chai.md) ^4.0.2
- [@types/execa](https://npm.io/package/@types/execa.md) ^0.7.0
- [@types/mocha](https://npm.io/package/@types/mocha.md) ^2.2.41
- [@types/commander](https://npm.io/package/@types/commander.md) ^2.9.1

## Alternatives

- [eslint-plugin-sonarjs](https://npm.io/package/eslint-plugin-sonarjs.md) — 2.9M weekly downloads
- [eslint-config-expo](https://npm.io/package/eslint-config-expo.md) — 1.5M weekly downloads
- [@matter/protocol](https://npm.io/package/@matter/protocol.md) — 63.5K weekly downloads
- [@eventcatalog/linter](https://npm.io/package/@eventcatalog/linter.md) — 24.8K weekly downloads
- [@inrupt/eslint-config-base](https://npm.io/package/@inrupt/eslint-config-base.md) — 4.5K weekly downloads

## Recent versions

- 1.0.6 (latest) — 2017-09-01
- 1.0.5 — 2017-08-23
- 1.0.4 — 2017-08-23
- 1.0.3 — 2017-08-23
- 1.0.2 — 2017-08-23
- 1.0.1 — 2017-08-21
- 1.0.0 — 2017-08-21

## README

# 🌟 MessageLint

A formatter to make inconsistent commit messages obsolete!


## Installation and Usage

Go to any git project and run:

```
npm install -g messagelint
messagelint setup
```

Then create a commit as usual:

```
git commit -m "made a change"
```

MessageLint will either:

- Approve (silently)
- Modify (silently)
- Reject (verbosely)

...your commit message

## Development

```
git clone git@github.com:martinhartt/messagelint.git
npm install
npm build
npm start
```

## Rules

These rules are run as part of the linting process, and are setup to reflect
commit message best practices.

### No whitespace padding

This ensures there is no redundant whitespace around the subject and body of the
commit message.

### No trailing dot

Message subjects shouldn't end with a dot and this rule strips them if necessary.

### First letter capital

In line with most conventions, this rule ensures the first letter is capital.

### First word of the subject is a verb in present tense and imperitive mood

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