开源项目 sync.sketchplugin 使用教程

开源项目 sync.sketchplugin 使用教程

sync.sketchpluginKeep your design team in sync!项目地址:https://gitcode.com/gh_mirrors/sy/sync.sketchplugin

1. 项目的目录结构及介绍

sync.sketchplugin/
├── Contents
│   ├── Resources
│   │   ├── icon.png
│   │   └── main.js
│   └── Sketch
│       └── manifest.json
├── README.md
└── LICENSE

• Contents: 主要内容目录，包含插件的核心文件。
  • Resources: 资源文件夹，存放插件所需的静态资源，如图标和主要脚本。
    • icon.png: 插件图标。
    • main.js: 插件的主要执行脚本。
  • Sketch: Sketch 相关文件夹，包含插件的配置和功能实现。
    • manifest.json: 插件的配置文件，定义插件的基本信息和入口点。
• README.md: 项目说明文档，介绍项目的基本信息和使用方法。
• LICENSE: 项目的许可协议文件。

2. 项目的启动文件介绍

项目的启动文件是 Contents/Resources/main.js。这个文件是插件的主要执行脚本，负责初始化插件并定义插件的主要功能。

// main.js 示例代码
export function onRun(context) {
    // 插件启动时执行的代码
    console.log("插件已启动");
}

3. 项目的配置文件介绍

项目的配置文件是 Contents/Sketch/manifest.json。这个文件定义了插件的基本信息和入口点。

{
    "name": "sync.sketchplugin",
    "identifier": "com.example.sync.sketchplugin",
    "version": "1.0",
    "description": "一个用于同步Sketch文件的插件",
    "author": "nolastan",
    "commands": [
        {
            "name": "同步文件",
            "identifier": "sync.file",
            "script": "./Contents/Resources/main.js",
            "handler": "onRun"
        }
    ],
    "menu": {
        "title": "同步插件",
        "items": [
            "sync.file"
        ]
    }
}

• name: 插件的名称。
• identifier: 插件的唯一标识符。
• version: 插件的版本号。
• description: 插件的描述信息。
• author: 插件的作者。
• commands: 定义插件的命令，包括命令的名称、标识符、脚本路径和处理函数。
• menu: 定义插件在 Sketch 菜单中的显示信息。

sync.sketchpluginKeep your design team in sync!项目地址:https://gitcode.com/gh_mirrors/sy/sync.sketchplugin