title: Vue 3与ESLint、Prettier：构建规范化的前端开发环境
date: 2024/6/11
updated: 2024/6/11
publisher: cmdragon
excerpt:
这篇文章介绍了如何在Vue 3项目中配置ESLint和Prettier以统一代码风格，实现代码规范性与可读性的提升。通过设置规则、解决冲突、以及将配置融入持续集成流程和代码审查过程，确保团队协作时代码风格的一致性，提升开发效率与项目维护性。
categories:
tags:
扫码关注或者微信搜一搜：编程智域 前端至全栈交流与成长
Vue 3是Vue.js前端框架的第三个主要版本，它带来了许多新的特性和改进，旨在提供更好的性能、更小的体积和更灵活的API。Vue 3的核心库采用了Composition API，这使得组件的逻辑组织更加清晰，同时保持了与Vue 2的兼容性。Vue 3还引入了Tree-shaking、Teleport、Fragment、Suspense等新特性，以及更好的TypeScript支持。
搭建Vue 3开发环境通常需要以下步骤：
vue create命令，可以选择预设或手动配置项目。npm install或yarn install命令安装项目依赖。npm run serve或yarn serve命令启动开发服务器，查看项目是否正常运行。Vue 3项目通常具有以下目录结构：
my-vue3-project/
├── node_modules/ # 项目依赖
├── public/ # 公共静态资源
│ └── index.html # 入口HTML文件
├── src/ # 源代码
│ ├── assets/ # 静态资源
│ ├── components/ # Vue组件
│ ├── router/ # 路由配置
│ ├── store/ # Vuex状态管理
│ ├── App.vue # 根组件
│ └── main.js # 入口文件
├── .eslintrc.js # ESLint配置文件
├── .prettierrc.js # Prettier配置文件
├── package.json # 项目配置和依赖
└── README.md # 项目说明
node_modules/：存放项目的依赖库。public/：存放公共静态资源，如入口HTML文件。src/：存放源代码，包括组件、路由、状态管理等。.eslintrc.js：ESLint的配置文件，用于定义代码规范。.prettierrc.js：Prettier的配置文件，用于定义代码格式化规则。package.json：定义项目依赖、脚本和配置信息。README.md：项目说明文件，通常包含项目的基本信息和构建指南。通过理解Vue 3项目的基础和结构，开发者可以更好地进行项目开发和维护。
ESLint是一个插件化的JavaScript代码检查工具，用于识别和报告JavaScript代码中的模式，以确保代码质量。它可以帮助开发者遵循编码规范，避免潜在的错误，并保持代码的一致性。ESLint是高度可配置的，可以通过插件和规则来扩展其功能。cmdragon's Blog
安装ESLint通常需要以下步骤：
npm install -g eslint来全局安装ESLint。npm install eslint --save-dev来安装ESLint作为开发依赖。npx eslint --init，根据提示选择配置选项，生成.eslintrc.*配置文件。.eslintrc.js、.eslintrc.json或.eslintrc.yaml，根据个人喜好选择。ESLint的配置文件定义了代码检查的规则。以下是一些基本的规则和配置示例：
rules对象来启用或禁用规则。例如，要启用semi规则（要求或禁止使用分号），可以设置"semi": ["error", "always"]。env对象来指定代码运行的环境，如browser、node等。globals对象来声明全局变量，例如"jQuery": true。extends属性来扩展其他配置文件，如"extends": "eslint:recommended"。plugins属性来使用ESLint插件，例如"plugins": ["vue"]。以下是一个简单的.eslintrc.js配置文件示例：
module.exports = {
"env": {
"browser": true,
"node": true
},
"extends": "eslint:recommended",
"globals": {
"jQuery": true
},
"rules": {
"semi": ["error", "always"],
"quotes": ["error", "double"]
},
"plugins": [
"vue"
]
};
这个配置文件启用了浏览器和Node.js环境，扩展了ESLint的推荐规则，声明了jQuery为全局变量，要求使用分号，并使用双引号，同时启用了Vue插件。
通过学习和配置ESLint，开发者可以确保代码质量，减少错误，并保持代码风格的一致性。
Prettier是一个自动格式化代码的工具，它通过解析代码并使用自己的规则重新打印代码，以保持一致的代码风格。Prettier支持多种语言，包括JavaScript、TypeScript、HTML、CSS、SCSS等。它旨在减少开发者之间关于代码格式的争论，并提高开发效率。
安装Prettier通常需要以下步骤：
npm install prettier --save-dev来安装Prettier作为开发依赖。.prettierrc文件，或者在package.json中添加prettier配置。npx prettier --write <文件路径>来格式化单个文件，或者npx prettier --write .来格式化整个项目。Prettier的配置选项可以在.prettierrc文件中设置，或者在package.json中的prettier字段中设置。以下是一些常用的配置选项：
printWidth：指定每行代码的最大宽度（默认为80）。tabWidth：指定每个制表符的空格数（默认为2）。useTabs：指定是否使用制表符而不是空格（默认为false）。semi：指定是否在语句末尾添加分号（默认为true）。singleQuote：指定是否使用单引号而不是双引号（默认为false）。trailingComma：指定多行对象和数组的最后一个元素后面是否添加逗号（默认为"es5"）。bracketSpacing：指定对象字面量属性之间是否需要空格（默认为true）。jsxBracketSameLine：指定多行JSX元素是否在最后一行闭合（默认为false）。以下是一个.prettierrc配置文件示例：
{
"printWidth": 100,
"tabWidth": 2,
"useTabs": false,
"semi": true,
"singleQuote": true,
"trailingComma": "es5",
"bracketSpacing": true,
"jsxBracketSameLine": false
}
这个配置文件设置了每行代码的最大宽度为100，使用2个空格作为制表符，语句末尾添加分号，使用单引号，多行对象和数组的最后一个元素后面添加逗号，对象字面量属性之间需要空格，多行JSX元素不在最后一行闭合。
通过学习和配置Prettier，开发者可以保持一致的代码风格，减少手动格式化代码的时间，并提高代码的可读性和可维护性。
要在Vue 3项目中安装ESLint和Prettier，可以按照以下步骤操作：
安装Node.js和npm：确保你的系统上已经安装了Node.js和npm。
创建Vue 3项目：如果还没有Vue 3项目，可以使用Vue CLI创建一个新的项目。运行vue create your-project-name，并选择手动配置，以便可以添加ESLint和Prettier。
安装ESLint和Prettier：在项目目录下运行以下命令来安装ESLint和Prettier及其相关依赖：
npm install eslint eslint-plugin-vue --save-dev
npm install prettier eslint-config-prettier eslint-plugin-prettier --save-dev
安装编辑器插件：大多数现代代码编辑器都支持ESLint和Prettier，可以通过安装相应的插件来集成。
为了使ESLint能够正确地解析Vue单文件组件（.vue文件），需要安装并配置eslint-plugin-vue。这通常在创建Vue项目时就已经完成，但如果需要手动配置，可以按照以下步骤操作：
创建ESLint配置文件：在项目根目录下创建一个.eslintrc.js文件，并添加以下内容：
module.exports = {
root: true,
env: {
node: true
},
extends: [
'plugin:vue/vue3-essential',
'eslint:recommended',
'@vue/prettier'
],
parserOptions: {
parser: 'babel-eslint'
},
rules: {
// 在这里添加自定义规则
}
};
确保ESLint能够解析.vue文件：确保.eslintignore文件中不包含.vue扩展名，这样ESLint就会检查Vue文件。
为了使Prettier和ESLint协同工作，需要安装eslint-config-prettier和eslint-plugin-prettier，并在ESLint配置中引入它们。这通常在安装Prettier时已经完成，但如果需要手动配置，可以按照以下步骤操作：
.eslintrc.js文件中，确保extends数组中包含了'plugin:prettier/recommended'，这样Prettier的规则就会被ESLint所采用。.prettierrc文件，并添加你的Prettier配置。通过以上步骤，你就可以在Vue 3项目中集成ESLint和Prettier，从而保持代码风格的一致性，并提高代码质量。
代码规范是指一组关于代码编写风格和结构的规则。它们对于软件开发项目来说至关重要，原因如下：
选择或创建代码规范集时，可以考虑以下几个方面：
一旦选择了代码规范，就需要将其应用到项目中。以下是一些步骤：
.eslintrc.js、.prettierrc等配置文件。通过以上步骤，可以将代码规范有效地应用到项目中，从而提高代码质量，促进团队合作。
变量和函数的命名是代码规范中非常重要的一部分，良好的命名可以提高代码的可读性和可维护性。以下是一些通用的命名规范：
变量命名：
userAge。ID。maxWidth而不是w。_privateVariable。函数命名：
calculateTotal。getUserProfile。doSomething。代码的缩进和格式化对于代码的可读性至关重要。以下是一些通用的缩进和格式化规范：
缩进：
格式化：
a = b + c。array = [1, 2, 3]。functionName(arg1, arg2)。在实践代码规范时，以下是一些最佳实践和常见陷阱：
最佳实践：
常见陷阱：
持续集成（CI）是一种软件开发实践，其中团队成员的代码更改频繁地集成到主分支中。ESLint是一个用于识别和报告JavaScript代码中的模式匹配的工具，而Prettier是一个自动格式化代码的工具。将ESLint和Prettier集成到CI流程中可以确保代码质量和一致性。
AD：覆盖广泛主题工具可供使用
配置ESLint：
.eslintrc文件，配置ESLint规则。npm install eslint --save-dev。npx eslint --init来初始化ESLint配置。配置Prettier：
.prettierrc文件，配置Prettier规则。npm install prettier --save-dev。package.json中添加一个脚本来运行Prettier："prettier": "prettier --write '**/*.{js,jsx,ts,tsx}'"。集成到CI：
.travis.yml或Jenkinsfile），添加步骤来安装ESLint和Prettier。npm run lint和npm run prettier。代码审查是确保代码质量的关键步骤，ESLint和Prettier可以帮助提供自动化的反馈。
代码审查：
ESLint和Prettier反馈：
自动化代码质量监控可以帮助团队保持代码质量，并及早发现潜在的问题。
设置监控：
定期报告：
持续改进：
通过持续集成、代码审查和自动化代码质量监控，可以确保代码质量并提高开发效率。
自定义ESLint规则可以帮助团队根据项目需求调整代码规范。
创建自定义规则：
eslint-rules的文件夹。custom-rule.js。配置ESLint使用自定义规则：
.eslintrc文件中，添加extends字段来指定自定义规则文件。rules字段来启用和配置自定义规则。ESLint插件可以扩展ESLint的功能，提供额外的规则和功能。
安装ESLint插件：
npm install eslint-plugin-example --save-dev来安装插件（example是插件名）。配置ESLint使用插件：
.eslintrc文件中，添加plugins字段来指定插件。rules字段来启用和配置插件的规则。Prettier和ESLint可以协同工作，以确保代码既符合风格规范又符合代码质量规范。
安装ESLint Prettier插件：
npm install eslint-config-prettier eslint-plugin-prettier --save-dev来安装插件。配置ESLint忽略Prettier冲突：
.eslintrc文件中，添加extends字段来指定eslint-config-prettier。plugins字段中添加prettier。rules字段中，将prettier/prettier规则设置为error。配置Prettier忽略ESLint格式化：
.prettierrc文件中，添加eslintIntegration字段并设置为true。通过这些高级配置，可以确保Prettier和ESLint协同工作，提高代码质量和一致性。
ESLint 提供了大量的规则来帮助开发者编写高质量的代码。以下是一些常用的ESLint规则：
semi: 要求或禁止使用分号而不是 ASI（自动分号插入）。quotes: 强制使用单引号、双引号或模板字符串。no-unused-vars: 禁止出现未使用过的变量。no-console: 禁止使用console对象。no-debugger: 禁止使用debugger语句。indent: 强制使用一致的缩进。linebreak-style: 强制使用一致的换行风格（LF 或 CRLF）。no-multiple-empty-lines: 禁止出现多行空行。no-trailing-spaces: 禁止行尾空格。arrow-parens: 要求箭头函数的参数使用圆括号。Prettier 提供了一系列配置选项来控制代码格式化。以下是一些常用的Prettier配置选项：
printWidth: 指定每行代码的最大字符数。tabWidth: 指定每个制表符的空格数。useTabs: 强制使用制表符而不是空格。semi: 在语句末尾添加分号。singleQuote: 使用单引号而不是双引号。trailingComma: 在多行对象字面量中打印尾随逗号。bracketSpacing: 在对象字面量属性中打印空格。jsxBracketSameLine: 将多行JSX元素的>放置在最后一行的末尾。arrowParens: 为单个参数的箭头函数添加圆括号。在使用Vue 3与ESLint、Prettier时，可能会遇到以下问题：
Vue文件格式化问题：
eslint-plugin-vue插件来支持Vue文件。vue语言支持。组件命名规范：
vue/component-name-in-template-casing。模板语法检查：
vue/no-unused-vars。