@fal-works/chokidar-incremental

Wrapper around chokidar for incremental build process.

Usage no npm install needed!

<script type="module">
  import falWorksChokidarIncremental from 'https://cdn.skypack.dev/@fal-works/chokidar-incremental';
</script>

README

chokidar-incremental

Wrapper around chokidar for incremental build process.

Might be useful for cases where you'd like to set callbacks depending on the result of the initial run, e.g. calling any rebuild function, which is derived from the initial build, for each file change.

It also displays the time taken to execute the onStart/onChange callback.

Usage

import { watch } from "@fal-works/chokidar-incremental";

watch(paths, onStart, options);

  • paths: Glob pattern(s), just like chokidar.watch().

  • onStart (async): Called once when ready.
    Should return onChange (async) and onExit (optional).

  • options (optional):

    • onStartMessage: message factory for onStart.
    • onChangeMessage: message factory for onChange.
    • chokidarOptions: options for the original chokidar API.

See type declaration for details.

Console output

Looks like this:

Initial run > Done. (17 ms)
Watching files for changes...
Changed src\setup.ts > Done. (10 ms)
Changed src\setup.ts > Done. (13 ms)
Changed src\main.ts > Done. (14 ms)
Stop watching.