fix(types): fix some types

log101 · Mar 21, 2024 · 8ef7f91 · 8ef7f91
2 parents ca234aa + 7b4775c
commit 8ef7f91
Show file tree

Hide file tree

Showing 12 changed files with 255 additions and 94 deletions.
diff --git a/lib/Compilation.js b/lib/Compilation.js
@@ -849,7 +849,7 @@ BREAKING CHANGE: Asset processing hooks in Compilation has been merged into a si
  /** @type {SyncHook<[Chunk, string]>} */
  chunkAsset: new SyncHook(["chunk", "filename"]),
 
- /** @type {SyncWaterfallHook<[string, object, AssetInfo]>} */
+ /** @type {SyncWaterfallHook<[string, object, AssetInfo | undefined]>} */
  assetPath: new SyncWaterfallHook(["path", "options", "assetInfo"]),
 
  /** @type {SyncBailHook<[], boolean>} */

diff --git a/lib/Dependency.js b/lib/Dependency.js
@@ -49,7 +49,7 @@ const memoize = require("./util/memoize");
  * @property {number=} index
  */
 
-/** @typedef {SyntheticDependencyLocation|RealDependencyLocation} DependencyLocation */
+/** @typedef {SyntheticDependencyLocation | RealDependencyLocation} DependencyLocation */
 
 /**
  * @typedef {Object} ExportSpec

diff --git a/lib/EvalDevToolModulePlugin.js b/lib/EvalDevToolModulePlugin.js
@@ -12,6 +12,7 @@ const RuntimeGlobals = require("./RuntimeGlobals");
 const JavascriptModulesPlugin = require("./javascript/JavascriptModulesPlugin");
 
 /** @typedef {import("webpack-sources").Source} Source */
+/** @typedef {import("../declarations/WebpackOptions").OutputNormalized} OutputOptions */
 /** @typedef {import("./Compiler")} Compiler */
 
 /** @type {WeakMap<Source, Source>} */
@@ -27,7 +28,17 @@ const devtoolWarning = new RawSource(`/*
  */
 `);
 
+/**
+ * @typedef {Object} EvalDevToolModulePluginOptions
+ * @property {OutputOptions["devtoolNamespace"]=} namespace namespace
+ * @property {string=} sourceUrlComment source url comment
+ * @property {OutputOptions["devtoolModuleFilenameTemplate"]=} moduleFilenameTemplate module filename template
+ */
+
 class EvalDevToolModulePlugin {
+ /**
+ * @param {EvalDevToolModulePluginOptions=} options options
+ */
  constructor(options) {
  this.namespace = options.namespace || "";
  this.sourceUrlComment = options.sourceUrlComment || "\n//# sourceURL=[url]";

diff --git a/lib/ExportsInfo.js b/lib/ExportsInfo.js
@@ -171,6 +171,10 @@ class ExportsInfo {
  this._exportsAreOrdered = true;
  }
 
+ /**
+ * @param {ExportsInfo | undefined} exportsInfo exports info
+ * @returns {boolean} result
+ */
  setRedirectNamedTo(exportsInfo) {
  if (this._redirectTo === exportsInfo) return false;
  this._redirectTo = exportsInfo;

diff --git a/lib/ExternalModule.js b/lib/ExternalModule.js
@@ -442,9 +442,11 @@ const getSourceForDefaultCase = (optional, request, runtimeTemplate) => {
  };
 };
 
+/** @typedef {Record<string, string | string[]>} RequestRecord */
+
 class ExternalModule extends Module {
  /**
- * @param {string | string[] | Record<string, string | string[]>} request request
+ * @param {string | string[] | RequestRecord} request request
  * @param {string} type type
  * @param {string} userRequest user request
  * @param {DependencyMeta=} dependencyMeta dependency meta

diff --git a/lib/FlagDependencyExportsPlugin.js b/lib/FlagDependencyExportsPlugin.js
@@ -15,6 +15,7 @@ const Queue = require("./util/Queue");
 /** @typedef {import("./Dependency").ExportsSpec} ExportsSpec */
 /** @typedef {import("./ExportsInfo")} ExportsInfo */
 /** @typedef {import("./Module")} Module */
+/** @typedef {import("./Module").BuildInfo} BuildInfo */
 
 const PLUGIN_NAME = "FlagDependencyExportsPlugin";
 const PLUGIN_LOGGER_NAME = `webpack.${PLUGIN_NAME}`;
@@ -63,7 +64,10 @@ class FlagDependencyExportsPlugin {
  }
  }
  // If the module has no hash, it's uncacheable
- if (typeof module.buildInfo.hash !== "string") {
+ if (
+ typeof (/** @type {BuildInfo} */ (module.buildInfo).hash) !==
+ "string"
+ ) {
  statFlaggedUncached++;
  // Enqueue uncacheable module for determining the exports
  queue.enqueue(module);
@@ -79,7 +83,8 @@ class FlagDependencyExportsPlugin {
  }
  cache.get(
  module.identifier(),
- module.buildInfo.hash,
+ /** @type {BuildInfo} */
+ (module.buildInfo).hash,
  (err, result) => {
  if (err) return callback(err);
 
@@ -234,7 +239,10 @@ class FlagDependencyExportsPlugin {
  if (exports) {
  const nestedExportsInfo =
  exportInfo.createNestedExportsInfo();
- mergeExports(nestedExportsInfo, exports);
+ mergeExports(
+ /** @type {ExportsInfo} */ (nestedExportsInfo),
+ exports
+ );
  }
 
  if (
@@ -272,7 +280,8 @@ class FlagDependencyExportsPlugin {
 
  if (exportInfo.exportsInfoOwned) {
  if (
- exportInfo.exportsInfo.setRedirectNamedTo(
+ /** @type {ExportsInfo} */
+ (exportInfo.exportsInfo).setRedirectNamedTo(
  targetExportsInfo
  )
  ) {
@@ -312,7 +321,7 @@ class FlagDependencyExportsPlugin {
 
  logger.time("figure out provided exports");
  while (queue.length > 0) {
- module = queue.dequeue();
+ module = /** @type {Module} */ (queue.dequeue());
 
  statQueueItemsProcessed++;
 
@@ -356,7 +365,11 @@ class FlagDependencyExportsPlugin {
  asyncLib.each(
  modulesToStore,
  (module, callback) => {
- if (typeof module.buildInfo.hash !== "string") {
+ if (
+ typeof (
+ /** @type {BuildInfo} */ (module.buildInfo).hash
+ ) !== "string"
+ ) {
  // not cacheable
  return callback();
  }
@@ -370,7 +383,8 @@ class FlagDependencyExportsPlugin {
  }
  cache.store(
  module.identifier(),
- module.buildInfo.hash,
+ /** @type {BuildInfo} */
+ (module.buildInfo).hash,
  cachedData,
  callback
  );