Skip to content

docs: 开发教程和插件契约链接改到 lithe-plugin-docs #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
xiaoyumuxi merged 1 commit into from
Oct 23, 2026
Merged

docs: 开发教程和插件契约链接改到 lithe-plugin-docs #5

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,9 @@ Lithe 已预置 Lithe Store 社区插件源。如果你之前移除了它，先

## 用这个仓库做模板

先读 Lithe Store 的[LSP 插件完整生命周期教程](https://github.com/Lithe-IDEA/Lithe-store/blob/main/docs/lsp-plugin-lifecycle.md)，
先读 [lithe-plugin-docs](https://github.com/Lithe-IDEA/lithe-plugin-docs) 的[LSP 插件完整生命周期教程](https://github.com/Lithe-IDEA/lithe-plugin-docs/blob/main/guides/lsp-plugin-lifecycle.md)，
跟着完成清单、服务器打包、激活、状态隔离、停止与升级验收。
需要接入构建工具、运行或测试时，继续读[构建工具接入指南](https://github.com/Lithe-IDEA/Lithe-store/blob/main/docs/build-tool-integration.md)。
需要接入构建工具、运行或测试时，继续读[构建工具接入指南](https://github.com/Lithe-IDEA/lithe-plugin-docs/blob/main/guides/build-tool-integration.md)。
教程会区分已可发布的 API 与开发中的构建系统接口。

```text
Expand All @@ -60,8 +60,8 @@ scripts/package.mjs # 下载并校验 LuaLS，按平
往插件目录写文件，需要写的状态请放到用户缓存目录（参考 `bin/lithe-lua-language-server`）。
3. 修改启动器中的缓存命名空间和 `.github/workflows/ci.yml` 中读取清单的路径，
同步更新作者信息、许可证和第三方声明。项目相关的索引应按工作区隔离。
4. `plugin.json` 的完整格式见 Lithe 的
[插件契约](https://github.com/1lck/Lithe-IDEA/blob/preview/shared/contracts/plugins/v1/README.md)。
4. `plugin.json` 的完整格式见 lithe-plugin-docs 里的
[插件契约](https://github.com/Lithe-IDEA/lithe-plugin-docs/blob/main/contract/v1/README.md)。

本地先用 Node.js 22+ 打包（还需要 `tar`、`zip`、`unzip`）：

Expand All @@ -70,7 +70,7 @@ node scripts/package.mjs
```

脚本重新生成 `dist/`，输出两个 macOS 架构的 zip 和摘要。CI 还会检查归档结构与社区包声明。
发布前按[生命周期验收步骤](https://github.com/Lithe-IDEA/Lithe-store/blob/main/docs/lsp-plugin-lifecycle.md#7-把停止失败和卸载也当作功能验收)
发布前按[生命周期验收步骤](https://github.com/Lithe-IDEA/lithe-plugin-docs/blob/main/guides/lsp-plugin-lifecycle.md#7-把停止失败和卸载也当作功能验收)
在目标 Mac 上确认 LSP、运行、禁用、重启、更新和卸载；打包成功不等于这些交互已经通过。

## 发布新版本
Expand Down
Loading