Automatically refresh and reload your code in your browser when your code changes. No browser plugins required.
Restarting your HTTP server and refreshing your browser is annoying.
Reload works in two different ways depending on if you're using it:
- In an existing Express application in which it creates a server side route for reload or,
- As a command line tool which starts its own Express application to monitor the file you're editing for changes and to serve
reload-client.jsto the browser.
Once reload-server and reload-client are connected, the client side code opens a WebSocket to the server and waits for the WebSocket to close, once it closes, reload waits for the server to come back up (waiting for a socket on open event), once the socket opens we reload the page.
npm install [-g] [--save-dev] reload
There are two different ways to use reload.
- In an Express application, allowing your whole project to utilize reload when the code is altered
- As a command line application to serve up static HTML files and be able to reload when the code is altered
When used with Express reload creates a new Express route for reload. When you restart the server, the client will detect the server being restarted and automatically refresh the page.
Reload can be used in conjunction with tools that allow for automatically restarting the server such as supervisor (recommended), nodemon, forever, etc.
server.js:
var express = require('express')
var http = require('http')
var path = require('path')
var reload = require('reload')
var bodyParser = require('body-parser')
var logger = require('morgan')
var app = express()
var publicDir = path.join(__dirname, 'public')
app.set('port', process.env.PORT || 3000)
app.use(logger('dev'))
app.use(bodyParser.json()) //parses json, multi-part (file), url-encoded
app.get('/', function(req, res) {
res.sendFile(path.join(publicDir, 'index.html'))
})
var server = http.createServer(app)
// Reload code here
reload(server, app)
server.listen(app.get('port'), function(){
console.log("Web server listening on port " + app.get('port'));
});public/index.html:
<!doctype html>
<html>
<head>
<title>Reload Express Sample App</title>
</head>
<body>
<h1>Reload Express Sample App12</h1>
<!-- All you have to do is include the reload script and have it be on every page of your project -->
<script src="/reload/reload.js"></script>
</body>
</html>Refer to the reload express sample app for this working example.
You can manually call a reload event by calling reload() yourself. An example is shown below:
reloadServer = reload(server, app);
watch.watchTree(__dirname + "/public", function (f, curr, prev) {
// Fire server-side reload event
reloadServer.reload();
});reload(httpServer, expressApp, [verbose])
httpServer: The Node.js http server from the modulehttp.expressApp: The express app. It may work with other frameworks, or even with Connect. At this time, it's only been tested with Express.verbose: If set to true, will show logging on the server and client side
There are two ways to use the command line application.
- In a directory serving blank static HTML files or
- In a project with a
package.jsonfile
Each will require different modes of installing.
In case one you should install reload globally with npm install reload -g. Also with reload installed globally you can go to any directory with an HTML file and use the command reload to constantly watch it and reload it while you make changes.
In case two you should install locally with npm install --save-dev, since this tool is to aid in development you should install it as a dev dependency.
Navigate to your html directory:
reload -b
This will open your index.html file in the browser. Any changes that you make will now reload in the browser. You don't need to modify your HTML at all.
Usage: reload [options]
Options:
-h, --help Output usage information
-V, --version Output the version number
-b, --browser Open in the browser automatically.
-n, --hostname If -b flag is being used, this allows for custom hostnames. Defaults to localhost.
-d, --dir [dir] The directory to serve up. Defaults to current dir.
-e, --exts [extensions] Extensions separated by commas or pipes. Defaults to html,js,css.
-p, --port [port] The port to bind to. Can be set with PORT env variable as well. Defaults to 8080
-s, --start-page [start-page] Specify a start page. Defaults to index.html.
-v, --verbose Turns on logging on the server and client side. Defaults to false.
(MIT License)
Copyright 2016, JP Richardson jprichardson@gmail.com