Hướng dẫn friendsofphp/php-cs-fixer - friendsofphp / php-cs-fixer
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 7 là download các file Phar và chạy trưc tiếp
Globally (composer)Cài đặt qua Composer, bạn có thể cài dưới dạng global (system-wide)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à 8, nhưng bạn có thể check giá trị bạn cần sử dụng bằng lệnh:
Mình dùng 1 nên sẽ thêm vào file 2
Thêm dòng này vào nha:
Sau đó kiểm tra lại bằng 3 ra xem đã có chưa:
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 4 của bạn
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 5 kết hợp file, thư mục bạn muốn kiểm tra:
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 0Nếu bạn không muốn hiển thị các warning 1Và bạn nên sử dụng như vậy 2Và fix lỗi convention 3ConfigBạ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 4Cách thay đổi config như vậy KHÔNG KHUYẾN KHÍCH, thay vào đó bạn nên setup 5 cho từng project của bạn, sử dụng các file 7.KHÔNG KHUYẾN KHÍCH, thay vào đó bạn nên setup 5 cho từng project của bạn, sử dụng các file 7.Cài đặt Framgia PHP StandardsCác tiêu chuẩn check code của PHPCS được đặt trong thư mục 8. Vì vậy nếu bạn muốn thêm 1 tiêu chuẩn check code, bạn chỉ cần clone nó vào thư mục này: 5Sử dụng: 6Khá đơ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 5 =))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 ý @@)(khởi động bằng lệnh mới được ý @@) 7Tí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 standardwarning 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 đặtLocallyNếu chỉ cần cài cho project, bạn có thể install trong phạm vi project Globally (manual)Cách đơn giản nhất để bắt đầu với 7 là download các file Phar và chạy trưc tiếp 8Globally (composer) 9Cài đặt qua Composer, bạn có thể cài dưới dạng global (system-wide) 0Then: 1Sau đó 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à 8, nhưng bạn có thể check giá trị bạn cần sử dụng bằng lệnh:Đối với bash thì file đó là .bashrc ở thư mục home từ là composer global config bin-dir --absolute 9, với zsh là file vi .zshrc 0Mình dùng 1 nên sẽ thêm vào file 2 2Thêm dòng này vào nha: 3Xong! Sử dụngĐể sử dụng, khá đơn giản, sử dụng lệnh 5 kết hợp file, thư mục bạn muốn kiểm tra: 4Mộ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
Sử dụngĐể sử dụng, khá đơn giản, sử dụng lệnh 5 kết hợp file, thư mục bạn muốn kiểm tra: (trường hợp này là Ctrl + Alt + F)
OK, cool ngầu nào (JS có Prettier thì phải :3) |