Hướng dẫn cài đặt và sử dụng PHP-CS-Fixer vào trong VS-Code

Jan 30, 2024

1. Cài đặt:

Mở terminal và chạy lệnh sau để cài đặt PHP CS Fixer thông qua Composer :

$composer global require friendsofphp/php-cs-fixer

2. Thêm thư mục Composer bin vào biến môi trường PATH

Thêm thư mục Composer bin vào biến môi trường PATH:

Mở Control Panel trên Windows. Chọn “System and Security” và sau đó chọn “System”.

Chọn “Advanced system settings” ở thanh bên trái. Nhấn nút “Environment Variables”.

Tìm và chọn biến môi trường Path ở mục “System variables” và nhấn nút “Edit”.

Nhấn nút “New” và thêm đường dẫn tới thư mục bin của Composer (ví dụ: C:\Users{username}\AppData\Roaming\Composer\vendor\bin). Nhấn “OK” để lưu các thay đổi.

3. Cài đặt Extension PHP CS Fixer cho VSCode

Mở VSCode và chuyển đến trang Extensions bằng cách nhấn Ctrl + Shift + X hoặc bấm vào biểu tượng hình chiếc mũi tên hai bên ở thanh bên trái.

Tìm kiếm “PHP CS Fixer” và cài đặt extension có tên “PHP CS Fixer” do junstyle cung cấp.

4. Cấu hình VSCode để sử dụng PHP CS Fixer

Mở file cấu hình của VSCode (settings.json). Bạn có thể mở nhanh bằng cách nhấn Ctrl + , hoặc bấm vào biểu tượng bánh răng ở thanh bên trái và chọn “Settings”. Bấm vào biểu tượng mũi tên ở góc phải trên cùng và chọn “Open Settings (JSON)”. Thêm cấu hình sau:

    "php-cs-fixer.rules": "",
    "php-cs-fixer.executablePath": "${extensionPath}/php-cs-fixer.phar",
    "php-cs-fixer.config": "${workspaceFolder}/.php_cs.dist",
    "editor.formatOnSave": true,
    "php-cs-fixer.formatHtml": true,
    "php-cs-fixer.onsave": true,
    "[php]": {
        "editor.defaultFormatter": "junstyle.php-cs-fixer"
    },

5. Kiểm tra

– Mặt định sẽ là Rule: PSR12. Có thể xem thêm tại https://github.com/PHP-CS-Fixer/PHP-CS-Fixer/tree/master/doc/ruleSets – Bây giờ, khi bạn lưu một file PHP trong VSCode, PHP CS Fixer sẽ tự động chạy để sửa lỗi và định dạng mã nguồn theo cấu hình đã thiết lập.

6. Auto fix

– Fix all folder:

$ php-cs-fixer fix [/path/to/folder]

– Fix 1 file

$ php-cs-fixer fix [/path/to/file]

– Tham khảo thêm các option tại đây: https://github.com/PHP-CS-Fixer/PHP-CS-Fixer/blob/master/doc/usage.rst

You need to login in order to like this post: click here