nette / code-checker
✅ Nette CodeChecker:一个简单的工具,用于检查源代码是否符合Nette编码标准。
v3.3.2
2023-10-11 14:07 UTC
Requires
- php: >= 8.0
- latte/latte: ^3.0.1
- nette/application: ^3.1
- nette/caching: ^3.1
- nette/command-line: ^2.0
- nette/forms: ^3.0
- nette/neon: ^3.0
- nette/utils: ^4.0
Requires (Dev)
- nette/tester: ^2.0
- phpstan/phpstan: ^0.12
- tracy/tracy: ^2.6
This package is auto-updated.
Last update: 2024-09-11 16:04:30 UTC
README
简介
该工具可以检查并可能修复您源代码中的一些形式错误。
使用方法
Usage: php code-checker [options]
Options:
-d <path> Folder or file to scan (default: current directory)
-i | --ignore <mask> Files to ignore
-f | --fix Fixes files
-l | --eol Convert newline characters
--no-progress Do not show progress dots
--strict-types Checks whether PHP 7.0 directive strict_types is enabled
没有参数时,它以只读模式检查当前工作目录,有-f
参数时修复文件。
在您了解这个工具之前,请务必先备份您的文件。
您可以为Windows下更方便地执行Code-Checker创建一个批处理文件,例如code.bat
。
php path_to\Nette_tools\Code-Checker\code-checker %*
Code-Checker做什么?
- 移除BOM
- 检查Latte模板的有效性
- 检查
.neon
、.php
和.json
文件的有效性 - 检查控制字符
- 检查文件是否以UTF-8编码
- 控制拼写错误的
/* @annotations */
(第二个星号缺失) - 从PHP文件中移除PHP结束标签
?>
- 从文件末尾移除尾随空格和多余的空白行
- 将行结束符标准化为系统默认值(使用
-l
参数)
安装
通过Composer安装。该项目不是为了作为依赖项运行,因此请将其作为独立项目安装
composer create-project nette/code-checker
或者通过以下方式全局安装
composer global require nette/code-checker
并确保您的全局vendor二进制目录包含在您的$PATH
环境变量中。
它需要PHP版本8.0。