nette/code-checker
GitHub: nette/code-checker
一款 Nette 官方维护的命令行代码格式检查与自动修复工具,帮助开发者快速发现并修正源文件中的常见格式问题。
Stars: 88 | Forks: 30
# 代码 Checker
[](https://packagist.org/packages/nette/code-checker)
[](https://github.com/nette/code-checker/actions)
[](https://github.com/nette/code-checker/releases)
[](https://github.com/nette/code-checker/blob/master/license.md)
## 简介
Code Checker 是一个命令行工具,可以扫描你的源代码以查找常见的格式错误——并且能够自动修复其中的许多问题。它适用于 PHP、Latte、NEON、JSON 和 YAML 文件,可检查编码、换行符、缩进、行尾空格等。
它作为独立应用程序运行,而不是作为项目依赖项。
## 安装
通过 Composer 全局安装:
```
composer global require nette/code-checker
```
确保你的全局 Composer `bin` 目录在你的 [`PATH`](https://getcomposer.org/doc/03-cli.md#global) 中。
然后,你可以在任何操作系统上从任何地方使用 `code-checker` 命令。
或者,将其作为独立项目安装:
```
composer create-project nette/code-checker
```
它需要 PHP 8.0 或更高版本。
## 用法
默认情况下,Code Checker 以**只读模式**运行,仅报告其发现的问题:
```
code-checker
```
要实际修复文件,请添加 `--fix`。**请先备份你的文件**,或者在干净的工作树中运行它,以便你随后可以使用 `git diff` 查看更改:
```
code-checker --fix
```
你可以将扫描限制在特定路径,跳过文件,或者运行更快的仅语法检查:
```
code-checker -d src --ignore "temp/*"
code-checker --only-syntax
```
在只读模式下,如果一切正常,工具将以代码 `0` 退出;如果发现任何问题,则以 `1` 退出,因此它非常适合集成到 CI pipeline 中。
完整选项列表:
```
Usage: code-checker [options]
Options:
-d Folder or file to scan (default: current directory)
-i | --ignore Files to ignore
-f | --fix Fix the files
-l | --eol Normalize line endings to the system default
--only-syntax Check syntax only (faster)
--no-progress Do not show progress dots
--version Show version
```
## Code Checker 的功能
- 检查 **PHP**、**Latte**、**NEON** 和 **JSON** 文件的语法
- 移除 [BOM](https://doc.nette.org/glossary#toc-bom)
- 验证文件是否为有效的 **UTF-8**
- 检查 [控制字符](https://doc.nette.org/glossary#toc-control-characters)
- 检测 annotation 周围格式错误的 phpDoc 注释(例如用 `/* @var` 代替了 `/** @var`)
- 检查 PHP 文件是否声明了 `strict_types=1`
- 强制要求 PHP、CSS、JS 和 TS 文件使用制表符缩进,YAML 使用空格缩进
- 移除行尾空格和文件末尾的空行
- 将换行符统一为系统默认设置(使用 `-l` 参数)
标签:Apache Flink, ffuf, Nette, OpenVAS, PHP, 云安全监控, 代码规范检查, 文档结构分析, 静态分析