Blade Indenter

Example

@extends('layout')

@section('title', $title)

@section('content')
<h1>
@if($article->exists)
Edit Article {{ $article->id }}
@php($url = route('articles.update', $article->id))
@else
Create a new Article
@php($url = route('articles.store'))
@endif
</h1>

{!! Form::model($article, ['url' => $url]) !!}

<div id='title-group'>
{!! Form::label('title', 'Title') !!}
{!! Form::text('title') !!}
@error('title')
<p>{{ $message }}</p>
@enderror
</div>

{!! Form::submit('Save') !!}

{!! Form::close() !!}
@endsection

@extends('layout')

@section('title', $title)

@section('content')
    <h1>
        @if($article->exists)
            Edit Article {{ $article->id }}
            @php($url = route('articles.update', $article->id))
        @else
            Create a new Article
            @php($url = route('articles.store'))
        @endif
    </h1>

    {!! Form::model($article, ['url' => $url]) !!}

    <div id='title-group'>
        {!! Form::label('title', 'Title') !!}
        {!! Form::text('title') !!}
        @error('title')
        <p>{{ $message }}</p>
        @enderror
    </div>

    {!! Form::submit('Save') !!}

    {!! Form::close() !!}
@endsection

Quick start

Simply import the package with composer:

composer require bgaze/laravel-blade-indenter

Configuration can be published to /config/blade-indenter.php:

php artisan vendor:publish --tag=blade-indenter-config

The package exposes a single service which indents a Blade string :

$indentedString = resolve(\Bgaze\BladeIndenter\BladeIndenter::class)->indent($stringToIndent);

Two helpers are also provided for convenience :

// Indent a string
$indentedString = indent_blade_string($stringToIndent);

// Indent a blade file, overwrite it and return formatted content.
$indentedFileContent = indent_blade_file($filePath);

// Indent a blade file and return formatted content without overwriting.
$indentedFileContent = indent_blade_file($filePath, false);

Configuration

The indenter supports Blade directives described in official documentation.
However, if needed, you can customize supported tags and directives (check package configuration for defaults).

Two ways to do that:

• publish and edit package configuration.
• configure BladeIndenter from the boot section of a Service provider.

As an example, here is the way to configure the indenter for bgaze/bootstrap-form custom directives.

// From boot method of App\Providers\AppServiceProvider:

resolve(\Bgaze\BladeIndenter\BladeIndenter::class)
    // @close directive closes @open, @vertical, @horizontal and @inline directives
    ->addClosingDirectives([
        'open' => 'close',
        'vertical' => 'close',
        'horizontal' => 'close',
        'inline' => 'close',
    ])
    // Indent level won't change on line after one of these directives
    ->addSelfClosingDirectives([
        'text', 'email', 'url', 'tel', 'number', 'date', 'time', 'textarea',
        'password', 'file', 'hidden', 'select', 'range', 'checkbox', 'checkboxes',
        'radio', 'radios', 'label', 'submit', 'reset', 'button', 'link',
    ]);

Self-closing HTML tags

Indentation level won't increase after these HTML tags.
Edit self_closing_tags section in configuration or use following methods:

/**
* @param  array  $tags
* @return BladeIndenter
*/
public function setSelfClosingTags(array $tags);

/**
* @param  array  $tags
* @return BladeIndenter
*/
public function addSelfClosingTags(array $tags);

Self-closing Blade directives

Indentation level won't increase after these directives.
Edit self_closing_directives section in configuration or use following methods:

/**
* @param  array  $directives
* @return BladeIndenter
*/
public function setSelfClosingDirectives(array $directives);

/**
* @param  array  $directives
* @return BladeIndenter
*/
public function addSelfClosingDirectives(array $directives);

Closing Blade directives

The "end" version of any directive is supported (for instance @endsection for @section), but some directives can also be closed by other directives, like @show closes @section.

Edit closing_directives section in configuration or use following methods to define the mapping of these behaviours (without @ character).

/**
* @param  array  $directives
* @return BladeIndenter
*/
public function setClosingDirectives(array $directives);

/**
* @param  array  $directives
* @return BladeIndenter
*/
public function addClosingDirectives(array $directives);

Examples:

'closing_directives' => [
    'section' => 'show',
    'opening_directive_2' => ['closing_directive_21', 'closing_directive_22'],
],

Else Blade directives

Else directive will be indented one level down, but previous level will be preserved on following line.
Edit else_directives section in configuration or use following methods:

/**
* @param  array  $directives
* @return BladeIndenter
*/
public function setElseDirectives(array $directives);

/**
* @param  array  $directives
* @return BladeIndenter
*/
public function addElseDirectives(array $directives);

Other packages

Feel free to visit my other packages: