Git Product home page Git Product logo

node-hot's Introduction

๐Ÿ”ฅ node-hot

node-hot is a Node.js package that will automatically monitor and hot reload modules (stuff that you require).

Based on this article by Kenneth Chung.

Installation

npm install --save-dev node-hot

Usage

// --- main.js ---

// Will only hot reload after this
require('node-hot')
    // Globally configure node-hot (optional)
    .configure({
        // Disable logging (default: false)
        silent: true,

        // Automatically patch all exported classes (default: false)
        patchExports: true,

        // Exclude patterns (default: node_modules)
        exclude: [
            /[\/\\]node_modules[\/\\]/,
            /[\/\\]bower_components[\/\\]/,
            /[\/\\]jspm_packages[\/\\]/
        ]
    });

// Main/entry module can't be reloaded, hence the extra file
require('./app');
// --- app.js ---

class Foo {}
let foo;

if (module.hot) {
    // Reload this module and its dependencies, when they change (optional)
    module.hot.accept();

    // Gets called before reload (optional)
    module.hot.store(stash => {
        stash.foo = foo;
    });

    // Gets called after reload, if there was a store (optional)
    module.hot.restore(stash => {
        foo = stash.foo;
    });

    // Replaces class methods and accessors (optional)
    module.hot.patch(Foo);
}

if (!foo) {
    foo = new Foo();
}

Once you modify a module on disk, node-hot recursively traverses the dependants of that module, looking for an accepting module. Once it finds that it will re-require that module.

You usually only need accept in one of your first modules to run. However, due to the main/entry module being treated differently from the rest by Node.js, you will not be able to accept from the main/entry module, meaning it can't be reloaded.

You can choose to omit accept entirely, in which case node-hot will automatically accept when it reaches a module with no dependants, which will most likely be the modules require'd by your main module.

License

See LICENSE.

node-hot's People

Contributors

mihe avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

node-hot's Issues

Update README.md

Hi, how are you?
This module was very useful for me, couldn't figure it out how to reload a babel-compiled (through babel-register) React APP without triggering webpack build twice (the first because of webpack-dev-middleware and the second because of babel-watch).
I've tried several ways and mainly I was getting frustrated.
Until I tried node-hot.
Simple code example:

  require('node-hot');

  app.use('*', (req, res) => {
    const serverApp = require('./src/server').default;
    res.send(ReactDOMServer.renderToString(React.createElement(serverApp)));
  })

Now I simply run node server.js and in every request I get the app reloaded.
It would very useful if you update the README.md including this feature.

Regards.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.