Sketch Wanderer 项目教程-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00007/article/details/139518895

Sketch Wanderer 项目教程

sketch-wanderer A small SketchApp extension that introduces 'Finder' like features for working with layer list. 项目地址: https://gitcode.com/gh_mirrors/sk/sketch-wanderer

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

Sketch Wanderer 项目的目录结构如下：

sketch-wanderer/
├── Wanderer.sketchplugin/
│   ├── Contents/
│   │   ├── Sketch/
│   │   │   ├── Wanderer.js
│   │   │   ├── Wanderer.css
│   │   │   └── ...
│   │   ├── Resources/
│   │   │   └── ...
│   │   └── Info.plist
│   ├── README.md
│   ├── LICENSE
│   ├── appcast.xml
│   ├── editorconfig
│   ├── gitignore
│   ├── package-lock.json
│   └── package.json
└── ...

目录结构介绍

Wanderer.sketchplugin/: 这是 Sketch 插件的主目录，包含了插件的所有文件。
- Contents/: 插件的核心内容目录。
  - Sketch/: 包含插件的主要脚本文件和样式文件。
    - Wanderer.js: 插件的主要 JavaScript 文件，包含了插件的核心逻辑。
    - Wanderer.css: 插件的样式文件，用于定义插件的界面样式。
  - Resources/: 包含插件所需的资源文件，如图片、图标等。
  - Info.plist: 插件的配置文件，包含了插件的基本信息和配置。
- README.md: 项目的说明文档，介绍了插件的功能和使用方法。
- LICENSE: 项目的开源许可证文件，通常为 MIT 许可证。
- appcast.xml: 插件的更新配置文件，用于自动更新插件。
- editorconfig: 编辑器配置文件，用于统一代码风格。
- gitignore: Git 忽略文件配置，用于指定不需要版本控制的文件。
- package-lock.json: 依赖包锁定文件，确保依赖包版本一致。
- package.json: 项目的配置文件，包含了项目的依赖和脚本等信息。

2. 项目的启动文件介绍

Sketch Wanderer 项目的启动文件是 Wanderer.sketchplugin/Contents/Sketch/Wanderer.js。这个文件是插件的核心逻辑所在，负责处理用户交互、层级导航等功能。

启动文件介绍

Wanderer.js: 这是插件的主要 JavaScript 文件，包含了插件的核心逻辑。它定义了插件的各种功能和快捷键绑定，处理用户在 Sketch 中的操作，并根据用户的输入执行相应的操作，如选择层级、展开或折叠组等。

3. 项目的配置文件介绍

Sketch Wanderer 项目的配置文件主要包括以下几个：

Info.plist: 这是插件的配置文件，包含了插件的基本信息和配置。它定义了插件的名称、版本、作者等信息，并指定了插件的入口文件。
package.json: 这是项目的配置文件，包含了项目的依赖和脚本等信息。它定义了插件的依赖包、版本号、脚本命令等，方便开发者进行项目的管理和构建。
appcast.xml: 这是插件的更新配置文件，用于自动更新插件。它定义了插件的最新版本、更新日志、下载地址等信息，方便用户获取最新版本的插件。

配置文件介绍

Info.plist:
- CFBundleIdentifier: 插件的唯一标识符。
- CFBundleName: 插件的名称。
- CFBundleVersion: 插件的版本号。
- NSPrincipalClass: 插件的主类，通常为 Wanderer。
package.json:
- name: 项目的名称。
- version: 项目的版本号。
- description: 项目的描述。
- main: 项目的入口文件，通常为 Wanderer.js。
- scripts: 项目的脚本命令，如 build、test 等。
- dependencies: 项目的依赖包列表。
appcast.xml:
- item: 定义了插件的更新项。
  - title: 更新项的标题。
  - sparkle:version: 更新项的版本号。
  - sparkle:releaseNotesLink: 更新日志的链接。
  - enclosure: 更新包的下载地址。