Integrate PHP Code Sniffer with PHPStorm

Code cần phải có chuẩn, và PHP cũng không ngoại lệ, có các chuẩn PSR mà bạn phải follow. Để thuận tiện cho việc kiểm tra code đã follow đúng chuẩn chưa, bộ công cụ PHP Code Sniffer đã ra đời. Mình sẽ hướng dẫn các bạn integrate PHP Code Sniffer với PHPStorm. Ngoài việc dùng PHPStorm thì các bạn có thể integrate bộ công cụ này với bất kì IDE nào, hoặc thậm chí chạy độc lập trên command line cũng được nữa.

Download PHP Code Sniffer

Trước tiên là down cháu này về, dùng Pear, Pyrus hay download manually cũng được sất.

http://pear.php.net/package/PHP_CodeSniffer/download

Âu cơ, lấy về giải nén ra, được thư mục dạng PHP_CodeSniffer-2.2.0 - nhớ cất ở đâu đó cho dễ nhớ, lần sau khỏi lấy lại hấy.

Browse to file phpcs

Trong PHPStorm, mò vào File -> Setting và tìm đến Code Sniffer và browse tới file phpcs như sau
brower codesniffer

Sau đó nhấn Validate, nếu hiện lên thông báo xanh lè success là được.

Usage

Trong PHPStorm, mò vào Code -> Inspect Code... và cấu hình Inspection profile như sau:
PHP code sniffer validation

Ở đây mình chọn chuẩn format Coding standard của mình là PSR2, các bạn có thể chọn chuẩn khác tùy theo yêu cầu của Project hoặc framework mà bạn đang làm việc.
Âu cơ, bây giờ mỗi khi bạn code, nếu code của bạn không validate chuẩn, phpcs sẽ ngay lập tức detect và thông báo
phpcs notify

Lỗi trên là theo chuẩn PSR2, cuối file phải có 1 new line, các bạn chỉ cần enter thêm 1 line nữa là ok.
Chúc các bạn code tốt và đúng chuẩn. Thân