Hướng dẫn phpcs auto fix
Nếu bạn muốn gặp các vấn đề với code convention và loay hoay tìm một công cụ nào đó hiệu quả giúp bạn tự động kiểm tra, auto fix các lỗi đó, thì bạn hãy ...... lên Google để tìm kiếm giải pháp. Bài viết sau cũng là một gợi ý =)) Show PHP CodeSniffer
Cài đặtCó rất nhiều cách cài đặt PHPCS, bạn có thể sử dụng 1 số cách sau: Globally (manual)Cách đơn giản nhất để bắt đầu với
Globally (composer)Cài đặt qua Composer, bạn có thể cài dưới dạng global (system-wide)
Sau đó hãy chắc chắn rằng thư mục
bin của composer đã trong PATH của bạn. Giá trị mặc định của thư mục này là
Mình dùng
Thêm dòng này vào nha:
Sau đó kiểm tra lại
bằng
LocallyNếu chỉ cần cài cho project, bạn có thể install trong phạm vi project
Hoặc cập nhật file
Lúc này bạn đã có thể chạy phpcs dựa trên đường dẫn vendor trong project
Sử dụngĐể sử dụng, khá đơn giản, sử dụng lệnh
Một vài tùy chọn khá hữu ích bạn nên thêm trong quá trình sử dụng
Nếu bạn không muốn hiển thị các warning
Và bạn nên sử dụng như vậy
Và fix lỗi convention
ConfigBạn hoàn toàn cấu hình các chuẩn kiểm tra code mà bạn muốn, như sử dụng tab hay space, check các thư muc nào, ignore những file nào, chuẩn nào. Sau khi setting PHPCS, mặc định nó sẽ sử dụng điều kiện PEAR, chuẩn này đã cũ, bạn có thể thay đổi điều này bằng cách sử dụng các standard của công ty Framgia hoặc PRS2
Cách thay đổi config như vậy KHÔNG KHUYẾN KHÍCH, thay vào đó bạn nên setup Cài đặt Framgia PHP StandardsCác tiêu chuẩn check code của PHPCS được đặt trong thư mục
Sử dụng:
Khá đơn giản nhỉ Tích hợp PHPCS vào Sublime text 3Công việc tiếp theo là bạn nên tích hợp việc check cú pháp này trực tiếp vào các editor để tự động phát hiện lỗi, thay vì cột 1 mạch và lại chạy lệnh Bạn cần cài 2 package trong Subime Text để được hỗ trợ việc này
Khởi động lại Sublime Text luôn để tận hưởng chức năng siêu mới này nhé :v (khởi động bằng lệnh mới được ý @@)
Tích hợp PHPCS vào PHPStormĐể tích hợp check phpcs và các tiêu chuẩn vào PHPStorm, bạn cài đặt theo đường dẫn. FIle => Setting => Editor => Inspections => PHP => PHP Code sniffer validation (Có thể ở trong Quality tools) Sau đó bạn lựa chọn các cài đặt, hiển thị lỗi ở mức warning hay error và chọn Coding standard PHP Coding Standards FixerThe PHP Coding Standards Fixer (PHP CS Fixer) là một công cụ sửa code của bạn theo các chuẩn, cho dù bạn tuân theo các tiêu chuẩn mã hóa PHP được định nghĩa trong PSR-1, PSR-2, v.v. hay các tiêu chuẩn do cộng đồng khác như Symfony. Bạn cũng có thể xác định các style cho team của mình thông qua các cấu hình Cài đặtLocallySiêu đơn giản, tải cái file php-cs-fixer.phar về rồi chạy luôn Globally (manual)Đầu tiên bạn tải nó về
Vẫn là tải nhưng xác định thêm version
Cũng là tải nhưng dùng lệnh khác
Then:
End, xong rồi đó, test thôi Globally (Composer)Đầu tiên bạn cũng tải nó dưới dạng global
Thêm vào PATH như phpcs
Xong! Sử dụngKhông khác
See usage, list of built-in rules, list of rule sets and configuration file documentation for more details. If you need to apply code styles that are not supported by the tool, you can create custom rules Tích hợp vào Sublime Text 3
Sử dụngSau khi đã cài thành công rồi, mỗi lần file bạn bị lỗi, bạn sử dụng như sau: Ctrl + Shift + P và Tìm kiếm PHP CS Fixer. Thậm chí bạn có thể nhìn thấy tổ hợp phím tắt của nó không, ấn luôn nếu bạn đang ở file lỗi đó cho ngầu như quả bầu (trường hợp này là Ctrl + Alt + F)OK, cool ngầu nào (JS có Prettier thì phải :3) |