# projectScanPlugin

**Repository Path**: httpxiaohou/project-scan-plugin

## Basic Information

- **Project Name**: projectScanPlugin
- **Description**: 代码扫描idea插件
- **Primary Language**: Java
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-11-20
- **Last Updated**: 2025-11-20

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Project Directory Scanner Plugin

IntelliJ IDEA 插件 - 扫描并展示项目目录结构

## 功能特性

- 扫描项目根目录
- 以树形结构展示目录和文件
- 支持展开/折叠目录
- 双击查看文件路径
- 自动过滤隐藏文件（保留 .idea 目录）

## 开发环境

- IntelliJ IDEA 2025.2+
- JDK 17+
- Gradle 8.0+

## 构建和运行

### 使用 Gradle 命令行

1. 编译项目：
   ```bash
   ./gradlew clean compileJava
   ```

2. 打包插件：
   ```bash
   ./gradlew clean buildPlugin
   ```
   打包完成后，插件 ZIP 文件位于：`build/distributions/project-directory-scanner-1.0.0.zip`

3. 运行插件（开发模式）：
   ```bash
   # Windows 系统
   gradlew.bat clean runIde
   
   # 或者 Linux/Mac 系统
   ./gradlew clean runIde
   ```
   
   **说明**：
   - 首次运行会下载 Gradle 和 IntelliJ IDEA 2025.2（如果本地没有）
   - 会启动一个新的 IDEA 实例，插件已加载
   - 在新实例中打开一个项目，即可测试插件功能

### 使用 IntelliJ IDEA（图形界面）

1. **打开项目**：
   - 在 IntelliJ IDEA 中打开 `plugin1` 目录
   - Gradle 会自动导入项目

2. **运行插件**（三种方式任选其一）：
   
   **方式 A：使用 Gradle 工具窗口**
   - 打开 Gradle 工具窗口（View → Tool Windows → Gradle）
   - 展开项目 → Tasks → intellij
   - 双击 `runIde` 任务
   
   **方式 B：使用运行配置**
   - 右键点击 `build.gradle.kts` 文件
   - 选择 "Run 'runIde'"
   
   **方式 C：使用终端**
   - 打开 Terminal（Alt + F12）
   - 执行：`gradlew.bat runIde`

## 使用方法

1. 在 IntelliJ IDEA 中打开项目
2. 通过菜单 `Tools` -> `扫描项目目录` 或使用快捷键 `Ctrl+Alt+S`
3. 右侧会打开 "ProjectDirectoryScanner" 工具窗口
4. 点击 "扫描项目" 按钮开始扫描
5. 在树形结构中浏览项目目录

## 项目结构

```
plugin1/
├── src/
│   └── main/
│       ├── java/
│       │   └── com/example/scanner/
│       │       ├── action/          # Action 定义
│       │       ├── service/          # 服务层
│       │       └── ui/              # UI 组件
│       └── resources/
│           └── META-INF/
│               └── plugin.xml       # 插件配置
├── build.gradle.kts                 # Gradle 构建配置
└── settings.gradle.kts              # Gradle 设置
```

## 打包插件

### 方法一：使用 Gradle 命令打包（推荐）

1. **构建插件 ZIP 包**（可直接安装）：
   ```bash
   cd plugin1
   ./gradlew clean buildPlugin
   ```
   生成的插件包位置：`build/distributions/project-directory-scanner-1.0.0.zip`

2. **仅编译项目**：
   ```bash
   ./gradlew clean build
   ```
   编译后的类文件位于：`build/classes` 目录

### 方法二：使用 IntelliJ IDEA

1. 打开 Gradle 工具窗口（View -> Tool Windows -> Gradle）
2. 展开项目 -> Tasks -> intellij
3. 双击 `buildPlugin` 任务
4. 打包完成后，在 `build/distributions` 目录找到 ZIP 文件

### 安装插件

1. 打开 IntelliJ IDEA
2. File -> Settings -> Plugins
3. 点击 ⚙️ 图标 -> Install Plugin from Disk...
4. 选择生成的 `project-directory-scanner-1.0.0.zip` 文件
5. 点击 OK，然后重启 IDEA

### 打包输出说明

- **ZIP 文件**（推荐）：包含插件所有文件和元数据，可直接安装
- 位置：`build/distributions/project-directory-scanner-1.0.0.zip`

### 常见问题

1. **打包失败**：确保 JDK 版本为 17+
2. **找不到插件**：检查 `build/distributions` 目录是否存在
3. **安装失败**：确保插件版本与 IDEA 版本兼容
4. **Gradle 下载失败**：
   - 如果遇到 Gradle 依赖下载问题，尝试清理缓存：
     ```bash
     # Windows 系统
     gradlew.bat clean --refresh-dependencies
     ```
   - 确保网络可以访问 Maven Central 仓库
   - 如果使用代理，配置 `gradle.properties` 文件
5. **无法下载 JetBrains Java Runtime (JBR)**：
   - 已配置使用本地 JDK，不需要下载 JBR
   - 如果仍然失败，确保系统已安装 JDK 17+
   - 检查环境变量 `JAVA_HOME` 是否正确设置
   - 如果使用代理，在 `gradle.properties` 中配置代理设置