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

CÓ THỂ BẠN QUAN TÂM

Laravel Middlewares

Laravel Middlewares

Middleware cung cấp một cơ chế thuận tiện để lọc các yêu cầu HTTP gửi đến ứng dụng bạn. Nó là một lớp trung gian nằm giữa request và controller. Bạn có thể thêm các xử lý logic trước khi gửi đến contr...

Implementing Private User Folders with elFinder in Laravel

Implementing Private User Folders with elFinder in Laravel

elFinder elFinder là một trình quản lý tập tin mã nguồn mở dành cho web, được viết bằng JavaScript sử dụng jQuery UI. elFinder được phát triển dựa trên cảm hứng từ sự tiện lợi và đơn giản của chư...

Generate PDF with Header and Footer on every page in Laravel

Generate PDF with Header and Footer on every page in Laravel

Hôm nay, trong bài viết này mình sẽ chia sẻ với các bạn cách dompdf mà header và footer sẽ được hiển thị ở tất cả các trang. Đây cũng là một vấn đề khá phổ biến, khi chúng ta phát triển các tính năng...

Method WhereAny / WhereAll  in Laravel Eloquent

Method WhereAny / WhereAll in Laravel Eloquent

New Laravel 10: Eloquent WhereAny() và WhereAll() Laravel cung cấp cho chúng ta khả năng xây dựng các truy vấn dữ liệu mạnh mẽ với Eloquent ORM, giúp chúng ta có thể xử lý các truy vấn cơ sở dữ li...

Laravel Queue Workers With Systemd

Laravel Queue Workers With Systemd

Systemd chủ yếu được sử dụng để quản lý các service trên môi trường Linux, nhưng nó cũng cho phép chúng ta quản lý các service với quyền không phải là root. Điều này, làm cho systemd trở thành một giả...

Laravel Controllers

Laravel Controllers

Trong mô hình MVC, chữ "C" là từ viết tắt của Controller và nó đóng vai trò rất quan trọng để phân tích các logic business. Khi người dùng truy cập vào trình duyệt, nó sẽ đi đến route đầu tiên, sau đó...

Csv import with Validation for Laravel

Csv import with Validation for Laravel

Trong một bài viết lúc trước, mình đã chia sẻ đến các bạn cách xây dựng một service import và export CSV sử dụng Facades, nếu có bạn nào không biết hoặc đã quên các bạn có thể tham khảo lại bài viết t...

Integrating OpenAI in Laravel

Integrating OpenAI in Laravel

OpenAI OpenAI là một phòng thí nghiệm nghiên cứu trí tuệ nhân tạo (AI) của Mỹ bao gồm tổ chức phi lợi nhuận OpenAI Incorporated (OpenAI Inc.) và công ty con hoạt động vì lợi nhuận OpenAI Limited Par...

Efficient Laravel PDF Export for Large Datasets

Efficient Laravel PDF Export for Large Datasets

Xuất file PDF là một tính năng quan trọng của nhiều ứng dụng web, đặc biệt là các trang thương mại điện tử, giúp người dùng tạo và lưu trữ các bản báo cáo, hóa đơn, v.v.  Tuy nhiên, khi phải xử lý...

ManhDanBlogs