the-forest/client/node_modules/webpack/lib/WatchIgnorePlugin.js

154 lines
3.9 KiB
JavaScript
Raw Normal View History

2024-09-17 20:35:18 -04:00
/*
MIT License http://www.opensource.org/licenses/mit-license.php
Author Tobias Koppers @sokra
*/
"use strict";
const { groupBy } = require("./util/ArrayHelpers");
const createSchemaValidation = require("./util/create-schema-validation");
/** @typedef {import("../declarations/plugins/WatchIgnorePlugin").WatchIgnorePluginOptions} WatchIgnorePluginOptions */
/** @typedef {import("../declarations/WebpackOptions").WatchOptions} WatchOptions */
/** @typedef {import("./Compiler")} Compiler */
/** @typedef {import("./util/fs").TimeInfoEntries} TimeInfoEntries */
/** @typedef {import("./util/fs").WatchFileSystem} WatchFileSystem */
/** @typedef {import("./util/fs").WatchMethod} WatchMethod */
/** @typedef {import("./util/fs").Watcher} Watcher */
const validate = createSchemaValidation(
require("../schemas/plugins/WatchIgnorePlugin.check.js"),
() => require("../schemas/plugins/WatchIgnorePlugin.json"),
{
name: "Watch Ignore Plugin",
baseDataPath: "options"
}
);
const IGNORE_TIME_ENTRY = "ignore";
class IgnoringWatchFileSystem {
/**
* @param {WatchFileSystem} wfs original file system
* @param {WatchIgnorePluginOptions["paths"]} paths ignored paths
*/
constructor(wfs, paths) {
this.wfs = wfs;
this.paths = paths;
}
/** @type {WatchMethod} */
watch(files, dirs, missing, startTime, options, callback, callbackUndelayed) {
files = Array.from(files);
dirs = Array.from(dirs);
/**
* @param {string} path path to check
* @returns {boolean} true, if path is ignored
*/
const ignored = path =>
this.paths.some(p =>
p instanceof RegExp ? p.test(path) : path.indexOf(p) === 0
);
const [ignoredFiles, notIgnoredFiles] = groupBy(
/** @type {Array<string>} */
(files),
ignored
);
const [ignoredDirs, notIgnoredDirs] = groupBy(
/** @type {Array<string>} */
(dirs),
ignored
);
const watcher = this.wfs.watch(
notIgnoredFiles,
notIgnoredDirs,
missing,
startTime,
options,
(err, fileTimestamps, dirTimestamps, changedFiles, removedFiles) => {
if (err) return callback(err);
for (const path of ignoredFiles) {
/** @type {TimeInfoEntries} */
(fileTimestamps).set(path, IGNORE_TIME_ENTRY);
}
for (const path of ignoredDirs) {
/** @type {TimeInfoEntries} */
(dirTimestamps).set(path, IGNORE_TIME_ENTRY);
}
callback(
null,
fileTimestamps,
dirTimestamps,
changedFiles,
removedFiles
);
},
callbackUndelayed
);
return {
close: () => watcher.close(),
pause: () => watcher.pause(),
getContextTimeInfoEntries: () => {
const dirTimestamps = watcher.getContextTimeInfoEntries();
for (const path of ignoredDirs) {
dirTimestamps.set(path, IGNORE_TIME_ENTRY);
}
return dirTimestamps;
},
getFileTimeInfoEntries: () => {
const fileTimestamps = watcher.getFileTimeInfoEntries();
for (const path of ignoredFiles) {
fileTimestamps.set(path, IGNORE_TIME_ENTRY);
}
return fileTimestamps;
},
getInfo:
watcher.getInfo &&
(() => {
const info =
/** @type {NonNullable<Watcher["getInfo"]>} */
(watcher.getInfo)();
const { fileTimeInfoEntries, contextTimeInfoEntries } = info;
for (const path of ignoredFiles) {
fileTimeInfoEntries.set(path, IGNORE_TIME_ENTRY);
}
for (const path of ignoredDirs) {
contextTimeInfoEntries.set(path, IGNORE_TIME_ENTRY);
}
return info;
})
};
}
}
class WatchIgnorePlugin {
/**
* @param {WatchIgnorePluginOptions} options options
*/
constructor(options) {
validate(options);
this.paths = options.paths;
}
/**
* Apply the plugin
* @param {Compiler} compiler the compiler instance
* @returns {void}
*/
apply(compiler) {
compiler.hooks.afterEnvironment.tap("WatchIgnorePlugin", () => {
compiler.watchFileSystem = new IgnoringWatchFileSystem(
/** @type {WatchFileSystem} */
(compiler.watchFileSystem),
this.paths
);
});
}
}
module.exports = WatchIgnorePlugin;