Format Code
Package to format the Laravel php code in the style of WordPress.
Requirements
- PHP 7.2+
- Laravel 5.5+
Installation
Composer
Run the following to include this via Composer
composer require aodamuz/format-codeArtisan Commands
Scan specific directories and format all PHP files within.
php artisan format:scan vendor/symfonyOr many directories separated by commas.
php artisan format:scan vendor/symfony,app,config,testsFormat all files within the Laravel project. Default directories:
- app
- config
- database
- routes
- tests
- vendor/laravel
php artisan format:allFormat all specified PHP files.
php artisan format:file config/app.phpOr many files separated by commas.
php artisan format:file config/app.php,config/filesystems.php,app/Models/User.phpExamples
Before formatting the user model.
<?php
namespace App\Models;
use Illuminate\Notifications\Notifiable;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Foundation\Auth\User as Authenticatable;
use Illuminate\Contracts\Auth\MustVerifyEmail;
class User extends Authenticatable
{
use HasFactory, Notifiable;
/**
* The attributes that are mass assignable.
*
* @var array
*/
protected $fillable = [
'name', 'email', 'password',
];
/**
* The attributes that should be hidden for arrays.
*
* @var array
*/
protected $hidden = [
'password', 'remember_token',
];
/**
* The attributes that should be cast to native types.
*
* @var array
*/
protected $casts = [
'email_verified_at' => 'datetime',
];
}Note that the code has the standard Laravel look and the indentation is with spaces.
After
<?php
namespace App\Models;
use Illuminate\Notifications\Notifiable;
use Illuminate\Contracts\Auth\MustVerifyEmail;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Foundation\Auth\User as Authenticatable;
class User extends Authenticatable {
use HasFactory, Notifiable;
/**
* The attributes that are mass assignable.
*
* @var array
*/
protected $fillable = [
'name', 'email', 'password',
];
/**
* The attributes that should be hidden for arrays.
*
* @var array
*/
protected $hidden = [
'password', 'remember_token',
];
/**
* The attributes that should be cast to native types.
*
* @var array
*/
protected $casts = [
'email_verified_at' => 'datetime',
];
}After formatting the file, the result would be a code with tabs, with class imports ordered by length and with the WordPress standard.
License
Format Code is open-sourced software licensed under the MIT license.
