Simplify Your Laravel Workflow with Laravel Pint

Laravel Pint là gì?

Laravel Pint là một công cụ sửa đổi mã nguồn của bạn để mã nguồn của bạn tuân thủ theo các tiêu chuẩn.

Nói một cách khác, Laravel Pint sẽ quét toàn bộ mã nguồn của bạn, phát hiện các vấn đề về tiêu chuẩn mã hóa và sửa đổi chúng cho bạn trong vài giây, điều này thật tuyệt vời phải không nào!

Bây giờ, chúng ta hãy xem cách mà Laravel Pint hành động⚡⚡⚡⚡⚡⚡

/**
 * Show the form for creating a new resource.
 *
 * @return \Illuminate\Http\Response
 */
public function create()
{
    return [
        "title" =>         'ManhDanBlogs',
        'author' => 'Huynh Manh Dan (Beater)',
    ];

}

Đây là một mã nguồn, bạn sẽ không muốn chúng xuất hiện trong dự án của mình, nhưng đôi khi điều lại luôn xảy.

Một số điều cần thay đổi trong mã nguồn trên như sau:
- Dấu ngoặc kép
- Khoảng trống bị thừa

Hãy xem Laravel Pint khắc phục điều đó cho chúng ta như thế nào nha.

/**
 * Show the form for creating a new resource.
 *
 * @return \Illuminate\Http\Response
 */
public function create()
{
    return [
        'title' => 'ManhDanBlogs',
        'author' => 'Huynh Manh Dan (Beater)',
    ];
}

Ngoài ra,  Laravel Pint cũng cho bạn biết được các điều sau:

- Có bao nhiêu file được quét

- File nào được thay đổi

- Lỗi được sửa

Cài đặt Laravel Pint

Chúng ta cài đặt Laravel Pint thông qua lệnh composer sau:

composer require laravel/pint --dev

☛Lưu ý:
- Phiên bản Laravel mình sử dụng trong bài viết này là Laravel 10

- Đây là một package đã được cài đặt sẵn trong Laravel 9 và Laravel 10

Sử dụng Laravel Pint: Running Pint

Nếu bạn muốn quét toàn bộ và sửa đổi tất cả file, bạn hãy sử dụng lệnh sau:

./vendor/bin/pint

Để xem thêm chi tiết về Laravel Pint đang thay đổi những gì, bạn hãy sử dụng lệnh sau:

./vendor/bin/pint -v

Bạn cũng có thể chạy Laravel Pint trên file hoặc folder cụ thể:

./vendor/bin/pint app/Models

./vendor/bin/pint app/Models/User.php

Nếu bạn chỉ muốn hiển thị lỗi nhưng không sửa đổi file, bạn chạy lênh sau:

./vendor/bin/pint --test

Cấu hình Laravel Pint

Laravel Pint không cần cấu hình để sử dụng, bạn có thể cài đặt và sử dụng trực tiếp mà không cần nghĩ đến việc cấu hình.
Tuy nhiên, nếu bạn vẫn muốn tùy chỉnh quy tắc hay chỉ loại trừ các files/folders trong quá trình kiểm tra, bạn có thể làm điều đó bằng cách tạo ra file pint.json nằm ở thư mục gốc của dự án.

Presets

Mặc định Laravel Pint sẽ sử dụng "laravel", nhưng bạn vẫn có thể thay đổi điều này bằng cách sử đổi pint.json như sau:

{
    "preset": "psr12"
}

Ngoài ra bạn vẫn có thể thay đổi điều này khi chạy lệnh:

./vendor/bin/pint --preset psr12

Hiện tại Laravel Pint đang hỗ trợ các presets sau: laravel, psr12 và symfony.

Loại trừ Files / Folders

Mặc định Laravel Pint sẽ quét toàn bộ mã nguồn, nhưng có những thư mục bạn muốn loại bỏ chúng khi Laravel Pint thực hiện, bạn sử dụng exclude như sau:

{
    "exclude": [
        "path/to/your-folder"
    ]
}

Nếu bạn muốn loại trừ các file chứa một kí tự nào đó, bạn hãy sử dụng notName như sau:

{
    "notName": [
        "*-your-cool-file.php"
    ]
}

Còn trường hợp bạn biết chính xác tên, hãy sử dụng notPath như sau:

{
    "notPath": [
        "path/to/your-file.php"
    ]
}

Rules

nếu bạn muốn điều chỉnh một số quy tắc, bạn có thể thực hiện điều đó bằng cách chỉnh sửa pint.json như sau:

{
    "preset": "laravel",
    "rules": {
        "simplified_null_return": true,
        "braces": false,
        "new_with_braces": {
            "anonymous_class": false,
            "named_class": false
        }
    }
}

Tóm lại, Laravel Pint là một công cụ quan trọng giúp cải thiện thiện quá trình phát triển ứng dụng Laravel của bạn.
Từ đó, giúp chúng ta có thể giảm thiểu sai sót và tiết kiệm thời gian cho công việc viết mã nguồn, giúp chúng ta tập trung hơn vào việc xây dựng tính năng quan trọng cho dự án của mình.

Tài liệu tham khảo:

https://laravel.com/docs/10.x/pint