# build-sublime-plug

**Repository Path**: chenbool/build-sublime-plug

## Basic Information

- **Project Name**: build-sublime-plug
- **Description**: Sublime 语法提示插件生成器
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-05-05
- **Last Updated**: 2026-05-05

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Sublime 语法提示插件生成器

用于生成 Sublime Text 语法提示插件的工具，支持 PHP 和 Python。

## QQ群

QQ群：484043598


## 演示截图

| 演示 |
|------|
| ![演示](./demo.png) |


## 功能特性

- 生成 Sublime Text 代码片段（Snippets）
- 支持 PHP 语法提示
- 支持 Python 语法提示
- 一键生成插件文件
- **PySide6 GUI 界面**（推荐）

## 项目结构

```
build-sublime-plug/
├── php/               # PHP 插件生成
│   ├── plug.php      # 插件生成类
│   ├── index.php     # 示例入口
│   └── run.bat       # 运行脚本
├── python3/           # Python 插件生成
│   ├── Plug.py       # 插件生成类
│   └── test.py       # 测试示例
├── pyside6/           # PySide6 GUI 版本
│   ├── main.py       # 主程序
│   ├── pyproject.toml
│   └── .gitignore
├── demo.png          # 演示截图
└── README.md
```

## PySide6 GUI 版本（推荐）

### 环境要求

- Python 3.10+
- uv 包管理器

### 安装依赖

```bash
cd pyside6
uv sync
```

### 运行程序

```bash
cd pyside6
uv run python main.py
```

### 使用说明

1. **输出设置**
   - 输出目录：选择生成文件的保存位置（默认当前目录的 output 文件夹）
   - 子目录：可设置子目录（如 `php/` 或 `python/`）

2. **代码片段设置**
   - 触发词：Tab 触发的关键字
   - 作用域：选择语言类型（PHP、Python、JavaScript 等）
   - 描述：提示描述
   - 代码内容：输入要插入的代码

3. 点击 **"生成插件"** 按钮即可生成 `.sublime-snippet` 文件

## PHP 使用方法

### 1. 创建插件实例

```php
$plug = new Plug('输出目录', '子目录');
```

### 2. 生成代码片段

```php
$plug->build('触发词', '代码内容', '描述', '作用域');
```

### 参数说明

| 参数 | 说明 | 默认值 |
|------|------|--------|
| 触发词 | Tab 触发关键字 | 必填 |
| 代码内容 | 插入的代码 | 必填 |
| 描述 | 提示描述 | 必填 |
| 作用域 | 语法作用域 | `source.php` |

### 完整示例

```php
<?php
include 'plug.php';

$plug = new Plug('C:\\Users\\Administrator\\Desktop\\1', '\\');

$plug->build('where', 'where()', 'where查询');
$plug->build('foreach', 'foreach()', 'foreach循环');
```

## Python 使用方法

### 1. 创建插件实例

```python
plug = Plug('输出目录', '子目录')
```

### 2. 生成代码片段

```python
plug.build('触发词', '代码内容', '描述', '作用域')
```

### 完整示例

```python
from Plug import Plug

plug = Plug('./output', '/')

plug.build('print', 'print()', '打印输出', 'source.python')
```

## 生成的 Snippet 格式

```xml
<snippet>
    <content><![CDATA[代码内容]]></content>
    <scope>source.php</scope>
    <tabTrigger>触发词</tabTrigger>
    <description>描述</description>
</snippet>
```

## 相关插件案例

| 框架 | 仓库 |
|------|------|
| YAF | https://github.com/bool1993/sublime_yaf |
| Swoole | https://github.com/bool1993/sublime_swoole |
| ThinkPHP5 | https://github.com/bool1993/sublime_thinkphp5 |

## 依赖

- PHP 5.6+ 或 Python 3.6+
- PySide6 6.7.0+（GUI 版本）