Phpc SublimeLinter

Các lệnh PHPCS trên máy cục bộ đang chạy Windows có thể yêu cầu định dạng khác với các ví dụ về lệnh được hiển thị bên dưới

Cài đặt trên toàn cầu

  1. Chạy lệnh dưới đây trong một thiết bị đầu cuối. Lệnh này có thể được chạy để cập nhật cài đặt toàn cầu hiện có. Đầu ra chi tiết trong thiết bị đầu cuối sẽ cho biết những gì đang được cài đặt (hoặc cập nhật)
composer g require --dev automattic/vipwpcs dealerdirect/phpcodesniffer-composer-installer -W
  1. Lệnh
    composer g require --dev automattic/vipwpcs dealerdirect/phpcodesniffer-composer-installer -W
    1 bây giờ sẽ nằm trong PATH của máy cục bộ
$ ls ~/.composer/vendor/bin
phpcbf	phpcs
  1. Kiểm tra PHPCS để đảm bảo nó được cập nhật
$ phpcs --version
PHP_CodeSniffer version 3.7.1 (stable) by Squiz (http://www.squiz.net)

Xử lý sự cố

Nếu lệnh

composer g require --dev automattic/vipwpcs dealerdirect/phpcodesniffer-composer-installer -W
1 không hoạt động, thư mục bin Trình soạn thảo trên máy cục bộ sẽ cần được thêm vào biến môi trường PATH. Trên hầu hết các hệ điều hành, các tệp
composer g require --dev automattic/vipwpcs dealerdirect/phpcodesniffer-composer-installer -W
3 và
composer g require --dev automattic/vipwpcs dealerdirect/phpcodesniffer-composer-installer -W
1 nằm trong thư mục
composer g require --dev automattic/vipwpcs dealerdirect/phpcodesniffer-composer-installer -W
5. Trên máy cục bộ chạy Linux, đường dẫn tệp có thể là
composer g require --dev automattic/vipwpcs dealerdirect/phpcodesniffer-composer-installer -W
6. Xác minh vị trí của tệp
composer g require --dev automattic/vipwpcs dealerdirect/phpcodesniffer-composer-installer -W
3 và
composer g require --dev automattic/vipwpcs dealerdirect/phpcodesniffer-composer-installer -W
1 trên máy cục bộ của người dùng và sửa đổi đường dẫn tệp nếu cần khi làm theo hướng dẫn bên dưới

  1. Chỉnh sửa cấu hình shell (e. g.
    composer g require --dev automattic/vipwpcs dealerdirect/phpcodesniffer-composer-installer -W
    9,
    $ ls ~/.composer/vendor/bin
    phpcbf	phpcs
    0,
    $ ls ~/.composer/vendor/bin
    phpcbf	phpcs
    1) và thêm biến môi trường PATH.
    Cú pháp (và tệp thực tế mà trình bao tải khi khởi động) sẽ khác nhau tùy thuộc vào trình bao được sử dụng.
    Ví dụ: trong
    composer g require --dev automattic/vipwpcs dealerdirect/phpcodesniffer-composer-installer -W
    9, hãy thêm đoạn mã sau vào cuối tệp.

composer g require --dev automattic/vipwpcs dealerdirect/phpcodesniffer-composer-installer -W
5 Bản saoĐã sao chép

  1. Sau khi thêm và lưu biến môi trường PATH vào cấu hình trình bao
    • Mở một cửa sổ Terminal mới
    • hoặc nguồn cấu hình shell trong cửa sổ Terminal hiện có bằng cách chạy.
      $ ls ~/.composer/vendor/bin
      phpcbf	phpcs
      3
  1. Chạy lại lệnh
    composer g require --dev automattic/vipwpcs dealerdirect/phpcodesniffer-composer-installer -W
    1

Cài đặt ở cấp dự án

cân nhắc

  • Các ứng dụng VIP được tạo sau tháng 1 năm 2022 đã chứa các tệp
    $ ls ~/.composer/vendor/bin
    phpcbf	phpcs
    5 và
    $ ls ~/.composer/vendor/bin
    phpcbf	phpcs
    6. Đối với những ứng dụng đó, có thể làm theo hướng dẫn cài đặt này thay vì hướng dẫn bên dưới
  • Tiêu chuẩn mã hóa VIP hiện tại (VIPCS) 2. x yêu cầu tối thiểu WordPress-Coding-Standards (WPCS) 2. x. Xem README để biết phiên bản tối thiểu chính xác

Các bước để cài đặt

Trong thiết bị đầu cuối của máy cục bộ

  1. Điều hướng (
    $ ls ~/.composer/vendor/bin
    phpcbf	phpcs
    7) đến thư mục gốc của dự án
  2. Chạy lệnh sau để thêm hoặc cập nhật các tệp
    $ ls ~/.composer/vendor/bin
    phpcbf	phpcs
    6 và
    $ ls ~/.composer/vendor/bin
    phpcbf	phpcs
    9 và thư mục
    $ phpcs --version
    PHP_CodeSniffer version 3.7.1 (stable) by Squiz (http://www.squiz.net)
    0 (có thể bỏ qua thư mục
    $ phpcs --version
    PHP_CodeSniffer version 3.7.1 (stable) by Squiz (http://www.squiz.net)
    0 tùy chọn trong kiểm soát phiên bản)
$ ls ~/.composer/vendor/bin
phpcbf	phpcs
5

Khi PHPCS được cài đặt cục bộ (ở cấp dự án), cần phải định dạng các lệnh hiển thị bên dưới tham chiếu trực tiếp đến tệp thực thi tại

$ phpcs --version
PHP_CodeSniffer version 3.7.1 (stable) by Squiz (http://www.squiz.net)
2 instead of
composer g require --dev automattic/vipwpcs dealerdirect/phpcodesniffer-composer-installer -W
1.

Ví dụ, lệnh này

$ ls ~/.composer/vendor/bin
phpcbf	phpcs
8

thay vào đó nên được định dạng là

$ ls ~/.composer/vendor/bin
phpcbf	phpcs
9

Tiêu chuẩn cài đặt

Sự hiện diện của gói plugin

$ phpcs --version
PHP_CodeSniffer version 3.7.1 (stable) by Squiz (http://www.squiz.net)
4 Composer tự động đăng ký các tiêu chuẩn với PHPCS, vì vậy nhiệm vụ này không cần phải thực hiện riêng. Để bổ sung thêm các tiêu chuẩn sau này, gói này cũng có thể đăng ký các tiêu chuẩn mới

Có thể trả về danh sách các tiêu chuẩn đã cài đặt bằng cách chạy lệnh

$ phpcs --version
PHP_CodeSniffer version 3.7.1 (stable) by Squiz (http://www.squiz.net)
5. Sau khi làm theo các bước cài đặt ở trên, các tiêu chuẩn được trả về phải khớp với ví dụ này

$ phpcs --version
PHP_CodeSniffer version 3.7.1 (stable) by Squiz (http://www.squiz.net)
2

Tiêu chuẩn

$ phpcs --version
PHP_CodeSniffer version 3.7.1 (stable) by Squiz (http://www.squiz.net)
6 không được xuất hiện trong danh sách trả về. Tiêu chuẩn này không còn được dùng nữa, không được sử dụng trong phiên bản VIPCS mới nhất và đã bị xóa hoàn toàn khỏi WPCS 2. x

Chạy PHPCS dựa trên mã

Ví dụ về lệnh sau đặt tiêu chuẩn thích hợp (

$ phpcs --version
PHP_CodeSniffer version 3.7.1 (stable) by Squiz (http://www.squiz.net)
7), yêu cầu PHPCS hiển thị mã vi phạm đối với bất kỳ vi phạm nào (
$ phpcs --version
PHP_CodeSniffer version 3.7.1 (stable) by Squiz (http://www.squiz.net)
8), hiển thị thanh tiến trình (
$ phpcs --version
PHP_CodeSniffer version 3.7.1 (stable) by Squiz (http://www.squiz.net)
9), cắt đường dẫn tệp xuống tương đối từ thư mục hiện tại (
composer g require --dev automattic/vipwpcs dealerdirect/phpcodesniffer-composer-installer -W
50),

$ phpcs --version
PHP_CodeSniffer version 3.7.1 (stable) by Squiz (http://www.squiz.net)
9

Đầu ra lệnh cũng có thể được giới hạn chỉ xuất ra các lỗi và cảnh báo về mức độ nghiêm trọng

composer g require --dev automattic/vipwpcs dealerdirect/phpcodesniffer-composer-installer -W
52 trở lên và định dạng đầu ra thành các cột

composer g require --dev automattic/vipwpcs dealerdirect/phpcodesniffer-composer-installer -W
0

Hướng dẫn bổ sung về Diễn giải báo cáo PHPCS hiện có và hướng dẫn thêm về cách sử dụng PHPCS có thể được tìm thấy trong PHPCS wiki

Tích hợp PHPCS vào trình soạn thảo mã hoặc IDE

VIP khuyên bạn nên tích hợp PHPCS bên trong trình chỉnh sửa mã hoặc IDE để nhận phản hồi PHPCS theo thời gian thực trong quá trình phát triển.
Tài liệu tích hợp PHPCS trong một số trình soạn thảo phổ biến.

Mã VS

Nhiều plugin có sẵn

PHPStorm

https. //www. phản lực. com/help/phpstorm/2019. 1/sử dụng-php-code-sniffer. html

Văn bản tuyệt vời

https. //github. com/benmatselby/sublime-phpcs
https. //github. com/SublimeLinter/SublimeLinter-phpcs

trình chỉnh sửa nguyên tử

https. // nguyên tử. io/gói/linter-phpcs
https. //github. com/bpearson/atom-phpcs

Cũng có thể chạy PHP CodeSniffer trong quy trình xây dựng Tích hợp liên tục (e. g. thông qua Travis hoặc Circle CI), cho phép báo cáo sự cố đối với bất kỳ yêu cầu kéo nào và gửi báo cáo sự cố qua email và các kênh khác