Squizlabs php_codesniffer

composer global config bin-dir --absolute

Hiệp Trần @hieptran

Theo dõi

792 26 21

Đã đăng vào ngày 22 tháng 8 năm 2019 9. 32 SA 5 phút đọc

4. 1k

0

4

• Report
• Add to series of me

Bài đăng này đã không được cập nhật trong 3 năm

quy ước mã hóa

• Trước khi tìm hiểu xem PHP Code Sniffer là gì thì các bạn cần phải nắm lấy quy ước mã hóa là gì đã
• Quy ước mã hóa là tập hợp các quy ước cụ thể khi viết mã mà lập trình viên cần tuân theo. Việc tuân thủ những quy ước này sẽ giúp code dễ đọc, dễ quản lý. bảo trì, nâng cấp
• Đối với các bạn sinh viên còn ở trên ghế nhà trường thì có thể khái niệm này còn khá mới mẻ, nhưng khi ra trường và bắt đầu làm việc tại các công ty thì quy ước mã hóa nhiệm vụ sẽ là điều kiện bắt buộc và khó có thể thực hiện được.
• Tùy công ty sẽ có các quy ước mã hóa tiêu chuẩn khác nhau nhưng hầu hết sẽ dựa trên các tiêu chuẩn phổ biến trên thế giới
• Đối với PHP thì hiện nay có 2 chuẩn phổ biến nhất đó là PSR1 và PSR2. Để tìm hiểu kỹ về hai chuẩn này mọi người có thể truy cập link bên dưới, còn trong bài này mình xin phép không đề cập nhật sâu
  • PSR1. https. //www. php-fig. tổ chức/psr/psr-1/
  • PSR2. https. //www. php-fig. tổ chức/psr/psr-2/

PHP Code Sniffer là gì?

• PHP Code Sniffer [hay còn gọi là phpcs] là một công cụ hỗ trợ lập trình viên trong công việc kiểm tra các quy ước viết mã. Đó là lý do tại sao mình giới thiệu về quy ước mã hóa trước
• PHP Code Sniffer bao gồm 2 tập lệnh PHP
  • Lệnh

    composer global config bin-dir --absolute
    

    2 là lệnh chính mã hóa các tệp PHP, Javascript, CSS để phát hiện các quy ước mã hóa phạm vi
  • Lệnh

    composer global config bin-dir --absolute
    

    3 để tự động chỉnh sửa các phần mã vi phạm quy ước mã hóa tiêu chuẩn
• Đây là 1 công cụ phát triển thiết yếu để đảm bảo mã của bạn sạch sẽ, tuân thủ các quy ước mã hóa mà bạn không bị mất thời gian, rà soát lại mã để kiểm tra

Cài đặt

• Cách dễ nhất để cài đặt là tải xuống các tệp PHAR bằng mỗi câu lệnh sau.

  # Download using curl
  curl -OL //squizlabs.github.io/PHP_CodeSniffer/phpcs.phar
  curl -OL //squizlabs.github.io/PHP_CodeSniffer/phpcbf.phar
  
  # Or download using wget
  wget //squizlabs.github.io/PHP_CodeSniffer/phpcs.phar
  wget //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 trình soạn nhạc, bạn có thể cài đặt PHP Code Sniffer bằng câu lệnh sau.

  composer global require "squizlabs/php_codesniffer=*"
  

• Hãy chắc chắn rằng bạn có thư mục thùng của nhà soạn nhạc. Giá trị mặc định là

  composer global config bin-dir --absolute
  

  4, nhưng bạn có thể kiểm tra giá trị này bằng cách chạy lệnh.

  composer global config bin-dir --absolute
  

• Hoặc bạn có thể thêm PHP Code Sniffer trong tệp

  composer global config bin-dir --absolute
  

  5 của bạn. Ví dụ.

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

• Thế là bạn có thể chạy PHP Code Sniffer từ thư mục

  composer global config bin-dir --absolute
  

  6.

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

Bản sao Git

• Bạn cũng có thể tải xuống PHP Code Sniffer và chạy các lệnh

  composer global config bin-dir --absolute
  

  2 và

  composer global config bin-dir --absolute
  

  3 bằng cách sao chép từ Git

  composer global config bin-dir --absolute
  

  2

Use

• Chuẩn PEAR là chuẩn mặc định mà PHP Code Sniffer sử dụng để kiểm tra. Để kiểm tra 1 tệp có tiêu chuẩn PEAR hay không, bạn chỉ cần xác định vị trí của tệp.

  composer global config bin-dir --absolute
  

  3
• 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 config bin-dir --absolute

• Còn nếu bạn muốn kiểm tra theo tiêu chuẩn khác, hãy sử dụng

  composer global config bin-dir --absolute
  

  9.

  composer global config bin-dir --absolute
  

  6
• Câu lệnh trên sẽ kiểm tra mã thư mục của bạn theo tiêu chuẩn PSR2

Ví dụ

• Ví dụ kết quả trả về khi thực hiện kiểm tra 1 tệp theo tiêu chuẩn mặc định.

  composer global config bin-dir --absolute
  

  7
• Ví dụ kết quả trả về khi thực hiện kiểm tra 1 thư mục theo tiêu chuẩn.

  composer global require "squizlabs/php_codesniffer=*"
  

  0

• https. //github. com/squizlabs/PHP_CodeSniffer

Phpc PHP

Đã đăng ký Bản quyền

• Report
• Add to series of me

PHP Codesniffer là gì?

Các tiêu chuẩn mã hóa trong PHP là gì?