11# ZY Language Support Plugin
22
3- IntelliJ IDEA 插件,为 ` .zy ` 文件提供语法高亮、代码提示和 LSP 集成功能 。
3+ IntelliJ IDEA 插件,为 ` .zy ` 文件提供语法高亮、代码提示和代码跳转功能 。
44
55## 功能特性
66
77- ✅ ** 语法高亮** : 基于 TextMate 语法文件 ` origami.tmLanguage.json `
8- - ✅ ** 代码提示** : 基于 LSP 的智能代码补全
9- - ✅ ** LSP 集成 ** : 连接到外部语言服务器
8+ - ✅ ** 代码提示** : 智能代码补全和自动完成
9+ - ✅ ** 代码跳转 ** : 支持定义跳转和引用查找
1010- ✅ ** 文件类型支持** : 支持 ` .zy ` 文件扩展名
1111- ✅ ** 错误高亮** : 语法错误和诊断信息
12+ - ✅ ** 符号索引** : 快速符号搜索和导航
13+
14+ ## 安装方法
15+
16+ ### 从 Release 安装(推荐)
17+
18+ 1 . ** 下载插件包**
19+
20+ - 访问 [ Releases 页面] ( https://github.com/php-any/idea_plugin/releases )
21+ - 下载最新版本的 ` plugin-distributions-*.zip ` 文件
22+
23+ 2 . ** 在 IntelliJ IDEA 中安装**
24+
25+ - 打开 IntelliJ IDEA
26+ - 进入 ` File ` → ` Settings ` → ` Plugins `
27+ - 点击 ` ⚙️ ` 图标 → ` Install Plugin from Disk... `
28+ - 选择下载的 ` .zip ` 文件
29+ - 点击 ` OK ` 并重启 IDE
30+
31+ 3 . ** 验证安装**
32+ - 创建或打开 ` .zy ` 文件
33+ - 检查是否有语法高亮和代码提示功能
34+
35+ ### 支持版本
36+
37+ - ** IntelliJ IDEA** : 2024.1 - 2025.2
38+ - ** 平台** : Windows / macOS / Linux
39+ - ** 插件大小** : ~ 96 KB
1240
1341## 技术栈
1442
15- - ** 开发语言** : Kotlin
43+ - ** 开发语言** : Java
1644- ** 构建工具** : Gradle
17- - ** IntelliJ Platform SDK** : 2023.1+
18- - ** LSP 集成** : IntelliJ LSP API
19- - ** 语言服务器** : ` /Users/lvluo/Desktop/github.com/php-any/origami/bin/zy-lsp `
45+ - ** IntelliJ Platform SDK** : 2024.1+
46+ - ** 实现方式** : 本地 Java 实现,无外部依赖
47+
48+ ## 使用方法
49+
50+ ### 创建 .zy 文件
51+
52+ 1 . 在 IntelliJ IDEA 中创建新文件
53+ 2 . 文件名以 ` .zy ` 结尾
54+ 3 . 开始编写 ZY 语言代码
55+
56+ ### 功能使用
57+
58+ - ** 语法高亮** : 自动识别 ZY 语言语法并高亮显示
59+ - ** 代码补全** : 输入时按 ` Ctrl+Space ` 触发代码提示
60+ - ** 代码跳转** : ` Ctrl+Click ` 或 ` F12 ` 跳转到定义
61+ - ** 符号搜索** : ` Ctrl+Shift+Alt+N ` 搜索符号
2062
2163## 项目结构
2264
2365```
2466src/
2567├── main/
26- │ ├── kotlin /
68+ │ ├── java /
2769│ │ └── com/company/plugin/
2870│ │ ├── language/ # 语言相关功能
29- │ │ ├── lsp/ # LSP 客户端集成
3071│ │ ├── completion/ # 代码提示
3172│ │ ├── navigation/ # 代码跳转
32- │ │ └── highlighting/ # 语法高亮
73+ │ │ ├── highlighting/ # 语法高亮
74+ │ │ └── index/ # 符号索引
3375│ └── resources/
3476│ ├── META-INF/
3577│ │ └── plugin.xml # 插件配置
3678│ ├── icons/ # 图标资源
3779│ └── fileTypes/ # 文件类型定义
3880└── test/
39- └── kotlin /
81+ └── java /
4082```
4183
4284## 开发指南
@@ -59,24 +101,68 @@ src/
59101./gradlew buildPlugin
60102```
61103
62- ## 配置
104+ ### 版本管理
105+
106+ ``` bash
107+ # 快速创建下一个补丁版本
108+ ./scripts/quick-tag.sh
109+
110+ # 创建次版本
111+ ./scripts/tag-version.sh --minor
63112
64- ### LSP 服务器路径
113+ # 创建主版本
114+ ./scripts/tag-version.sh --major
115+ ```
65116
66- 默认 LSP 服务器路径: ` /Users/lvluo/Desktop/github.com/php-any/origami/bin/zy-lsp `
117+ ## 配置
67118
68119### 支持的文件类型
69120
70- - 扩展名: ` .zy `
71- - MIME 类型: ` text/x-zy `
72- - 语言: DIY 语言 (Origami)
121+ - ** 扩展名** : ` .zy `
122+ - ** MIME 类型** : ` text/x-zy `
123+ - ** 语言** : ZY 语言 (Origami)
124+ - ** 图标** : 自定义 ZY 文件图标
125+
126+ ## 故障排除
127+
128+ ### 插件安装失败
129+
130+ 1 . ** 检查 IntelliJ IDEA 版本**
131+
132+ - 确保使用 2024.1 或更高版本
133+ - 检查插件兼容性
134+
135+ 2 . ** 重新安装插件**
136+
137+ - 卸载现有插件
138+ - 重启 IDE
139+ - 重新安装插件
140+
141+ 3 . ** 检查插件文件**
142+ - 确保下载的是完整的 ` .zip ` 文件
143+ - 检查文件大小(约 96 KB)
144+
145+ ### 功能不工作
146+
147+ 1 . ** 重启 IDE**
148+
149+ - 安装后需要重启 IntelliJ IDEA
150+
151+ 2 . ** 检查文件类型**
152+
153+ - 确保文件扩展名是 ` .zy `
154+ - 检查文件是否被正确识别
155+
156+ 3 . ** 查看日志**
157+ - 打开 ` Help ` → ` Show Log in Explorer `
158+ - 查看是否有错误信息
73159
74160## 开发规范
75161
76162- 遵循 IntelliJ Platform 编码规范
77- - 使用 Kotlin 作为主要开发语言
163+ - 使用 Java 作为主要开发语言
78164- 基于 TextMate 语法文件实现语法高亮
79- - 使用 IntelliJ LSP API 进行语言服务器集成
165+ - 本地实现所有功能,无外部依赖
80166- 异步处理耗时操作,避免阻塞 UI
81167
82168## 许可证
@@ -86,3 +172,13 @@ MIT License
86172## 贡献
87173
88174欢迎提交 Issue 和 Pull Request!
175+
176+ ## 更新日志
177+
178+ ### v0.0.3
179+
180+ - ✅ 支持 .zy 文件语法高亮
181+ - ✅ 实现代码补全功能
182+ - ✅ 添加代码跳转支持
183+ - ✅ 集成符号索引服务
184+ - ✅ 支持 IntelliJ IDEA 2024.1 - 2025.2
0 commit comments