XcodeTemplate-SketchPlugin 使用教程

XcodeTemplate-SketchPlugin 使用教程

XcodeTemplate-SketchPlugin项目地址:https://gitcode.com/gh_mirrors/xc/XcodeTemplate-SketchPlugin

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

XcodeTemplate-SketchPlugin/
├── LICENSE
├── README.md
├── images
│   └── example.png
├── xctemplate
│   ├── Sketch Plugin Bundle.xctemplate
│   │   ├── ___FILEBASENAME___.sketchplugin
│   │   │   ├── Contents
│   │   │   │   ├── Resources
│   │   │   │   │   └── main.js
│   │   │   │   └── Sketch
│   │   │   │       └── manifest.json
│   │   │   └── TemplateIcon.png
│   │   └── TemplateInfo.plist
│   ├── Sketch Plugin Framework.xctemplate
│   │   ├── ___FILEBASENAME___.framework
│   │   │   ├── Headers
│   │   │   │   └── ___FILEBASENAME___.h
│   │   │   └── Modules
│   │   │       └── module.modulemap
│   │   └── TemplateInfo.plist
│   └── Sketch Panel UI Framework.xctemplate
│       ├── ___FILEBASENAME___.framework
│       │   ├── Headers
│       │   │   └── ___FILEBASENAME___.h
│       │   └── Modules
│       │       └── module.modulemap
│       └── TemplateInfo.plist
└── xcshareddata
    └── xcschemes
        └── ___FILEBASENAME___.xcscheme

目录结构介绍

• LICENSE: 项目的许可证文件。
• README.md: 项目的说明文档。
• images: 存放项目相关的图片资源。
• xctemplate: 包含项目的模板文件。
  • Sketch Plugin Bundle.xctemplate: Sketch 插件包模板。
    • FILEBASENAME.sketchplugin: 生成的 Sketch 插件文件夹。
      • Contents: 插件内容目录。
        • Resources: 资源文件夹，包含主要的 JavaScript 文件。
        • Sketch: Sketch 相关文件夹，包含 manifest.json 文件。
  • Sketch Plugin Framework.xctemplate: Sketch 插件框架模板。
    • FILEBASENAME.framework: 生成的框架文件夹。
      • Headers: 头文件目录。
      • Modules: 模块目录。
  • Sketch Panel UI Framework.xctemplate: Sketch 面板 UI 框架模板。
    • FILEBASENAME.framework: 生成的框架文件夹。
      • Headers: 头文件目录。
      • Modules: 模块目录。
• xcshareddata: Xcode 共享数据目录。
  • xcschemes: 包含项目的 scheme 文件。

2. 项目的启动文件介绍

在 Sketch Plugin Bundle.xctemplate 中，启动文件是 main.js，位于 ___FILEBASENAME___.sketchplugin/Contents/Resources/ 目录下。这个文件是插件的主要入口点，负责初始化和执行插件的逻辑。

3. 项目的配置文件介绍

在 Sketch Plugin Bundle.xctemplate 中，配置文件是 manifest.json，位于 ___FILEBASENAME___.sketchplugin/Contents/Sketch/ 目录下。这个文件包含了插件的元数据，如插件的标识符、版本号、作者信息等。

{
  "identifier": "com.example.sketchplugin",
  "version": "1.0",
  "description": "Example Sketch Plugin",
  "author": "Example Author",
  "authorEmail": "author@example.com",
  "commands": [
    {
      "name": "Example Command",
      "identifier": "example.command",
      "script": "main.js"
    }
  ],
  "menu": {
    "title": "Example Plugin",
    "items": [
      "example.command"
    ]
  }
}

配置文件字段介绍

• identifier: 插件的唯一标识符。
• version: 插件的版本号。
• description: 插件的描述信息。
• author: 插件的作者。
• authorEmail: 作者的电子邮件。
• commands: 插件包含的命令列表。
  • name: 命令的显示名称。
  • **

XcodeTemplate-SketchPlugin项目地址:https://gitcode.com/gh_mirrors/xc/XcodeTemplate-SketchPlugin