# ide-helper

**Repository Path**: fiberphp/ide-helper

## Basic Information

- **Project Name**: ide-helper
- **Description**: 💡 FiberPHP IDE 辅助生成器 —— 生成 _ide_helper.php 文件，支持 PhpStorm 自动补全，开箱即用。
- **Primary Language**: PHP
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-08-23
- **Last Updated**: 2026-09-10

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# FiberPHP IDE Helper

为 PHPStorm 等 IDE 生成 Facade、辅助函数、模型属性桩文件，增强自动补全。生成结果输出到 `ide/` 目录，仅需在 IDE 中将该目录纳入项目索引。

## 环境要求

- PHP >= 8.3
- 依赖 `fiberphp/console`、`fiberphp/discovery`、`fiberphp/framework`
- 可选 `fiberphp/database`：用于模型属性桩生成

## 安装

```bash
composer require --dev fiberphp/ide-helper
```

## 使用

```bash
# 生成全部桩文件（helpers + facades + models）
php fiberphp ide-helper:generate

# 仅生成某类
php fiberphp ide-helper:generate --helpers
php fiberphp ide-helper:generate --facades
php fiberphp ide-helper:generate --models

# 指定输出目录
php fiberphp ide-helper:generate --dir=storage/ide
```

默认输出到 `ide/` 目录：

```
ide/
├── helpers.php      # 辅助函数桩（含返回类型与参数）
├── facades.php      # Facade 别名桩
└── models/          # 模型属性桩（每个模型一个文件）
```

## 特性

| 能力       | 说明                                                            |
|------------|-----------------------------------------------------------------|
| 辅助函数桩 | 扫描框架与包注册的 helper 函数，生成带类型声明的桩              |
| Facade 桩  | 为 Facade 别名生成 `@method` 桩，补全方法签名                   |
| 模型属性   | 反射模型类，为属性生成 `@property` 桩（需 `fiberphp/database`） |
| 按需生成   | `--helpers` / `--facades` / `--models` 单独生成某一类           |
| 自定义输出 | `--dir` 指定输出目录                                            |

## License

[MIT](LICENSE)