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 包 redva-core 使用教程

    前言 在前端开发中,我们经常需要处理大量的状态,这时候就需要使用一些框架或者库来帮助我们管理状态。而前端领域中最流行的库之一就是 React,它使用了一种名为 Flux 的架构来管理数据流。

    3 年前
  • npm 包 redva-loading 使用教程

    在前端开发中,loading 状态的展示是很常见的功能。一旦页面有需要加载的内容,尤其是针对大量或者长时间的异步请求,loading 状态就显得更显眼、更必要了。而使用 redva-loading 这...

    3 年前
  • npm 包 @mees-/bench 使用教程

    随着前端技术的不断发展和变化,我们的代码也越来越复杂和庞大,效率也成为了我们所关注的问题之一。对于如何提高代码效率,我们可以通过使用一些工具和框架来优化代码。 在本篇文章中,我们将重点介绍一个名为 @...

    3 年前
  • npm 包 copy-with-symlinks 使用教程

    前言: 在前端工程开发过程中,我们经常需要涉及到文件的复制,有些情况下,我们需要复制的文件夹中有符号链接,例如软链接,这时候,我们常常会遇到一些问题。为了解决这个问题,我们可以使用 npm 包 cop...

    3 年前
  • npm 包 dash-merge 使用教程

    npm 包 dash-merge 使用教程 在前端开发的过程中,我们经常要处理对象或数组的合并操作。如果我们想要方便快捷的进行合并操作,那么就需要使用一些工具来帮助我们完成。

    3 年前
  • npm 包 generator-ssrmvc 使用教程

    前言 随着前端技术的不断发展,前端应用的架构不断升级,而在这个过程中,更加深入的理解了MVC(Model-View-Controller)的优点,以及懂得如何巧妙的应用它。

    3 年前
  • npm 包 node-logger-winston 使用教程

    随着前端开发的不断发展,日志管理和记录变得越来越重要。在 node.js 中,我们可以使用 node-logger-winston 这个 npm 包来帮助我们管理日志。

    3 年前
  • npm 包 rpscript-api-twitter 使用教程

    在前端开发中,我们经常需要对 Twitter 数据进行操作,包括获取数据、发送信息和进行自动化任务等。而 rpscript-api-twitter 就是一款可以实现这些操作的 npm 包。

    3 年前
  • npm 包 dog-zip 使用教程

    在前端开发中,文件打包压缩是非常有必要的一步。随着前端工程化的发展,很多流程都被自动化,其中压缩的过程也被自动化了。在 Node.js 中,我们可以借助 npm 包 dog-zip 来实现文件压缩的功...

    3 年前
  • npm 包 tapazz 使用教程

    前言 tapazz 是一款前端自动化测试框架,使用该框架可以轻松地进行自动化测试,提高测试效率,减少人力成本。本文将详细介绍如何使用 npm 包 tapazz 进行前端自动化测试。

    3 年前
  • npm 包 @eim-materials/eim-login-block 使用教程

    简介 @eim-materials/eim-login-block 是一个前端开发所用的 npm 包,用于生成登录页常见的左右对称的带提示信息的登录框,增加页面美观度和交互性。

    3 年前
  • npm 包 custom-merge-graphql-schemas 使用教程

    GraphQL 是一种新兴的 API 设计语言,许多公司和开发者都开始尝试使用它来构建强大的 API。然而,在实际开发中,我们不仅需要编写 GraphQL schema,还需要将多个 schema 组...

    3 年前
  • npm 包 generator-drudge 使用教程

    简介 generator-drudge 是一个基于 Yeoman 的前端项目脚手架,用于快速搭建前端项目。它帮助开发者在项目的初始化和搭建时,自动化地进行一些常见的流程,例如项目结构的构建、依赖的安装...

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

    什么是 gulp-dmn? gulp-dmn 是一个基于 gulp 的 npm 包,它提供了一套简洁易用的 API,用于管理和执行 DMN (决策建模与标记)文件。

    3 年前
  • npm 包 sam-calendar 使用教程

    在前端开发中,日期选择器是一个很常见的组件。而 npm 包 sam-calendar 就是一款非常实用的日历组件,通过它可以轻松实现日期选择功能。本文将为大家介绍 sam-calendar 的使用方法...

    3 年前
  • npm 包 the_forge 使用教程

    简介 the_forge 是一个 npm 包,它提供了一组工具和模块,帮助前端工程师以更高效的方式进行开发。它主要提供以下功能: 自动化构建和打包 代码压缩和优化 模块化打包 浏览器兼容性处理 使...

    3 年前
  • npm 包 typescript-asyncblock 使用教程

    在前端开发中,异步操作是非常常见的操作方式,如 ajax 请求、事件监听等等,这些操作需要我们采用异步编程的方式进行处理。而在 JavaScript 中,异步编程时常会遇到一些问题,如:回调地狱、可读...

    3 年前
  • npm 包 react-three-fbx-viewer 使用教程

    由 Facebook 开发的 React 和 Three.js 是现今前端领域最受欢迎和广泛应用的技术,而 react-three-fbx-viewer 正是一个基于 React 和 Three.js...

    3 年前
  • npm 包 api-spotify-wrapper 使用教程

    前言 在前端开发中,我们经常需要调用 API 来获取数据,上述的 api-spotify-wrapper 是一个可以让我们快速地使用 Spotify Web API 在前端开发中调用它们的数据的 Ja...

    3 年前
  • npm 包 meta-spec 使用教程

    在前端开发中,使用 npm 包是非常常见的,而 meta-spec 包则提供了一种管理和描述一组数据的方式。本文将详细介绍如何使用 meta-spec 包,并提供示例代码。

    3 年前

相关推荐

    暂无文章