lokhman/silex-autoreload

Silex 2.0+ service provider for AutoReload functionality

2.0.1 2017-03-06 09:23 UTC

Requires

• ext-apcu: *
• silex/silex: ~2.0
• symfony/finder: ^3.2

MIT

• Alexander Lokhman

• silex
• tools
• autoreload

README

AutoReload functionality service provider for Silex 2.0+ micro-framework.

This project is a part of silex-tools library.

Installation

You can install silex-autoreload with Composer:

composer require lokhman/silex-autoreload

Documentation

Simple service provider for page auto-reload functionality. It will embed small JavaScript file into every page with text/html content type, that will reload the page once any (as per configuration) file in the tree is updated. Supports directories, file name patterns and path exclusions.

use Lokhman\Silex\Provider\AutoReloadServiceProvider;

$app->register(new AutoReloadServiceProvider(), [
    'autoreload.interval' => 60,
    'autoreload.uri' => '/__autoreload',
    'autoreload.js_uri' => '/__autoreload.js',
    'autoreload' => [
        'dirs' => ['/dir/to/watch1', '/dir/to/watch2'],
        'files' => ['*.twig', '*.css', '*.js'],
        'exclude' => ['node_modules'],
    ],
]);

Module can be switched off with setting autoreload parameter to false.

Requires APCu extension enabled and Symfony Finder library.

License

Library is available under the MIT license. The included LICENSE file describes this in detail.