exakat/exakat-ga

GitHub Action 版 Exakat

镜像概述

Exakat是一款可定制的静态分析引擎，适用于所有PHP 5.2至PHP 8.0-dev版本的应用，旨在提升代码质量、安全性、性能及文档完整性。本镜像为Exakat的GitHub Actions版本，可无缝集成到代码仓库工作流中，自动扫描PHP代码。

核心功能

• 检测代码中的潜在问题与安全漏洞
• 控制代码质量，遵循最佳实践
• 自动识别常见PHP库和框架
• 支持排除特定规则（ignore_rules）和目录（ignore_dirs）
• 生成Perfile风格的详细分析报告

使用场景

• GitHub仓库CI/CD工作流：在代码推送或拉取请求时自动执行静态分析，确保代码质量
• 本地代码检查：通过Docker镜像快速扫描项目代码

配置说明

GitHub Actions工作流配置

在仓库的.github/workflows/test.yml中添加以下内容：

yaml
on: [push, pull_request]
name: Test
jobs:
  exakat:
    name: Scan with Exakat
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
    - name: Exakat
      uses: docker://exakat/exakat-ga

默认使用"CI-checks"规则集，详情见https://exakat.readthedocs.io/en/latest/Rulesets.html#ci-checks%E3%80%82

自定义排除规则与目录

如需排除特定规则或目录，添加with参数：

yaml
uses: docker://exakat/exakat-ga
with:
  ignore_rules: 'Classes/StaticMethodsCalledFromObject,Php/ShouldUseCoalesce,Functions/UsesDefaultArguments'
  ignore_dirs: '/path/to/repos#1,/path/to/repos#2,/path/to/repos#3'

规则名称需使用文档中的"Short name"（如"@ Operator"对应"Structures/Noscream"）。

本地Docker运行

扫描当前目录代码：

bash
docker run --rm -it -v ${PWD}:/app exakat/exakat-ga:latest

其他说明

• 免费版使用PHP 7.4，如需其他版本可联系官方
• 分析结果以Perfile格式展示问题行号、规则名称等
• 规则文档含修复示例，可参考https://exakat.readthedocs.io/en/latest/Reports.html#perfile
• 帮助支持：Exakat帮助中心