npm 包 eslint-config-sketchplugin 使用教程

阅读时长 3 分钟读完

概述

eslint-config-sketchplugin 是一个基于 eslint 的规则集。它包含了基本的 JavaScript 规则,并且针对 Sketch 插件开发做出了部分配置。通过该 npm 包,我们可以快速搭建一个 Sketch 插件项目的代码规范。

安装

使用

在项目根目录下创建 .eslintrc 文件,并添加以下内容:

这样就可以使用 eslint 并且继承了 eslint-config-sketchplugin 的规则集了。

配置项

.eslintrc 中也可以自定义配置项,例如:

上例中,我们覆盖了 sketchplugin 规则集中的 semi 规则,改为要求必须添加分号。

示例代码

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

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

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

在使用 eslint-config-sketchplugin 的配置后,对于以上示例代码,会有以下规则提示:

  • 禁止使用未定义的变量。(no-undef
  • 函数中必须使用类型注释。(@typescript-eslint/explicit-function-return-type
  • 禁止使用类成员中的 this。(class-methods-use-this
  • 对象字面量必须使用简写语法。(@typescript-eslint/object-shorthand
  • 对象字面量中属性和值之间必须加空格。(key-spacing

以上仅为部分规则展示,完整列表可到 eslint-config-sketchplugin 的仓库查看。

总结

eslint-config-sketchplugin 是一个非常有用的 npm 包,能够大大提高我们的代码质量和规范性。在使用过程中,我们还可以根据自己的需求来自定义规则,以便更好地适应当前的项目。

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

纠错
反馈