Laravel Pint (vendor/bin/pint) 설명
Laravel Pint는 Laravel에서 공식적으로 제공하는 자동 코드 포매터(Auto Code Formatter) 입니다.
PHP 코드 스타일을 자동으로 정리해주며, Laravel 및 PHP 커뮤니티에서 널리 사용되는 PSR-12 및 Laravel 코드 스타일을 준수합니다.
Pint는 Laravel 팀에서 개발한 PHP 코드 스타일 교정 도구로, PHP-CS-Fixer를 기반으로 만들어졌습니다.
기능 및 목적
- PHP 코드의 스타일을 자동으로 수정하여 일관된 코딩 스타일을 유지하도록 도와줍니다.
- PSR-12 및 Laravel 코딩 스타일 규칙을 기반으로 코드를 정리합니다.
- 들여쓰기, 공백, 괄호, 배열 구문 등 코드의 형식을 일관되게 정리합니다.
- 설정이 간단함 →
pint.json
파일로 원하는 스타일을 쉽게 변경 가능 - 빠른 속도 → 무거운 종속성 없이 가볍게 실행됨
- PHP 8 이상 지원 → 최신 PHP 버전에서 최적화
설치 방법
composer require laravel/pint --dev
--dev 옵션을 사용하면 개발 환경에서만 설치됩니다.
기본 사용법
전체 프로젝트 코드 스타일 정리
아래 명령어를 실행하면 프로젝트 내 모든 PHP 파일을 자동으로 정리합니다.
vendor/bin/pint
# 실제로 파일을 수정하지 않고 어떤 파일이 스타일 규칙을 위반하는지 보여줍니다.
vendor/bin/pint --test
# 특정 디렉토리 지정
vendor/bin/pint app/Models
vendor/bin/pint app/Http/Controllers/UserController.php
# 더 자세한 정보를 보여줍니다.
vendor/bin/pint -v
Laravel Pint는 기본적으로
app/
,config/
,database/
,resources/
,routes/
,tests/
디렉터리의 파일을 자동으로 정리합니다.
설정 파일 사용 (pint.json)
기본 설정을 변경하고 싶다면 프로젝트 루트에 pint.json
파일을 생성하면 됩니다.
예시:
{
"preset": "laravel",
"exclude": [
"storage",
"vendor"
],
"rules": {
"array_syntax": {
"syntax": "short"
},
"ordered_imports": {
"sort_algorithm": "alpha"
},
"no_unused_imports": true
}
}
}
preset
: 사용할 코드 스타일 (psr12
,laravel
,symfony
등 선택 가능)exclude
: 제외할 디렉터리나 파일
CI/CD에서 사용하기
GitHub Actions 같은 CI/CD 환경에서도 Laravel Pint를 실행할 수 있습니다.
예제 (.github/workflows/pint.yml
):
name: Laravel Pint Code Style Check
on: [push, pull_request]
jobs:
pint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Set up PHP
uses: shivammathur/setup-php@v2
with:
php-version: '8.2'
- name: Install dependencies
run: composer install --no-progress --no-suggest --prefer-dist
- name: Run Pint
run: vendor/bin/pint --test
--test
옵션을 사용하면 코드 스타일을 수정하지 않고 테스트 모드로 검증만 합니다.
Laravel Pint vs PHP CS Fixer 차이점
Laravel Pint는 PHP CS Fixer 기반으로 만들어졌지만, 차이점이 있습니다.
비교 항목 | Laravel Pint | PHP CS Fixer |
---|---|---|
설치 방식 | composer require laravel/pint --dev |
composer require friendsofphp/php-cs-fixer --dev |
설정 파일 | pint.json |
.php-cs-fixer.php |
스타일 가이드 | laravel , psr12 , symfony 등 |
다양한 설정 가능 |
사용 편의성 | 간단한 설정과 빠른 실행 | 좀 더 세밀한 설정 가능 |
CI/CD 지원 | GitHub Actions 예제 제공 | 별도로 설정 필요 |
핵심정리
Laravel 프로젝트에서 코드 스타일을 쉽게 유지하려면 Laravel Pint를 사용하는 것이 좋습니다.
✔ 설치가 간편하고 자동화 가능
✔ Laravel 스타일 가이드에 최적화
✔ CI/CD에서 코드 품질 유지 가능
'Laravel' 카테고리의 다른 글
Mailpit - 로컬PC 에서 SMTP 테스트하기 (0) | 2025.02.07 |
---|---|
Docker 에서 Laravel 개발하기 (0) | 2025.01.28 |
Laravel > favicon.ico 자동만들기 (0) | 2024.12.22 |
Laravel > 폴더 구조를 라우터로 연결하기 (0) | 2024.12.15 |
Laravel 에서 sqlite 추가 및 사용 방법 (0) | 2024.11.14 |
Laravel Pint (vendor/bin/pint) 설명
Laravel Pint는 Laravel에서 공식적으로 제공하는 자동 코드 포매터(Auto Code Formatter) 입니다.
PHP 코드 스타일을 자동으로 정리해주며, Laravel 및 PHP 커뮤니티에서 널리 사용되는 PSR-12 및 Laravel 코드 스타일을 준수합니다.
Pint는 Laravel 팀에서 개발한 PHP 코드 스타일 교정 도구로, PHP-CS-Fixer를 기반으로 만들어졌습니다.
기능 및 목적
- PHP 코드의 스타일을 자동으로 수정하여 일관된 코딩 스타일을 유지하도록 도와줍니다.
- PSR-12 및 Laravel 코딩 스타일 규칙을 기반으로 코드를 정리합니다.
- 들여쓰기, 공백, 괄호, 배열 구문 등 코드의 형식을 일관되게 정리합니다.
- 설정이 간단함 →
pint.json
파일로 원하는 스타일을 쉽게 변경 가능 - 빠른 속도 → 무거운 종속성 없이 가볍게 실행됨
- PHP 8 이상 지원 → 최신 PHP 버전에서 최적화
설치 방법
composer require laravel/pint --dev
--dev 옵션을 사용하면 개발 환경에서만 설치됩니다.
기본 사용법
전체 프로젝트 코드 스타일 정리
아래 명령어를 실행하면 프로젝트 내 모든 PHP 파일을 자동으로 정리합니다.
vendor/bin/pint
# 실제로 파일을 수정하지 않고 어떤 파일이 스타일 규칙을 위반하는지 보여줍니다.
vendor/bin/pint --test
# 특정 디렉토리 지정
vendor/bin/pint app/Models
vendor/bin/pint app/Http/Controllers/UserController.php
# 더 자세한 정보를 보여줍니다.
vendor/bin/pint -v
Laravel Pint는 기본적으로
app/
,config/
,database/
,resources/
,routes/
,tests/
디렉터리의 파일을 자동으로 정리합니다.
설정 파일 사용 (pint.json)
기본 설정을 변경하고 싶다면 프로젝트 루트에 pint.json
파일을 생성하면 됩니다.
예시:
{
"preset": "laravel",
"exclude": [
"storage",
"vendor"
],
"rules": {
"array_syntax": {
"syntax": "short"
},
"ordered_imports": {
"sort_algorithm": "alpha"
},
"no_unused_imports": true
}
}
}
preset
: 사용할 코드 스타일 (psr12
,laravel
,symfony
등 선택 가능)exclude
: 제외할 디렉터리나 파일
CI/CD에서 사용하기
GitHub Actions 같은 CI/CD 환경에서도 Laravel Pint를 실행할 수 있습니다.
예제 (.github/workflows/pint.yml
):
name: Laravel Pint Code Style Check
on: [push, pull_request]
jobs:
pint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Set up PHP
uses: shivammathur/setup-php@v2
with:
php-version: '8.2'
- name: Install dependencies
run: composer install --no-progress --no-suggest --prefer-dist
- name: Run Pint
run: vendor/bin/pint --test
--test
옵션을 사용하면 코드 스타일을 수정하지 않고 테스트 모드로 검증만 합니다.
Laravel Pint vs PHP CS Fixer 차이점
Laravel Pint는 PHP CS Fixer 기반으로 만들어졌지만, 차이점이 있습니다.
비교 항목 | Laravel Pint | PHP CS Fixer |
---|---|---|
설치 방식 | composer require laravel/pint --dev |
composer require friendsofphp/php-cs-fixer --dev |
설정 파일 | pint.json |
.php-cs-fixer.php |
스타일 가이드 | laravel , psr12 , symfony 등 |
다양한 설정 가능 |
사용 편의성 | 간단한 설정과 빠른 실행 | 좀 더 세밀한 설정 가능 |
CI/CD 지원 | GitHub Actions 예제 제공 | 별도로 설정 필요 |
핵심정리
Laravel 프로젝트에서 코드 스타일을 쉽게 유지하려면 Laravel Pint를 사용하는 것이 좋습니다.
✔ 설치가 간편하고 자동화 가능
✔ Laravel 스타일 가이드에 최적화
✔ CI/CD에서 코드 품질 유지 가능
'Laravel' 카테고리의 다른 글
Mailpit - 로컬PC 에서 SMTP 테스트하기 (0) | 2025.02.07 |
---|---|
Docker 에서 Laravel 개발하기 (0) | 2025.01.28 |
Laravel > favicon.ico 자동만들기 (0) | 2024.12.22 |
Laravel > 폴더 구조를 라우터로 연결하기 (0) | 2024.12.15 |
Laravel 에서 sqlite 추가 및 사용 방법 (0) | 2024.11.14 |