Merge pull request #7658 from mohsen1/ContextExclusionPlugin-types

Add JSDoc types for ContextExclusionPlugin
webpack · Jul 17, 2018 · 2dde005 · 2dde005
2 parents fa02f3d + b3a7c4d
commit 2dde005
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/lib/ContextExclusionPlugin.js b/lib/ContextExclusionPlugin.js
@@ -1,10 +1,21 @@
 "use strict";
 
+/** @typedef {import("./Compiler")} Compiler */
+/** @typedef {import("./ContextModuleFactory")} ContextModuleFactory */
+
 class ContextExclusionPlugin {
+	/**
+	 * @param {RegExp} negativeMatcher Matcher regular expression
+	 */
 	constructor(negativeMatcher) {
 		this.negativeMatcher = negativeMatcher;
 	}
 
+	/**
+	 * Apply the plugin
+	 * @param {Compiler} compiler Webpack Compiler
+	 * @returns {void}
+	 */
 	apply(compiler) {
 		compiler.hooks.contextModuleFactory.tap("ContextExclusionPlugin", cmf => {
 			cmf.hooks.contextModuleFiles.tap("ContextExclusionPlugin", files => {

diff --git a/lib/ContextModuleFactory.js b/lib/ContextModuleFactory.js
@@ -15,15 +15,21 @@ const {
 const ContextModule = require("./ContextModule");
 const ContextElementDependency = require("./dependencies/ContextElementDependency");
 
+/** @typedef {import("./Module")} Module */
+
 const EMPTY_RESOLVE_OPTIONS = {};
 
 module.exports = class ContextModuleFactory extends Tapable {
 	constructor(resolverFactory) {
 		super();
 		this.hooks = {
+			/** @type {AsyncSeriesWaterfallHook<TODO>} */
 			beforeResolve: new AsyncSeriesWaterfallHook(["data"]),
+			/** @type {AsyncSeriesWaterfallHook<TODO>} */
 			afterResolve: new AsyncSeriesWaterfallHook(["data"]),
+			/** @type {SyncWaterfallHook<string[]>} */
 			contextModuleFiles: new SyncWaterfallHook(["files"]),
+			/** @type {SyncWaterfallHook<TODO[]>} */
 			alternatives: new AsyncSeriesWaterfallHook(["modules"])
 		};
 		this._pluginCompat.tap("ContextModuleFactory", options => {