Files
php/README.md

74 lines
1.3 KiB
Markdown

# php
Php 项目工程模板(带自动代码校验)
## 使用方法
启动开发服务器:
```bash
php -S 0.0.0.0:8000
```
## 代码质量检查
### 安装依赖
```bash
composer install
```
### 运行代码检查
运行所有检查:
```bash
composer check
```
单独运行检查:
```bash
# PHP 语法检查
composer syntax-check
# 代码风格检查
composer cs-check
# 代码风格自动修复
composer cs-fix
# 静态分析 (PHPStan)
composer phpstan
# 静态分析 (Psalm)
composer psalm
# 自动格式化代码
composer fix
```
## 自动化工作流
项目包含自动化代码校验工作流 (`.gitea/workflows/code-check.yml`),会在以下情况自动运行:
- 推送代码到 `main`, `master`, 或 `develop` 分支
- 创建 Pull Request
工作流会自动执行:
1. PHP 语法验证
2. 代码风格检查 (PSR-12 标准)
3. 静态代码分析 (PHPStan & Psalm)
4. 代码格式检查
## 配置文件说明
- `.php-cs-fixer.php` - PHP CS Fixer 代码格式配置
- `phpcs.xml` - PHP_CodeSniffer 代码风格配置
- `phpstan.neon` - PHPStan 静态分析配置
- `psalm.xml` - Psalm 静态分析配置
- `composer.json` - 项目依赖和脚本配置
### 版权说明
Copyright @ Mengning Software
梦宁软件(江苏)有限公司 版权所有