ImageOptim Sketch 插件使用教程

ImageOptim Sketch 插件使用教程

Sketch-pluginImageOptim plugin for the Sketch app项目地址:https://gitcode.com/gh_mirrors/sk/Sketch-plugin

项目目录结构及介绍

Sketch-plugin/
├── README.md
├── plugin.sketchplugin
│   ├── Contents
│   │   ├── Resources
│   │   │   └── icon.png
│   │   └── Sketch
│   │       ├── manifest.json
│   │       └── script.js
└── src
    └── index.js

• README.md: 项目说明文件，包含项目的基本信息和使用说明。
• plugin.sketchplugin: 插件的主文件夹，包含插件的所有内容。
  • Contents: 插件内容文件夹。
    • Resources: 资源文件夹，包含插件的图标等资源。
      • icon.png: 插件图标文件。
    • Sketch: Sketch 插件的核心文件夹。
      • manifest.json: 插件的配置文件，包含插件的名称、版本、作者等信息。
      • script.js: 插件的主要脚本文件，包含插件的逻辑代码。
• src: 源代码文件夹，包含插件的源代码。
  • index.js: 插件的入口文件，包含插件的主要逻辑。

项目的启动文件介绍

插件的启动文件是 plugin.sketchplugin 文件夹中的 script.js 文件。这个文件包含了插件的主要逻辑代码，当插件被激活时，Sketch 会执行这个文件中的代码。

项目的配置文件介绍

插件的配置文件是 plugin.sketchplugin/Contents/Sketch/manifest.json 文件。这个文件包含了插件的基本信息和配置，如下所示：

{
  "name": "ImageOptim",
  "description": "压缩图片的 Sketch 插件",
  "author": "ImageOptim",
  "homepage": "https://github.com/ImageOptim/Sketch-plugin",
  "version": "1.0",
  "identifier": "com.imageoptim.sketch-plugin",
  "appcast": "https://api.github.com/repos/ImageOptim/Sketch-plugin/releases",
  "commands": [
    {
      "name": "Optimize Images",
      "identifier": "optimize-images",
      "script": "script.js",
      "handler": "onRun"
    }
  ],
  "menu": {
    "title": "ImageOptim",
    "items": [
      "optimize-images"
    ]
  }
}

• name: 插件的名称。
• description: 插件的描述。
• author: 插件的作者。
• homepage: 插件的主页。
• version: 插件的版本。
• identifier: 插件的唯一标识符。
• appcast: 插件的更新信息。
• commands: 插件的命令列表。
  • name: 命令的名称。
  • identifier: 命令的唯一标识符。
  • script: 命令对应的脚本文件。
  • handler: 命令对应的处理函数。
• menu: 插件的菜单配置。
  • title: 菜单的标题。
  • items: 菜单项的列表。

通过这个配置文件，Sketch 可以识别插件的基本信息和功能，并在菜单中显示相应的命令。

Sketch-pluginImageOptim plugin for the Sketch app项目地址:https://gitcode.com/gh_mirrors/sk/Sketch-plugin