PHPCS configuration

File PHPCS config mẫu

Thư mục config phpcs nằm ở thư mục root dự án, tên là .phpcs.xml, phpcs.xml, .phpcs.xml.dist, phpcs.xml.dist

Note: If multiple default configuration files are found, PHP_CodeSniffer will select one using the following order: .phpcs.xml, phpcs.xml, .phpcs.xml.dist, phpcs.xml.dist

File mẫu: https://raw.githubusercontent.com/squizlabs/PHP_CodeSniffer/master/phpcs.xml.dist

<?xml version="1.0"?>
<ruleset name="Framgia Extended">
    <!-- Bước 1: Mô tả convention -->
    <description>Framgia Extended Coding Convention</description>

    <!-- Bước 2: Set các thông tin thêm cho convention thôi -->
    <arg name="tab-width" value="4"/>
    <arg name="encoding" value="UTF-8"/>
    <config name="ignore_warnings_on_exit" value="1"/>

    <!-- Bước 3:
         <file> Danh sách các file check convention
         Ex: Check both app/ and config/ and resources/lang 
     -->
    <file>./app</file>
    <file>./config</file>
    <file>./resources/lang</file>

	<!-- Bước 4: (tùy chọn, có thể có hoặc không)
		<exclude-pattern>: Loại bỏ các định dạng file không chạy PHPCS
	-->
    <exclude-pattern>*/src/Standards/*/Tests/*\.(inc|css|js)$</exclude-pattern>
    <exclude-pattern>*/tests/Core/*/*Test\.(inc|css|js)$</exclude-pattern>
    
    <!-- Bước 5: Dùng rule nào để kiểm tra convention, nó sẽ có các chuẩn PEAR, PSR1, PSR2, Framgia -->
    <rule ref="Framgia"/>

    <!-- Bước 6: Tùy chọn, có thể có hoặc không?
         Đoạn sau này sẽ là custom lại các biến nhé. 
         Ví dụ tag là 4 space, mình không thích và muốn chuyển về 2 chẳng hạn
         Chi tiết các tham số trong property https://github.com/squizlabs/PHP_CodeSniffer/wiki/Customisable-Sniff-Properties#psr12operatorsoperatorspacing 
    -->
    <rule ref="Squiz.WhiteSpace.SuperfluousWhitespace">
        <properties>
            <!-- Force checking whitespace on blank lines -->
            <property name="ignoreBlankLines" value="false" />
        </properties>
    </rule>
    <!-- Check space between operator +-*/ -->
    <rule ref="Squiz.WhiteSpace.OperatorSpacing">
        <properties>
            <property name="ignoreNewlines" value="true" />
        </properties>
    </rule>
    <!-- Line between class method -->
    <!-- Đoạn code sau có ý nghĩa là: với rule FunctionSpacing, thì `space` là 1, không có `space` nào sau và trước hàm (giá trị mặc định là bao nhiêu méo biết) -->
    <rule ref="Squiz.WhiteSpace.FunctionSpacing">
        <properties>
            <property name="spacing" value="1" />
            <property name="spacingAfterLast" value="0" />
            <property name="spacingBeforeFirst" value="0" />
        </properties>
    </rule>
    <!-- Space after type cast, e.g. (string) $response -->
    <rule ref="Generic.Formatting.SpaceAfterCast" />
</ruleset>

Hãy hiểu property là thay đổi các biến mặc định trong rule đó, nếu bạn muốn chỉnh sửa. Ví dụ trường hợp gần cuối, spacing mặc định có thể đang là 2, mình custom lại 1 :D

Ngoài ra trong từng rule bạn cũng có thể tuỳ chỉnh check những file nào

<rule ref="Generic.PHP.CharacterBeforePHPOpeningTag">
    <exclude-pattern>*.phtml</exclude-pattern>
</rule>

Hoặc có thể comment disable một fule trong chính file PHP

<?php
/**
 * File description
 *
 * @tags
 * @phpcs:disable Standard.Cat.SniffName
 */

Hoặc comment theo hàm

// phpcs:disable Generic.Metrics.CyclomaticComplexity
protected function a()
{
}

Ref: https://github.com/squizlabs/PHP_CodeSniffer/issues/1179#issuecomment-446988725

Docs

• https://github.com/squizlabs/PHP_CodeSniffer/wiki/Customisable-Sniff-Properties (đọc chỗ Pages (13) ấy, chắc có nhiều thứ bạn cần).
• Ngoài ra nó còn có hướng dẫn kiểm tra PHPCS trước mỗi lần commit với Git (PreCommit Githooks). Hãy xem xét nếu dự án của bạn cần nhé:
  https://medium.com/@setkyarwalar/setting-up-phpcs-on-laravel-908bccb82db