npm 包 sketch-naming-lint 使用教程

在前端设计过程中,常常会使用 Sketch 软件来设计页面的原型。在进行项目开发时,如何保持命名规范是一个非常重要的问题,因为规范的命名可以让代码更易于阅读和维护。而 Sketch 的命名规范也需要保持一致性,否则会给开发过程带来困难。

在这种情况下,我们可以使用 sketch-naming-lint 这个 npm 包来检查 Sketch 文件是否符合规范。

什么是 sketch-naming-lint

sketch-naming-lint 是一个可以检查 Sketch 文件中命名是否符合规范的 npm 包。它可以根据配置文件中的规则来检查每一个元素的命名是否规范。如果有命名不规范的元素,该元素会被标记出来,开发人员就可以根据标记来进行调整。

安装和使用

首先,你需要在本地安装 sketch-naming-lint。你可以使用如下的命令进行安装:

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

安装完成后,你需要在项目中创建一个配置文件,来定义检查规则。在项目的根目录下创建一个 sketch-naming-lint.config.js 文件,并写入如下内容:

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

在规则中,我们定义了四个检查规则:

  • empty: 检查名称是否为空;
  • symbol: 检查符号名称是否以 Symbol_ 开头;
  • shapeGroup: 检查形状组名称是否以 宽度x高度 描述 的格式命名;
  • artboard: 检查画板名称是否以 宽度x高度 描述 的格式命名。

你可以根据具体的需求,自己定义规则。

完成配置后,你可以在命令行中输入以下的命令来执行检查:

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

其中 <path-to-sketch-file> 是你要检查的 Sketch 文件的路径。

执行完毕后,将会在命令行中输出检查结果。

学习和指导

通过使用 sketch-naming-lint 这个 npm 包,我们可以较为方便地约束 Sketch 文件的命名规范,从而确保项目开发过程中,代码和设计的完整性。同时,学习使用这个工具也让开发人员更深入地了解了 Sketch 文件的结构和命名规范。

在使用过程中,我们可以结合实际的项目需求,自定义规则来满足特定项目的需求,这样就可以更有效地约束项目的开发。

示例代码

下面是一个示例 Sketch 文件,其中包含了一个符号、一个形状组、一个画板,以及一个没有命名的元素:

我们可以使用 sketch-naming-lint 来检查这个文件的命名规范,执行结果如下:

从结果中可以看出,符号 Symbol8 的命名不符合规范(应该以 Symbol_ 开头),形状组 16x16 cancel 的命名不符合规范(应该以 宽度x高度 描述 的格式命名),画板 375x667 Login 的命名符合规范。

通过本篇文章的介绍,我相信大家已经掌握了 sketch-naming-lint 这个 npm 包的使用方法和意义,希望它可以帮助大家更好地约束 Sketch 文件的命名规范,提高项目的开发质量。

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


猜你喜欢

  • npm 包 ssb-about-resource 使用教程

    在前端开发中,我们经常需要使用一些第三方的库或工具来辅助我们完成开发任务。其中,npm 是前端开发中最主流的包管理工具之一。在这篇文章中,我们将介绍一个 npm 包 ssb-about-resourc...

    3 年前
  • npm 包 auto-e2e 使用教程

    简介 auto-e2e 是一个基于 Puppeteer 的自动化测试框架。该框架可以自动化执行端到端(End to End)测试,并生成测试报告。它支持多种配置,例如:跨浏览器测试、对单个或多个 UR...

    3 年前
  • NPM包 Oops_sf 使用教程

    简介 如今前端开发离不开NPM,NPM包也越来越成熟和普及。在NPM上,有很多优秀的包可以为我们的开发带来更多的便利。本篇文章介绍一个名为 oops_sf 的NPM包,它可以快速帮助我们从接口中获取数...

    3 年前
  • npm 包 dx-locale-zh-cn 使用教程

    随着 Web 前端开发的不断发展,国际化的需求也越来越强烈。对于涉及多语言内容的网站,需要使用多个语言环境来满足用户的需求。因此,本文将介绍一个 npm 包,即 dx-locale-zh-cn,该包提...

    3 年前
  • npm 包 @component-tree/config 使用教程

    在前端开发中,npm 包的使用非常广泛,其中 @component-tree/config 是一个专门用于前端组件树配置的 npm 包。本文将详细介绍如何使用该包来配置前端组件树,并附带实例代码。

    3 年前
  • npm 包 waterimage 使用教程

    简介 waterimage 是一款可以为图片添加水印的 Node.js 包,支持文字和图片水印,可以控制水印的位置、大小、字体颜色等,具有非常高的灵活性。 安装 要安装 waterimage,只需要在...

    3 年前
  • npm 包 happy-url-regex 使用教程

    介绍 在开发 Web 应用程序时,我们经常需要处理 URL。而 URL 可能存在各种不同的格式,使得其解析变得相当困难。happy-url-regex 这个 npm 包就是一个快速、简单、易于使用的解...

    3 年前
  • npm 包 crip-vue-bootstrap 使用教程

    前言 crip-vue-bootstrap 是一个基于 Vue.js 的 UI 组件库,具有类似 Bootstrap 的风格。它包含了多种常用的 UI 组件,如按钮、表格、表单、图标等等。

    3 年前
  • NPM 包 ethereum-notary-contracts 使用教程

    如果你正在构建一个基于以太坊的应用程序,你可能需要编写和部署智能合约。Ethereum Notary Contracts 是一个基于以太坊的智能合约开发工具,它可以帮助开发者更容易地开发、测试、部署和...

    3 年前
  • npm 包 nixconfig-yaml 使用教程

    在前端开发中,我们经常会遇到需要配置一些变量或者环境参数的情况。而 nixconfig-yaml 就是一个非常重要的 npm 包,能够帮我们快速的解决这一问题。本篇文章将为大家详细介绍 nixconf...

    3 年前
  • npm 包 homebridge-phicomm-air_detector 使用教程

    简介 homebridge-phicomm-air_detector 是一款用于 Homebridge 框架的一个插件,它可以与小米空气净化器进行无缝连接,并提供了丰富的功能,使用户可以通过 Home...

    3 年前
  • npm 包 meepo-article 使用教程

    meepo-article 是一款前端邮件编辑器的 npm 包。它基于 Angular5+ 实现,提供了丰富的邮件投递模板模块,支持自定义模板以及模板样式等功能。在邮件编辑过程中,可以快速地生成各种邮...

    3 年前
  • npm 包 react-confirmation-button 使用教程

    简介 react-confirmation-button 是一款基于 React 的 npm 包,提供了一个可自定义的确认按钮组件,用于表示对某个操作的确认或取消操作。

    3 年前
  • npm 包 see-variable.js 使用教程

    介绍 see-variable.js 是一个 npm 包,它可以用来在浏览器控制台中打印 JavaScript 变量的值。这个包非常实用,它可以帮助开发者快速定位代码中的问题。

    3 年前
  • npm 包 ssi-cmd 使用教程

    在前端开发中,有时候我们需要在多个 HTML 文件中共享一些通用的内容,比如导航栏、页脚、版权声明等。如果每个 HTML 文件都手动复制粘贴这些内容,那么一旦需要修改这些内容,就需要逐个修改每个文件,...

    3 年前
  • npm 包 vuex-async-module 使用教程

    在前端开发中,Vue 是一个很流行的框架,并且随着应用的复杂度不断增加,Vuex 的使用也变得越来越广泛。然而,面对许多异步操作的场景,Vuex 的状态管理变得更加困难,这就需要用到一个可以更好支持异...

    3 年前
  • npm 包 electron-renderer-react-scripts-target 使用教程

    介绍 electron-renderer-react-scripts-target 是一个使用 React 技术栈进行 Electron 应用开发的 npm 包。它能够帮助开发者使用 React 开发...

    3 年前
  • npm 包 gulp-qmui-svg-sprite 使用教程

    随着前端技术的发展,我们越来越多地使用 SVG 图片来展示不同的图形。然而,将多个 SVG 图形合并成一个文件,可以减少 HTTP 请求,从而加快网页加载速度。 在这篇文章中,我们将学习如何使用 np...

    3 年前
  • npm 包 uxcore-cg-uploader 使用教程

    在 Web 前端开发中,文件上传是一个必不可少的功能。为了提高上传文件的效率、可靠性和易用性,前端工程师们一直在探索更好的解决方案。其中一种比较流行的方案是使用 npm 软件包,其中的 uxcore-...

    3 年前
  • npm 包 lebo 使用教程

    前言 在前端开发或者其他领域开发中,经常会使用一些第三方的库或者包来加快开发进度,npm 包就是其中最常用的之一。在本篇文章中,我们将介绍如何使用 npm 包 lebo 来优雅地处理业务逻辑和用户交互...

    3 年前

相关推荐

    暂无文章