Làm cách nào để sử dụng Phpc trong Sublime?

Đây là phần tiếp theo của bài viết gần đây của tôi về Các Plugin Essential Sublime Text 3 dành cho Nhà phát triển PHP để giải thích cách cài đặt và định cấu hình Sublime-phpcs cho tiêu chuẩn mã CakePHP. Mặc dù tôi đang mô tả cách định cấu hình phpcs cụ thể cho Cake nhưng hy vọng nó sẽ hữu ích cho bất kỳ ai muốn bắt đầu với phpcs trong Sublime Text và bắt đầu phát triển mã tốt hơn

Tôi sẽ cho rằng bạn đã quen thuộc với Composer và đã cài đặt nó

Tại sao nên sử dụng Trình đánh hơi mã

Trình thám thính mã kiểm tra mã của bạn dựa trên tiêu chuẩn mã hóa được xác định trước. Có rất nhiều tiêu chuẩn viết mã như PSR-2, Zend và CakePHP PSR. Sử dụng một tiêu chuẩn mã hóa và trình thám thính mã có thể giúp đạt được những điều sau. -

  • Tính nhất quán trong mã, do đó làm giảm phiền nhiễu
  • Cảnh báo chống lại lỗi tiềm ẩn dẫn đến lỗi chính tả
  • Mã dễ bảo trì hơn
  • Giảm xung đột hợp nhất kiểm soát phiên bản
  • Nói chung có thể giúp bạn viết mã tốt hơn

Cài đặt CakePHP Code Sniffer

Vậy hãy bắt đầu. Trước tiên, chúng ta cần cài đặt trình thám thính cho CakePHP PSR bằng Trình soạn thảo

Đối với CakePHP 3. -

composer global require --dev cakephp/cakephp-codesniffer:2.*

CakePHP 3 sử dụng bộ quy tắc tương thích PSR-2, nhưng có một số quy tắc bổ sung cho tài liệu và quy ước đặt tên

Đối với CakePHP 2. -

composer global require --dev cakephp/cakephp-codesniffer:1.*

Trình thám thính cho CakePHP 2 sử dụng phiên bản cũ hơn của phpcs;

Sau khi cài đặt cakephp-codesniffer thông qua Composer, phpcs cũng phải được cài đặt vì đây là yêu cầu của trình dò ​​tìm mã CakePHP. Bạn sẽ tìm thấy nó trong thư mục trình soạn thảo (toàn cầu) của mình trong nhà cung cấp/bin (người dùng CakePHP 2 có thể sẽ phải tìm trong nhà cung cấp/squizlabs/php_codesniffer/scripts để biết tệp thực thi); . -

~/.composer/vendor/bin/phpcs -i

Điều này sẽ trả về tất cả các tiêu chuẩn mã hóa đã cài đặt mà phpc hiện được định cấu hình cho. -

The installed coding standards are MySource, PEAR, PHPCS, PSR1, PSR2, Squiz and Zend

Bạn sẽ nhận thấy rằng CakePHP không được liệt kê là một trong những tiêu chuẩn mã hóa mặc dù mới cài đặt nó. Chúng ta cần cho phpc biết về mã CakePHP mới (đảm bảo bạn cập nhật đường dẫn đến cakephp-codesniffer đến vị trí của nó trên máy của chính bạn). -

~/.composer/vendor/bin/phpcs --config-set \
installed_paths ~/.composer/vendor/cakephp/cakephp-codesniffer

Chạy lại

composer global require --dev cakephp/cakephp-codesniffer:1.*
3 sẽ hiển thị CakePHP là một trong những tiêu chuẩn mã hóa có sẵn

Cài đặt phpc

Nếu bạn vừa làm theo hướng dẫn cài đặt cho trình dò ​​tìm mã CakePHP thì bạn đã cài đặt phpc và có thể chuyển sang phần tiếp theo. Mặt khác, một trong những cách dễ nhất để cài đặt phpc là thông qua Composer. -

composer global require squizlabs/php_codesniffer=*

Cài đặt gói văn bản tuyệt vời của phpcs

Sử dụng Kiểm soát gói trong Sublime Text tìm kiếm phpcs và cài đặt nó. Nếu bạn chưa cài đặt Kiểm soát gói, hãy cài đặt nó trước. Đó là một trong những gói Sublime Text thiết yếu của tôi và giúp cài đặt các gói khác cực kỳ đơn giản

Sau khi cài đặt gói phpcs Sublime Text, việc tiếp theo cần làm là cấu hình nó…

Cấu hình phpc trong Sublime Text

Trong Sublime Text, mở các tùy chọn mặc định cho PHP Code Sniffer và sao chép chúng vào PHP Code Sniffer User Preferences. Chúng tôi sẽ chỉnh sửa tùy chọn người dùng cho gói và giữ các giá trị mặc định làm bản sao lưu/tham chiếu

Điều đầu tiên chúng ta cần làm là báo cho Sublime-phpcs biết PHP Code Sniffer ở đâu trên máy tính của chúng ta. -

________số 8

Đây cần phải là đường dẫn tuyệt đối đầy đủ đến tệp thực thi phpc. Nếu bạn đã sử dụng một phương pháp khác để cài đặt phpcs, người dùng OSX và Linux có thể sử dụng

composer global require --dev cakephp/cakephp-codesniffer:1.*
5 để thử và xác định vị trí của nó trên hệ thống của bạn

Chúng tôi muốn đặt tiêu chuẩn mã của mình để đánh hơi CakePHP (hoặc bất kỳ tiêu chuẩn nào bạn đang sử dụng). -

composer global require --dev cakephp/cakephp-codesniffer:1.*
0

Nếu bây giờ bạn vào và chỉnh sửa tệp PHP, bạn sẽ thấy phpcs chạy khi bạn lưu với bảng điều khiển nhanh bật lên với bất kỳ lỗi nào được tìm thấy. Ý tưởng của việc này là giúp bạn điều hướng đến các lỗi để bạn có thể sửa chúng. Điều này có thể thực sự hữu ích hoặc chỉ gây phiền toái, Bạn có thể tắt nó bằng cài đặt này. -

composer global require --dev cakephp/cakephp-codesniffer:1.*
1

Nếu bị tắt, các lỗi vẫn sẽ được đánh dấu trong tệp và nhấp vào chúng sẽ hiển thị lỗi được báo cáo trên thanh trạng thái ở cuối cửa sổ

Nếu có vẻ như phpc không chạy thì có một cài đặt gỡ lỗi hữu ích cho gói mà bạn có thể bật. -

composer global require --dev cakephp/cakephp-codesniffer:1.*
2

Đặt điều này thành true và sau đó mở Bảng điều khiển văn bản tuyệt vời ('Hiển thị bảng điều khiển' trong menu 'Chế độ xem'). Hãy thử lưu tệp PHP và bạn sẽ thấy bất kỳ lỗi nào với gói được liệt kê. Có khả năng nó không thể tìm thấy tệp thực thi phpc

Thay đổi tiêu chuẩn mã hóa

Tôi có xu hướng làm việc với các tiêu chuẩn mã hóa khác nhau tùy thuộc vào dự án. Rõ ràng đối với mã CakePHP, tôi sử dụng tiêu chuẩn riêng của Cake, nhưng nếu đó là dự án Laravel, tôi sử dụng PSR-2 (được cài đặt sẵn với phpcs). Để thay đổi tiêu chuẩn, bạn có thể chỉnh sửa tùy chọn gói hoặc sử dụng 'PHP Code Sniffer > Switch coding standard' bằng cách nhấp chuột phải vào tệp

Trình nói dối PHP

Ngoài việc kiểm tra các tiêu chuẩn mã hóa, việc kiểm tra lỗi cú pháp cũng rất hữu ích. Bạn có thể kích hoạt gói phpcs để cung cấp giao diện cho

composer global require --dev cakephp/cakephp-codesniffer:1.*
6. -

composer global require --dev cakephp/cakephp-codesniffer:1.*
0

Nếu bạn đang sử dụng gói linting như SublimeLinter, bạn có thể muốn tắt tính năng này

Trình phát hiện lộn xộn PHP

PHP Mess Detector (phpmd) kiểm tra mã nguồn của bạn để tìm các hàm/phương thức quá phức tạp;

Nếu bạn chưa cài đặt, bạn có thể tải xuống bằng Composer. -

composer global require --dev cakephp/cakephp-codesniffer:1.*
1

Sau đó, bạn sẽ cần cho Sublime Text biết tệp thực thi phpmd ở đâu (khá giống với những gì chúng tôi đã làm với phpcs). -

composer global require --dev cakephp/cakephp-codesniffer:1.*
2

Từ cuối cùng

Có rất nhiều giá trị trong việc sử dụng một tiêu chuẩn viết mã và việc sử dụng các phpc giúp việc gắn bó với một tiêu chuẩn dễ dàng hơn rất nhiều. Việc tích hợp nó với Sublime Text sẽ mất một vài bước, nhưng khi bạn đã thiết lập xong nó, bạn đang trên đường viết mã chất lượng tốt hơn

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

Trước tiên, hãy đảm bảo rằng bạn đã cài đặt đúng Coder và PHPCS bằng cách làm theo hướng dẫn cài đặt. .
Kiểm tra các tiêu chuẩn mã hóa Drupal. .
Kiểm tra các tiêu chuẩn mã hóa Drupal và bỏ qua trình soạn thảo và nút. thư mục js. .
Liệt kê các quy tắc tiêu chuẩn mã hóa Drupal được kích hoạt. .
Chỉ kiểm tra một quy tắc
Kiểm tra các phương pháp hay nhất của Drupal

Làm cách nào để cài đặt PHP CS Fixer trên Sublime Text?

Cài đặt plugin .
Trong Sublime Text, mở Command Palette và gõ install. Trong số các lệnh bạn sẽ thấy Kiểm soát gói. Cài đặt gói. .
Khi danh sách plugin xuất hiện, hãy nhập php-cs-fixer. Trong số các mục bạn sẽ thấy SublimeLinter-php-cs-fixer

Làm cách nào để thiết lập Phpc?

Cài đặt trình cắm .
Mở mã Visual Studio
Nhấn Ctrl+P trên Windows hoặc Cmd+P trên Mac để mở hộp thoại Mở nhanh
Gõ ext install phpc để tìm phần mở rộng
Nhấn Enter hoặc nhấp vào biểu tượng đám mây để cài đặt nó
Khởi động lại Visual Studio Code khi được nhắc

Làm cách nào để làm đẹp mã PHP trong Sublime?

Cách sử dụng. ctrl + shift + P và nhập Tidy PHP hoặc bạn có thể sử dụng tổ hợp phím ctrl + alt + T.