npm 包 eslint-config-unobtrusive 使用教程

简介

在前端开发中,为了确保代码质量与风格的一致性,我们经常需要使用一些代码规范工具。其中,ESLint 是一款比较流行的 JavaScript 代码检查工具,它可以检查代码风格是否符合指定规范,并提供了一些修复能力。

然而,使用 ESLint 进行代码检查也需要一些配置,在维护和更新时也需要一定的成本。因此,社区中也出现了一些可复用的规则配置,如 eslint-config-airbnb、eslint-config-standard 等,这些配置可以直接在项目中使用,方便了前端开发人员的开发过程。

本文将介绍一个比较小众的 eslint 配置包 eslint-config-unobtrusive,它可以帮助我们维护高质量的代码,降低代码维护成本。

安装

只需要在项目中安装 eslint 和 eslint-config-unobtrusive 两个包即可。

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

使用

单个项目中使用

在项目根目录下,新建 .eslintrc.js 文件,然后在其中添加如下配置:

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

然后,在项目根目录下运行以下命令即可开始 lint:

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

在多个项目中使用

如果我们想在多个项目中使用相同的规则配置,我们可以将配置提取到单独的配置项目中,这样我们在多个项目中共享同一个配置项目即可。

首先,我们在根目录下创建一个 lint-config 项目,然后在其根目录下创建 .eslintrc.js 文件,用于存放通用配置。

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

接着,在其他项目中安装 eslint 和 eslint-config-unobtrusive,并在项目根目录下安装它们的依赖:

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

然后,在项目根目录下新建配置文件 .eslintrc.js,指定 extends 和 rules:

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

这样,在项目中运行 eslint 命令时,将会优先使用项目根目录下的配置文件;如果没找到,则会使用 .eslintrc.js 中指定的配置。

规则

该包默认启用了 airbnb 的常见规则,由于篇幅限制,我们在此不再进行详细说明,请查看链接了解其含义:https://github.com/airbnb/javascript

此外,该包还启用了以下规则:

  • 'no-console': 'error'
  • 'no-unused-vars': ['error', { 'vars': 'all', 'args': 'none', 'ignoreRestSiblings': false }]
  • 'no-restricted-properties': [ 2, { 'object': 'it', 'property': 'only', 'message': 'Do not use mocha-exclusive tests in this project.' } ]

其中:

  • 禁用 console
  • 禁止未使用变量
  • 禁止在 mocha 测试中使用 it.only

这些规则可以帮助我们规范JavaScript代码的风格,避免一些常见的 Bug。

结语

ESLint 的配置十分灵活,可以根据不同的项目、团队或个人喜好来进行定制。本文介绍了一款小众的 eslint 规则配置包,通过使用它我们可以快速地规范我们的前端代码并减少代码维护成本。希望这篇文章对你有所帮助!

来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/5eedaf25b5cbfe1ea0610fa4


猜你喜欢

  • npm 包 array-rearrange 使用教程

    简介 在前端开发过程中,经常需要对数组进行操作,以满足一些特定的需求。而 npm 包 array-rearrange 就是一个非常实用的工具,可以帮助开发者轻松地对数组进行重新排列操作。

    4 年前
  • npm 包 color-id 使用教程

    前言 在前端开发中,经常需要使用颜色,例如设置文本颜色、背景颜色等等。但是我们经常遇到的问题是,如何快速地获取到我们需要的颜色值?因为在设计中,我们会遇到很多颜色值需要使用,而且这些颜色不是我们手动去...

    4 年前
  • npm 包 array-normalize 使用教程

    在前端开发中,我们常常需要对数组进行操作和处理,而 array-normalize 是一个可以快速将数组扁平化(flatten)的 npm 包。在本文中,我们将学习如何使用 array-normali...

    4 年前
  • npm 包 fps-indicator 使用教程

    简介 在前端开发过程中,我们经常需要关注页面的渲染性能,确保用户能够顺畅地使用我们的应用。其中一个非常重要的性能指标就是 FPS(Frames Per Second,每秒画面帧数)。

    4 年前
  • npm 包 ta-scripts 使用教程

    前端开发中,我们经常使用 npm 包来管理依赖关系。其中,一个非常实用的工具就是 ta-scripts,它可以帮助我们快速地搭建项目环境,并提供一些常用的命令,例如启动开发服务器、打包代码等。

    4 年前
  • npm 包 css-rules 使用教程

    介绍 在前端开发中,我们经常需要对网页进行样式布局。对于 CSS,我们经常使用预处理器如 SASS 和 LESS 来编写可复用的样式。但是在某些情况下,我们需要以编程方式生成 CSS 样式。

    4 年前
  • npm 包 remote-content 使用教程

    前言 remote-content 是一个可以将远程内容(例如 Markdown 文件、HTML 文件、图片)转换成完整的 HTML 容器的 npm 包。该包可以在前端应用程序中任何位置调用,非常适合...

    4 年前
  • npm 包 href-content 使用教程

    在前端开发中,我们经常需要获取文本中的链接地址。而当这些链接地址需要对用户进行更多解释时(例如当用户将鼠标移到链接上时),我们可能需要向用户展示一些文本内容。这时候,npm 包 href-conten...

    4 年前
  • npm 包 list-stylesheets 使用教程

    在 Web 开发中,我们常常会需要获取网页中使用的样式表(CSS 文件)的信息,例如样式表的文件名、路径、大小、所属的页面等等。然而,JavaScript 标准库并不提供相关的 API。

    4 年前
  • npm 包 mediaquery-text 使用教程

    npm 是一个用来管理 node.js 依赖关系的工具,可以非常方便的对前端项目中的依赖进行处理和管理。其中,mediaquery-text 包就是一个非常实用的前端工具,它可以用来处理 CSS 中媒...

    4 年前
  • npm 包 style-data 使用教程

    CSS 是前端开发中不可缺少的一部分,而在实际开发中我们常常需要对某些样式进行动态的操作,这时候就需要使用 JavaScript 对 CSS 进行操作。在这个过程中,我们可能会遇到一些比较麻烦的问题,...

    4 年前
  • npm 包 extract-css 使用教程

    在前端开发中,样式是非常重要的一部分。而当我们在开发过程中,需要将页面中使用到的样式提取出来,以便一些页面使用了相同样式的合并为一个文件,从而减少浏览器请求,提高页面加载速度。

    4 年前
  • npm 包 flat-util 使用教程

    在前端开发中,经常需要对 JavaScript 对象进行操作,其中包括将嵌套对象转换为扁平结构以便于处理,或者将扁平结构转换为嵌套对象以方便 UI 展示。npm 包 flat-util 提供了对于这一...

    4 年前
  • 使用 npm 包 @jonkemp/package-utils

    介绍 在前端开发过程中,我们经常会使用到各种第三方包。其中,npm 包管理工具被广泛使用。在使用 npm 包时,我们常常会遇到一些问题,例如需要获取包的各种信息,或者需要计算两个版本之间的差异。

    4 年前
  • npm 包 has-util 使用教程

    简介 has-util 是一个在 JavaScript 程序中检查对象是否拥有指定属性的工具库。在前端开发中,我们常常需要检查一个对象是否拥有某个属性,这时就可以使用 has-util。

    4 年前
  • npm 包 pick-util 使用教程

    简介 在前端开发中,我们经常需要对对象或数组进行操作,将其中的一部分提取出来。而这个过程中,我们不可避免地会遇到一些问题,比如数据结构复杂、提取方式繁琐等。Npm 包 pick-util 正是为了解决...

    4 年前
  • npm 包 inline-css 使用教程

    当我们在开发前端页面时,有时需要将 CSS 样式直接嵌入到 HTML 中,以减少请求次数或避免引用外部 CSS 文件的问题。而这时可以使用 npm 包 inline-css 来实现。

    4 年前
  • npm 包 image-palette 使用教程

    简介 image-palette 是一个基于 Node.js 的 npm 包,用来获取图片主色调的工具。该包可以帮助前端开发者快速获取图片的颜色信息,并应用到设计中去。

    4 年前
  • npm 包 convert-length 使用教程

    如果你是前端开发中需要进行数字单位转换的场景,那么 npm 包 convert-length 可能会对你很有帮助,它可以将各种长度单位进行转换。本文将为大家介绍 convert-length 包的安装...

    4 年前
  • 使用 rollup-plugin-strict-alias 实现前端模块化开发

    在前端模块化开发中,我们经常会使用各种工具来管理模块之间的依赖关系。而其中一个重要的工具就是 npm 包管理器。本文将介绍一个与 npm 包管理器结合使用的 rollup 插件,它叫做 rollup-...

    4 年前

相关推荐

    暂无文章