Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/imcuttle/simple-hot-reload-server
simple hot reload server by nodejs
https://github.com/imcuttle/simple-hot-reload-server
hot-reload nodejs server
Last synced: 29 days ago
JSON representation
simple hot reload server by nodejs
- Host: GitHub
- URL: https://github.com/imcuttle/simple-hot-reload-server
- Owner: imcuttle
- License: mit
- Created: 2017-03-28T16:06:28.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2022-01-07T14:58:14.000Z (about 3 years ago)
- Last Synced: 2024-04-09T11:32:18.089Z (10 months ago)
- Topics: hot-reload, nodejs, server
- Language: JavaScript
- Homepage:
- Size: 122 KB
- Stars: 22
- Watchers: 2
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: Readme.md
- License: License
Awesome Lists containing this project
README
# Simple Hot Reload Server
[](https://www.npmjs.com/package/simple-hot-reload-server)
[中文文档点这](https://imcuttle.github.io/say-goodbye-to-manual-refresh)
Set up a server for frontend files(html/css/js/favicon) & Watch frontend files.
connected server and client by WebSocket.
## Feature
- **Hot Reload**
- **Debugger**
- **Files View (Easy to open page in root)**
`http://localhost:8082/__hrs__/file`
- **Source Map Preview**
1. Single
`http://localhost:8082/index.html.hrs.map`
```json
{
"/Users/moyu/my-code/JavaCode/dike/js/jquery-1.9.1.js": "../../js/jquery-1.9.1.js",
"/Users/moyu/my-code/JavaCode/dike/js/bootstrap.js": "../../js/bootstrap.js",
"/Users/moyu/my-code/JavaCode/dike/js/navbar.js": "../../js/navbar.js",
"/Users/moyu/my-code/JavaCode/dike/css/font-awesome.min.css": "../../css/font-awesome.min.css",
"/Users/moyu/my-code/JavaCode/dike/css/navbar.css": "../../css/navbar.css",
"/Users/moyu/my-code/JavaCode/dike/css/conceptModel.css": "../../css/conceptModel.css",
"/Users/moyu/my-code/JavaCode/dike/css/dropzone/dropzone.css": "../../css/dropzone/dropzone.css"
}
```
2. Total
`http://localhost:8082/__hrs__/map`
- **Forward Request**
`http://localhost:8082/__hrs__/forward?url=http://blog.moyuyc.xyz/head.jpg`
- **Config**
Be Named `hrs.config.js` on current work directory.
```js
module.exports = {
proxy: {
"/api": {
target: "http://www.huya.com/longdd",
},
"/php": {
redirect: true, // default: true
target: "http://localhost:63343/start/static",//"http://localhost:6999",
changeHost: true, // default: true
hot: true, // hot reload enable? default: false
// Function/RegExp: will be set root config hotRule if it is null
hotRule: function (filename, request) {
// console.log(request.url);
return /\.(php)$/.test(filename);
},
// Function: return local file path
mapLocal: function (request) {
// request: Express Request Object
// console.log('mapLocal', request.originalUrl, request.baseUrl, request.url);
const url = request.url.replace(/\?[\s\S]*/, '')
return "/Users/moyu/my-code/phpCode/start/static" + url;
},
// Function/String: return detected directory path
mapRoot: function (request) {
// request: Express Request Object
return "/Users/moyu/my-code/phpCode/start/static";
}
},
},
// RegExp or function (filename) {...}
hotRule: /\.(html|htm)$/, // default: /\.(html|htm)$/
setUp: function (app) {
/* app is an express server object. */
// http://localhost:8082/test
app.get('/test', function (req, res) {
res.end("TEST!");
});
}
};
```
## Install
```bash
npm install -g simple-hot-reload-server
```
```text
Usage: hrs [-p port] path
Options:
-v --version get current version.
-p --port set port of server. (default: 8082)
-c --config config path. (default hrs.config.js)
-h --help how to use it.
```
## Others
**Support Local Server**
*Importance: Only support files which filename ends with `.html/.htm` or is required by html/htm*
1. set up an node server
```bash
hrs path/to/front/root
```
2. open html in address
```
http://localhost:8082/where?dubug=true&reload=true
```
`debug`: whether `console.log/error/...` on browser could print on node server. **default: false**
`reload`: whether reload when file changed. **default: true**
**Support CORS**
*Importance: support all files (php/jsp/asp...)*
1. set up an node server
```bash
hrs
```
2. insert script in HTML manually.
```html
```
`hrs-local`: map to local html file
`hrs-root`: node server detect the directory for hot reload.