# fecode-commitlint-config

> > TODO: description

Latest version **0.0.18** (published 2024-02-27) · ISC license · 0 weekly downloads

## Install

```sh
npm install fecode-commitlint-config
pnpm add fecode-commitlint-config
yarn add fecode-commitlint-config
bun add fecode-commitlint-config
```

## 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.0.18 |
| Published | 2024-02-27 |
| First published | 2024-02-27 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 2.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | zhutianhe |
| Maintainers | zhutianhe |

## Links

- npm: https://www.npmjs.com/package/fecode-commitlint-config
- Repository: https://gitee.com/zth136/fecode-spec
- npm.io page: https://npm.io/package/fecode-commitlint-config

## Dependencies (1)

- [conventional-changelog-conventionalcommits](https://npm.io/package/conventional-changelog-conventionalcommits.md) ^4.5.0

## Recent versions

- 0.0.18 (latest) — 2024-02-27
- 0.0.17 — 2024-02-27
- 0.0.13 — 2024-02-27
- 0.0.12 — 2024-02-27
- 0.0.7 — 2024-02-27
- 0.0.6 — 2024-02-27

## README

# `fecode-commitlint-config`

> TODO: description

支持配套的 [commitlint 配置](https://commitlint.js.org/#/concepts-shareable-config)，用于对 `git commit message` 进行校验。

## 安装

使用时，需要安装 [@commitlint/cli](https://www.npmjs.com/package/@commitlint/cli)：

```bash
npm install fecode-commitlint-config @commitlint/cli --save-dev
```

## 使用

在 `commitlint.config.js` 中集成本包:

```javascript
module.exports = {
	extends: ['fecode-commitlint-config'],
};
```

## 设置 git hook

可通过 [husky](https://www.npmjs.com/package/husky) 设置在 `git commit` 时触发 `commitlint`。

首先安装 husky：

```bash
npm install husky --save-dev
```

然后执行添加`commit-msg`:

```bash
npx husky add .husky/commit-msg 'npx commitlint --edit $1'
```

更多信息可参考 [commitlint 文档](https://commitlint.js.org/#/guides-local-setup?id=install-husky)。

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