在前端开发过程中,代码质量问题经常成为开发的瓶颈之一。要保证代码质量,我们需要不断地把代码进行规范化和优化。而Lint是完成这个任务的一种工具,能够发现代码中的一些潜在问题并给出建议。本文将介绍一个npm包,@brikcss/eslint-config-brikcss,它提供了一组ESLint规则,帮助开发者自动化规范化代码风格,保障代码质量。
安装
全局安装ESLint
在安装@brikcss/eslint-config-brikcss之前,需要确保在全局安装了ESLint。使用以下命令即可安装:
npm install -g eslint
安装@brikcss/eslint-config-brikcss
在你的项目中使用以下命令安装@brikcss/eslint-config-brikcss:
npm install --save-dev @brikcss/eslint-config-brikcss
这条命令会把@brikcss/eslint-config-brikcss以及它所依赖的其他npm包一次性地安装到你项目的node_modules
目录下,并保存在package.json
文件中的devDependencies
中。
使用
创建一个配置文件
在项目根目录下新建一个.eslintrc
文件,并在其中加入以下内容:
{ "extends": [ "@brikcss/eslint-config-brikcss" ] }
这表示你的ESLint配置继承自@brikcss/eslint-config-brikcss。
也可以在.eslintrc
文件中加入自定义的规则规范。例如:
-- -------------------- ---- ------- - ---------- - -------------------------------- -- -------- - ------- --------- ---------- --------- --------- --------- - -
这个例子中,我们修改了@brikcss/eslint-config-brikcss中的规则,规定了代码必须以分号结尾,并使用双引号。
配置文件放置的位置
当在项目目录下找不到.eslintrc
文件,ESLint便会在逐层向上查找,直到找到.eslintrc
文件或者到达文件系统的根目录为止。ESLint会使用第一个.eslintrc
文件中定义的配置。
VS Code配置
如果你使用的是Visual Studio Code,需要进行以下配置才能使ESLint生效。
打开VS Code,按Ctrl + Shift + P
打开命令面板,在里面输入“settings.json”并打开。在打开的用户全局设置中,添加以下内容:
{ "eslint.enable": true, "eslint.options": { "configFile": "./.eslintrc.js" } }
请注意修改configFile
的值,指向你的.eslintrc
配置文件(ESLint需要支持已安装)。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/600566d781e8991b448e32b8