GitSavvy 项目教程

GitSavvy 项目教程

GitSavvyFull git and GitHub integration with Sublime Text项目地址:https://gitcode.com/gh_mirrors/gi/GitSavvy

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

GitSavvy 是一个用于 Sublime Text 的 Git 插件，提供了丰富的 Git 功能和集成。以下是 GitSavvy 项目的目录结构及其介绍：

GitSavvy/
├── docs/
│   ├── README.md
│   └── ...
├── GitSavvy/
│   ├── core/
│   ├── github/
│   ├── inline_diff/
│   ├── ...
│   └── main.py
├── .gitignore
├── .travis.yml
├── LICENSE
├── README.md
└── ...

• docs/: 包含项目的文档文件，如 README.md。
• GitSavvy/: 核心代码目录，包含各个功能模块的代码。
  • core/: 核心功能模块。
  • github/: GitHub 集成模块。
  • inline_diff/: 行内差异显示模块。
  • main.py: 主启动文件。
• .gitignore: Git 忽略文件配置。
• .travis.yml: Travis CI 配置文件。
• LICENSE: 项目许可证。
• README.md: 项目介绍文档。

2、项目的启动文件介绍

GitSavvy 的启动文件是 GitSavvy/main.py。这个文件负责初始化插件并加载各个功能模块。以下是 main.py 的主要内容：

import sublime
import sublime_plugin

from .core.commands import *
from .core.github import *
from .core.inline_diff import *
# 其他导入

def plugin_loaded():
    from .core.git_command import GitCommand
    GitCommand.plugin_loaded()

def plugin_unloaded():
    from .core.git_command import GitCommand
    GitCommand.plugin_unloaded()

• plugin_loaded(): 插件加载时调用的函数，初始化 GitCommand 类。
• plugin_unloaded(): 插件卸载时调用的函数，清理资源。

3、项目的配置文件介绍

GitSavvy 的配置文件主要包括 .gitignore 和 .travis.yml。

.gitignore

.gitignore 文件用于指定 Git 忽略的文件和目录，避免将不必要的文件提交到版本库中。以下是 .gitignore 的部分内容：

*.pyc
*.sublime-workspace
*.sublime-project
__pycache__/

.travis.yml

.travis.yml 文件用于配置 Travis CI 的持续集成任务。以下是 .travis.yml 的部分内容：

language: python
python:
  - "3.6"
  - "3.7"
  - "3.8"
install:
  - pip install -r requirements.txt
script:
  - pytest

• language: 指定项目使用的编程语言。
• python: 指定测试使用的 Python 版本。
• install: 安装依赖包。
• script: 运行测试脚本。

以上是 GitSavvy 项目的基本教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些内容能帮助你更好地理解和使用 GitSavvy 插件。

GitSavvyFull git and GitHub integration with Sublime Text项目地址:https://gitcode.com/gh_mirrors/gi/GitSavvy