improve StatsPrinter types

This commit is contained in:
Tobias Koppers 2020-05-12 14:05:07 +02:00
parent 362514c10b
commit c76090f18e
2 changed files with 36 additions and 33 deletions

View File

@ -7,6 +7,9 @@
const { HookMap, SyncWaterfallHook, SyncBailHook } = require("tapable"); const { HookMap, SyncWaterfallHook, SyncBailHook } = require("tapable");
/** @template T @typedef {import("tapable").AsArray<T>} AsArray<T> */
/** @typedef {import("tapable").Hook} Hook */
/** /**
* @typedef {Object} PrintedElement * @typedef {Object} PrintedElement
* @property {string} element * @property {string} element
@ -16,40 +19,44 @@ const { HookMap, SyncWaterfallHook, SyncBailHook } = require("tapable");
class StatsPrinter { class StatsPrinter {
constructor() { constructor() {
this.hooks = Object.freeze({ this.hooks = Object.freeze({
/** @type {HookMap<SyncBailHook<[string[], Object]>>} */ /** @type {HookMap<SyncBailHook<[string[], {}], true>>} */
sortElements: new HookMap( sortElements: new HookMap(
() => new SyncBailHook(["elements", "context"]) () => new SyncBailHook(["elements", "context"])
), ),
/** @type {HookMap<SyncBailHook<[PrintedElement[], Object]>>} */ /** @type {HookMap<SyncBailHook<[PrintedElement[], {}], string>>} */
printElements: new HookMap( printElements: new HookMap(
() => new SyncBailHook(["printedElements", "context"]) () => new SyncBailHook(["printedElements", "context"])
), ),
/** @type {HookMap<SyncBailHook<[any[], Object]>>} */ /** @type {HookMap<SyncBailHook<[any[], {}], true>>} */
sortItems: new HookMap(() => new SyncBailHook(["items", "context"])), sortItems: new HookMap(() => new SyncBailHook(["items", "context"])),
/** @type {HookMap<SyncBailHook<[any, Object]>>} */ /** @type {HookMap<SyncBailHook<[any, {}], string>>} */
getItemName: new HookMap(() => new SyncBailHook(["item", "context"])), getItemName: new HookMap(() => new SyncBailHook(["item", "context"])),
/** @type {HookMap<SyncBailHook<[string[], Object]>>} */ /** @type {HookMap<SyncBailHook<[string[], {}], string>>} */
printItems: new HookMap( printItems: new HookMap(
() => new SyncBailHook(["printedItems", "context"]) () => new SyncBailHook(["printedItems", "context"])
), ),
/** @type {HookMap<SyncBailHook<[Object, Object]>>} */ /** @type {HookMap<SyncBailHook<[{}, {}], string>>} */
print: new HookMap(() => new SyncBailHook(["object", "context"])), print: new HookMap(() => new SyncBailHook(["object", "context"])),
/** @type {HookMap<SyncWaterfallHook<[string, Object]>>} */ /** @type {HookMap<SyncWaterfallHook<[string, {}]>>} */
result: new HookMap(() => new SyncWaterfallHook(["result", "context"])) result: new HookMap(() => new SyncWaterfallHook(["result", "context"]))
}); });
/** @type {Map<HookMap<SyncBailHook<[any[], Object]>>, Map<string, SyncBailHook<[any[], Object]>[]>>} */ /** @type {Map<HookMap<Hook>, Map<string, Hook[]>>} */
this._levelHookCache = new Map(); this._levelHookCache = new Map();
this._inPrint = false; this._inPrint = false;
} }
/** /**
* @private
* @template {Hook} T
* get all level hooks * get all level hooks
* @param {HookMap<any, any>} hookMap HookMap * @param {HookMap<T>} hookMap HookMap
* @param {string} type type * @param {string} type type
* @returns {SyncBailHook<[any[], any], any>[]} hook * @returns {T[]} hooks
*/ */
_getAllLevelHooks(hookMap, type) { _getAllLevelHooks(hookMap, type) {
let cache = this._levelHookCache.get(hookMap); let cache = /** @type {Map<string, T[]>} */ (this._levelHookCache.get(
hookMap
));
if (cache === undefined) { if (cache === undefined) {
cache = new Map(); cache = new Map();
this._levelHookCache.set(hookMap, cache); this._levelHookCache.set(hookMap, cache);
@ -58,6 +65,7 @@ class StatsPrinter {
if (cacheEntry !== undefined) { if (cacheEntry !== undefined) {
return cacheEntry; return cacheEntry;
} }
/** @type {T[]} */
const hooks = []; const hooks = [];
const typeParts = type.split("."); const typeParts = type.split(".");
for (let i = 0; i < typeParts.length; i++) { for (let i = 0; i < typeParts.length; i++) {
@ -71,12 +79,14 @@ class StatsPrinter {
} }
/** /**
* Run `fn` for each level * @private
* @template T * @template T
* @param {HookMap<any, any>} hookMap HookMap * @template R
* Run `fn` for each level
* @param {HookMap<SyncBailHook<T, R>>} hookMap HookMap
* @param {string} type type * @param {string} type type
* @param {(hook: SyncBailHook<[any[], any], any>) => T} fn function * @param {(hook: SyncBailHook<T, R>) => R} fn function
* @returns {T} result of `fn` * @returns {R} result of `fn`
*/ */
_forEachLevel(hookMap, type, fn) { _forEachLevel(hookMap, type, fn) {
for (const hook of this._getAllLevelHooks(hookMap, type)) { for (const hook of this._getAllLevelHooks(hookMap, type)) {
@ -89,12 +99,11 @@ class StatsPrinter {
* Run `fn` for each level * Run `fn` for each level
* @private * @private
* @template T * @template T
* @template U * @param {HookMap<SyncWaterfallHook<T>>} hookMap HookMap
* @param {HookMap<any, any>} hookMap HookMap
* @param {string} type type * @param {string} type type
* @param {Object} data data * @param {AsArray<T>[0]} data data
* @param {(hook: SyncBailHook<[any[], any], any>, data: U) => T} fn function * @param {(hook: SyncWaterfallHook<T>, data: AsArray<T>[0]) => AsArray<T>[0]} fn function
* @returns {T} result of `fn` * @returns {AsArray<T>[0]} result of `fn`
*/ */
_forEachLevelWaterfall(hookMap, type, data, fn) { _forEachLevelWaterfall(hookMap, type, data, fn) {
for (const hook of this._getAllLevelHooks(hookMap, type)) { for (const hook of this._getAllLevelHooks(hookMap, type)) {
@ -104,7 +113,6 @@ class StatsPrinter {
} }
/** /**
* print
* @param {string} type The type * @param {string} type The type
* @param {Object} object Object to print * @param {Object} object Object to print
* @param {Object=} baseContext The base context * @param {Object=} baseContext The base context
@ -125,7 +133,6 @@ class StatsPrinter {
} }
/** /**
* print
* @private * @private
* @param {string} type type * @param {string} type type
* @param {Object} object object * @param {Object} object object

18
types.d.ts vendored
View File

@ -6764,18 +6764,14 @@ declare interface StatsOptions {
} }
declare abstract class StatsPrinter { declare abstract class StatsPrinter {
hooks: Readonly<{ hooks: Readonly<{
sortElements: HookMap<SyncBailHook<[string[], any], any>>; sortElements: HookMap<SyncBailHook<[string[], {}], true>>;
printElements: HookMap<SyncBailHook<[PrintedElement[], any], any>>; printElements: HookMap<SyncBailHook<[PrintedElement[], {}], string>>;
sortItems: HookMap<SyncBailHook<[any[], any], any>>; sortItems: HookMap<SyncBailHook<[any[], {}], true>>;
getItemName: HookMap<SyncBailHook<[any, any], any>>; getItemName: HookMap<SyncBailHook<[any, {}], string>>;
printItems: HookMap<SyncBailHook<[string[], any], any>>; printItems: HookMap<SyncBailHook<[string[], {}], string>>;
print: HookMap<SyncBailHook<[any, any], any>>; print: HookMap<SyncBailHook<[{}, {}], string>>;
result: HookMap<SyncWaterfallHook<[string, any]>>; result: HookMap<SyncWaterfallHook<[string, {}]>>;
}>; }>;
/**
* print
*/
print(type: string, object?: any, baseContext?: any): string; print(type: string, object?: any, baseContext?: any): string;
} }
type StatsValue = type StatsValue =