npm 包 eslint-config-sketchplugin 使用教程

概述

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


猜你喜欢

  • npm 包 sectionize 使用教程

    在前端开发中,我们常常需要对文章或者页面进行分段展示和样式调整。而在这个过程中,我们会发现一个名叫 sectionize 的 npm 包,它可以帮助我们快速地将页面内容分段。

    3 年前
  • npm 包 @dilan2/ckeditor5-build-imageupload 使用教程

    前言 在前端开发中,富文本编辑器是一个常见的需求。其中,CKEditor 是一个流行的开源富文本编辑器。为了扩展 CKEditor 的功能,社区开发了许多插件,而这些插件通常以 npm 包的形式发布。

    3 年前
  • npm包gendiff-emk使用教程

    随着前端开发变得越来越复杂,代码的维护过程变得越来越困难。为了避免出现问题,我们需要对代码进行更加严格的测试和检查。 其中之一就是比较两个文件之间的差异,并且将其以一种易于阅读的方式展示出来。

    3 年前
  • npm 包 api-console-dev-preview 使用教程

    在前端开发中,调试 API 是非常常见的任务。一个好的 API 调试工具可以提高我们的开发效率。而 npm 包 api-console-dev-preview 就是一款非常好的 API 调试工具。

    3 年前
  • npm 包 images-drop-area-component 的使用教程

    前言 在前端开发过程中,图片上传是一个常见需求,在以往的实现方式中,最常用的是利用 input 标签进行文件选择,再通过 ajax 或 form 表单提交实现上传。

    3 年前
  • npm 包 node-red-contrib-gitlab 使用教程

    当今时代,GitLab 已成为一个非常流行的代码托管平台,而且在使用中发现,部署与配置都比较方便。为了方便开发人员更好的使用 GitLab,npm 上已有了一个名为 node-red-contrib-...

    3 年前
  • npm 包 react-native-scrollable-tab-view-cys 使用教程

    前言 在前端开发中,移动端开发的需求越来越普遍,同时也为我们带来了新的技术挑战。在移动端开发中,很多时候我们需要用到 tab 栏,为了方便我们的开发,这里介绍了一个 npm 包:react-nativ...

    3 年前
  • npm 包 grunt-jfw 使用教程

    在前端开发中,我们经常需要使用一些自动化构建工具来优化我们的开发效率,其中像 Grunt、Gulp 等构建工具就是非常常用的工具之一。今天我们将介绍 Grunt 中的一个常用插件——grunt-jfw...

    3 年前
  • npm 包 simple-javascript-router 使用教程

    在前端开发中,常常需要通过 URL 控制页面的显示和跳转,这就需要使用到路由。而 simple-javascript-router 就是一个简单而强大的 JavaScript 路由库,能够通过监听 U...

    3 年前
  • npm 包 @mebank/fcm-push 使用教程

    Firebase Cloud Messaging (FCM) 是一款跨平台、开放式的消息传递服务,可供开发人员使用其 API 以将消息传送至云端网络。而使用 FCM,需要配置和设置各种设备和应用程序参...

    3 年前
  • npm 包 sanitize-mail 使用教程

    概述 在前端开发中,经常需要对用户输入的邮件地址进行验证和处理。而邮件地址中往往包含许多特殊字符,如 angle brackets(< >)、反斜杠(\)等。

    3 年前
  • npm 包 gekkio 使用教程

    为什么要学习 gekkio 当我们进行前端开发时,难免会遇到很多需要图形进行展示和交互的场景,而 gekkio 就是一款帮助开发者实现图形渲染和交互的 npm 包。

    3 年前
  • npm 包 react-network-info 使用教程

    在前端开发中,网络信息的获取是非常重要的一个环节,特别是在移动端浏览器中,网络情况时刻在变化,因此我们需要一个快速、准确地获取当前网络状态的工具。 在众多可供选择的 npm 包中,react-netw...

    3 年前
  • npm 包 gigs-adapter-remoteok 使用教程

    简介 gigs-adapter-remoteok 是一个可以获取 remoteok.io 上的招聘信息的 npm 包。 Remote OK 是一个聚焦于远程工作的职位招聘网站,提供了全职,兼职,实习等...

    3 年前
  • npm 包 gulp-env-modify 使用教程

    在前端开发中,使用 gulp 管理任务是很常见的。而在 gulp 的任务中,往往需要根据不同的环境变量来处理不同的配置,这时候就需要用到 npm 包 gulp-env-modify。

    3 年前
  • npm 包 faster-faster 使用教程

    简介 faster-faster 是一款基于 Node.js 的命令行工具,用于加速 JavaScript 项目的编译、构建和打包过程。它通过自动优化编译器的缓存机制、提高硬盘写入速度等手段,大大缩短...

    3 年前
  • npm包 map-map 使用教程

    map-map是一个非常有用的npm包,它可以帮助开发者快速地将一个嵌套的对象或数组中的每一个元素映射到一个新的值上。本篇文章将为大家提供详细的使用教程,帮助大家更好地掌握这个工具,并带来实际的应用案...

    3 年前
  • npm 包 star-evaluation 使用教程

    在前端开发过程中,我们经常需要使用评分组件来展示用户评价或者评分。而 star-evaluation 是一个简单易用的评分组件,可以方便地用在各种前端项目中。本篇文章介绍如何使用 star-evalu...

    3 年前
  • npm 包 just-rest-cookies 使用教程

    前言 JavaScript 是一门前端语言,在开发 web 应用时经常需要发送 HTTP 请求以获取或提交数据。Cookie 是在客户端存储用户信息的一种方式,而 just-rest-cookies ...

    3 年前
  • npm 包 @purtuga/web-components-polyfill-webpack-plugin 使用教程

    前言 @purtuga/web-components-polyfill-webpack-plugin 是一个适用于 Webpack 的插件,可以帮助开发者在旧版浏览器(如 IE11、Edge 等)中支...

    3 年前

相关推荐

    暂无文章