README

Corpus 编码标准为 PHP_CodeSniffer。

需求

dealerdirect/phpcodesniffer-composer-installer: *
squizlabs/php_codesniffer: *
slevomat/coding-standard: ^8.14
php: >=7.4

安装

使用以下命令安装最新版本

composer require --dev 'corpus/coding-standard'

嗅探器

类: \Corpus\Sniffs\ControlStructures\ClosingBraceNewlineSniff

嗅探器: Corpus.ControlStructures.ClosingBraceNewline

确保所有闭合花括号之后都跟着一个空行。

示例

if( $foo ) {
    echo $bar;
}
echo $baz;

变为

if( $foo ) {
    echo $bar;
}

echo $baz;

类: \Corpus\Sniffs\ControlStructures\OpeningOneTrueBraceSniff

嗅探器: Corpus.ControlStructures.OpeningOneTrueBrace

确保使用 K&R "一个真正的大括号" 风格。

示例

class Foo
{
    public function bar()
    {
        echo "bbq";
    }
}

变为

class Foo {
    public function bar() {
        echo "bbq";
    }
}

类: \Corpus\Sniffs\General\BinaryOperationNewlineSniff

嗅探器: Corpus.General.BinaryOperationNewline

确保在多行逻辑语句中 && 和 || 引导行而不是尾部。

示例

if(
    $foo &&
    $bar &&
    $baz
)}

变为

if(
    $foo
    && $bar
    && $baz
)}

类: \Corpus\Sniffs\General\ReturnTrailingNewlineSniff

嗅探器: Corpus.General.ReturnTrailingNewline

确保返回语句和后面的花括号之间没有空白行。

示例

if( $foo == true ){
    return 1;

}

变为

if( $foo == true ){
    return 1;
}

类: \Corpus\Sniffs\Methods\ClosureSpacingSniff

嗅探器: Corpus.Methods.ClosureSpacing

在闭包中强制在函数/fn 关键字和开括号之间留空白。

示例

$foo = function ( string $foo ) { echo $foo; };
$bar = fn ( int $bar ) => $bar + 1;

变为

$foo = function( string $foo ) { echo $foo; };
$bar = fn( int $bar ) => $bar + 1;

类: \Corpus\Sniffs\Methods\MethodParameterFormattingSniff

嗅探器: Corpus.Methods.MethodParameterFormatting

设置函数参数的最大长度。通过分成多行来修复。

示例

function Foo( ClosingBraceNewlineSniffTest $closingBraceNewlineSniffTest, OpeningOneTrueBraceSniffTest $openingOneTrueBraceSniffTest ) { }

变为

function Foo(
    ClosingBraceNewlineSniffTest $closingBraceNewlineSniffTest,
    OpeningOneTrueBraceSniffTest $openingOneTrueBraceSniffTest
) { }

<?php
namespace Corpus\Sniffs\Methods;

class MethodParameterFormattingSniff {
	/**
	 * Maximum line character length after which to break function arguments into newlines
	 */
	public $maxLength = 130;
}

corpus / coding-standard

维护者

详细信息