GitXplorerGitXplorer
h

eslint-config-halo

public
6 stars
2 forks
0 issues

Commits

List of commits on branch master.
Unverified
678f2ece6c63ad425520f32cb39d2ad4360d9bfb

10.0.0

hhjkcai committed a year ago
Unverified
d557b9d1bbc59c71616137ea8d60ed264d062810

feat: update rules

hhjkcai committed a year ago
Unverified
3c02dfb5489169b34f0f3b8dab2e94735829749f

fix restrict-plus-operands

hhjkcai committed a year ago
Unverified
678ceb8803cbb98c2acbb5533038c1f20e7825ba

update dependencies

hhjkcai committed a year ago
Unverified
3dd54399432ace49d35bdfc3567681783541c29b

9.2.0

hhjkcai committed 2 years ago
Verified
b5f2622f52421a33879600e901da0f462b0fba1b

fix: Environment key "jest/globals" is unknown 和 'jest/no-jest-import' not found 的问题 (#1)

wwxqqh committed 2 years ago

README

The README file for this repository.

eslint-config-halo

本规则是我在 halo 团队发起的,多年前端编码的规则沉淀

设计原则

  1. 基于 tencent 规则扩展
  2. ESLint 是帮助编码的工具,不要成为负担
  3. 内置大量 TypeScript 最佳实践规则,按这个写准没错

开始使用

首先安装 ESLint 和规则:

npm install -D eslint @hjkcai/eslint-config-halo

在你的项目的根目录下创建一个 .eslintrc.js 文件,根据你的项目类型,复制下面的代码到该文件中。同时下面也提供了参考的 package.json scripts 配置,可以自行加入到已有的项目中去。

JavaScript

普通 JavaScript 项目

module.exports = {
  extends: '@hjkcai/eslint-config-halo/js'
};
{
  "scripts": {
    "lint": "eslint ."
  }
}

React + JavaScript 项目

module.exports = {
  extends: '@hjkcai/eslint-config-halo/js/react'
};
{
  "scripts": {
    "lint": "eslint . --ext .js,.jsx"
  }
}

TypeScript

普通 TypeScript 项目

module.exports = {
  extends: '@hjkcai/eslint-config-halo/ts'
};
{
  "scripts": {
    "lint": "eslint . --ext .js,.ts"
  }
}

React + TypeScript 项目

module.exports = {
  extends: '@hjkcai/eslint-config-halo/ts/react'
};
{
  "scripts": {
    "lint": "eslint . --ext .js,.jsx,.ts,.tsx"
  }
}

TypeScript 严格模式

对于某些需要非常认真地对待的项目,不能马虎的那种,推荐使用 TypeScript 严格模式配置。

普通 TypeScript 项目

module.exports = {
  extends: '@hjkcai/eslint-config-halo/ts-strict'
};
{
  "scripts": {
    "lint": "eslint . --ext .js,.ts"
  }
}

React + TypeScript 项目

module.exports = {
  extends: '@hjkcai/eslint-config-halo/ts-strict/react'
};
{
  "scripts": {
    "lint": "eslint . --ext .js,.jsx,.ts,.tsx"
  }
}

License

MIT