# @tuling/lint

一个集成了多种代码规范配置的工具包，帮助您快速在项目中设置和维护代码质量标准。

## 📦 功能特性

- ESLint 配置 - JavaScript/TypeScript 代码规范
- Stylelint 配置 - CSS/SCSS 样式规范
- Commitlint 配置 - Git 提交信息规范
- Changelog 配置 - 变更日志生成规范
- Remark 配置 - Markdown 文档规范
- Prettier 配置 - 代码格式化规范
- Semantic Release 配置 - 语义化发布规范

## 📦 安装

```bash
$ bun add @tuling/lint -D
```

## 🤯 使用指南

### .npmrc 配置

为了确保依赖包正确提升，请在项目根目录添加以下配置：

```text
public-hoist-pattern[]=*@umijs/lint*
public-hoist-pattern[]=*changelog*
public-hoist-pattern[]=*commitlint*
public-hoist-pattern[]=*eslint*
public-hoist-pattern[]=*postcss*
public-hoist-pattern[]=*prettier*
public-hoist-pattern[]=*remark*
public-hoist-pattern[]=*semantic-release*
public-hoist-pattern[]=*stylelint*
```

### ESLint 配置

在项目根目录创建 `.eslintrc.js`：

```js
module.exports = require('@tuling/lint').eslint;
```

配置详情可查看 [`.eslintrc.js`](/src/eslint/index.ts)

### Stylelint 配置

在项目根目录创建 `.stylelintrc.js`：

```js
module.exports = require('@tuling/lint').stylelint;
```

配置详情可查看 [`.stylelintrc.js`](/src/stylelint/index.ts)

### Commitlint 配置

在项目根目录创建 `.commitlintrc.js`：

```js
module.exports = require('@tuling/lint').commitlint;
```

配置详情可查看 [`.commitlintrc.js`](/src/commitlint/index.ts)

### Changelog 配置

在项目根目录创建 `.changelogrc.js`：

```js
module.exports = require('@tuling/lint').changelog;
```

配置详情可查看 [`.changelogrc.js`](/src/changelog/index.ts)

### Remark 配置

在项目根目录创建 `.remarkrc.js`：

```js
module.exports = require('@tuling/lint').remarklint;
```

配置详情可查看 [`.remarkrc.js`](/src/remarklint/index.ts)

### Prettier 配置

在项目根目录创建 `.prettierrc.js`：

```js
module.exports = require('@tuling/lint').prettier;
```

配置详情可查看 [`.prettierrc.js`](/src/prettier/index.ts)

### Semantic Release 配置

在项目根目录创建 `.releaserc.js`：

```js
module.exports = require('@tuling/lint').semanticRelease;
```

配置详情可查看 [`.releaserc.js`](/src/semantic-release/index.ts)

## ⌨️ 本地开发

```bash
$ cd tuling/lint
$ bun install
$ bun start
```

## 📝 协议

MIT