Phpc không tìm thấy

PHP_CodeSniffer (PHPCS) là một công cụ xác thực mã của bạn dựa trên một bộ tiêu chuẩn được xác định trước và đảm bảo rằng các tiêu chuẩn đó được duy trì trong nhóm. Hướng dẫn này sẽ hướng dẫn bạn cách tự động hóa các xác thực đó trong quá trình phát triển bằng cách thiết lập PHPCS trên Sublime Text, Visual Studio Code và PHPStorm

Ghi chú. Dự án mẫu đi kèm có sẵn tại https. //github. com/idoqo/twilio-chào mừng. Bạn cũng có thể tải xuống phpc. xml để sử dụng trong dự án hiện tại của bạn

điều kiện tiên quyết

Hoàn thành hướng dẫn này yêu cầu các điều kiện tiên quyết sau

• Trình soạn nhạc đã cài đặt
• Đã cài đặt Sublime Text, VS Code hoặc PHPStorm

Cài đặt Trình đánh hơi mã PHP

Tất cả các trình chỉnh sửa bên dưới đều yêu cầu cài đặt sẵn PHPCS và vì chúng tôi dự định sử dụng nó trên các dự án nên chúng tôi sẽ cài đặt nó trên toàn cầu bằng lệnh sau

$ composer global require "squizlabs/php_codesniffer=*"

Bạn có thể kiểm tra cài đặt của mình với

$ phpcs

Ghi chú. Nếu bạn gặp lỗi tương tự như command not found, hãy đảm bảo rằng bạn đã đặt thư mục Composer bin trong PATH của mình (thường là $HOME/.config/composer/vendor/bin cho Linux và $HOME/.composer/vendor/bin cho MacOS)

Thiết lập PHPCS với Sublime Text

Kho lưu trữ gói Sublime Text có hai plugin có thể được sử dụng để giao tiếp với PHPCS. SublimeLinter-phpcs và Phpcs. Chúng tôi sẽ sử dụng plugin Phpcs độc lập vì nó cung cấp nhiều tùy chọn cấu hình hơn

Khởi chạy điều khiển gói bằng (Shift+Ctrl+P hoặc Shift+Cmd+P). Chọn “Kiểm soát gói. Cài đặt gói” từ menu bật lên và tìm kiếm “Phpc”. Kết quả hàng đầu là những gì chúng tôi đang tìm kiếm như trong hình bên dưới

Tiếp theo, chúng ta sẽ thiết lập tệp cấu hình gói bằng cách vào Tùy chọn > Cài đặt gói > Cài đặt - Người dùng từ Thanh Menu, dán khối mã bên dưới vào phpcs mới tạo. sublime-settings và lưu nó

{  
   // full path to our phpcs binary,   
   // replace "YOUR_HOME_DIRECTORY" with the path to your home folder  
   "phpcs_php_path": "/home/idoko/.config/composer/vendor/bin/phpcs",  
  
   // run phpcs on every PHP file after we save it.  
   // you can ignore folders by excluding them in the phpcs.xml config file  
   "phpcs_execute_on_save": true,  
  
   // mark lines that have violated the rules  
   "phpcs_show_gutter_marks": true,  
  
   // ignore blade templates, you can add more file extensions in the array  
   // Do not execute for twig files  
    "extensions_to_blacklist": ["blade.php"],  
  
   // you can even pass additional arguments to phpcs  
    "phpcs_additional_args": {  
        "-n": ""  
    },  
}

Để có danh sách đầy đủ tất cả các tùy chọn cấu hình có thể, bạn có thể tra cứu các cài đặt ví dụ trong mã nguồn plugin

Lần tới khi bạn sửa đổi tệp PHP và lưu, PHPCS sẽ tự động chạy và báo cáo mọi vi phạm xảy ra trong menu bật lên

Thiết lập PHPCS với Visual Studio Code

Sử dụng PHPCS trên Mã VS tương đối dễ dàng vì plugin vscode-phpcs thực hiện rất nhiều công việc nặng nhọc cho chúng tôi. Để cài đặt plugin

• Mở hộp thoại Quick Open trên VS Code (bằng Ctrl+P hoặc Cmd+P)
• Nhập “ext install phpc” để tìm tiện ích mở rộng và
• Nhấp vào biểu tượng đám mây để cài đặt

Sau khi cài đặt, hãy khởi động lại Mã VS và plugin sẽ tự động tìm kiếm đường dẫn tổng hợp toàn cầu của bạn để cài đặt PHPCS. Lưu ý rằng nó cũng tìm kiếm gốc dự án của bạn để tìm các bộ quy tắc hiện có (đó là mục đích của tệp phpcs.xml trong dự án mẫu của chúng tôi)

Bây giờ, hãy mở một tệp PHP mà bạn muốn đánh hơi. Các đường màu đỏ sẽ xuất hiện ở tất cả các vị trí vi phạm như hình bên dưới

Thiết lập PHPCS với PHPStorm

PHPStorm vốn hỗ trợ kiểm tra mã với PHP_CodeSniffer, mặc dù việc định cấu hình nó khá khó khăn

Đầu tiên, khởi chạy hộp thoại Cài đặt (Ctrl+Alt+S) và điều hướng đến Ngôn ngữ và Khung > PHP > Công cụ Chất lượng. Mở rộng Trình đánh hơi mã PHP trên trang Công cụ chất lượng và chọn Cục bộ từ menu thả xuống Cấu hình. Nhấp vào “nút ba chấm” bên cạnh danh sách thả xuống được đánh dấu bên dưới

Chỉ định đường dẫn đầy đủ của tệp thực thi PHPCS trong hộp thoại mới mở ra (là

$ phpcs

Bây giờ, bạn sẽ thấy một lỗi khác trên trang Công cụ chất lượng cho bạn biết rằng kiểm tra CodeSniffer chưa được bật

Kiểm tra mã là cách PHPStorm phát hiện (và sửa) các vấn đề như mã chết, lỗi chính tả và tất nhiên là vi phạm kiểu mã trong dự án của bạn

Trong hộp thoại Cài đặt, đi tới Trình chỉnh sửa > Kiểm tra. Từ màn hình kiểm tra, mở rộng PHP. Nút công cụ chất lượng và kích hoạt “xác thực PHP CodeSniffer”

Trong ngăn cấu hình hiện đã được bật, hãy chọn “Tùy chỉnh” từ trình đơn thả xuống “Tiêu chuẩn mã hóa”, tìm cấu hình bộ quy tắc (phpcs.xml trong thư mục dự án của chúng tôi) và áp dụng các thay đổi của bạn

Bằng cách này, chúng tôi có thể chỉ định tùy chọn của mình trong tệp phpcs.xml và áp dụng nó trong dự án của chúng tôi (bất kể công cụ chúng tôi đang sử dụng). Mã của chúng tôi hiện đang tự động được kiểm tra theo tiêu chuẩn ưu tiên của chúng tôi và các lỗi bắt nguồn từ PHPCS sẽ có tiền tố là

$ phpcs

Phần kết luận

PHP Code Sniffer giúp đạt được tính đồng nhất của các kiểu mã và để trình soạn thảo của bạn tự động kiểm tra các vi phạm sẽ góp phần cải thiện chất lượng cơ sở mã của bạn một cách lâu dài

Tôi hy vọng bạn thích bài đăng này và nếu có vấn đề hoặc câu hỏi nào, vui lòng liên hệ với tôi qua Email hoặc trên Github

Phpc tọa lạc ở đâu?

Làm thế nào để cài đặt các tiêu chuẩn PHPCS?

Làm thế nào để sử dụng Phpc?

Phpc XML ở đâu?