【亲测免费】 Sublime Text Git 插件使用教程

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

Sublime Text Git 插件的目录结构如下：

sublime-text-git/
├── CHANGELOG.md
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── git.py
├── git_commands.py
├── git_gutter.py
├── git_gutter_events.py
├── git_gutter_handler.py
├── git_gutter_popup.py
├── git_status.py
├── main.py
├── messages/
│   ├── en/
│   │   └── messages.json
│   └── fr/
│       └── messages.json
├── plugin_unittests.py
├── requirements.txt
├── sublime_git.py
├── sublime_git_tests.py
└── support/
    ├── __init__.py
    ├── git.py
    ├── git_command.py
    ├── git_watcher.py
    ├── helpers.py
    ├── path.py
    ├── repository.py
    ├── settings.py
    └── status.py

目录结构介绍

• CHANGELOG.md: 记录插件的更新日志。
• CONTRIBUTING.md: 贡献指南，指导如何为项目贡献代码。
• LICENSE: 项目的许可证信息。
• README.md: 项目的基本介绍和使用说明。
• git.py, git_commands.py, git_gutter.py, git_gutter_events.py, git_gutter_handler.py, git_gutter_popup.py, git_status.py: 插件的核心功能实现文件。
• main.py: 插件的主入口文件。
• messages/: 多语言支持的配置文件。
• plugin_unittests.py, sublime_git_tests.py: 单元测试文件。
• requirements.txt: 项目依赖的第三方库。
• sublime_git.py: 插件的主要逻辑文件。
• support/: 插件的支持模块，包括 Git 命令处理、路径处理、仓库状态管理等。

2. 项目的启动文件介绍

项目的启动文件是 main.py，它负责初始化插件并加载相关模块。以下是 main.py 的主要内容：

import sublime
import sublime_plugin
import git
import git_commands
import git_gutter
import git_gutter_events
import git_gutter_handler
import git_gutter_popup
import git_status

def plugin_loaded():
    git.plugin_loaded()
    git_commands.plugin_loaded()
    git_gutter.plugin_loaded()
    git_gutter_events.plugin_loaded()
    git_gutter_handler.plugin_loaded()
    git_gutter_popup.plugin_loaded()
    git_status.plugin_loaded()

def plugin_unloaded():
    git.plugin_unloaded()
    git_commands.plugin_unloaded()
    git_gutter.plugin_unloaded()
    git_gutter_events.plugin_unloaded()
    git_gutter_handler.plugin_unloaded()
    git_gutter_popup.plugin_unloaded()
    git_status.plugin_unloaded()

启动文件介绍

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

3. 项目的配置文件介绍

项目的配置文件主要位于 support/settings.py 中，它定义了插件的各种设置选项。以下是 settings.py 的主要内容：

import sublime
import sublime_plugin

class GitSettings:
    def __init__(self):
        self.settings = sublime.load_settings('Git.sublime-settings')

    def get(self, key, default=None):
        return self.settings.get(key, default)

    def set(self, key, value):
        self.settings.set(key, value)
        sublime.save_settings('Git.sublime-settings')

git_settings = GitSettings()

配置文件介绍

• GitSettings: 配置