manferlo81/rollup-plugin-spawn-process

README

rollup-plugin-spawn-process

A rollup plugin to spawn a process

Install

Using npm

npm install rollup-plugin-spawn-process

Using yarn

yarn add rollup-plugin-spawn-process

Usage

// rollup.config.js

import { spawnProcess } from 'rollup-plugin-spawn-process';

export default {
  ...
  plugins: [
    spawnProcess({ ...options }),
  ],
  ...
};

See the Options section for available options.

Options

command

string
default "node"

The command to be passed to the spawn method.

file

string | null
default <bundleOutputFile>

A file path to be passed as first argument to the spawn method.

If not specified, the plugin will try to find the output file of your bundle.

If set explicitly to null it will ignore the file and pass only the arguments set by the args option.

args

string[]
default []

Extra arguments to be passed to the spawn method after the file path specified with the file option.

key

string
default "spawn-process"

The key to be used to store the process into the plugin context. This option is required when you have more than one instance of the plugin and you are using a global context, it tells the plugin what process to cleanup and kill.

global

boolean | string

Whether or not to use a global variable to store the plugin context.

If a string is passed it will be used as a key to store the plugin context into the global scope otherwise "ROLLUP_PLUGIN_SPAWN_PROCESS_CONTEXT" will be used.

If not specified the plugin will infer the correct value base on process.env.ROLLUP_WATCH environment variable.

The reason behind this option

When rollup is in watch mode and rollup.config.js is modified rollup will reload the config file causing plugins to be recreated, it causes the plugin context to be recreated as well, and since the previous process was stored in the previous local plugin context it wont be detected, nor passed to the cleanup method, nor killed before the new one is created, which will result in multiple instances of the running process.

events

{ [event: string]: EventListener };
Array<{ event: string, listener: EventListener }>;

An object or array with a series of event listeners to be added to the process.

Use the array notation if you need to add the events in a particular order. Events will be removed in the reverse order they were added.

Events defined with this option will be automatically added after the process is created, right before setup is called, and removed before it is killed, right after cleanup is called.

setup

function (process: ChildProcess): void

A function to be called after a new process has been created. It will be called after all events has been attached. It will receive the new process as only argument.

cleanup

function (process: ChildProcess): void

A function to be called before a new process is created. It will be called right before all events are detached (removed) and the current process is killed. It will receive the current process as only argument.

LICENSE