# lint

**Repository Path**: lensung/lint

## Basic Information

- **Project Name**: lint
- **Description**: Lint Sharable Configurations and Rules
- **Primary Language**: JavaScript
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-04-27
- **Last Updated**: 2026-04-11

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# lint

## 使用

1. 安装 `@lensung/lint`

```sh
npm install --save-dev @lensung/lint
# or
yarn add @lensung/lint -D
```

2. 将在根目录下自动生成一下文件 .eslintrc.json/.prettierrc.json/.lintstagedrc.json/.husky/.commitlintrc.json (注意如果已有相应文件不会覆盖)

3. 可修改规则

in `.eslintrc.json`

```json
{
  "extends": "./node_modules/@lensung/lint/src/eslint.js",
  "rules": {}
}
```

可选择使用 eslint strict 规则，将启用 airbnb 严格规则约束。

```json
{
  "extends": "./node_modules/@lensung/lint/src/eslint.strict.js",
  "rules": {}
}
```

in `.lintstagedrc.json`

```json
{
  "*.{less,sass,scss,md,json,yml}": ["prettier --write", "git add"],
  "*.{js,jsx,html}": ["prettier --write", "eslint --fix", "git add"],
  "*.ts?(x)": [
    "prettier --parser=typescript --write",
    "eslint --fix",
    "git add"
  ]
}
```

## 注意

Mac os 可能不执行 lint, 请执行以下命令:

```bash
chmod ug+x .husky/*
chmod ug+x .git/hooks/*
```

## CHANGELOG

[CHANGELOG](./CHANGELOG.md)

## LICENSE

[MIT](./LICENSE)