Sketch Plugin Manager (skpm) 使用教程

Sketch Plugin Manager (skpm) 使用教程

skpm💎📦 A utility to build and publish Sketch plugins项目地址:https://gitcode.com/gh_mirrors/sk/skpm

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

skpm 是一个用于构建和发布 Sketch 插件的实用工具。以下是 skpm 项目的典型目录结构及其介绍：

my-plugin/
├── .babelrc
├── .editorconfig
├── .eslintrc.yml
├── .gitignore
├── .prettierignore
├── .travis.yml
├── LICENSE
├── README.md
├── package.json
├── prettier.config.js
├── src/
│   ├── manifest.json
│   ├── my-command.js
│   └── my-panel.js
└── template/

• .babelrc: Babel 配置文件，用于转换 JavaScript 代码。
• .editorconfig: 编辑器配置文件，用于统一代码风格。
• .eslintrc.yml: ESLint 配置文件，用于代码检查。
• .gitignore: Git 忽略文件列表。
• .prettierignore: Prettier 忽略文件列表。
• .travis.yml: Travis CI 配置文件，用于持续集成。
• LICENSE: 项目许可证。
• README.md: 项目说明文档。
• package.json: 项目依赖和脚本配置。
• prettier.config.js: Prettier 配置文件，用于代码格式化。
• src/: 插件源代码目录。
  • manifest.json: 插件清单文件，包含插件的元数据。
  • my-command.js: 插件命令文件。
  • my-panel.js: 插件面板文件。
• template/: 插件模板目录。

2. 项目的启动文件介绍

skpm 项目的启动文件通常是 src/manifest.json，它包含了插件的基本信息和启动配置。以下是一个示例：

{
  "name": "my-plugin",
  "description": "A Sketch plugin",
  "author": "Your Name",
  "version": "0.1.0",
  "identifier": "com.example.my-plugin",
  "commands": [
    {
      "name": "My Command",
      "identifier": "my-plugin.my-command",
      "script": "./my-command.js"
    }
  ],
  "menu": {
    "title": "My Plugin",
    "items": [
      "my-plugin.my-command"
    ]
  }
}

• name: 插件名称。
• description: 插件描述。
• author: 插件作者。
• version: 插件版本。
• identifier: 插件唯一标识符。
• commands: 插件命令列表。
  • name: 命令名称。
  • identifier: 命令唯一标识符。
  • script: 命令脚本文件路径。
• menu: 插件菜单配置。
  • title: 菜单标题。
  • items: 菜单项列表。

3. 项目的配置文件介绍

skpm 项目的配置文件主要包括 package.json 和一些工具配置文件。以下是这些配置文件的介绍：

package.json

package.json 文件包含了项目的依赖、脚本和其他元数据。以下是一个示例：

{
  "name": "my-plugin",
  "version": "0.1.0",
  "description": "A Sketch plugin",
  "main": "src/manifest.json",
  "scripts": {
    "build": "skpm-build",
    "watch": "skpm-build --watch",
    "start": "skpm-build --watch --run",
    "publish": "skpm publish"
  },
  "author": "Your Name",
  "license": "MIT",
  "devDependencies": {
    "@skpm/builder": "^0.7.0"
  }
}

• name: 项目名称。
• version: 项目版本。
• description: 项目描述。
• main: 主文件路径。
• scripts: 脚本命令。
  • build: 构建插件。
  • watch: 监听文件变化并构建。
  • start:

skpm💎📦 A utility to build and publish Sketch plugins项目地址:https://gitcode.com/gh_mirrors/sk/skpm