# @walrus/plugin-commitlint

> Lint your commit messages

Latest version **1.2.1** (published 2020-08-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install @walrus/plugin-commitlint
pnpm add @walrus/plugin-commitlint
yarn add @walrus/plugin-commitlint
bun add @walrus/plugin-commitlint
```

## Health

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

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.1 |
| Published | 2020-08-22 |
| First published | 2019-11-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 7 |
| Unpacked size | 20.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | wangxingkang, wangxingkang1314 |

## Links

- npm: https://www.npmjs.com/package/@walrus/plugin-commitlint
- npm.io page: https://npm.io/package/@walrus/plugin-commitlint

## Dependencies (7)

- [get-stdin](https://npm.io/package/get-stdin.md) 8.0.0
- [resolve-from](https://npm.io/package/resolve-from.md) 5.0.0
- [resolve-global](https://npm.io/package/resolve-global.md) 1.0.0
- [@commitlint/lint](https://npm.io/package/@commitlint/lint.md) 9.1.2
- [@commitlint/load](https://npm.io/package/@commitlint/load.md) 9.1.2
- [@commitlint/read](https://npm.io/package/@commitlint/read.md) 9.1.2
- [@commitlint/format](https://npm.io/package/@commitlint/format.md) 9.1.2

## Recent versions

- 1.2.1 (latest) — 2020-08-22
- 1.2.0 — 2020-04-06
- 1.1.1 — 2020-03-26
- 1.1.0 — 2020-03-25
- 0.4.1 — 2019-11-29
- 0.4.0 — 2019-11-28
- 0.3.1 — 2019-11-14
- 0.3.0 — 2019-11-05

## README

<h1 align="center">
  @walrus/plugin-commitlint
</h1>

> [commitlint](https://github.com/conventional-changelog/commitlint) 封装

## 🏗 安装

```
// npm
npm install --save --dev @walrus/cli @walrus/plugin-commitlint

// yarn
yarn add --dev @walrus/cli @walrus/plugin-commitlint
```

建议直接安装 [@walrus/preset-lint](https://github.com/walrusjs/plugins/tree/master/packages/preset-lint)

## 🛡命令

```
# 检查commit message
walrus commitlint
```

## 🌟 commitlint 配置

内置配置请查看 [commitlint.config.js](https://github.com/walrusjs/plugins/blob/master/packages/plugin-commitlint/src/commitlint.config.js)

## 📝 配置

**注意：** 优先级 Flags >> config commitlint >> config lint

可在 `.walrusrc.ts`、`walrus.config.ts`添加如下配置

```
import { Config } from '@walrus/types';

const config: Config = {
  // ...
  commitlint: {
    edit: string;
    from: string;
    to: string;
    env: string;
    verbose: boolean;
    config?: string;
  }
};

export default config;
```

## ⚡ Flags

### --edit

从指定文件读取最后的提交消息，或回退到./.git/COMMIT_EDITMSG

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