1.0.0 • Published 1 year ago

@mlz/eslint-config v1.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

mlz-eslint-config

eslint 统一规范配置,集成了 eslint-plugin-importeslint-plugin-prettiereslint-plugin-promiseeslint-plugin-reacteslint-plugin-react-hooks

Installation

npm i -D @mlz/eslint-config

Usage

  • 在项目根目录新建 tsconfig.json 文件,并写入下面👇代码
{
  "extends": "@mlz/eslint-config/tsconfig.json",
  "compilerOptions": {
    "baseUrl": ".",
  }
}
  • React 项目在根目录新建 .eslintrc.json 文件,并加入下面👇代码
{
  "extends": "@mlz/eslint-config",
}
  • 单纯 TypeScript 项目在根目录新建 .eslintrc.json 文件,并加入下面👇代码
{
  "extends": ["@mlz/eslint-config:typescript"],
}

不生效可能原因及解决方法:

  • 1、eslint未启用或执行报错:

    调出eslint控制台(点击vscode右下角eslint打开控制台, 如找不到,则,点击左下角设置按钮 --> 选择setting --> 输入eslint --> 把 Eslint:Always Show StatusEslint:Enable勾选上 --> 点击任意js或ts文件则会出现,若还未出现请升级vscode版本),查看是否执行过程中出现错误

  • 2、vscode版本过低(请升级到1.41.1或以上)

    mac中如果遇到无法升级,则确认vscode是否在应用程序中,如不在则手动把vscode移到应用程序中方可进行升级


AutoFix

1、打开编辑器设置文件(以vscode为例):

command + P  -->  输入setting  --> 选择 settings.json文件

2、在文件中添加如下代码并保存:

  "editor.codeActionsOnSave": {
    "source.fixAll.eslint": true,
    "source.fixAll.stylelint": true,
  },

3、修改文件后保存,便会自动修复空格、顺序等风格问题


配置说明

++++++

该项目中的配置为公司前端统一配置,除一些标明可自定义的配置外,其他配置最好不要随意更改,以保持前端代码风格的统一

++++++

tsconfig

详情请见:tsconfig.json

配置原因
targetESNext保留所有特性,配合 @babelswc 使用
moduleESNext使用ES的方式组织代码
lib"DOM", "DOM.Iterable", "ESNext"把这些库文件包含进编译的过程中保证编译的正确快速执行
allowJstrue允许检查js文件,保证js文件的质量
checkJstrue允许ts检查js文件的错误,保证js文件的质量
jsxpreserve输出.jsx且dom编译后还是原dom方便后续babel等编译
sourceMaptrue输出.map文件,方便调试
outDirbuild指定输出目录为build
removeCommentstrue删除编译后的所有的注释(使代码安全简洁,减少代码量)
noImplicitAnytrue类型安全更加严格(强制类型检验)
strictNullCheckstruenull 和 undefined检查,避免错误(严格空校验)
noUnusedLocalstrue不需要不用的变量
noImplicitReturnstrue函数的所有路径都必须有返回值
moduleResolutionnode使用node的模块解析策略
baseUrl.把tsconfig所在的目录当成是解析非相对模块的基准目录
paths-模块名到基于 baseUrl 的路径映射的列表
allowSyntheticDefaultImportstrue允许从没有设置默认导出的模块中默认导入
experimentalDecoratorstrue启用装饰器

eslint

详情请见 index.jstypescript.js 文件