phpcs - PHP Coding Standards

Tại sao cần phpcs

• Quy chuẩn hóa toàn bộ cách viết PHP hợp lệ
• Đảm bảo các tiêu chuẩn bảo mật

Cách thức setup

• Trên máy cần có composer. Xem cách cài đặt composer và đảm bảo trên máy có composer.
• Đọc file phpcs.xml.dist của 1 dự án, ví dụ ct-bones để nắm được cách rules nào sẽ áp dụng cơ bản
• Chạy composer install trên dự án nào có file composer.json
• Xem các command để chạy ở scripts của file composer.json, ví dụ:

{
 "scripts": {
      "standards:check": "@php ./vendor/squizlabs/php_codesniffer/bin/phpcs",
      "standards:fix": "@php ./vendor/squizlabs/php_codesniffer/bin/phpcbf",
      "lint": "@php ./vendor/bin/parallel-lint --exclude .git --exclude vendor .",
      "analyze": "@php ./vendor/bin/phpstan analyze"
  }
}

Command phổ biến là standards:check để tự check trên máy, standards:fix để fix tự động 1 số lỗi (nhưng không hết), lint để thực thi test.

Có thể lên CircleCI để xem report cụ thể và fix theo từng file.

Một số quy tắc cần tuân thủ

Sử dụng escape và sanitize - bao gồm nhiều function để format dữ liệu khi thu thập từ người dùng (vd từ đường dẫn), từ input (vd nhập text).

Xem thêm

Các dự án có quy tắc set prefix cụ thể thì sẽ cần đảm bảo các function sử dụng bắt đầu bằng các prefix function.

Xem thêm

Hạn chế việc output HTML trong biến của PHP để hạn chế code quét security level cao

Xem thêm