ElasticDash API Scanner

简介

ElasticDash API Scanner 是一个用于扫描代码中的 API 并提供 XAI 支持的 VS Code 扩展。

功能

• Hello World: 显示一个 "Hello World" 消息框。
• 读取文件: 扫描工作区中的文件并读取内容。
• 询问 XAI: 向 XAI 提问并获取响应。
• 读取文件并发送到 XAI: 扫描工作区中的文件并将内容发送到 XAI 进行分析。
• 侧边栏 API 列表: 在侧边栏中显示包含 API 的文件列表，并在每个文件名下显示 API 列表。用户可以点击收起/展开文件（默认全部展开）。
• 登录界面: 如果 token 不存在，显示登录界面，用户可以输入 email 和 password 进行登录。

安装

1. 克隆此仓库到本地。
2. 在 VS Code 中打开此项目。
3. 运行 npm install 安装依赖。
4. 运行 npm run compile 编译扩展。
5. 按 F5 启动扩展。

构建此拓展

1. 运行vsce package。
2. 根目录会生成名为elastic-dash-vscode-0.0.1.vslx的文件。
3. 使用该文件安装即可。

忽略文件

当运行【读取文件】和【读取文件并发送到XAI】这两个指令时，本扩展会自动忽视 .gitignore 和 .edignore 文件里指定的路径。.edignore 的格式应与 .gitignore 相同。

使用

Hello World

1. 打开命令面板（Ctrl+Shift+P 或 Cmd+Shift+P）。
2. 输入 Hello World 并选择 elastic-dash-vscode.helloWorld 命令。

读取文件

1. 打开命令面板（Ctrl+Shift+P 或 Cmd+Shift+P）。
2. 输入 Read Files 并选择 elastic-dash-vscode.readFiles 命令。

询问 XAI

1. 打开命令面板（Ctrl+Shift+P 或 Cmd+Shift+P）。
2. 输入 Ask XAI 并选择 elastic-dash-vscode.askXAI 命令。
3. 输入你的问题并按回车。

读取文件并发送到 XAI

1. 打开命令面板（Ctrl+Shift+P 或 Cmd+Shift+P）。
2. 输入 Scan APIs 并选择 elastic-dash-vscode.scanApis 命令。

侧边栏 API 列表

1. 在侧边栏中找到 ElasticDash 面板。
2. 展开 Files containing API 列表，查看包含 API 的文件及其 API 列表。

登录界面

1. 如果 token 不存在，侧边栏会显示登录界面。
2. 输入你的 email 和 password 进行登录。
3. 登录成功后，侧边栏会显示 API 列表。

开发

扩展指南

确保你已经阅读了扩展指南，并遵循创建扩展的最佳实践。

• 扩展指南

使用 Markdown

你可以使用 Visual Studio Code 编写你的 README。以下是一些有用的编辑器快捷键：

• 分割编辑器（Cmd+\ 在 macOS 或 Ctrl+\ 在 Windows 和 Linux）。
• 切换预览（Shift+Cmd+V 在 macOS 或 Shift+Ctrl+V 在 Windows 和 Linux）。
• 按 Ctrl+Space（Windows, Linux, macOS）查看 Markdown 代码片段列表。

更多信息

• Visual Studio Code 扩展 API
• Node.js
• TypeScript