@kamikai/live-reload

Current Version

v0.1.5

Introduction

This is a package to provide livereload for IIS, Apache2, Abyss, etc.

It generates a live-reload.js that you can include in your pages, for providing live-reload to it.

This package serves a WebSocket server on desired port that you can set with inline arguments or a JSON Config File

Right now it only ignores "/logs" directory under any subdirectory level of your application, in a future version you should be able to provide additional filters.

Getting Started

Installation

You can install this package using the command bellow

npm install -g @kamikai/live-reload

Usage

Using command line parameters

You can start this package with one of the commands bellow:

livereload-foryou

# Or the shortened version

lr4u

Parameter	Description
--port <portNumber>	Changes the port the WebSocket should listen to. If serverStatic is enabled it will be served at the same port.
-p <portNumber>
--js-path <path>	Relative path where the live-reload.js should be saved to
-js <path>
--watch-dir <path>	Default is current working directory
-w <path>
--serve-static	Default is false enables serving of static files
--serve-static-root <path>	Default is the same as watchDirectoryPath
--ignore-path <path>	Allow multiple | Add path to ignore list.
--config-file	Default is livereload.config.json

You can use the arguments above, like so:

lr4u --port 3030

# Or

livereload-foryou -p 3030 -js js

Using a JSON Config File

If you want to use a JSON Config File instead, so that you can just run lr4u for example and always listen in the same port for each project.

Then, you should add a live-reload.config.json under the root(public) of your project directory and run the package's CLI from there.

And it's content should be like so:

{
    "port": 17655,
    "locationForJSFile": "js",
    "watchDirectoryPath": "."
}

If you want to serve static files for your project, you can add this to your live-reload.config.json:

{
    "staticServe":{
        "enabled": true,
        "root": "public"
    }
}

If you want to add ignore paths to your, you can add this to your live-reload.config.json:

{
    "ignorePaths": ["images/*", "tmp/*"]
}

IMPORTANT: The "logs" directory is always ignored, and also some common config files such as: .gitignore, .dockerignore, .eslintrc*, Dockerfile, package.json, package-lock.json, yarn.lock

After setting up the JSON Config File as mentioned, you should just open a shell under the same directory and run

livereload-foryou

Or the shortened version

lr4u