karen-nalbandian/symfony-coding-standard

Symfony 编码标准的 CodeSniffer 规则集(PCG Cube 风味)

1.0.0 2018-07-29 19:22 UTC

This package is not auto-updated.

Last update: 2024-09-18 03:48:00 UTC


README

这是一个编码标准,用于检查与 Symfony 编码标准 的兼容性,基于优秀的 escapestudios/symfony2-coding-standard 仓库。

重要提示:请小心使用这个库,因为它仅供内部使用,可能不会得到维护

差异

以下标准已被修改

  • 添加了 Symfony.Commenting.FunctionComment.MissingParamType
  • 移除了 Symfony.Commenting.FunctionComment.SpacingAfterParamType
  • 移除了 Symfony.Commenting.Annotations.Invalid
  • 移除了 Symfony.Functions.Arguments.Invalid
  • 移除了 Squiz.Strings.ConcatenationSpacing.PaddingFound

安装

Composer

这个标准可以通过 Composer 依赖管理器安装。

  1. 安装 Composer

  2. 将编码标准作为你项目的依赖安装

     composer require --dev karen-nalbandian/symfony-coding-standard:dev-master
    
  3. 将编码标准添加到 PHP_CodeSniffer 的安装路径

     vendor/bin/phpcs --config-set installed_paths vendor/karen-nalbandian/symfony-coding-standard
    
  4. 检查已安装的编码标准中的 "Symfony"

     vendor/bin/phpcs -i
    
  5. 完成!

     vendor/bin/phpcs /path/to/code
    

### 独立安装

  1. 安装 PHP_CodeSniffer

  2. 检出这个仓库

     git clone https://github.com/karen-nalbandian/symfony-coding-standard.git
    
  3. 将编码标准添加到 PHP_CodeSniffer 的安装路径

     phpcs --config-set installed_paths /path/to/symfony-coding-standard
    

    或者将这个仓库的 "Symfony"-文件夹复制/符号链接到 phpcs 的 Standards 目录中

  4. 检查已安装的编码标准中的 "Symfony"

     phpcs -i
    
  5. 完成!

     phpcs /path/to/code