@liukewia/lint v1.0.0-beta.36

Usage

方式1: 仅 eslint 格式化项目方式

eslint

1. 安装依赖

yarn add -D @liukewia/lint

2. 配置 eslint

// file: ./.eslintrc.js
module.exports = {
  extends: [require.resolve('@liukewia/lint/eslint')],
};

可在 package.json 中增加快捷 script:

// 基本
"lint:es": "eslint ./src/ --ext .js,.jsx,.ts,.tsx"

// 不接受warning
"lint:es": "eslint ./src/ --ext .js,.jsx,.ts,.tsx --max-warnings=0"

// 用eslint-formatter-pretty output方式查看lint检查结果
"lint:es": "eslint ./src/ --ext .js,.jsx,.ts,.tsx --format=pretty"

// 不接受warning，且用eslint-formatter-pretty output方式查看lint检查结果
"lint:es": "eslint ./src/ --ext .js,.jsx,.ts,.tsx --format=pretty --max-warnings=0"

// 仅lint，不自动fix
yarn lint:es

// lint，且自动fix
yarn lint:es --fix

3. 禁用 prettier

// file: ./.prettierignore
**/*

3. 配置 stylelint 脚本，用命令检查错误（可选）

执行

yarn add -D stylelint@^14

in package.json

"lint:style": "stylelint '**/*.{css,less}' --fix"

执行

yarn lint:style

4. 禁用 prettier

// file: ./.prettierignore
**/*

方式2: eslint + prettier 格式化项目

eslint

1. 安装依赖

yarn add -D @liukewia/lint

2. 配置 eslint

// file: ./.eslintrc.js
module.exports = {
  extends: [require.resolve('@liukewia/lint/eslint-prettier/eslint')],
};

可在 package.json 中增加快捷 script:

// 基本
"lint:es": "eslint ./src/ --ext .js,.jsx,.ts,.tsx"

// 不接受warning
"lint:es": "eslint ./src/ --ext .js,.jsx,.ts,.tsx --max-warnings=0"

// 用eslint-formatter-pretty output方式查看lint检查结果
"lint:es": "eslint ./src/ --ext .js,.jsx,.ts,.tsx --format=pretty"

// 不接受warning，且用eslint-formatter-pretty output方式查看lint检查结果
"lint:es": "eslint ./src/ --ext .js,.jsx,.ts,.tsx --format=pretty --max-warnings=0"

// 仅lint，不自动fix
yarn lint:es

// lint，且自动fix
yarn lint:es --fix

3. 配置 prettier

配置 prettier：

// file: ./.prettierrc.js
const prettierRules = require('@liukewia/lint/eslint-prettier/prettier');

module.exports = {
  ...prettierRules,
};

或配置自己偏好的配置。

附加：stylelint

1. 安装依赖

yarn add -D @liukewia/lint

2. 配置 stylelint

// file: ./.stylelintrc.js
module.exports = {
  extends: [require.resolve('@liukewia/lint/stylelint')],
};

Publish

改 package.json 版本号；

cd packages/lint
pnpm build
pnpm publish --tag latest --access public --no-git-checks