前端之家

  1. 首页
  2. 博文

Web项目如何配置Eslint

• 博文 • 作者：CanotStop

介绍

ESLint 是一个根据方案识别并报告 ECMAScript/JavaScript 代码问题的工具，其目的是使代码风格更加一致并避免错误。在很多地方它都与 JSLint 和 JSHint 类似，除了：

  • ESLint 使用 Espree 对 JavaScript 进行解析。
  • ESLint 在代码中使用 AST 评估方案。
  • ESLint 完全是插件式的，每个规则都是一个插件，你可以在运行时中添加更多插件。

安装

@REM npm 安装eslint
npm i -D eslint
@REM yarn 安装eslint
yarn  add -D eslint

配置

配置过程

npm init @eslint/config

You can also run this command directly using 'npm init @eslint/config'.
Need to install the following packages:
  @eslint/create-config@0.4.6
Ok to proceed? (y) y
@REM 您还可以使用“npm init @eslint/config”直接运行此命令。
@REM 需要安装以下软件包：
@REM  @eslint/create-config@0.4.6
@REM 确定继续: 是

How would you like to use ESLint? ...
  To check syntax only
  To check syntax and find problems
> To check syntax,find problems,and enforce code style
@REM 您想如何使用 ESLint？ ...
@REM   仅检查语法
@REM   检查语法并发现问题
@REM > 检查语法、发现问题并强制执行代码风格

What type of modules does your project use? ...
> JavaScript modules (import/export)
  CommonJS (require/exports)
  None of these
@REM 您的项目使用什么类型的模块？ ...
@REM > JavaScript 模块（导入/导出）
@REM   CommonJS（要求/导出）
@REM   都不是

Which framework does your project use? ...
  React
> Vue.js
  None of these
@REM 您的项目使用哪个框架？ ...
@REM   React
@REM > Vue.js
@REM   都不是

Does your project use TypeScript? » No / Yes
@REM 您的项目使用 TypeScript 吗？ » 否/是

Where does your code run? ...  (Press <space> to select,<a> to toggle all,<i> to invert selection)
√ Browser
√ Node
你的代码在哪里运行？ ...（按 <space> 进行选择，<a> 切换全部，<i> 反转选择）
√ 浏览器
√ 节点

How would you like to define a style for your project? ...
> Use a popular style guide
  Answer questions about your style
@REM 您希望如何为您的项目定义风格？ ...
@REM > 使用流行的风格指南
@REM   回答有关您风格的问题

Which style guide do you want to follow? ...
  Airbnb: https://github.com/airbnb/javascript
> Standard: https://github.com/standard/standard
  Google: https://github.com/google/eslint-config-google
  XO: https://github.com/xojs/eslint-config-xo

@REM 您想遵循哪种风格指南？ ...
@REM   Airbnb: https://github.com/airbnb/javascript
@REM > Standard: https://github.com/standard/standard
@REM   Google: https://github.com/google/eslint-config-google
@REM   XO: https://github.com/xojs/eslint-config-xo

What format do you want your config file to be in? ...
> JavaScript
  YAML
  JSON
@REM 您希望配置文件采用什么格式？ ...
@REM > JavaScript
@REM   YAML
@REM   JSON

@REM 您选择的配置需要以下依赖项：

@REM eslint-plugin-vue@latest eslint-config-standard@latest eslint@^8.0.1 eslint-plugin-import@^2.25.2 eslint-plugin-n@^15.0.0 || ^16.0.0  eslint-plugin-promise@^6.0.0
@REM ？您想现在安装它们吗？ » 否/是
The config that you've selected requires the following dependencies:

eslint-plugin-vue@latest eslint-config-standard@latest eslint@^8.0.1 eslint-plugin-import@^2.25.2 eslint-plugin-n@^15.0.0 || ^16.0.0  eslint-plugin-promise@^6.0.0
? Would you like to install them now? » No / Yes

Which package manager do you want to use? ...
> npm
  yarn
  pnpm
@REM 您想使用哪个包管理器？ ...
@REM > npm
@REM   yarn
@REM   pnpm

配置结果

√ How would you like to use ESLint? · style
√ What type of modules does your project use? · esm
√ Which framework does your project use? · vue
√ Does your project use TypeScript? · No / Yes
√ Where does your code run? · browser,node
√ How would you like to define a style for your project? · guide
√ Which style guide do you want to follow? · standard
√ What format do you want your config file to be in? · JavaScript
Checking peerDependencies of eslint-config-standard@latest
The config that you've selected requires the following dependencies:

eslint-plugin-vue@latest eslint-config-standard@latest eslint@^8.0.1 eslint-plugin-import@^2.25.2 eslint-plugin-n@^15.0.0 || ^16.0.0  eslint-plugin-promise@^6.0.0
√ Would you like to install them now? · No / Yes
√ Which package manager do you want to use? · npm
Installing eslint-plugin-vue@latest,eslint-config-standard@latest,eslint@^8.0.1,eslint-plugin-import@^2.25.2,eslint-plugin-n@^15.0.0 || ^16.0.0,eslint-plugin-promise@^6.0.0

安装项目 Eslint 支持

Webpack 方式

安装 eslint-webpack-plugin

@REM npm
npm install eslint-webpack-plugin -D
@REM yarn
yarn add eslint-webpack-plugin --save-dev

在 Webpack.config.js 中使用

详细配置可查看官网：eslint-webpack-plugin

plugins: [
  new ESLintWebpackPlugin({
    // 指定检查文件的根目录
    context: path.resolve(__dirname,"src")
  })
],

Vite 方式

其实， Viite 创建的项目本来是不需要另外配置 Eslint 根据 Vite 官网文档，一般在使用 Vite 的命令创建 Web 项目时使用自定义创建使用不使用默认模版时会询问是否需要配置 Eslint，但是在使用脚本创建 uniapp 项目时需要另外安装

使用 Vite 建立项目例子

npm create vite@latest my-vue-app --template vue
√ Select a framework: » Vue
√ Select a variant: » Customize with create-vue ↗
Need to install the following packages:
  create-vue@3.7.3
Ok to proceed? (y) y

Vue.js - The Progressive JavaScript Framework

√ Add TypeScript? ... No / Yes
√ Add JSX Support? ... No / Yes
√ Add Vue Router for Single Page Application development? ... No / Yes
√ Add Pinia for state management? ... No / Yes
√ Add Vitest for Unit Testing? ... No / Yes
√ Add an End-to-End Testing Solution? » No
√ Add ESLint for code quality? ... No / Yes
√ Add Prettier for code formatting? ... No / Yes

安装 vite-plugin-eslint

说明: 该包是用于配置 vite 运行的时候自动检测 eslint 规范 不符合页面会报错

@REG npm 安装
npm i -D vite-plugin-eslint
@REG yarn 安装
yarn add -D vite-plugin-eslint --save-dev

安装 eslint-parser

@REM npm 安装
npm i -D @babel/core @babel/eslint-parser
@REM yarn 安装
yarn add @babel/core @babel/eslint-parser --save-dev

拓展（安装 prettier）

正常来说安装到上一步已经是完成了 Eslint 配置，此时使用的是 Eslint 流行风格中的 Standard 风格，由于该规则比较严格，使用起来可能有点麻烦，有些开发者就喜欢使用 prettier 的相对比较宽松的规则，以下就是该规则的配置方式

安装依赖

@REM npm 安装
npm i -D prettier eslint-config-prettier eslint-plugin-prettier
@REM yarn 安装
yarn add prettier eslint-config-prettier eslint-plugin-prettier --save-dev

配置.prettierrc.js

在根目录下面添加.prettierrc.js 文件，然后将下面的配置添加到其中：

//这些配置随项目规范而定，并非需要
module.exports = {
  // 一行最多多少个字符
  printWidth: 150,// 指定每个缩进级别的空格数
  tabWidth: 2,// 使用制表符而不是空格缩进行
  usetabs: true,// 在语句末尾是否需要分号
  semi: true,// 是否使用单引号
  singleQuote: true,// 更改引用对象属性的时间 可选值"<as-needed|consistent|preserve>"
  quoteProps: "as-needed",// 在JSX中使用单引号而不是双引号
  jsxSingleQuote: false,// 多行时尽可能打印尾随逗号。（例如，单行数组永远不会出现逗号结尾。） 可选值"<none|es5|all>"，默认none
  trailingComma: "es5",// 在对象文字中的括号之间打印空格
  bracketSpacing: true,// jsx 标签的反尖括号需要换行
  jsxBracketSameLine: false,// 在单独的箭头函数参数周围包括括号 always：(x) => x \ avoid：x => x
  arrowParens: "always",// 这两个选项可用于格式化以给定字符偏移量（分别包括和不包括）开始和结束的代码
  rangeStart: 0,rangeEnd: Infinity,// 指定要使用的解析器，不需要写文件开头的 @prettier
  requirePragma: false,// 不需要自动在文件开头插入 @prettier
  insertPragma: false,// 使用默认的折行标准 always\never\preserve
  proseWrap: "preserve",// 指定HTML文件的全局空格敏感度 css\strict\ignore
  htmlWhitespaceSensitivity: "css",// Vue文件脚本和样式标签缩进
  vueIndentScriptAndStyle: false,endOfLine: "auto",};

注意：配置文件修改如果是 eslint 能立刻反应并且提示，但是 prettier 修改后，由于结合了 eslint 插件，可能会导致不同步，需要重启 VsCode 才能一致，比如把单引号修改为双引号，prettier 能立马格式化代码使用双引号，但是 eslint 检查会报错，所以修改完成 prettier 配置文件建议重启一下 VsCode，保证 eslint 检查同步更新。

配置.prettierignore

如果不想格式化某些文件可以再添加一个的文件，用法和.gitignore 文件差不多，将不需要格式化的文件夹或文件通过正则匹配或者具名的方式添加进去，这样就不会格式化对应的文件了。

Prettier 结合 ESLint

在 package.json 的 scripts 节点中添加如下节点

"lint": "eslint . --ext .vue,.js,.jsx,.cjs,.mjs --fix --ignore-path .gitignore"

在.eslintrc.js 在添加如下选项，然后运行 npm run lint 命令即可生效

"plugin:prettier/recommended","prettier";

版权声明：本文内容由互联网用户自发贡献，该文观点仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌抄袭侵权/违法违规的内容， 请发送邮件举报，一经查实，本站将立刻删除。

本文链接：https://www.f2er.com/3188640.html

大家都在看

  • 飞码LowCode前端技术系列：如何便捷快速验证实现投产及飞码探索 博文

    飞码LowCode前端技术系列：如何便捷快速验证实现投产及飞码探索

    本篇文章从数据中心，事件中心如何协议工作、不依赖环境对vue2.x、vue3.x都可以支持、投产页面问题定位三个方面进行分析。
    2023-11-16 • 博文
  • 如何优雅使用 vuex 博文

    如何优雅使用 vuex

    大纲 本文内容更多的是讲讲使用 vuex 的一些心得想法，所以大概会讲述下面这些点： Q1：我为什么会想使用 vuex 来管理数据状态交互？ Q2：使用 vuex 框架有哪些缺点或者说副作用？ Q3：我是如何在项目里使用 vuex 的？ 初识 vuex 对于 vuex，有人喜欢，有人反感 喜欢的人觉
    2023-11-16 • 博文

  • 第三方组件及计算属性传参的问题解决方式

    1. 前言 唉，好想玩滋嘣。 2. 计算属性直接传参接收不到 表格数据某一列需要用的计算属性时，模板中使用计算属性 fullName 就会直接调用 fullName 函数，而在模板中 fullName(item) 相当于fullName()(item)，此处为函数柯里化。 &lt;el-table-
    2023-11-16 • 博文
  • 记录--Vue3基于Grid布局简单实现一个瀑布流组件 博文

    记录--Vue3基于Grid布局简单实现一个瀑布流组件

    这里给大家分享我在网上总结出来的一些知识，希望对大家有所帮助 前言 在学习Grid布局之时，我发现其是CSS中的一种强大的布局方案，它将网页划分成一个个网格，可以任意组合不同的网格，做出各种各样的布局，在刷某书和某宝首页时，我们发现其展示方式就是一种瀑布流，是一种流行的网站页面布局，视觉表……
    2023-11-16 • 博文

  • 用强数据类型保护你的表单数据-基于antd表单的类型约束

    接口数据类型与表单提交数据类型，在大多数情况下，大部分属性的类型是相同的，但很少能做到完全统一。我在之前的工作中经常为了方便，直接将接口数据类型复用为表单内数据类型，在遇到属性类型不一致的情况时会使用any强制忽略类型错误。后来经过自省与思考，这种工作模式会引起各种隐藏bug，一定有更……
    2023-11-16 • 博文
  • pinia的使用 博文

    pinia的使用

    前言 最近新开了个项目，以前老项目都是vue2+vuex开发的，都说用vue3+pinia爽得多，那新项目就vue3+pinia吧。这里记录一下pinia的使用。 使用方法 安装pinia: npm i pinia main.js中引入pinia: //main.js import { create
    2023-11-16 • 博文
  • 记录--让我们来深入了解一下前端“三清”是什么 博文

    记录--让我们来深入了解一下前端“三清”是什么

    这里给大家分享我在网上总结出来的一些知识，希望对大家有所帮助 前端“三清” 在前端开发中，我们经常听到关于“三清”的说法，即 window、document、Object。这三者分别代表了 BOM（浏览器对象模型）、DOM（文档对象模型）以及 JS 的顶层对象。在这个体系中，我们通过 JavaScr
    2023-11-16 • 博文
  • 记录--啊？Vue是有三种路由模式的？ 博文

    记录--啊？Vue是有三种路由模式的？

    这里给大家分享我在网上总结出来的一些知识，希望对大家有所帮助 众所周知，vue路由模式常见的有 history 和 hash 模式，但其实还有一种方式-abstract模式（了解一哈~） 别急，本文我们将重点逐步了解： 路由 + 几种路由模式 + 使用场景 + 思考 + freestyle 路由概念
    2023-11-16 • 博文