Registry / devops / filewatcher-webpack-plugin

filewatcher-webpack-plugin

library1.2.0jsnpmunverified

Webpack plugin that watches files and folders outside webpack's default watch scope using glob patterns. Version 1.2.0. It relies on chokidar for file system monitoring and triggers webpack recompilation when glob-matched files change. Unlike similar plugins (e.g., file-watcher-webpack-plugin, webpack-watch-files-plugin), this one supports recursive directory watching, custom event handlers via chokidar's API, and granular ignore patterns. The package is ESM-only. Note: The plugin's constructor expects an object with a 'watchFileRegex' property (string or array of strings). Common issues include incorrect require style (CJS vs ESM) and misconfiguring the watch path glob (must be relative to the project root).

devops http-networking web-framework

npm install filewatcher-webpack-plugin

github ↗package ↗

INSTALL

IMPORT

SIG · FILEWATCHER-WEBPAC

filewatcher-webpack-plugin

devopsjavascriptv1.2.0

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–226 runs

build_error

glibc

node 18–226 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

default

✓ import FileWatcherPlugin from 'filewatcher-webpack-plugin'

✗ const FileWatcherPlugin = require('filewatcher-webpack-plugin')

Since v1.0.0, the package is ESM-only. CommonJS require() will fail.

FileWatcherPlugin (if named)

✓ import { FileWatcherPlugin } from 'filewatcher-webpack-plugin'

✗ import FileWatcherPlugin from 'filewatcher-webpack-plugin'

The package exports a default export, not a named one. Named import will be undefined.

type imports

✓ import type { FileWatcherPluginOptions } from 'filewatcher-webpack-plugin'

TypeScript definitions are included since v1.1.0. The options type is exported for convenience.

Configures the plugin in a webpack config file, watching JS and CSS files outside webpack's default watch scope.

// webpack.config.js import FileWatcherPlugin from 'filewatcher-webpack-plugin'; export default { // ... other config plugins: [ new FileWatcherPlugin({ watchFileRegex: ['./src/scripts/**/*.js', './src/styles/**/*.css'], // Optional chokidar options: ignored: /node_modules/, ignoreInitial: true }) ] };

Debug

Known issues

breakingThe package switched from CJS to ESM in v1.0.0, breaking all require() calls.

fix

Change require() to import statements (ESM) or use a dynamic import wrapper.

affects: >=1.0.0

deprecatedConstructor argument 'watchFileRegex' is required but its name is misleading (it accepts strings/arrays, not RegExp objects).

fix

Use a string glob pattern like './dir/**/*.js' — not a RegExp literal.

affects: all

gotchaThe plugin does not automatically ignore node_modules; you must set 'ignored' option explicitly to avoid performance issues.

fix

Add `ignored: /node_modules/` to the constructor options.

affects: all

gotchaRelative paths in 'watchFileRegex' are resolved from the project root (current working directory), not from the webpack config location.

fix

Use absolute paths or paths relative to process.cwd().

affects: all

deprecatedAs of webpack 5, the 'watchRun' hook signature changed, and some older versions of this plugin may not be compatible.

fix

Update to v1.2.0+ which explicitly supports webpack 5.

affects: >=1.0.0 <1.2.0

Errors

Common errors & fixes

Error: Cannot find module 'filewatcher-webpack-plugin'

Using CommonJS require() on an ESM-only package.

fix

Switch to import statement: `import FileWatcherPlugin from 'filewatcher-webpack-plugin'`

TypeError: Class constructor FileWatcherPlugin cannot be invoked without 'new'

Importing the default export incorrectly (e.g., destructuring it).

fix

Use `new FileWatcherPlugin(...)` after default import, not `new (await import(...)).FileWatcherPlugin(...)`.

The 'watchFileRegex' option must be a string or an array of strings.

Passing a RegExp object instead of a glob string.

fix

Use glob patterns (e.g., './**/*.js') not RegExp (e.g., /\.js$/).

No changes detected after file save

The watched path is incorrect or ignored by 'ignored' option.

fix

Verify absolute/relative path and ensure 'ignored' does not cover the target files.

Upgrade

Version history

1.2.0latest on npm

Audit

Dependencies

webpackrequiredProvides the compiler hooks (e.g., 'watchRun') that the plugin uses to attach the watcher.

chokidarrequiredUsed to monitor file system changes; all of the plugin's underlying file-watching functionality depends on chokidar.

Agent activity

6 hits · last 30 days

node

Resources

githubhttps://github.com/sap9433/filewatcher-webpack-plugin ↗

packagehttps://www.npmjs.com/package/filewatcher-webpack-plugin ↗