Skip to content

Commit 7d9d1af

Browse files
committed
📝 更新 README:项目状态和图标展示
✅ 状态更新: - 测试验证: 已完成 ✅ - 性能优化: 已完成 ✅ - 项目统计: 更新 Marketplace 和生产验证状态 🎨 视觉改进: - 添加应用图标展示 (头部 + 安装指南) - 图标设计理念说明和多分辨率展示 - 图标设计文档引用 📊 文档完善: - CI/CD 完整开发流程说明 - 质量保证策略详细说明 - 社区支持和反馈渠道 - 项目统计数据更新
1 parent ff2506c commit 7d9d1af

1 file changed

Lines changed: 157 additions & 9 deletions

File tree

README.md

Lines changed: 157 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,15 @@
1-
# API Navigator
1+
# API Navigator for Spring Boot
2+
3+
<div align="center">
4+
<img src="images/icon@2x.png" alt="API Navigator Logo" width="128" height="128">
5+
6+
[![CI](https://github.com/xkcoding/API-Navigator/actions/workflows/ci.yml/badge.svg)](https://github.com/xkcoding/API-Navigator/actions/workflows/ci.yml)
7+
[![Release](https://github.com/xkcoding/API-Navigator/actions/workflows/release.yml/badge.svg)](https://github.com/xkcoding/API-Navigator/actions/workflows/release.yml)
8+
[![VSCode Marketplace](https://img.shields.io/visual-studio-marketplace/v/xkcoding.xkcoding-api-navigator)](https://marketplace.visualstudio.com/items?itemName=xkcoding.xkcoding-api-navigator)
9+
[![Downloads](https://img.shields.io/visual-studio-marketplace/d/xkcoding.xkcoding-api-navigator)](https://marketplace.visualstudio.com/items?itemName=xkcoding.xkcoding-api-navigator)
10+
[![Rating](https://img.shields.io/visual-studio-marketplace/r/xkcoding.xkcoding-api-navigator)](https://marketplace.visualstudio.com/items?itemName=xkcoding.xkcoding-api-navigator)
11+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
12+
</div>
213

314
一个强大的 VSCode 扩展,帮助 Java Spring Boot 开发者快速导航和管理 REST API 端点。
415

@@ -50,19 +61,29 @@ API Navigator 是从 IntelliJ IDEA 插件 RestfulHelper 移植而来的 VSCode
5061

5162
- VSCode 1.60.0+
5263
- Java 项目 (Spring Boot 推荐)
53-
- Node.js 16+ (开发环境)
5464

5565
### 安装插件
5666

57-
1. 在 VSCode 扩展市场搜索 "API Navigator"
58-
2. 点击安装
59-
3. 重新加载 VSCode
67+
#### 方式 1: VSCode 扩展市场
68+
1. 在 VSCode 扩展市场搜索 "API Navigator for Spring Boot"
69+
2. 寻找我们的专用图标:<img src="images/icon.png" alt="Extension Icon" width="24" height="24" style="vertical-align: middle;">
70+
3. 点击安装
71+
4. 重新加载 VSCode
72+
73+
#### 方式 2: 命令行安装
74+
```bash
75+
code --install-extension xkcoding.xkcoding-api-navigator
76+
```
77+
78+
#### 方式 3: 手动安装
79+
1.[GitHub Releases](https://github.com/xkcoding/API-Navigator/releases) 下载最新的 `.vsix` 文件
80+
2. 在 VSCode 中使用 `Extensions: Install from VSIX...` 命令安装
6081

6182
### 使用方法
6283

6384
1. **打开 Java Spring Boot 项目**
6485
2. **查看侧边栏**: 在资源管理器中找到 "API Navigator" 面板
65-
3. **快速搜索**: 按 `CMD+\` 打开 API 搜索
86+
3. **快速搜索**: 按 `CMD+\` (Mac) 或 `Ctrl+\` (Windows/Linux) 打开 API 搜索
6687
4. **跳转代码**: 点击任意 API 端点跳转到对应代码
6788

6889
## 📊 性能指标
@@ -76,6 +97,7 @@ API Navigator 是从 IntelliJ IDEA 插件 RestfulHelper 移植而来的 VSCode
7697

7798
### ✅ 已完成功能
7899

100+
#### 核心功能
79101
- [x] **基础架构**: TypeScript + VSCode Extension API
80102
- [x] **Java 解析器**: 基于 java-ast 库的 Spring 注解解析
81103
- [x] **Worker Threads**: 多线程异步处理架构
@@ -85,11 +107,30 @@ API Navigator 是从 IntelliJ IDEA 插件 RestfulHelper 移植而来的 VSCode
85107
- [x] **代码跳转**: 点击端点跳转到源码位置
86108
- [x] **文件监控**: 实时检测 Java 文件变更
87109

110+
#### CI/CD 和质量保证
111+
- [x] **GitHub Actions CI**: Node.js 矩阵测试 (18, 20)
112+
- [x] **自动化测试**: Jest 测试框架,覆盖率 41.7%
113+
- [x] **代码质量**: TypeScript 编译检查,ESLint
114+
- [x] **安全审计**: npm audit 依赖安全检查
115+
- [x] **自动发布**: VSCode Marketplace 自动发布
116+
- [x] **依赖管理**: Dependabot 自动依赖更新
117+
- [x] **应用图标**: 多分辨率专业图标设计 (128px/256px/512px)
118+
- [x] **测试验证**: 在真实 Spring Boot 项目中测试完成
119+
- [x] **性能优化**: 大型项目性能调优完成
120+
121+
<div align="center">
122+
<img src="images/icon.png" alt="128px" width="64" height="64" title="128px">
123+
<img src="images/icon@2x.png" alt="256px" width="64" height="64" title="256px">
124+
<img src="images/icon@4x.png" alt="512px" width="64" height="64" title="512px">
125+
<br>
126+
<small>🎨 专业图标设计:指南针 + API 概念,多分辨率适配</small>
127+
</div>
128+
88129
### 🚧 进行中
89130

90-
- [ ] **测试验证**: 在真实 Spring Boot 项目中测试
91-
- [ ] **性能优化**: 大型项目性能调优
92131
- [ ] **错误处理**: 完善异常情况处理
132+
- [ ] **测试覆盖率提升**: 目标从 41.7% 提升到 70%+
133+
- [ ] **用户反馈收集**: 基于 Marketplace 用户反馈持续改进
93134

94135
### 📋 待开发
95136

@@ -125,6 +166,81 @@ src/
125166
- **构建工具**: TypeScript Compiler
126167
- **Java 解析**: java-ast 库
127168
- **并发处理**: Worker Threads
169+
- **测试框架**: Jest
170+
- **CI/CD**: GitHub Actions
171+
172+
## 🔧 开发环境设置
173+
174+
### 环境要求
175+
- Node.js 16+
176+
- npm 7+
177+
- VSCode 1.60.0+
178+
- Git
179+
180+
### 本地开发
181+
182+
1. **克隆仓库**
183+
```bash
184+
git clone --recursive https://github.com/xkcoding/API-Navigator.git
185+
cd API-Navigator
186+
```
187+
188+
2. **安装依赖**
189+
```bash
190+
npm install
191+
```
192+
193+
3. **编译项目**
194+
```bash
195+
npm run compile
196+
```
197+
198+
4. **运行测试**
199+
```bash
200+
npm test
201+
npm run test:coverage # 查看覆盖率报告
202+
```
203+
204+
5. **开发调试**
205+
- 在 VSCode 中按 `F5` 启动调试
206+
- 选择 "Launch Extension" 配置
207+
- 新窗口将加载开发中的扩展
208+
209+
### 构建和发布
210+
211+
#### 本地构建
212+
```bash
213+
# 编译 TypeScript
214+
npm run compile
215+
216+
# 构建扩展包
217+
npm run vscode:prepublish
218+
219+
# 打包 VSIX
220+
npx vsce package
221+
```
222+
223+
#### 自动发布流程
224+
1. **创建 Release**: 在 GitHub 上创建新的 Release
225+
2. **自动触发**: GitHub Actions 自动执行构建和发布
226+
3. **多端发布**: 同时发布到 VSCode Marketplace 和 GitHub Releases
227+
228+
### 质量保证
229+
230+
#### 测试策略
231+
- **单元测试**: Jest 测试核心组件
232+
- **集成测试**: VSCode 扩展环境测试
233+
- **CI 测试**: GitHub Actions 多 Node.js 版本测试
234+
235+
#### 代码质量
236+
- **TypeScript**: 严格类型检查
237+
- **覆盖率**: 当前 41.7%,目标 70%+
238+
- **安全审计**: npm audit + Dependabot
239+
240+
#### 设计资源
241+
- **图标设计**: 查看 [icon-design-spec.md](icon-design-spec.md) 了解设计理念
242+
- **图标文件**: `images/` 目录包含多分辨率版本
243+
- **设计概念**: 指南针象征导航 + API 符号,体现扩展功能
128244

129245
## 🤝 贡献指南
130246

@@ -136,6 +252,35 @@ src/
136252
4. 推送分支: `git push origin feature/new-feature`
137253
5. 创建 Pull Request
138254

255+
### 开发规范
256+
- 遵循 TypeScript 最佳实践
257+
- 编写单元测试覆盖新功能
258+
- 更新相关文档
259+
- 确保 CI 检查通过
260+
261+
## 📞 支持和反馈
262+
263+
### 问题报告
264+
- [GitHub Issues](https://github.com/xkcoding/API-Navigator/issues): 报告 Bug 或请求新功能
265+
- [VSCode Marketplace](https://marketplace.visualstudio.com/items?itemName=xkcoding.xkcoding-api-navigator): 用户评价和反馈
266+
267+
### 社区资源
268+
- **文档**: [项目 Wiki](https://github.com/xkcoding/API-Navigator/wiki)
269+
- **讨论**: [GitHub Discussions](https://github.com/xkcoding/API-Navigator/discussions)
270+
- **更新日志**: [Releases](https://github.com/xkcoding/API-Navigator/releases)
271+
272+
## 📊 项目统计
273+
274+
| 指标 | 状态 |
275+
|------|------|
276+
| **代码行数** | ~2,000+ 行 TypeScript |
277+
| **测试覆盖率** | 41.7% (持续提升中) |
278+
| **CI/CD 状态** | ✅ 完整自动化 |
279+
| **发布版本** | v1.0.0 (已发布) |
280+
| **支持平台** | Windows, macOS, Linux |
281+
| **Marketplace** | ✅ 已上线 |
282+
| **测试验证** | ✅ 生产环境验证 |
283+
139284
## 📄 许可证
140285

141286
本项目基于 MIT 许可证开源 - 查看 [LICENSE](LICENSE) 文件了解详情。
@@ -151,7 +296,10 @@ src/
151296
- **作者**: xkcoding (Yangkai.Shen)
152297
- **邮箱**: 237497819@qq.com
153298
- **GitHub**: https://github.com/xkcoding/API-Navigator
299+
- **VSCode Marketplace**: https://marketplace.visualstudio.com/publishers/xkcoding
154300

155301
---
156302

157-
**🌟 如果这个项目对你有帮助,请给我们一个 Star!**
303+
**🌟 如果这个项目对你有帮助,请给我们一个 Star!**
304+
305+
**📦 立即体验**: [安装 API Navigator for Spring Boot](https://marketplace.visualstudio.com/items?itemName=xkcoding.xkcoding-api-navigator)

0 commit comments

Comments
 (0)