https://github.com/lokhman/silex-autoreload

Silex 2.0+ service provider for AutoReload functionality
https://github.com/lokhman/silex-autoreload

autoreload silex tools

Last synced: about 2 months ago
JSON representation

Silex 2.0+ service provider for AutoReload functionality

• Host: GitHub
• URL: https://github.com/lokhman/silex-autoreload
• Owner: lokhman
• License: mit
• Created: 2017-01-24T12:27:31.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2017-03-09T12:42:07.000Z (over 9 years ago)
• Last Synced: 2025-12-14T16:24:01.170Z (7 months ago)
• Topics: autoreload, silex, tools
• Language: PHP
• Homepage: https://lokhman.github.io/silex-autoreload/
• Size: 4.88 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# silex-autoreload

[![StyleCI](https://styleci.io/repos/79909479/shield?branch=master)](https://styleci.io/repos/79909479)

AutoReload functionality service provider for [**Silex 2.0+**](http://silex.sensiolabs.org/) micro-framework.

> This project is a part of [`silex-tools`](https://github.com/lokhman/silex-tools) library.

## Installation

You can install `silex-autoreload` with [Composer](http://getcomposer.org):

    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`](http://php.net/manual/en/book.apcu.php) extension enabled and

[`Symfony Finder`](https://github.com/symfony/finder) library.

## License

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