Phần mở rộng chức năng tập tin php

Đây là bài viết tiếp theo của bài viết Code PHP chuẩn quy ước với PHP CodeSniffer. Trong bài này mình sẽ hướng dẫn các bạn auto check lỗi và format code PHP trong Vs Code – một trong những code editor được yêu thích nhất hiện nay

Lưu ý, để hiểu bài viết này hơn, thì bạn cần đảm bảo các yêu cầu sau

  • Máy tính đã cài đặt trình soạn thảo ở dạng toàn cầu
  • Máy tính đã cài đặt PHP CodeSniffer ở dạng toàn cầu
  • Bạn đã hiểu ý nghĩa của 2 công cụ phpcbf và phpcbf
  • Bạn đã hiểu ý nghĩa của file cấu hình phppcs. xml in project

Nếu không, hãy đọc phần trước của bài viết này, lúc đó mình đang cung cấp các nội dung hữu ích về các yêu cầu trên

lục mục

I. Giới thiệu về Mã định dạng tính năng trong VS Code

Giống như nhiều trình soạn thảo khác, Mã VS có tính năng tự động mã định dạng của bạn cho tiêu chuẩn hơn

Phần mở rộng chức năng tập tin php
Phần mở rộng chức năng tập tin php
Hình ảnh tạm thời mượn từ một nguồn khác phambinh. lưới 🙂

Phím tắt để định dạng mã trên Mã VS tương ứng với từng hệ điều hành như sau

  1. Trên Windows. Ca + Alt + F
  2. Trên máy Mac. Shift + Tùy chọn + F
  3. Trên Linux. Ctrl + Shift + Tôi

Tuy nhiên, mặc định thì Mã VS không có sẵn mã định dạng PHP, mà chúng ta phải cài đặt thêm từ tiện ích mở rộng bên ngoài và mình sẽ hướng dẫn các bạn cài đặt ngay mục bên dưới đây

II. Định dạng mã PHP trong VS Code với PHP Sniffer & Beautifier

Mình đã dùng thử khá nhiều mã định dạng mở rộng PHP, thì thấy thằng PHP Sniffer & Beautifier này dễ dùng và dễ biến nhất. Để cài đặt tiện ích mở rộng này, các bạn vào mục Tiện ích mở rộng của Mã VS, tìm kiếm với từ khóa là “Sniffer & Beautifier” sẽ ra

Phần mở rộng chức năng tập tin php
Phần mở rộng chức năng tập tin php
Cách tìm và cài đặt extension trong VS Code

Chúng ta tiến hành cài đặt bình thường như các tiện ích mở rộng khác, và sau khi cài đặt xong, hãy truy cập phần cài đặt riêng của tiện ích mở rộng này như hình bên dưới

Phần mở rộng chức năng tập tin php
Phần mở rộng chức năng tập tin php
Đi đến trang cài đặt riêng cho tiện ích mở rộng

Tại trang cài đặt riêng của tiện ích mở rộng Sniffer & Beautifier, có 3 cài đặt thông tin quan trọng là Bộ quy tắc tự động được phép, Đường dẫn thực thi CBF và Đường dẫn thực thi CS. Mình sẽ hướng dẫn các bạn cấu hình các thông tin này sao cho phù hợp ngay sau đây

Phần mở rộng chức năng tập tin php
Phần mở rộng chức năng tập tin php
Các thiết lập quan trọng

2. 1 Cấu hình thông tin Bộ quy tắc tự động được phép

In item (1) as in the hinh, hãy nhấn vào Chỉnh sửa trong cài đặt. json, và chắc chắn rằng phpsab.allowedAutoRulesets được cấu hình như sau

Phần mở rộng chức năng tập tin php
Phần mở rộng chức năng tập tin php

Để copy cho dễ thì mình viết các giá trị ra đây nhé

{
    // ...
    "phpsab.allowedAutoRulesets": [
        ".phpcs.xml",
        ".phpcs.xml.dist",
        "phpcs.xml",
        "phpcs.xml.dist",    
        "phpcs.ruleset.xml",
        "ruleset.xml"
    ],
    // ...
}

2. 2 Cấu hình 2 thông tin Đường dẫn thực thi CBF và Đường dẫn thực thi CS

In the item (2) as in the hinh, we need to điền đường dẫn tới 2 công cụ là phpcbfphpcs. Mình sẽ hướng dẫn các bạn cách lấy thông qua mấy bước đơn giản dưới đây

Chạy lệnh sau để lấy đường dẫn đến thư mục nhà của nhà soạn nhạc

composer config --list --global | grep "home"

Kết quả sẽ có dạng như sau, và phần bôi đậm chính là đường dẫn bạn cần quan tâm

Lưu ý. Mỗi máy sẽ cho ra một kết quả khác nhau, và bên dưới là kết quả trên máy của mình

[home] /Users/admin/.composer

Sau khi có đường dẫn về nhà, thì đường dẫn đến phpcsphpcbf sẽ có dạng như sau

# Đường dẫn tới phpcbf
/Users/admin/.composer/vendor/bin/phpcbf

# Đường dẫn tới phpcs
/Users/admin/.composer/vendor/bin/phpcs

Vì vậy, chúng ta đã có đường dẫn đến phpcbfphpcs, giờ chỉ cần điền chúng một lần vào mục Đường dẫn thực thi CBF và Đường dẫn thực thi CS trong trang cài đặt của tiện ích mở rộng Sniffer & Beautifier là xong

III. Use try

Khởi tạo một dự án mới với 1 tệp

composer config --list --global | grep "home"
3 ở thư mục gốc, có các quy tắc theo PSR12 như sau

<?xml version="1.0"?>
<ruleset name="PHP Standards">
    <rule ref="PSR12" />
</ruleset>

Tạo tiếp 1 tệp PHP có sẵn một vài quy ước lỗi

<?php

// File này cố tình code sai convention
 
function sum ($a ,$b){
    return $a+$b;
}
 
echo sum(1,2);

Bật dự án lên bằng Mã VS, và bạn sẽ thấy nó thông báo rất nhiều quy ước lỗi như sau

Phần mở rộng chức năng tập tin php
Phần mở rộng chức năng tập tin php
Rất nhiều quy ước cốt lõi đã được phát hiện

Và để khắc phục tất cả các lỗi này, bạn chỉ cần Click chuột phải chọn Định dạng tài liệu hoặc sử dụng tổ hợp phím định dạng mã như mình hướng dẫn ở đầu bài viết. Và dưới đây là kết quả sau khi định dạng lại mã, bạn sẽ thấy các quy ước lỗi đã được sửa

Phần mở rộng chức năng tập tin php
Phần mở rộng chức năng tập tin php
Các lỗi quy ước đã được sửa chữa

Công việc tích hợp Sniffer & Beautifier vào VS Code để định dạng code PHP đến đây là kết thúc, chúc các bạn thử nghiệm thành công

Hẹn gặp lại bạn trong các bài viết tiếp theo

Facebook

Twitter

Pinterest

WhatsApp

Phạm Bình

https. //phuongbinh. bọc lưới

Mình muốn chia sẻ những kiến ​​thức mà mình học được trong quá trình làm việc và phát triển, với hy vọng sẽ giúp ích cho bạn đọc - như cách mà mình học được từ việc đọc các blog khác