概述
实际工作中很多时候都是多人协同开发一个项目,这时需要保证大家的代码可读性和规范性,所以webpack提供了js语法检查功能eslint,可以让团队中的每位成员都保持相近的编码风格。
准备工作
新建一个项目eslint-demo,基本配置一下webpack。
index.js(写一个格式很丑的js):
function sum(a,b){
return a+b
}
sum(1,2)
index.html:
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>webpack</title>
</head>
<body>
</body>
</html>
webpack.config.js:
const {resolve} = require('path')
const HtmlWebpackPlugin = require('html-webpack-plugin')
module.exports = {
entry: './src/js/index.js',
output: {
filename: 'build.js',
path: resolve(__dirname, 'build')
},
module: {
rules: []
},
plugins: [
new HtmlWebpackPlugin({
template: './src/index.html'
})
],
mode: 'development'
}
安装
webpack使用eslint需要安装eslint和eslint-loader。
npm i eslint eslint-loader -D
添加eslint配置文件
eslint需要添加一些配置才能起作用,配置有两种方式,第一种是在项目根目录添加.eslintrc.js配置文件,第二种是在package.json中添加eslintConfig配置项。为了好管理,建议选择第一种。
.eslintrc.js:
module.exports = {
// 配置eslint的代码规范
// airbnb-base是比较好的代码规范
// 这里可以是数组,同时配置多个规范
extends: 'airbnb-base'
}
eslint的详细配置可以参考官方网站。
在npm官网上可以看到airbnb相关说明,使用之前需要安装eslint-config-airbnb-base和eslint-plugin-import。
npm i eslint-config-airbnb-base eslint-plugin-import -D
配置eslint-loader
webpack.config.js:
const {resolve} = require('path')
const HtmlWebpackPlugin = require('html-webpack-plugin')
module.exports = {
entry: './src/js/index.js',
output: {
filename: 'build.js',
path: resolve(__dirname, 'build')
},
module: {
rules: [
// js语法检查
{
test: /\.js$/,
loader: 'eslint-loader'
}
]
},
plugins: [
new HtmlWebpackPlugin({
template: './src/index.html'
})
],
mode: 'development'
}
看看效果
构建项目…
可以看到构建时eslint提示很多错误,这些都是编码不规范的错误,但是我们如果看着这些错误一个个找就有点麻烦,可以让eslint自动帮我们处理好,只需要修改一下eslint-loader的配置就可以了。
webpack.config.js:
const {resolve} = require('path')
const HtmlWebpackPlugin = require('html-webpack-plugin')
module.exports = {
entry: './src/js/index.js',
output: {
filename: 'build.js',
path: resolve(__dirname, 'build')
},
module: {
rules: [
// js语法检查
{
test: /\.js$/,
loader: 'eslint-loader',
options: {
// 自动处理不规范的代码
fix: true
}
}
]
},
plugins: [
new HtmlWebpackPlugin({
template: './src/index.html'
})
],
mode: 'development'
}
重新构建项目就不会报错了,现在查看一下源代码中的index.js的格式变化,发现代码变得规范了很多。
对eslint语法检查的介绍就到这里了,配置都很简单,想要详细了解可以看看官网,喜欢的点个赞吧,谢谢大家!
下一篇讲解js的浏览器兼容性问题,敬请期待!