README

官方弃用 : 使用 PHP 插件转向 SonarQube 以确保高效的代码质量保证。

SCQAT

这是 SCQAT，即标准化代码质量保证工具，一套开源工具，可以确保您的代码、您的开发团队以及您的老板的代码质量。

SCQAT 是一种轻量级的方式，将行业标准代码质量分析器包装在简单高效的工具中。

安装

您需要运行 PHP 5.4 或更高版本。

安装 Composer

SCQAT 依赖于 Composer 的魔法来管理依赖项。如果您尚未安装它，只需获取 composer.phar，然后运行您可以在 此处 找到的单行安装命令。

我们将假设您将在新创建的 /path/to/folder 目录中本地运行 composer.phar。

安装或更新 SCQAT

php composer.phar require clorichel/scqat:0.5

感谢每一位 Composer 贡献者，是的，就是它。首先 composer require 将安装所有内容，在同一目录下使用带有新版本号的另一个 require 将仅更新。

全局

使用 Linux / Unix / OSX ? 简单至极，运行 composer require 然后执行

ln -s /path/to/folder/vendor/bin/scqat /usr/local/bin/scqat

命令失败？只需再次使用 sudo 运行。在 OSX 上？创建可能不存在的 /usr/local/bin/ 文件夹。

更新 SCQAT 时，绝对没有必要再次运行该命令。

使用

全局安装了吗？只需打开您的控制台并执行

scqat -d /path/to/sourcecode

您的代码已被分析！显示的质量报告是自我解释的。没有全局安装？您必须添加路径，运行 /path/to/folder/vendor/bin/scqat

查看 CLI 手册 了解详细使用方法。使用简单的 .scqat YAML 文件配置几乎所有内容，如 配置手册 中所述。

关于它

SCQAT 致力于成为一个通用的工具，以确保代码质量保证。最初开发集中于 PHP 代码语言，通过一个简单的命令行工具 (CLI) 运行。

它如何帮助我

我想添加质量检查

你最喜欢的语言和/或QA工具缺失吗？你很高兴地提交一个问题。

熟悉Composer，请发送一个拉取请求：只需实现一个具有简单fileNameMatcher方法的\SCQAT\LanguageAbstract，以确定你的语言将处理哪些文件名，以及一个执行工作并返回\SCQAT\Result的\SCQAT\AnalyzerAbstract。

查看\SCQAT\Language\PHP和\SCQAT\Language\PHP\Analyzer\Lint的示例，并快速开始时只需复制它们。

未来工作估计

例如，SCQAT确实如其名所示：它是一个标准化代码质量保证的高效工具。你可以在许多平台上运行它。它安装速度快。报告清晰、简洁。可以在git预提交钩子或持续集成堆栈上使用它。实现新语言和分析器只需要一点PHP开发技能。

短期工作列在CHANGELOG中，每个版本都有。

中期到长期将致力于报告，以便能够以一些常用格式（TXT和HTML）导出，使用徽章进行评分和排名，以及可能出现的需求。你都可以提交问题或拉取请求，分享你的想法和/或需求。

卸载

没有东西被发送到各个地方，只需简单地删除你的/usr/local/bin/scqat符号链接（如果已全局安装）和/path/to/folder安装目录。在这样做之前，如果你遇到了问题，请提交一个问题；）