Làm cách nào để cài đặt Phpc trong Ubuntu?

PHP_CodeSniffer là một bộ gồm hai tập lệnh PHP; . PHP_CodeSniffer là một công cụ phát triển cần thiết để đảm bảo mã của bạn luôn rõ ràng và nhất quán

Yêu cầu

PHP_CodeSniffer yêu cầu phiên bản PHP 5. 4. 0 trở lên, mặc dù các lần đánh hơi riêng lẻ có thể có các yêu cầu bổ sung như các ứng dụng và tập lệnh bên ngoài. Xem trang hướng dẫn Tùy chọn cấu hình để biết danh sách các yêu cầu này

Nếu bạn đang sử dụng PHP_CodeSniffer như một phần của nhóm hoặc bạn đang chạy nó trên máy chủ CI, bạn có thể muốn định cấu hình cài đặt dự án của mình

Cài đặt

Cách dễ nhất để bắt đầu với PHP_CodeSniffer là tải xuống các tệp Phar cho từng lệnh

# Download using curl
curl -OL https://squizlabs.github.io/PHP_CodeSniffer/phpcs.phar
curl -OL https://squizlabs.github.io/PHP_CodeSniffer/phpcbf.phar

# Or download using wget
wget https://squizlabs.github.io/PHP_CodeSniffer/phpcs.phar
wget https://squizlabs.github.io/PHP_CodeSniffer/phpcbf.phar

# Then test the downloaded PHARs
php phpcs.phar -h
php phpcbf.phar -h

nhà soạn nhạc

Nếu bạn sử dụng Composer, bạn có thể cài đặt PHP_CodeSniffer trên toàn hệ thống bằng lệnh sau

composer global require "squizlabs/php_codesniffer=*"

Đảm bảo rằng bạn có thư mục bin của nhà soạn nhạc trong PATH của mình. Giá trị mặc định là

composer global require "squizlabs/php_codesniffer=*"
3, nhưng bạn có thể kiểm tra giá trị mà bạn cần sử dụng bằng cách chạy
composer global require "squizlabs/php_codesniffer=*"
4

Hoặc cách khác, bao gồm một phụ thuộc cho

composer global require "squizlabs/php_codesniffer=*"
5 trong tệp
composer global require "squizlabs/php_codesniffer=*"
6 của bạn. Ví dụ

________số 8

Sau đó, bạn sẽ có thể chạy PHP_CodeSniffer từ thư mục bin của nhà cung cấp

./vendor/bin/phpcs -h
./vendor/bin/phpcbf -h

phive

Nếu bạn sử dụng Phive, bạn có thể cài đặt PHP_CodeSniffer làm công cụ dự án bằng các lệnh sau

composer global require "squizlabs/php_codesniffer=*"
0

Sau đó, bạn sẽ có thể chạy PHP_CodeSniffer từ thư mục công cụ

composer global require "squizlabs/php_codesniffer=*"
1

QUẢ LÊ

Nếu bạn sử dụng PEAR, bạn có thể cài đặt PHP_CodeSniffer bằng trình cài đặt PEAR. Điều này sẽ làm cho các lệnh

composer global require "squizlabs/php_codesniffer=*"
1 và
composer global require "squizlabs/php_codesniffer=*"
2 có sẵn ngay lập tức để sử dụng. Để cài đặt PHP_CodeSniffer bằng trình cài đặt PEAR, trước tiên hãy đảm bảo bạn đã cài đặt PEAR rồi chạy lệnh sau

composer global require "squizlabs/php_codesniffer=*"
4

Bản sao Git

Bạn cũng có thể tải xuống nguồn PHP_CodeSniffer và chạy các lệnh

composer global require "squizlabs/php_codesniffer=*"
1 và
composer global require "squizlabs/php_codesniffer=*"
2 trực tiếp từ bản sao Git

composer global require "squizlabs/php_codesniffer=*"
7

Bắt đầu

Tiêu chuẩn mã hóa mặc định được sử dụng bởi PHP_CodeSniffer là tiêu chuẩn mã hóa PEAR. Để kiểm tra tệp theo tiêu chuẩn mã hóa PEAR, chỉ cần chỉ định vị trí của tệp

composer global require "squizlabs/php_codesniffer=*"
8

Hoặc nếu bạn muốn kiểm tra toàn bộ thư mục, bạn có thể chỉ định vị trí thư mục thay vì tệp

composer global require "squizlabs/php_codesniffer=*"
9

Nếu bạn muốn kiểm tra mã của mình theo tiêu chuẩn mã hóa PSR-12, hãy sử dụng đối số dòng lệnh

{
    "require-dev": {
        "squizlabs/php_codesniffer": "3.*"
    }
}
1

composer global require "squizlabs/php_codesniffer=*"
0

Nếu PHP_CodeSniffer tìm thấy bất kỳ lỗi mã hóa tiêu chuẩn nào, một báo cáo sẽ được hiển thị sau khi chạy lệnh

Thông tin sử dụng đầy đủ và báo cáo ví dụ có sẵn trên trang sử dụng

Tài liệu

Tài liệu về PHP_CodeSniffer có sẵn trên Github wiki

Vấn đề

Báo cáo lỗi và yêu cầu tính năng có thể được gửi trên Github Issue Tracker

Đóng góp

Xem ĐÓNG GÓP. md để biết thông tin

lập phiên bản

PHP_CodeSniffer sử dụng định dạng số phiên bản

{
    "require-dev": {
        "squizlabs/php_codesniffer": "3.*"
    }
}
2

Phiên bản

{
    "require-dev": {
        "squizlabs/php_codesniffer": "3.*"
    }
}
3 được tăng lên khi

  • các thay đổi không tương thích ngược được thực hiện đối với cách sử dụng các lệnh
    composer global require "squizlabs/php_codesniffer=*"
    1 hoặc
    composer global require "squizlabs/php_codesniffer=*"
    2, hoặc
  • các thay đổi không tương thích ngược được thực hiện đối với định dạng
    {
        "require-dev": {
            "squizlabs/php_codesniffer": "3.*"
        }
    }
    6 hoặc
  • các thay đổi không tương thích ngược được thực hiện đối với API được các nhà phát triển đánh hơi sử dụng hoặc
  • các loại mã thông báo PHP_CodeSniffer tùy chỉnh bị xóa hoặc
  • các trình đánh hơi hiện tại bị xóa hoàn toàn khỏi PHP_CodeSniffer

Phiên bản

{
    "require-dev": {
        "squizlabs/php_codesniffer": "3.*"
    }
}
7 được tăng lên khi

  • các tính năng tương thích ngược mới được thêm vào các lệnh
    composer global require "squizlabs/php_codesniffer=*"
    1 và
    composer global require "squizlabs/php_codesniffer=*"
    2 hoặc
  • các thay đổi tương thích ngược được thực hiện đối với định dạng
    {
        "require-dev": {
            "squizlabs/php_codesniffer": "3.*"
        }
    }
    6 hoặc
  • các thay đổi tương thích ngược được thực hiện đối với API được sử dụng bởi các nhà phát triển đánh hơi hoặc
  • đánh hơi mới được thêm vào một tiêu chuẩn bao gồm, hoặc
  • các trình đánh hơi hiện tại được xóa khỏi một tiêu chuẩn được bao gồm

GHI CHÚ. Các thay đổi tương thích ngược đối với API được sử dụng bởi các nhà phát triển đánh hơi sẽ cho phép một đánh hơi hiện tại tiếp tục chạy mà không tạo ra các lỗi nghiêm trọng nhưng có thể không dẫn đến việc đánh hơi báo cáo các lỗi giống như trước đây mà không cần thay đổi

Phiên bản

./vendor/bin/phpcs -h
./vendor/bin/phpcbf -h
1 được tăng lên khi

  • sửa lỗi tương thích ngược được thực hiện

GHI CHÚ. Vì PHP_CodeSniffer tồn tại để báo cáo và khắc phục sự cố, hầu hết các lỗi là kết quả của việc mã hóa các lỗi tiêu chuẩn được báo cáo không chính xác hoặc các lỗi tiêu chuẩn mã hóa không được báo cáo khi chúng nên được báo cáo. Điều này có nghĩa là các thông báo do PHP_CodeSniffer tạo ra và các bản sửa lỗi mà nó tạo ra có thể khác nhau giữa các phiên bản PATCH

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 để sử dụng PHP trong CS?

Để sử dụng PHP CS Fixer từ PhpStorm thay vì dòng lệnh, bạn cần phải đăng ký nó trong PhpStorm và định cấu hình nó làm công cụ kiểm tra mã PhpStorm . Sau khi được cài đặt và kích hoạt trong PhpStorm, công cụ này có sẵn trong mọi tệp PHP đã mở và không cần thực hiện thêm bước nào để khởi chạy nó.