# JsonProject

**Repository Path**: chinaqi/json-project

## Basic Information

- **Project Name**: JsonProject
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-08-03
- **Last Updated**: 2026-08-03

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# JSON Reader

JSON Reader 是一个本地运行的 VSCode TypeScript 插件，用于在 VSCode 内浏览和阅读工作区 JSON 文件。

## 当前能力

- 提供 JSON Reader 左侧活动栏入口。
- 提供 JSON Files 视图容器。
- 提供刷新 JSON 文件视图命令。
- 支持配置大文件阈值、扫描排除规则、左侧菜单显示上限、最大预览大小和自动刷新行为。
- 所有读取、解析、搜索和渲染均在本地完成，不上传 JSON 文件内容。
- 阅读视图会安全识别 URL 字符串和常见颜色字符串，并提供可读展示。
- 提供 TypeScript 编译脚本和 VSCode 插件调试配置模板。

## 配置项

- `jsonReader.largeFileThresholdMb`: 普通树形解析模式的最大文件大小，默认 `5` MB。
- `jsonReader.scanExclusions`: 扫描 JSON 文件时排除的 glob 规则。
- `jsonReader.maxFilesShown`: 左侧菜单一次扫描并显示的 JSON 文件数量上限，默认 `200`。
- `jsonReader.maxPreviewKb`: 大文件模式最多读取的文件开头预览大小，默认 `256` KB。
- `jsonReader.autoRefresh`: 工作区 JSON 文件变化时是否自动刷新左侧文件列表，默认开启。

## 左侧菜单性能

- 首次打开 JSON Files 视图或强制刷新时，左侧菜单会显示“正在扫描 JSON 文件...”状态，扫描完成后自动更新结果。
- `jsonReader.maxFilesShown` 会传入 VSCode 文件搜索上限，避免海量 JSON 文件一次性拖慢菜单；达到上限时菜单底部会显示提示。
- 如果工作区 JSON 文件较多，建议优先通过 `jsonReader.scanExclusions` 排除依赖、构建产物、缓存或临时目录，再按需调高 `jsonReader.maxFilesShown`。

## 开发

```bash
npm install
npm run compile
npm run package
```

在 VSCode 中打开本目录后，运行 `Run Extension` 调试配置即可启动扩展开发宿主。

如果当前环境没有 `.vscode` 目录，可将 `.vscode.example` 复制为 `.vscode` 后使用调试配置。