npm 包 eslint-config-jlarmst 使用教程

阅读时长 3 分钟读完

在前端开发的过程中,代码规范是非常重要的,它可以让我们的代码更加易读、易维护和易扩展。而 eslint 是一款非常强大的代码规范检测工具,可以协助我们检查代码规范,并给出相应的提示和警告,从而帮助我们提高代码质量。本文将介绍一款叫做 eslint-config-jlarmst 的 npm 包,它是一个 eslint 的配置包,可以让我们在开发中快速使用一个通用的 ESLint 配置。

npm 包 eslint-config-jlarmst

eslint-config-jlarmst 是一个基于 eslint 的规则配置包,但其并不含有 eslint 安装包,所以需要先安装 eslint。

安装

它的安装非常简单,只需要在你的项目中执行以下命令:

同时需要全局安装 eslint:

注意:由于当前你可能已经在项目中使用了 eslint,为避免冲突,需要先停止当前的 eslint 校验。

以下是一些常见的选项

选项
How would you like to configure ESLint? Use a popular style guide
Which style guide do you want to follow? Airbnb
What format do you want your config file to be in? JavaScript

配置

安装完成后需要配置 .eslintrc.js 文件,继承自 eslint-config-jlarmst 配置,并制定开发环境要使用的 ECMAScript 版本。

-- -------------------- ---- -------
-------------- - -
  ---------- -
    ---------
  --
  ------ -
    ------- -----
    ---------- -----
    ------ ----
  --
  ---------------- -
    -------------- ----
  -
-

在配置中,我们继承自 eslint-config-jlarmst 的配置,和指定了 ESLint 要解析的环境以及使用的 ECMAScript 版本。

在 VS Code 中使用

我们可以直接使用 VS Code 的 ESLint 插件来检查我们的代码规范,只需要在插件配置中设置 eslint.enable 为 true,同时可以通过 eslint.validate 来指定需要检查的文件。

参考

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60066b6151ab1864dac672f3

纠错
反馈