# 微擎表单验证IDE Helper

**Repository Path**: wm-code/engine-validate-ide-helper

## Basic Information

- **Project Name**: 微擎表单验证IDE Helper
- **Description**: 自动生成提示验证器位置的注释
- **Primary Language**: PHP
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: https://v.neww7.com/plugin/IdeHelper.html
- **GVP Project**: No

## Statistics

- **Stars**: 19
- **Forks**: 3
- **Created**: 2021-05-14
- **Last Updated**: 2023-02-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## 说明
此扩展用于生成提示[验证器](https://v.neww7.com)位置的注释

如果你使用了[验证器路由中间件](https://v.neww7.com/plugin/engine-validate-middleware.html),那么所有的验证过程将会在中间件部分完成，传递给控制器的时候已经是处理好的数据。

此扩展将根据 [ValidateMiddlewareConfig](https://v.neww7.com/plugin/engine-validate-middleware.html) 中的配置生成如下注释，方便定位验证器
```php
/**
 * @validate {@see UserValidate::sceneLogin()}
 */
```
## 安装
```shell
composer require itwmw/engine-validate-ide-helper --dev
```
## 使用
其他框架可以自行将`Itwmw\Validate\Ide\Helper\IdeHelperCommand`命令进行集成
### 软擎
如果你使用的软擎框架，在安装本扩展后，可直接使用命令
```shell
bin/gerent make:validate-ide [完整命名空间或者完整文件名] --dir [文件目录]
```
### Laravel
如果你使用的Laravel框架，在安装本扩展后，可直接使用命令
```shell
php artisan make:validate-ide [完整命名空间或者完整文件名] --dir [文件目录]
```
## WebStorm集成
### 软擎
文件->设置->工具->外部工具->添加
- 名称：`Validate-Ide`或者随意
- 程序:`bin\gerent` Windows选择bat文件
- 参数:`make:validate-ide $FilePath$`
- 工作目录:`$ProjectFileDir$`
### Laravel
文件->设置->工具->外部工具->添加
- 名称：`Validate-Ide`或者随意
- 程序: 如果有PHP的环境变量，可直接写入`php`,否则选择`php.exe`的位置
- 参数:`artisan make:validate-ide $FilePath$`
- 工作目录:`$ProjectFileDir$`

### 快捷键
为了更方便的使用，可以给此工具设置一个快捷键

文件->设置->键盘映射->外部工具->Validate-Ide-Helper->右键点击->添加键盘快捷键，作者这里是`ALT+G`