Symbol Swapper 开源项目教程
1. 项目的目录结构及介绍
Symbol Swapper 项目的目录结构如下:
symbol-swapper/
├── README.md
├── Symbol Swapper.sketchplugin
│ ├── Contents
│ │ ├── Resources
│ │ │ ├── icon.png
│ │ ├── Sketch
│ │ │ ├── manifest.json
│ │ │ ├── symbol-swapper.js
│ │ │ ├── symbol-swapper.sketchplugin
│ │ │ ├── symbol-swapper.css
README.md
: 项目说明文件,包含项目的基本信息和使用说明。Symbol Swapper.sketchplugin
: 插件的主要文件夹。Contents
: 插件内容文件夹。Resources
: 资源文件夹,包含插件的图标。icon.png
: 插件图标文件。
Sketch
: Sketch 插件文件夹。manifest.json
: 插件的配置文件,包含插件的基本信息和依赖项。symbol-swapper.js
: 插件的主要逻辑文件。symbol-swapper.sketchplugin
: 插件的入口文件。symbol-swapper.css
: 插件的样式文件。
2. 项目的启动文件介绍
项目的启动文件是 symbol-swapper.sketchplugin
,这是一个 Sketch 插件的入口文件。当用户在 Sketch 中启用该插件时,Sketch 会加载这个文件并执行其中的逻辑。
3. 项目的配置文件介绍
项目的配置文件是 manifest.json
,它位于 Symbol Swapper.sketchplugin/Contents/Sketch/
目录下。这个文件包含了插件的基本信息和依赖项,具体内容如下:
{
"name": "Symbol Swapper",
"description": "Swap the selected symbols for another.",
"author": "Jason Burns",
"homepage": "https://github.com/sonburn/symbol-swapper",
"version": "1.0",
"identifier": "com.sonburn.sketchplugins.symbol-swapper",
"appcast": "https://raw.githubusercontent.com/sonburn/symbol-swapper/master/appcast.xml",
"commands": [
{
"name": "Symbol Swapper",
"identifier": "symbol-swapper.swap",
"script": "symbol-swapper.js",
"handlers": {
"run": "onRun",
"actions": {
"SelectionChanged.finish": "onSelectionChanged"
}
}
}
],
"menu": {
"title": "Symbol Swapper",
"items": [
"symbol-swapper.swap"
]
}
}
name
: 插件的名称。description
: 插件的描述。author
: 插件的作者。homepage
: 插件的主页。version
: 插件的版本。identifier
: 插件的唯一标识符。appcast
: 插件的更新信息。commands
: 插件的命令列表。name
: 命令的名称。identifier
: 命令的唯一标识符。script
: 命令对应的脚本文件。handlers
: 命令的事件处理函数。
menu
: 插件的菜单配置。title
: 菜单的标题。items
: 菜单项的标识符列表。
通过这个配置文件,Sketch 可以正确加载和执行插件的各项功能。