fuégas/vanilla-psr

用于代码风格检查的修改版规则集

1.2.0 2017-03-16 14:58 UTC

This package is not auto-updated.

Last update: 2024-09-22 06:47:22 UTC


README

用于代码风格检查的修改版规则集。它基于PSR-2,但允许使用2个空格而不是4个空格缩进。

已知问题

目前没有。当你发现问题,请 创建问题

用法

你可以引用这个库

Composer

你可以使用 Composer 安装 Vanilla-psr。只需将 fuegas/vanilla-psr 添加到你的 composer.json 文件中。

{
    "require": {
        "fuegas/vanilla-psr": "*"
    }
}

PHPCS

你可以使用以下命令使用规则集:

如果你只想输入 phpcs,你可以在项目的根目录中创建一个名为 phpcs.xml 的文件,内容如下:

<?xml version="1.0"?>
<ruleset name="Vanilla PSR">
  <description>Coding standard using vanilla PSR.</description>

  <file>src/FileToTest.php</file>
  <file>tests/*.php</file>
  <file>tests/**/*.php</file>

  <rule ref="<dir_to_ruleset>/vanilla-psr/ruleset.xml"/>
</ruleset>

如果你想从命令行使用标准,你可以使用以下命令:

vendor/bin/phpcs \
  --standard=vanilla-psr \
  --runtime-set installed_paths vendor/fuegas/vanilla-psr \
  tests

Grunt

如果你使用 Grunt 来自动化代码风格标准的检查,可以将以下选项设置为使用 vanilla-psr(假设你使用 Composer 安装了 vanilla-psr):

phpcs: {
  options: {
    standard: './vendor/fuegas/vanilla-psr/vanilla-psr/ruleset.xml',
  }
}

变更日志

下一个

1.2.0

  • 修复标准路径以便检测和包含

1.1

  • 修复方法和方法的多行声明,可以使用2个空格缩进
  • 修复多行调用,可以使用2个空格缩进

1.0

  • 基于PSR-2的基本规则集
  • 允许使用2个空格缩进而不是4个空格