bkwld/laravel-pug

Pug view adapter for Laravel

Installs: 18 679

Dependents: 2

Suggesters: 0

Stars: 88

Watchers: 5

Forks: 10

Open Issues: 0

Type:composer-plugin

1.7.0 2018-12-02 10:16 UTC

README

Packagist Build Status StyleCI codecov Code Climate License

A small package that adds support for compiling Pug (Jade) templates to Laravel via Pug.php (see complete documentation). Both vanilla php and Blade syntax is supported within the view.

Installation

First you need composer if you have'nt yet: https://getcomposer.org/download/

Now open a terminal at the root of your laravel project. If it's a new project, create it with: composer create-project --prefer-dist laravel/laravel my-new-project (replace my-new-project with your own project name, see the documentation for further information)

Then run composer require bkwld/laravel-pug.

To get a line and offset in pug source files well formatted in standard Laravel error display to debug errors, we recommend you to implement the following in your app/Exceptions/ExceptionHandler:

<?php

namespace App\Exceptions;

use Bkwld\LaravelPug\ExceptionHandlerTrait;
use Exception;
use Illuminate\Foundation\Exceptions\Handler as ExceptionHandler;

class Handler extends ExceptionHandler
{
    use ExceptionHandlerTrait;
    
    /* ... */

    /**
     * Render an exception into an HTTP response.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  \Exception  $exception
     * @return \Illuminate\Http\Response
     */
    public function render($request, Exception $exception)
    {
        return $this->filterErrorResponse($exception, $request, parent::render($request, $exception));
    }
    
}

Note: this will works for pure .pug file, not .pug.blade since the error will happen in the blade engine.

Usage

Any file with the extension .pug will be compiled as a pug template. Laravel Pug also registers the .pug.php, .pug.blade, and .pug.blade.php as well as the .jade, .jade.php, .jade.blade, and .jade.blade.php extensions with Laravel and forwards compile requests on to Pug.php but we highly recommend you to use the clean and standard extension .pug that will be recognized by most systems. It compiles your Pug templates in the same way as Blade templates; the compiled template is put in your storage directory. Thus, you don't suffer compile times on every page load.

In other words, just put your Pug files in the regular views directory and name them like whatever.pug. You reference them in Laravel like normal:

  • Laravel 4 : View::make('home.whatever') for app/views/home/whatever.pug
  • Laravel 5 : view('home.whatever') for resources/views/home/whatever.pug

The Pug view files can work side-by-side with regular PHP views. To use Blade templating within your Pug, just name the files with .pug.blade or .pug.blade.php extensions. This feature is designed for transition purpose, since every blade features are available in pug, you would not need both. And be aware that this mode will first render your template with pug, then give the output to render to blade, it means your template must have a valid pug syntax and must render a valid blade template. This also means blade directives are only available through pug text output, see the example below:

| @if ($one === 1)
div $one = 1
| @endif
p {{ $two }}

If you render this with the following values: ['one' => 1, 'two' => 2], you will get:

<div>$one = 1</div>
<p>2</p>

PS: note that you would get the same output with the following pure pug code:

if one === 1
  div $one = 1
p=two

Use in Lumen

Register the service in bootstrap/app.php (Register Service Providers section is the dedicated place):

$app->register(Bkwld\LaravelPug\ServiceProvider::class);

Then you can use it with view():

$router->get('/', function () use ($router) {
    // will render resources/views/test.pug
    return view('test', [
        'name' => 'Bob',
    ]);
});

Troubleshooting

If your .pug files are not rendered, you can check if the provider is set. It's always the case with Laravel 5+. In older version our automated script should add it automatically. If it fails for some reason, it should display an error in your console when you execute a composer install, require or update command. But you still can add it manually:

  • Laravel 4: You must have a 'providers' => array() entry in your /app/config/app.php file (create it if not). And add 'Bkwld\LaravelPug\ServiceProvider', in this array.
  • Laravel 5: You must have a 'providers' => [] entry in your /config/app.php file (create it if not). And add Bkwld\LaravelPug\ServiceProvider::class, in this array.

Configuration

All Pug.php options are passed through via a Laravel config array file you can edit according to your Laravel version:

  • Laravel 4: /app/config/packages/bkwld/laravel-pug/config.php
  • Laravel 5: /config/laravel-pug.php

If for any reason, the config file is missing, just run the following command:

  • Laravel 4: php artisan config:publish bkwld/laravel-pug
  • Laravel 5: php artisan vendor:publish --provider="Bkwld\LaravelPug\ServiceProvider"

Extending Layouts / Include Sub-views

Default root directory for templates is resources/views, so from any template any deep in the directory, you can use absolute paths to get other pug files from the root: extends /layouts/main will extends the file resources/views/layouts/main.(pug|jade), include /partial/foo/bar, will include resources/views/partial/foo/bar.(pug|jade). You can use the basedir option to set the root to an other directory. Paths that does not start with a slash will be resolved relatively to the current template file.

History

Read the Github project releases for release notes.