reloaded-vibes 0.2.0

🔄 Smart auto-reloading service and server for web development


To use this package, run the following command in your project's root directory:

Manual usage
Put the following dependency into your project's dependences section:

InfoReference

Reloaded Vibes D Code Club - Discord server

Reloaded Vibes is a smart auto-reloading service and server for (web) development.

It watches a directory for changes and notifies web browsers (or other client applications) through its WebSocket server. This way those clients can respond to the change and e.g. reload the page so that they'll display the recent changes made by the user.

Are you're tired of hitting the refresh button again and again while developing?

Then Reloaded Vibes is the app you're looking for: It watches your project for changes and automatically triggers a refresh in your web browser. Moreover, it's possible to execute command lines before. This allows to schedule the runs of preprocessors (like Sass or Less) and source compilers or any other apps and scripts.

Plain and simple

This is Reloaded Vibes main design goal. It's achieved by not using complicated config or recipe files. Instead everything is configured by command line arguments.

What's more?

It features a built-in webserver for serving static files. Utilizing it's script-injection feature it can automatically insert the script loader into your HTML pages, so you don't have to take care of it manually.

Usage

Command line

./rlv --watch=<DIRECTORY TO WATCH> --action=<COMMANDLINE>
OptionExample valuesExplanation
--watch=<DIR>source, ../Directories to watch changes.
--action=<CMD>"npm run build",
./myScript.sh		Command lines to execute before triggering a refresh.

Visit http://<SOCKET NOTIFICATION SERVICE>/test to try it out on the test page.

Multiple directories or actions
./rlv --watch=<DIR_1> --watch=<DIR_2> --action=<CMD_1> --action=<CMD_2>

Just specify the respective arguments multiple times.

Custom socket for the notification service
./rlv --watch=<DIRECTORY TO WATCH> --socket=<SOCKET>
OptionExample valuesExplanation
--socket=<SOCKET>127.0.0.1:3001,
[::1]:3001		Socket to bind the notification service to.
Built-in webserver
./rlv --watch=<DIRECTORY TO WATCH> --webserver=<SOCKET> --htdocs=<DOCUMENT ROOT>
OptionExample valuesExplanation
--webserver=<SOCKET>127.0.0.1:3002,
[::1]:3002		Socket to bind the built-in webserver to.
--htdocs=<DIR>public/,
/var/www/mysite		Document root path for the built-in webserver.
--noinjectDisables injection of the script loader.
Automatic script-injection

Injects a script loader (<script></script>) into HTML files that allows the automatical setup of Reloaded Vibes. Those will need a .html file extension, plus a </body> closing tag.

This feature is enabled by default for the built-in webserver. Pass --noinject to disable it.

No service ("offline") mode

Use Reloaded Vibes to execute commands on changes - with networking disabled. 

./rlv --watch=<DIRECTORY TO WATCH> --action=<COMMANDLINE> --noservice
OptionExample valuesExplanation
--noserviceDisables to notification service. Reloaded Vibes will still watch for changes and execute the specified actions.

Website

Copy the following code into your webpage's HTML <body> and adjust the URL specified in the src attribute. 

<script src="http://<NOTIFICATION SERVICE>/reloaded-vibes.js"></script>

You can also open the notification service's index page in your browser and copy the pre-configured <script> tag from there.

Alternative: see the automatic script-injection of the built-in webserver.

Setup

Prerequisites

  1. Install your favorite D compiler
  2. Check whether DUB came bundled with it. If not, install DUB.

Build

git clone https://github.com/voidblaster/reloaded-vibes.git
cd reloaded-vibes
dub build --build=release

You can find the built executable inside the bin/ directory

Acknowledgements

  • rejectedsoftware
    • vibe.d
      • vibe.d is a high-performance asynchronous I/O, concurrency and web application toolkit written in D.
      • License: MIT
      • Copyright (c) 2012-2019, rejectedsoftware e.K.
  • Jan Jurzitza (@WebFreak001)
    • FSWatch
      • A cross-platform folder & file watching library using win32, inotify or std.file
      • License: BSL-1.0
      • Copyright © 2016, webfreak
  • Viktor (@dayllenger)

Packaging

Please note that while the source code of Reloaded Vibes itself is available under the Boost Software License 1.0, its dependency vibe.d is licensed under the terms of the MIT public license that also affects the final binary. Ask your laywer for an explanation or details.

Authors:
  • Elias Batek (0xEAB)
Dependencies:
vibe-d:tls, vibe-d:core, fswatch, vibe-d:http
Versions:
0.2.0 2019-May-29
0.1.2 2019-May-13
0.1.1 2019-May-13
0.1.0 2019-May-13
~master 2021-Nov-07
Show all 5 versions
Download Stats:

  • 0 downloads today

  • 0 downloads this week

  • 0 downloads this month

  • 23 downloads total

Score:
1.0
Short URL:
reloaded-vibes.dub.pm