Pretty 项目使用教程

Pretty 项目使用教程

pretty ✨ CLI command with sane defaults to simplify CodeSniffer and PHP-CS-Fixer 项目地址: https://gitcode.com/gh_mirrors/pretty4/pretty

1. 项目的目录结构及介绍

Pretty 项目的目录结构如下：

pretty/
├── .gitignore
├── LICENSE
├── README.md
├── composer.json
└── pretty

• .gitignore: 该文件用于指定 Git 版本控制系统中需要忽略的文件和目录。
• LICENSE: 项目的许可证文件，Pretty 项目使用 MIT 许可证。
• README.md: 项目的说明文件，包含项目的简介、安装方法、使用方法等信息。
• composer.json: Composer 的配置文件，用于管理项目的依赖关系。
• pretty: 项目的可执行文件，用于运行代码分析和修复工具。

2. 项目的启动文件介绍

Pretty 项目的启动文件是 pretty。该文件是一个可执行的 CLI 命令，用于简化 PHP CodeSniffer 和 PHP-CS-Fixer 的使用。通过运行 pretty 命令，可以自动检测当前目录中的配置文件，并运行相应的工具进行代码分析或修复。

使用方法

• 运行代码分析:

  pretty
  

  该命令将不会修改任何代码，仅进行代码分析。

• 修复代码错误:

  pretty fix
  

  该命令将自动修复代码中的错误。

• 在 CI 环境中运行:

  pretty ci
  

  该命令将禁用 PHP-CS-Fixer 或 CodeSniffer 的缓存选项，适用于持续集成环境。

3. 项目的配置文件介绍

Pretty 项目依赖于 PHP CodeSniffer 和 PHP-CS-Fixer 的配置文件。如果项目目录中存在这些工具的配置文件（如 .php_cs 或 phpcs.xml），Pretty 将自动使用这些配置文件进行代码分析和修复。

默认配置

如果项目目录中没有配置文件，Pretty 将默认使用 PHP CodeSniffer 并采用 PSR-2 标准进行代码分析。

自定义配置

用户可以根据项目需求，在项目根目录下创建相应的配置文件，例如：

• PHP-CS-Fixer 配置文件: .php_cs
• PHP CodeSniffer 配置文件: phpcs.xml

这些配置文件将覆盖默认配置，确保代码分析和修复符合项目的特定要求。

通过以上步骤，您可以轻松地使用 Pretty 项目进行代码分析和修复，提高代码质量。

pretty ✨ CLI command with sane defaults to simplify CodeSniffer and PHP-CS-Fixer 项目地址: https://gitcode.com/gh_mirrors/pretty4/pretty