npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

webpack-node-dev

v0.4.0

Published

Run a node-process built by webpack with automatic restart

Downloads

170

Readme

webpack-node-dev

Monitor your webpack-built node process during development. Somewhat like nodemon, except hooked directly into webpack instead of watching for file changes.

Installation

npm i -D webpack-node-dev

Running from commandline

webpack-node-dev [--config <webpack-config-path>].

  • --config, -c: The path to the webpack config file. Default is webpack.config.js.

Configuration can be specified as nodeDev in the webpack config-file.

Running programatically

The only export is a function for starting webpack in watch-mode and running/monitoring the node process. It takes the webpack config object as argument. Configuration can be specified as nodeDev in the webpack config-file or as a second argument to the function.

const nodeDev = require('webpack-node-dev')

nodeDev(webpackConfig, {
    // Settings
})

Configuration

Common concepts

StartupOptions: {
    debug: boolean,
    [key:string]: any,
}

Current settings for running the node process. The core script only recognizes the debug property, but other properties can be added freely and are passed to the onStart, getEnvironment, getArguments, onInput, onClose, onCompile.

debug toggles the node --inspect flag for the process.


StartProcess: (options?: Partial<StartupOptions>) => void

Supplied as argument to relevant events. Terminates the running node instance if one exists, then starts the process again.

StartupOptions can be changed by passing an object as argument.

Properties

defaultStartupOptions: StartupOptions

The StartupOptions used to first start the node process.

Default value:

{ debug: false }

onStart: (
    startProcess: StartProcess,
    options: StartupOptions,
) => void

Called whenever the process has been started. Useful for livereload-like scenarios. Can trigger a restart for API consistency, although it would probably be best not to, since it may cause a restart-loop.

Default value:

() => {}

waitForOutput: boolean

Delay calling onStart until output has been written to stdout. Useful for servers that have to run setup before being available.

Default value:

false

onClose: (
    reason: 'kill' | 'clean' | 'crash',
    startProcess: StartProcess,
    options: StartupOptions,
) => void

Called whenever the node process closes. It takes an enum-string indicating what caused the process closure:

  • 'kill': A call to StartProcess
  • 'clean': Process exited with code 0
  • 'crash': Process exited with non-zero code

Info about the closure is logged no matter what. It allows restarting the process, but this should generally be left to onCompile to avoid restart-loops.

Default value:

(reason) => {
    switch (reason) {
        case 'kill':
            console.log(yellow('Process restarted..'))
            break
        case 'clean':
            console.log(yellow('Process exited cleanly, restarts on new compilation'))
            break
        case 'crash':
            console.log(red('Process crashed, restarts on new compilation'))
            break
    }
}

onInput: (
    input: string,
    startProcess: StartProcess,
    options: StartupOptions,
) => void

Called whenever input is written to the terminal with the trimmed input-string. The default implementation recognizes rs and restart for restarts with same options and debug/normal to toggle the --inspect flag. You can basically put any convinient code in here though, such as generating tokens for a given id.

Default value:

(input, startProcess) => {
    switch (input) {
        case 'rs':
        case 'restart':
            startProcess()
            break
        case 'debug':
            startProcess({ debug: true })
            break
        case 'normal':
            startProcess({ debug: false })
            break
    }
}

onCompile: (
    error: WebpackWatchError,
    stats: WebpackStats,
    startProcess: StartProcess,
    options: StartupOptions,
) => void

Called whenever webpack compiles. The default implementation logs the result of the compilation and restarts the node process if there were no errors.

Default value:

(error, stats, startProcess) => {
    if (error) {
        console.log(red('Webpack compilation error'), error)
    } else if (stats.hasErrors()) {
        console.log(stats.toString({ chunks: false, colors: true }))
    } else {
        console.log(stats.toString({ chunks: false, colors: true }))

        startProcess()
    }
}

getEnvironment: (
    options: StartupOptions
) => { [key: string]: string }

Enhance the environment variables of the node process. Besides anything returned here, process.env is included, as well as FORCE_COLOR for chalk if color is supported. These can be overwritten by what is returned.

Default value:

() => ({})

getArguments: (
    options: StartupOptions
) => Array<string>

Add additional CLI arguments to the process.

Default value:

() => []

entrypoint: string | null

Scriptfile to run. If not set, webpackConfig.output.filename is used.

Default value:

null

cwd: string | null

Current working directory for the node proess. If not set, webpackConfig.output.path is used.

Default value:

null

terminationDelay: number | null

How long to wait (ms) after sending SIGINT until sending SIGKILL to the node process.

Set to 0 to send SIGKILL immediately instead of SIGINT.

Set to null to disable.

Default value:

2000