Git Sketch Plugin 使用教程

Git Sketch Plugin 使用教程

git-sketch-plugin:gem::octocat: A Git client generating pretty diffs built right into Sketch.项目地址:https://gitcode.com/gh_mirrors/gi/git-sketch-plugin

项目的目录结构及介绍

Git Sketch Plugin 是一个集成在 Sketch 中的 Git 客户端，用于生成漂亮的 diff 文件。以下是该项目的目录结构及其介绍：

git-sketch-plugin/
├── assets/
├── docs/
├── example/
├── src/
│   ├── commands/
│   ├── diffs/
│   ├── git/
│   ├── utils/
│   └── index.js
├── .babelrc
├── .editorconfig
├── .eslintrc.yml
├── .gitignore
├── .gitsketchrc
├── CHANGELOG.md
├── LICENSE
├── README.md
├── logo.png
├── package-lock.json
├── package.json
└── webpack.skpm.config.js

• assets/: 存放项目的静态资源文件。
• docs/: 存放项目的文档文件。
• example/: 存放示例文件。
• src/: 项目的源代码目录，包含主要的业务逻辑。
  • commands/: 存放命令行相关的代码。
  • diffs/: 存放生成 diff 文件的代码。
  • git/: 存放与 Git 相关的代码。
  • utils/: 存放工具函数。
  • index.js: 项目的入口文件。
• .babelrc: Babel 配置文件。
• .editorconfig: 编辑器配置文件。
• .eslintrc.yml: ESLint 配置文件。
• .gitignore: Git 忽略文件配置。
• .gitsketchrc: Git Sketch Plugin 的配置文件。
• CHANGELOG.md: 项目更新日志。
• LICENSE: 项目许可证。
• README.md: 项目说明文档。
• logo.png: 项目图标。
• package-lock.json: npm 依赖锁定文件。
• package.json: 项目依赖和脚本配置文件。
• webpack.skpm.config.js: Webpack 配置文件。

项目的启动文件介绍

项目的启动文件是 src/index.js。这个文件是整个插件的入口点，负责初始化插件并注册各种命令。以下是 src/index.js 的简要介绍：

import sketch from 'sketch'
import { initCommands } from './commands'

export default function() {
  initCommands()
}

• import sketch from 'sketch': 导入 Sketch 的 API。
• import { initCommands } from './commands': 导入命令初始化函数。
• export default function() { initCommands() }: 导出一个默认函数，该函数在插件启动时调用，负责初始化所有命令。

项目的配置文件介绍

.babelrc

Babel 配置文件，用于配置 Babel 转译器，确保代码可以在不同环境中运行。

{
  "presets": ["@babel/preset-env"]
}

.editorconfig

编辑器配置文件，用于统一不同编辑器和 IDE 的代码风格。

root = true

[*]
indent_style = space
indent_size = 2
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true

.eslintrc.yml

ESLint 配置文件，用于代码风格检查和错误检测。

extends: 'eslint:recommended'
env:
  node: true
  es6: true
rules:
  indent:
    - error
    - 2
  linebreak-style:
    - error
    - unix
  quotes:
    - error
    - single
  semi:
    - error
    - always

.gitignore

Git 忽略文件配置，指定哪些文件和目录不需要被 Git 追踪。

node_modules/
dist/
*.log

.gitsketchrc

Git Sketch Plugin 的配置文件，用于配置插件的行为。

{
  "gitPath": "/usr/local/bin/git",
  "sketchPath": "/Applications/Sketch.app/Contents/MacOS/Sketch"
}

package.json

项目依赖和脚本配置文件，包含项目的元

git-sketch-plugin:gem::octocat: A Git client generating pretty diffs built right into Sketch.项目地址:https://gitcode.com/gh_mirrors/gi/git-sketch-plugin