Sublime_ZK 项目启动与配置教程

1. 项目目录结构及介绍

Sublime_ZK 项目是一个用于增强 Sublime Text 编辑器功能的插件，其目录结构如下：

• sublime_zk/
  • README.md：项目说明文件，介绍了插件的功能、使用方法和安装步骤。
  • zk.py：插件的主要脚本文件，包含了插件的逻辑和功能实现。
  • zk_sublime.py：Sublime Text 的插件入口文件，用于集成到编辑器中。
  • default：包含默认配置文件的目录。
    • zk.sublime-settings：插件的默认设置文件。
  • icons：存放插件图标文件的目录。
    • zk.png：插件的图标文件。

2. 项目的启动文件介绍

项目的启动文件是 zk_sublime.py，这是 Sublime Text 识别和加载插件的入口。以下是该文件的主要内容：

import sublime
import sublime_plugin

class ZkSublimeCommand(sublime_plugin.TextCommand):
    def run(self, edit):
        # 插件运行的逻辑代码
        pass

# 插件加载时执行
def plugin_loaded():
    # 插件加载时的逻辑代码
    pass

# 插件卸载时执行
def plugin_unloaded():
    # 插件卸载时的逻辑代码
    pass

当 Sublime Text 加载此插件时，它会自动调用 plugin_loaded() 函数，而当插件被卸载时，会调用 plugin_unloaded() 函数。

3. 项目的配置文件介绍

插件的配置文件是位于 default 目录下的 zk.sublime-settings。该文件用于存储插件的默认设置，用户可以通过修改这个文件来自定义插件的行为。以下是配置文件的一个示例：

{
    "zk_enabled": true,
    "zk_host": "localhost",
    "zk_port": 2181,
    "zk_timeout": 5000
}

• zk_enabled：布尔值，用于开启或关闭插件功能。
• zk_host：字符串，指定 ZooKeeper 服务器的地址。
• zk_port：整数，指定 ZooKeeper 服务器的端口。
• zk_timeout：整数，指定连接 ZooKeeper 服务器的超时时间（毫秒）。

用户可以在 Sublime Text 的设置界面中直接修改这些配置项，或者直接编辑 zk.sublime-settings 文件。