Sketch Better Paste 项目教程

Sketch Better Paste 项目教程

sketch-better-pastePaste like it was meant to be--into the artboard you're viewing.项目地址:https://gitcode.com/gh_mirrors/sk/sketch-better-paste

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

sketch-better-paste/
├── README.md
├── package.json
├── src/
│   ├── manifest.json
│   ├── commands/
│   │   ├── betterPaste.js
│   │   └── betterPaste.css
│   └── ui/
│       ├── index.html
│       └── styles.css
└── dist/
    ├── sketch-better-paste.sketchplugin
    └── manifest.json

• README.md: 项目说明文件，包含项目的基本信息和使用指南。
• package.json: 项目的依赖管理文件，包含项目的依赖库和脚本命令。
• src/: 源代码目录，包含项目的所有源代码文件。
  • manifest.json: 插件的配置文件，定义插件的命令和菜单项。
  • commands/: 包含插件的命令文件。
    • betterPaste.js: 实现插件主要功能的JavaScript文件。
    • betterPaste.css: 插件的样式文件。
  • ui/: 包含插件的用户界面文件。
    • index.html: 插件的用户界面HTML文件。
    • styles.css: 用户界面的样式文件。
• dist/: 编译后的插件目录，包含最终生成的Sketch插件文件。
  • sketch-better-paste.sketchplugin: 编译后的Sketch插件文件。
  • manifest.json: 编译后的插件配置文件。

2. 项目的启动文件介绍

项目的启动文件是 src/commands/betterPaste.js。这个文件包含了插件的主要功能实现，当用户在Sketch中执行“Better Paste”命令时，这个文件会被调用。

// src/commands/betterPaste.js
export default function(context) {
    // 插件的主要功能实现代码
    const sketch = context.api();
    const pasteboard = NSPasteboard.generalPasteboard();
    const data = pasteboard.dataForType(NSPasteboardTypeString);
    // 处理粘贴数据
    // ...
}

3. 项目的配置文件介绍

项目的配置文件是 src/manifest.json。这个文件定义了插件的命令和菜单项，以及插件的基本信息。

{
    "name": "Better Paste",
    "identifier": "com.example.sketch.better-paste",
    "version": "1.0",
    "description": "Enhanced paste functionality for Sketch.",
    "author": "Ken Moore",
    "commands": [
        {
            "name": "Better Paste",
            "identifier": "betterPaste",
            "script": "./commands/betterPaste.js",
            "handlers": {
                "run": "onRun"
            }
        }
    ],
    "menu": {
        "title": "Better Paste",
        "items": [
            "betterPaste"
        ]
    }
}

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

以上是 Sketch Better Paste 项目的目录结构、启动文件和配置文件的详细介绍。希望这份教程能帮助你更好地理解和使用这个开源项目。

sketch-better-pastePaste like it was meant to be--into the artboard you're viewing.项目地址:https://gitcode.com/gh_mirrors/sk/sketch-better-paste