npm 包 @skpm/builder 使用教程

AI 编程助手,豆包旗下的编程助手,提供智能补全、智能预测、智能问答等能力,节省开发时间,释放脑海中的创造力,支持 VSCode,点击体验 AI

前言

前端开发人员想要编写 Sketch 插件,经常需要使用到 Sketch 插件开发工具包,即 Sketch Plugin Manager(skpm)。而对于 skpm 来说,@skpm/builder 是其中一个重要的 npm 包,用于构建 Sketch 插件。

本文旨在提供关于 @skpm/builder 的详细介绍,并提供一个简单的教程,指导读者如何使用它来进行 Sketch 插件开发。

什么是 @skpm/builder

@skpm/builder 是一个基于 Webpack 的工具,用于将 JavaScript、CSS 和图片等静态文件打包成一个 Sketch 插件。它负责将你编写的源代码编译为适合 Sketch 的 JavaScript 代码。

@skpm/builder 提供了一系列任务,包括编译源代码、压缩文件、监测代码变化,以及发布等功能。

如何安装 @skpm/builder

要安装 @skpm/builder,我们首先要创建一个新的 Sketch 插件项目。打开终端,输入以下命令:

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

进入到项目文件夹后,使用以下命令安装 @skpm/builder:

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

如何使用 @skpm/builder

@skpm/builder 依靠 webpack.config.js 来构建 Sketch 插件。该文件应该创建在项目根目录下。

创建 webpack.config.js 并输入以下代码:

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

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

上述配置会将项目中的 src/main.js 文件作为入口,构建到 my-plugin.sketchplugin/Contents/Sketch/script.js 文件中。

接下来,我们需要更新 package.json 的 scripts 属性,以便自动调用 webpack。

打开 package.json 文件,添加以下内容:

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

这里我们使用了 “skpm-build” 命令来代替直接运行 webpack 命令。

现在,只需要运行 npm run build,即可编译和压缩插件。

Sketch 插件的上传与发布

构建插件的最后一步是将它们发布到 Sketch 插件库中。这里我们需要在我们的 Sketch 插件的 GitHub 仓库中创建一个 release。

具体步骤如下:

  1. 在 GitHub 上找到你的 Sketch 插件仓库,并在导航栏中选择 “Releases”。

  2. 点击 “Draft a new release” 创建一个新的 version,并填写版本号和标题。

  3. 上传插件包,命名为 {插件名称}.{版本号}.{插件类型}。例如,my-plugin.0.0.1.sketchplugin。

  4. 发布 release,并填写 changelog。

  5. 推荐使用 sketchpacks 将插件添加到 Sketch 插件库中,并分享给更多的人。

示例代码

我们编写一个简单 plugin,帮助你更好地理解如何使用 @skpm/builder。

首先,创建一个文件夹,并初始化 Sketch 插件项目:

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

在 Sketch 中创建一个矩形图层,并将其重命名为 “rectangle”。

接下来,创建 src/main.js 文件,输入以下代码:

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

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

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

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

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

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

我们使用了 Sketch 官方提供的 UI 消息工具,并使用了 Sketch 模块中的 BrowserWindow 类创建了一个简单的 Web 浏览器视图。

接着,我们创建 src/hello.js 文件,输入以下代码:

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

最后,创建 index.html 文件,并输入以下代码:

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

在终端中,输入以下命令,构建插件:

--- --- -----

该命令会自动编译编写好的插件,并打包输出到 dist 目录下。

在 Sketch 中,安装插件并运行,即可看到插件已经在浏览器视图中成功运行。

总结

使用 @skpm/builder 构建 Sketch 插件是一项非常有意义的工作。它允许我们使用最新的前端技术和工具,以优美简洁的方式构建我们的插件。

本文提供了有关 @skpm/builder 的详细介绍,以及如何使用它来构建和发布一款 Sketch 插件的示例。希望读者在阅读本文后,可以基于此进行更进一步的工作和实践。

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


猜你喜欢

  • npm 包 @ipld/is-circular 使用教程

    简介 @ipld/is-circular 是一个 npm 包,它可以检查一个 JavaScript 对象是否存在循环引用。在前端开发中,循环引用问题是非常常见的,这个小工具可以帮助开发者快速解决该问题...

    4 年前
  • npm 包 @ipld/dag-json 使用教程

    在前端开发中,我们经常需要通过 JSON 格式的数据来实现程序运行时的数据传递和交互。而 @ipld/dag-json 这个 npm 包提供了一种新的方式来处理 JSON 格式的数据。

    4 年前
  • npm 包 polendina 使用教程

    polendina 是一个用于构建现代 Web 应用程序的 npm 包,它提供了一套完整的解决方案,帮助开发人员更容易地创建可维护的、易于测试和高效的应用程序。在这篇文章中,我们将深入研究 polen...

    4 年前
  • npm 包 @ipld/block 使用教程

    介绍 @ipld/block 是一个基于 IPFS 数据结构通过哈希链接会话的包,它可以帮助前端开发者构建可扩展、分布式的网络应用程序。该包实现了 IPLD 数据结构中的块,具备快速、可靠、可验证、可...

    4 年前
  • npm 包 @ipld/printify 使用教程

    @ipld/printify 是一个用于将 JavaScript 对象转换为人类可读的格式的 npm 包。它旨在方便在开发过程中根据需要和调试需求打印和输出对象。它支持各种 JavaScript 数据...

    4 年前
  • npm 包 @ipld/schema-gen 使用教程

    随着区块链等技术的不断普及,数据结构的验证变得愈加重要。此时,一些工具包,例如 @ipld/schema-gen 就显得尤为重要。本文将为大家介绍如何使用此工具包,并分享一些实用的技巧。

    4 年前
  • npm 包 hundreds 使用教程

    在前端开发中,我们经常需要进行数字格式化,比如将 10000 格式化成 10,000。但是这个过程既繁琐又易错,因此我们常常需要借助一些工具来完成这个任务。而 hundreds 就是其中一款非常实用的...

    4 年前
  • npm 包 bytesish 使用教程

    随着互联网技术的发展,前端的开发变得越来越重要,而使用 npm 包也成为了前端开发不可或缺的一环。其中一个常用的 npm 包是 bytesish,它提供了一种方便的方式来实现字节到字符串的转换,而且可...

    4 年前
  • npm 包 rabin-generator 使用教程

    前言 在前端开发中,我们经常需要生成随机数据来模拟测试数据。这时,快速生成强随机性的数据非常有用。 npm 包 rabin-generator 是一个生成随机数据的好工具,同时该工具还支持各种数据类型...

    4 年前
  • npm 包 ipld-schema 使用教程

    在前端开发过程中,我们经常需要处理各种各样的数据,而 IPLD(InterPlanetary Linked Data)是一个分布式 Web 的数据协议,为我们提供了一种标准的数据结构和查询语言,可以很...

    4 年前
  • npm 包 @ipld/unixfsv2 使用教程

    简介 @ipld/unixfsv2 是一个 JavaScript 库,用于处理 Unix 文件系统中的数据。它提供了一种简单的方式来解析 Unix 文件系统中的各种对象和数据,例如目录树、文件、链接、...

    4 年前
  • NPM 包 Reg 的使用指南

    NPM(Node Package Manager)是一个包管理器,Reg 是一个类库,用于从 NPM 库中快速搜索和获取包的信息。在前端开发中,我们经常需要查找和使用各种 NPM 包,而 Reg 提供...

    4 年前
  • npm 包 @alexbosworth/saxophone 使用教程

    在开发 Web 前端应用程序时,我们常常需要对 XML 或 HTML 文档进行解析和处理。其中一个流行的工具是解析器,@alexbosworth/saxophone 就是一个基于流的事件驱动的 SAX...

    4 年前
  • npm 包 @alexbosworth/html2unicode 使用教程

    在前端开发中,我们常常需要处理 Unicode 字符串。为了方便地将 HTML 字符串转换成 Unicode 字符串,我们可以使用 @alexbosworth/html2unicode 这个 npm ...

    4 年前
  • npm 包 @babel/plugin-transform-react-pure-annotations 使用教程

    前言 在 React 应用中,性能优化是一个十分重要的话题。React 中的 Pure Component 和 memo 函数都可以帮助我们优化性能。但是,纯组件和 memo 函数只有在接收到的 pr...

    4 年前
  • npm 包 @octokit/plugin-paginate-rest 使用教程

    简介 @octokit/plugin-paginate-rest 是一个用于 JavaScript 和 TypeScript 语言的 npm 包,它为 Octokit REST API 操作提供了分页...

    4 年前
  • npm 包 @octokit/plugin-request-log 使用教程

    众所周知,前端开发过程中,对网络请求的监控和分析是非常重要的一环。而 @octokit/plugin-request-log 是一个专门用于监控请求的 npm 包,它可以帮助你更好的分析网络请求并进行...

    4 年前
  • npm 包 zetta-led-mock-driver 使用教程

    1. 引言 zetta-led-mock-driver 是一款 npm 包,可以帮助开发者模拟 IoT 设备的 LED 灯光,非常适合在前端开发中进行测试和调试。本文将介绍如何安装和使用这个 npm ...

    4 年前
  • npm 包 zetta-photocell-mock-driver 使用教程

    前言 在开发嵌入式系统或物联网设备时,模拟传感器和执行器的行为是相当重要的。zetta-photocell-mock-driver 就是这样一款 npm 包,它可以模拟光敏电阻,用于测试和调试 zet...

    4 年前
  • npm 包 keydir 使用教程

    介绍 npm 是世界上最大的软件库之一,其中包含了许多前端开发所需的工具和库。其中一个非常常用的 npm 包就是 keydir。keydir 是一个轻量级的 JavaScript 工具,可以在前端和后...

    4 年前

相关推荐

    暂无文章