# @winner-fed/commitlint-config-win

> Commitlint shareable configuration for Whale F2E Guidelines

Latest version **1.2.1** (published 2025-05-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install @winner-fed/commitlint-config-win
pnpm add @winner-fed/commitlint-config-win
yarn add @winner-fed/commitlint-config-win
bun add @winner-fed/commitlint-config-win
```

## Health

**Score 35/100 (D)** — status: maintenance-mode.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.1 |
| Published | 2025-05-28 |
| First published | 2021-08-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=v12 |
| Dependencies | 1 |
| Unpacked size | 28.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | winner-fed |
| Keywords | commitlint, commitlint-config, @winner-fed/f2elint, hs-config |

## Links

- npm: https://www.npmjs.com/package/@winner-fed/commitlint-config-win
- npm.io page: https://npm.io/package/@winner-fed/commitlint-config-win

## Dependencies (1)

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

## 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.2.1 (latest) — 2025-05-28
- 1.2.0 — 2025-05-28
- 1.1.0 — 2025-05-27
- 1.0.1 — 2023-08-15
- 1.0.0 — 2021-08-06

## README

# @winner-fed/commitlint-config-win

本包提供了《Git 规约》配套的 [commitlint 可共享配置](https://commitlint.js.org/#/concepts-shareable-config)，用于对 git commit message 进行校验。

## 安装

除了本包，你需要同时安装 [@commitlint/cli](https://www.npmjs.com/package/@commitlint/cli)：

```bash
npm install @winner-fed/commitlint-config-win @commitlint/cli --save-dev
```

## 使用

本包同时支持 CommonJS 和 ESM 模块系统。

### CommonJS

在项目中的 `commitlint.config.js` 中继承本包:

```javascript
module.exports = {
  extends: ['@winner-fed/commitlint-config-win'],
};
```

### ESM

在项目中的 `commitlint.config.mjs` 中继承本包:

```javascript
export default {
  extends: ['@winner-fed/commitlint-config-win'],
};
```

或者在 `package.json` 中设置 `"type": "module"` 后，在 `commitlint.config.js` 中使用：

```javascript
export default {
  extends: ['@winner-fed/commitlint-config-win'],
};
```

### TypeScript

如果你使用 TypeScript，可以在 `commitlint.config.ts` 中使用：

```typescript
import type { UserConfig } from '@commitlint/types';

const config: UserConfig = {
  extends: ['@winner-fed/commitlint-config-win'],
};

export default config;
```

## 设置 git hook

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

首先安装 husky：

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

然后在 `package.json` 中增加：

```json
{
  "husky": {
    "hooks": {
      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
    }
  }
}
```

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

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