elephfront/robo-live-reload

Live reload mechanism for the Robo task runner when using it as a template builder

Robo Live Reload

, _(*1)

This Robo task starts a Live Reload server when using Elephfront., _(*2)

If you use the base Elephfront skeleton, it will be fired up when you start the serve command. Whenever you edit a file, it will trigger the related commands and triggers a refresh in the browsers connected to the Elephfront server. For instance, if you edit a SASS file, it will compile the SASS source to CSS, minify the results and automatically trigger a refresh in your browser., _(*3)

The Live Reload server is powered by compilation using the ratchetphp/Ratchet using a WebSocket server., _(*4)

You can of course use it outside of an Elephfront project., _(*5)

Requirements

• PHP >= 7.1.0
• Robo

Installation

You can install this Robo task using composer., _(*6)

The recommended way to install composer packages is:, _(*7)

composer require elephfront/robo-live-reload

Implementation

In order to work, this task needs two things :, _(*8)

• to launch a Live Reload server : this will be done by the elephfront-robo-live-reload file in the bin directory
• a javascript file that will connect your page to the Live Reload server and listen to message that will force the browser the reload. You will need to include this file (either manually or automatically) in your HTML pages. If you are using the Elephfront project skeleton, this file will automatically be added by the router at the end of your pages.

Using the task

You can load the task in your RoboFile using the LoadLiveReloadTaskTrait trait:, _(*9)

use Elephfront\RoboLiveReload\Task\Loader\LoadLiveReloadTaskTrait;

class RoboFile extends Tasks
{

    use LoadLiveReloadTaskTrait;

    public function someTask()
    {
        $this
            ->taskLiveReload()
            ->run();
    }
}

The LiveReload task has some utility methods that will give you the ability to customize the server launched., _(*10)

host()

Gives you the ability to change the host the server will be hosted on. By default : 127.0.0.1., _(*11)

port()

Gives you the ability to change the port the server will be hosted on. By default : 22222., _(*12)

bin()

Gives you the ability to change the bin path where the script that will start the Live Reload server is located. By default : vendor/bin., _(*13)

jsPath()

Gives you the ability to change the path where the javascript file needed to make the browser listen to the Live Reload server and force the refresh will be located. By default, it will put it in the expected location of the build directory of an Elephfront project : build/system/LiveReload/assets/js/livereload.js. Based on your project setup, you may have to customize this value., _(*14)

Notifying the LiveReload server

To send a message to the Live Reload server so it can propagate it to the browser and the reload triggered, you can use the sendReloadMessage() of the task::, _(*15)

use Elephfront\RoboLiveReload\Task\Loader\LoadLiveReloadTaskTrait;

class RoboFile extends Tasks
{

    use LoadLiveReloadTaskTrait;

    public function someTask()
    {
        $this
            ->taskLiveReload()
            ->run();

        // Further down...
        $this
            ->taskLiveReload()
            ->sendReloadMessage();
    }
}

This will send a "reload" message to the Live Reload server. If you load the livereload.js file created by the task, your browser will automatically reload when this message is received.
Typically, you will use this method when using a "watch" behavior so a reload can be triggered after your watch handler has been executed., _(*16)

If you want to send another message to extend the behavior of the Live Reload server, you can have access to the WebSocket client using the getWsClient() method and send the message you want :, _(*17)

use Elephfront\RoboLiveReload\Task\Loader\LoadLiveReloadTaskTrait;

class RoboFile extends Tasks
{

    use LoadLiveReloadTaskTrait;

    public function someTask()
    {
        $this
            ->taskLiveReload()
            ->run();

        // Further down...
        $this
            ->taskLiveReload()
            ->getWsClient()
            ->send('your-message');
    }
}

Contributing

If you find a bug or would like to ask for a feature, please use the GitHub issue tracker. If you would like to submit a fix or a feature, please fork the repository and submit a pull request., _(*18)

Coding standards

This repository follows the PSR-2 standard., _(*19)

License

Copyright (c) 2017, Yves Piquel and licensed under The MIT License. Please refer to the LICENSE.txt file., _(*20)