@shuvi/hook 1.0.22 → 1.0.24

package/esm/hookGroup.d.ts

@@ -1,54 +1,7 @@
-import { SyncHook, SyncBailHook, SyncWaterfallHook, AsyncParallelHook, AsyncSeriesWaterfallHook, SyncHookHandler, SyncBailHookHandler, SyncWaterfallHookHandler, AsyncParallelHookHandler, AsyncSeriesWaterfallHookHandler, AsyncSeriesHook, AsyncSeriesBailHook, AsyncSeriesHookHandler, AsyncSeriesBailHookHandler } from './hooks';
-export declare type PatchPluginParameter<T, C> = RemoveManagerVoidParameter<AddContextParameter<T, C>>;
-export declare type AddContextParameter<T, C> = T extends (initalValue: infer I, extraArg: infer E) => infer R ? (initalValue: I, extraArg: E, context: C) => R : T;
-export declare type AnyHook = SyncHook<any, any, any> | SyncBailHook<any, any, any> | SyncWaterfallHook<any, any> | AsyncParallelHook<any, any, any> | AsyncSeriesHook<any, any, any> | AsyncSeriesBailHook<any, any, any> | AsyncSeriesWaterfallHook<any, any>;
-export interface HookMap {
-    [x: string]: AnyHook;
-}
-export declare type Setup<HM extends HookMap = {}> = (utils: {
-    addHooks: (hook: Partial<HM>) => void;
-}) => void;
-export declare type CreatePlugin<HM extends HookMap, C> = (pluginHandlers: IPluginHandlers<HM, C> & {
-    setup?: Setup;
-}, options?: PluginOptions) => IPluginInstance<HM, C>;
-export declare type HookManager<HM extends HookMap, C> = {
-    createPlugin: CreatePlugin<HM, C>;
-    usePlugin: (...plugins: IPluginInstance<HM, C>[]) => void;
-    runner: RunnerType<HM>;
-    setContext: (context: C) => void;
-    clear: () => void;
-    addHooks: <EHM extends HookMap>(hook: Partial<EHM>) => void;
-    hooks: HM;
-    getPlugins: () => IPluginInstance<HM, C>[];
-};
-export declare type RunnerType<HM> = {
-    [K in keyof HM]: HookRunnerType<HM[K]>;
-} & {
-    setup: Setup;
-};
-export declare type HookRunnerType<H> = H extends SyncHook<infer T, infer E, infer R> ? SyncHook<T, E, R>['run'] : H extends SyncBailHook<infer T, infer E, infer R> ? SyncBailHook<T, E, R>['run'] : H extends SyncWaterfallHook<infer T, infer E> ? SyncWaterfallHook<T, E>['run'] : H extends AsyncParallelHook<infer T, infer E, infer R> ? AsyncParallelHook<T, E, R>['run'] : H extends AsyncSeriesHook<infer T, infer E, infer R> ? AsyncSeriesHook<T, E, R>['run'] : H extends AsyncSeriesBailHook<infer T, infer E, infer R> ? AsyncSeriesBailHook<T, E, R>['run'] : H extends AsyncSeriesWaterfallHook<infer T, infer E> ? AsyncSeriesWaterfallHook<T, E>['run'] : never;
-export declare type IPluginInstance<HM, C> = {
-    handlers: IPluginHandlers<HM, C>;
-    PLUGIN_SYMBOL: 'PLUGIN_SYMBOL';
-} & Required<PluginOptions>;
-export declare type IPluginHandlers<HM, C> = Partial<IPluginHandlersFullMap<HM, C>>;
-export declare type IPluginHandlersFullMap<HM, C> = {
-    [K in keyof HM]: HM[K] extends SyncHook<infer T, infer E, infer R> ? PatchPluginParameter<SyncHookHandler<T, E, R>, C> : HM[K] extends SyncBailHook<infer T, infer E, infer R> ? PatchPluginParameter<SyncBailHookHandler<T, E, R>, C> : HM[K] extends SyncWaterfallHook<infer T, infer E> ? PatchPluginParameter<SyncWaterfallHookHandler<T, E>, C> : HM[K] extends AsyncParallelHook<infer T, infer E, infer R> ? PatchPluginParameter<AsyncParallelHookHandler<T, E, R>, C> : HM[K] extends AsyncSeriesHook<infer T, infer E, infer R> ? PatchPluginParameter<AsyncSeriesHookHandler<T, E, R>, C> : HM[K] extends AsyncSeriesBailHook<infer T, infer E, infer R> ? PatchPluginParameter<AsyncSeriesBailHookHandler<T, E, R>, C> : HM[K] extends AsyncSeriesWaterfallHook<infer T, infer E> ? PatchPluginParameter<AsyncSeriesWaterfallHookHandler<T, E>, C> : never;
-};
-export declare type PluginOptions = {
-    name?: string;
-    pre?: string[];
-    post?: string[];
-    rivals?: string[];
-    required?: string[];
-    order?: number;
-    group?: number;
-    [x: string]: any;
-};
+import { IPluginHandlers, IPluginInstance, HookManager, HookMap, PluginOptions } from './types';
 export declare const isPluginInstance: <T extends IPluginInstance<any, any> = IPluginInstance<any, any>>(plugin: any) => plugin is T;
 export declare type ArrayElements<T extends {}> = {
     [K in keyof T]: T[K][];
 };
 export declare function createPlugin<HM extends HookMap, C = void>(pluginHandlers: IPluginHandlers<HM, C>, options?: PluginOptions): IPluginInstance<HM, C>;
 export declare const createHookManager: <HM extends HookMap, C = void>(hookMap: HM, hasContext?: boolean) => HookManager<HM, C>;
-export declare type RemoveManagerVoidParameter<T> = T extends (initalValue: infer I, extraArg: infer E, context: infer C) => infer R ? null extends I ? null extends E ? null extends C ? (initialValue: I, extraArg: E, context: C) => R : void extends C ? (initialValue: I, extraArg: E) => R : (initialValue: I, extraArg: E, context: C) => R : void extends E ? null extends C ? (initialValue: I, context: C) => R : void extends C ? (initialValue: I) => R : (initialValue: I, context: C) => R : null extends C ? (initialValue: I, extraArg: E, context: C) => R : void extends C ? (initialValue: I, extraArg: E) => R : (initialValue: I, extraArg: E, context: C) => R : void extends I ? null extends E ? null extends C ? (extraArg: E, context: C) => R : void extends C ? (extraArg: E) => R : (extraArg: E, context: C) => R : void extends E ? null extends C ? (context: C) => R : void extends C ? () => R : (context: C) => R : null extends C ? (extraArg: E, context: C) => R : void extends C ? (extraArg: E) => R : (extraArg: E, context: C) => R : null extends E ? null extends C ? (initialValue: I, extraArg: E, context: C) => R : void extends C ? (initialValue: I, extraArg: E) => R : (initialValue: I, extraArg: E, context: C) => R : void extends E ? null extends C ? (initialValue: I, context: C) => R : void extends C ? (initialValue: I) => R : (initialValue: I, context: C) => R : null extends C ? (initialValue: I, extraArg: E, context: C) => R : void extends C ? (initialValue: I, extraArg: E) => R : (initialValue: I, extraArg: E, context: C) => R : T;

package/esm/hookGroup.js

@@ -1,81 +1,17 @@
 import { createSyncHook, createSyncBailHook, createSyncWaterfallHook, createAsyncParallelHook, createAsyncSeriesWaterfallHook, createAsyncSeriesBailHook, createAsyncSeriesHook } from './hooks';
+import { verifyPlugins, sortPlugins } from './utils';
 const DEFAULT_OPTIONS = {
     name: 'untitled',
-    pre: [],
-    post: [],
-    rivals: [],
+    before: [],
+    after: [],
+    conflict: [],
     required: [],
-    order: 0,
     group: 0
 };
 const PLUGIN_SYMBOL = 'PLUGIN_SYMBOL';
 export const isPluginInstance = (plugin) => plugin &&
     plugin.hasOwnProperty(PLUGIN_SYMBOL) &&
     plugin.PLUGIN_SYMBOL === PLUGIN_SYMBOL;
-const sortPlugins = (input) => {
-    let plugins = input.slice();
-    plugins.sort((a, b) => {
-        // sort by group first
-        if (a.group === b.group) {
-            return a.order - b.order;
-        }
-        else {
-            return a.group - b.group;
-        }
-    });
-    for (let i = 0; i < plugins.length; i++) {
-        let plugin = plugins[i];
-        if (plugin.pre) {
-            for (const pre of plugin.pre) {
-                for (let j = i + 1; j < plugins.length; j++) {
-                    if (plugins[j].name === pre) {
-                        plugins = [
-                            ...plugins.slice(0, i),
-                            plugins[j],
-                            ...plugins.slice(i, j),
-                            ...plugins.slice(j + 1, plugins.length)
-                        ];
-                    }
-                }
-            }
-        }
-        if (plugin.post) {
-            for (const post of plugin.post) {
-                for (let j = 0; j < i; j++) {
-                    if (plugins[j].name === post) {
-                        plugins = [
-                            ...plugins.slice(0, j),
-                            ...plugins.slice(j + 1, i + 1),
-                            plugins[j],
-                            ...plugins.slice(i + 1, plugins.length)
-                        ];
-                    }
-                }
-            }
-        }
-    }
-    return plugins;
-};
-const checkPlugins = (plugins) => {
-    for (const origin of plugins) {
-        if (origin.rivals) {
-            for (const rival of origin.rivals) {
-                for (const plugin of plugins) {
-                    if (rival === plugin.name) {
-                        throw new Error(`${origin.name} has rival ${plugin.name}`);
-                    }
-                }
-            }
-        }
-        if (origin.required) {
-            for (const required of origin.required) {
-                if (!plugins.some(plugin => plugin.name === required)) {
-                    throw new Error(`The plugin: ${required} is required when plugin: ${origin.name} is exist.`);
-                }
-            }
-        }
-    }
-};
 function uuid() {
     return 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, function (c) {
         var r = (Math.random() * 16) | 0, v = c == 'x' ? r : (r & 0x3) | 0x8;
@@ -136,10 +72,9 @@ export const createHookManager = (hookMap, hasContext = true) => {
         _plugins.push(...plugins);
     };
     const load = () => {
-        let plugins = _plugins;
-        plugins = sortPlugins(plugins);
-        checkPlugins(plugins);
-        plugins.forEach(plugin => {
+        verifyPlugins(_plugins);
+        _plugins = sortPlugins(_plugins);
+        _plugins.forEach(plugin => {
             const handlers = plugin.handlers;
             let hookName;
             for (hookName in handlers) {

package/esm/index.d.ts

@@ -1,2 +1,3 @@
 export * from './hooks';
 export * from './hookGroup';
+export * from './types';

package/esm/index.js

@@ -1,2 +1,3 @@
 export * from './hooks';
 export * from './hookGroup';
+export * from './types';

package/esm/types.d.ts

@@ -0,0 +1,59 @@
+import { SyncHook, SyncBailHook, SyncWaterfallHook, AsyncParallelHook, AsyncSeriesWaterfallHook, SyncHookHandler, SyncBailHookHandler, SyncWaterfallHookHandler, AsyncParallelHookHandler, AsyncSeriesWaterfallHookHandler, AsyncSeriesHook, AsyncSeriesBailHook, AsyncSeriesHookHandler, AsyncSeriesBailHookHandler } from './hooks';
+export declare type PatchPluginParameter<T, C> = RemoveManagerVoidParameter<AddContextParameter<T, C>>;
+export declare type AddContextParameter<T, C> = T extends (initalValue: infer I, extraArg: infer E) => infer R ? (initalValue: I, extraArg: E, context: C) => R : T;
+export declare type AnyHook = SyncHook<any, any, any> | SyncBailHook<any, any, any> | SyncWaterfallHook<any, any> | AsyncParallelHook<any, any, any> | AsyncSeriesHook<any, any, any> | AsyncSeriesBailHook<any, any, any> | AsyncSeriesWaterfallHook<any, any>;
+export interface HookMap {
+    [x: string]: AnyHook;
+}
+export declare type Setup<HM extends HookMap = {}> = (utils: {
+    addHooks: (hook: Partial<HM>) => void;
+}) => void;
+export declare type CreatePlugin<HM extends HookMap, C> = (pluginHandlers: IPluginHandlers<HM, C> & {
+    setup?: Setup;
+}, options?: PluginOptions) => IPluginInstance<HM, C>;
+export declare type HookManager<HM extends HookMap, C> = {
+    createPlugin: CreatePlugin<HM, C>;
+    usePlugin: (...plugins: IPluginInstance<HM, C>[]) => void;
+    runner: RunnerType<HM>;
+    setContext: (context: C) => void;
+    clear: () => void;
+    addHooks: <EHM extends HookMap>(hook: Partial<EHM>) => void;
+    hooks: HM;
+    getPlugins: () => IPluginInstance<HM, C>[];
+};
+export declare type RunnerType<HM> = {
+    [K in keyof HM]: HookRunnerType<HM[K]>;
+} & {
+    setup: Setup;
+};
+export declare type HookRunnerType<H> = H extends SyncHook<infer T, infer E, infer R> ? SyncHook<T, E, R>['run'] : H extends SyncBailHook<infer T, infer E, infer R> ? SyncBailHook<T, E, R>['run'] : H extends SyncWaterfallHook<infer T, infer E> ? SyncWaterfallHook<T, E>['run'] : H extends AsyncParallelHook<infer T, infer E, infer R> ? AsyncParallelHook<T, E, R>['run'] : H extends AsyncSeriesHook<infer T, infer E, infer R> ? AsyncSeriesHook<T, E, R>['run'] : H extends AsyncSeriesBailHook<infer T, infer E, infer R> ? AsyncSeriesBailHook<T, E, R>['run'] : H extends AsyncSeriesWaterfallHook<infer T, infer E> ? AsyncSeriesWaterfallHook<T, E>['run'] : never;
+export declare type IPluginInstance<HM, C> = {
+    handlers: IPluginHandlers<HM, C>;
+    PLUGIN_SYMBOL: 'PLUGIN_SYMBOL';
+} & Required<PluginOptions>;
+export declare type IPluginHandlers<HM, C> = Partial<IPluginHandlersFullMap<HM, C>>;
+export declare type IPluginHandlersFullMap<HM, C> = {
+    [K in keyof HM]: HM[K] extends SyncHook<infer T, infer E, infer R> ? PatchPluginParameter<SyncHookHandler<T, E, R>, C> : HM[K] extends SyncBailHook<infer T, infer E, infer R> ? PatchPluginParameter<SyncBailHookHandler<T, E, R>, C> : HM[K] extends SyncWaterfallHook<infer T, infer E> ? PatchPluginParameter<SyncWaterfallHookHandler<T, E>, C> : HM[K] extends AsyncParallelHook<infer T, infer E, infer R> ? PatchPluginParameter<AsyncParallelHookHandler<T, E, R>, C> : HM[K] extends AsyncSeriesHook<infer T, infer E, infer R> ? PatchPluginParameter<AsyncSeriesHookHandler<T, E, R>, C> : HM[K] extends AsyncSeriesBailHook<infer T, infer E, infer R> ? PatchPluginParameter<AsyncSeriesBailHookHandler<T, E, R>, C> : HM[K] extends AsyncSeriesWaterfallHook<infer T, infer E> ? PatchPluginParameter<AsyncSeriesWaterfallHookHandler<T, E>, C> : never;
+};
+export declare type PluginOptions = {
+    name?: string;
+    /** current plugin should before these configured plugins.
+     * only works for same group
+     */
+    before?: string[];
+    /** current plugin should after these configured plugins.
+     * only works for same group.
+     */
+    after?: string[];
+    /** current plugin should not be used with these configured plugins */
+    conflict?: string[];
+    /** current plugin should be used with these configured plugins */
+    required?: string[];
+    /** current plugin group.
+     * smaller group will be executed first
+     * 0: default
+     */
+    group?: number;
+    [x: string]: any;
+};
+export declare type RemoveManagerVoidParameter<T> = T extends (initalValue: infer I, extraArg: infer E, context: infer C) => infer R ? null extends I ? null extends E ? null extends C ? (initialValue: I, extraArg: E, context: C) => R : void extends C ? (initialValue: I, extraArg: E) => R : (initialValue: I, extraArg: E, context: C) => R : void extends E ? null extends C ? (initialValue: I, context: C) => R : void extends C ? (initialValue: I) => R : (initialValue: I, context: C) => R : null extends C ? (initialValue: I, extraArg: E, context: C) => R : void extends C ? (initialValue: I, extraArg: E) => R : (initialValue: I, extraArg: E, context: C) => R : void extends I ? null extends E ? null extends C ? (extraArg: E, context: C) => R : void extends C ? (extraArg: E) => R : (extraArg: E, context: C) => R : void extends E ? null extends C ? (context: C) => R : void extends C ? () => R : (context: C) => R : null extends C ? (extraArg: E, context: C) => R : void extends C ? (extraArg: E) => R : (extraArg: E, context: C) => R : null extends E ? null extends C ? (initialValue: I, extraArg: E, context: C) => R : void extends C ? (initialValue: I, extraArg: E) => R : (initialValue: I, extraArg: E, context: C) => R : void extends E ? null extends C ? (initialValue: I, context: C) => R : void extends C ? (initialValue: I) => R : (initialValue: I, context: C) => R : null extends C ? (initialValue: I, extraArg: E, context: C) => R : void extends C ? (initialValue: I, extraArg: E) => R : (initialValue: I, extraArg: E, context: C) => R : T;

package/esm/types.js

@@ -0,0 +1 @@
+export {};

package/esm/utils.d.ts

@@ -0,0 +1,4 @@
+import { IPluginInstance } from './types';
+export declare const sortPluginsByRelationShip: <T extends IPluginInstance<any, any>[]>(input: T) => T;
+export declare const sortPlugins: <T extends IPluginInstance<any, any>[]>(input: T) => T;
+export declare const verifyPlugins: (plugins: IPluginInstance<any, any>[]) => void;

package/esm/utils.js

@@ -0,0 +1,104 @@
+export const sortPluginsByRelationShip = (input) => {
+    const plugins = new Map();
+    /**
+     * the key is the end point of the edge
+     * In this way, we can easily find the plugin with zero in-degree
+     */
+    const edges = new Map();
+    const addEdge = (start, end) => {
+        if (!edges.has(end)) {
+            edges.set(end, new Set());
+        }
+        edges.get(end).add(start);
+    };
+    // Firstly, set plugins into map
+    input.forEach(plugin => {
+        plugins.set(plugin.name, plugin);
+    });
+    input.forEach(plugin => {
+        if (!edges.has(plugin.name)) {
+            edges.set(plugin.name, new Set());
+        }
+        if (plugin.before) {
+            plugin.before.forEach(name => {
+                // If the plugin is not in the input, we will ignore it
+                if (plugins.has(name)) {
+                    addEdge(plugin.name, name);
+                }
+            });
+        }
+        if (plugin.after) {
+            plugin.after.forEach(name => {
+                // If the plugin is not in the input, we will ignore it
+                if (plugins.has(name)) {
+                    addEdge(name, plugin.name);
+                }
+            });
+        }
+    });
+    const sorted = [];
+    while (edges.size > 0) {
+        let hasZeroInDegree = false;
+        edges.forEach((value, key) => {
+            if (value.size === 0) {
+                hasZeroInDegree = true;
+                sorted.push(plugins.get(key));
+                edges.delete(key);
+                edges.forEach(v => {
+                    v.delete(key);
+                });
+            }
+        });
+        if (!hasZeroInDegree) {
+            throw new Error(`Plugin circular dependency detected: ${Array.from(edges.keys()).join(', ')}. Please ensure the plugins have correct 'before' and 'after' property.`);
+        }
+    }
+    return sorted;
+};
+export const sortPlugins = (input) => {
+    const groupMap = new Map();
+    input.forEach(plugin => {
+        if (!groupMap.has(plugin.group)) {
+            groupMap.set(plugin.group, []);
+        }
+        groupMap.get(plugin.group).push(plugin);
+    });
+    const groupNumbers = Array.from(groupMap.keys());
+    const sortedGroupNumbers = groupNumbers.sort((a, b) => a - b);
+    const sorted = [];
+    sortedGroupNumbers.forEach(groupNumber => {
+        sorted.push(...sortPluginsByRelationShip(groupMap.get(groupNumber)));
+    });
+    return sorted;
+};
+export const verifyPlugins = (plugins) => {
+    const names = new Set();
+    for (const current of plugins) {
+        if (typeof current.name !== 'string') {
+            throw new Error(`Plugin name must be string type.`);
+        }
+        if (!current.name) {
+            throw new Error(`Plugin name must be non-empty string.`);
+        }
+        if (names.has(current.name)) {
+            throw new Error(`Plugin name duplication detected: ${current.name}.`);
+        }
+        names.add(current.name);
+        if (current.conflict) {
+            for (const conflict of current.conflict) {
+                for (const plugin of plugins) {
+                    if (conflict === plugin.name) {
+                        throw new Error(`Plugin conflict detected: ${current.name} has conflict with ${plugin.name}.`);
+                    }
+                }
+            }
+        }
+        if (current.required) {
+            for (const required of current.required) {
+                if (!plugins.some(plugin => plugin.name === required)) {
+                    throw new Error(`Plugin missing detected: ${required} is required by ${current.name}.`);
+                }
+            }
+        }
+    }
+};

package/lib/hookGroup.d.ts

@@ -1,54 +1,7 @@
-import { SyncHook, SyncBailHook, SyncWaterfallHook, AsyncParallelHook, AsyncSeriesWaterfallHook, SyncHookHandler, SyncBailHookHandler, SyncWaterfallHookHandler, AsyncParallelHookHandler, AsyncSeriesWaterfallHookHandler, AsyncSeriesHook, AsyncSeriesBailHook, AsyncSeriesHookHandler, AsyncSeriesBailHookHandler } from './hooks';
-export declare type PatchPluginParameter<T, C> = RemoveManagerVoidParameter<AddContextParameter<T, C>>;
-export declare type AddContextParameter<T, C> = T extends (initalValue: infer I, extraArg: infer E) => infer R ? (initalValue: I, extraArg: E, context: C) => R : T;
-export declare type AnyHook = SyncHook<any, any, any> | SyncBailHook<any, any, any> | SyncWaterfallHook<any, any> | AsyncParallelHook<any, any, any> | AsyncSeriesHook<any, any, any> | AsyncSeriesBailHook<any, any, any> | AsyncSeriesWaterfallHook<any, any>;
-export interface HookMap {
-    [x: string]: AnyHook;
-}
-export declare type Setup<HM extends HookMap = {}> = (utils: {
-    addHooks: (hook: Partial<HM>) => void;
-}) => void;
-export declare type CreatePlugin<HM extends HookMap, C> = (pluginHandlers: IPluginHandlers<HM, C> & {
-    setup?: Setup;
-}, options?: PluginOptions) => IPluginInstance<HM, C>;
-export declare type HookManager<HM extends HookMap, C> = {
-    createPlugin: CreatePlugin<HM, C>;
-    usePlugin: (...plugins: IPluginInstance<HM, C>[]) => void;
-    runner: RunnerType<HM>;
-    setContext: (context: C) => void;
-    clear: () => void;
-    addHooks: <EHM extends HookMap>(hook: Partial<EHM>) => void;
-    hooks: HM;
-    getPlugins: () => IPluginInstance<HM, C>[];
-};
-export declare type RunnerType<HM> = {
-    [K in keyof HM]: HookRunnerType<HM[K]>;
-} & {
-    setup: Setup;
-};
-export declare type HookRunnerType<H> = H extends SyncHook<infer T, infer E, infer R> ? SyncHook<T, E, R>['run'] : H extends SyncBailHook<infer T, infer E, infer R> ? SyncBailHook<T, E, R>['run'] : H extends SyncWaterfallHook<infer T, infer E> ? SyncWaterfallHook<T, E>['run'] : H extends AsyncParallelHook<infer T, infer E, infer R> ? AsyncParallelHook<T, E, R>['run'] : H extends AsyncSeriesHook<infer T, infer E, infer R> ? AsyncSeriesHook<T, E, R>['run'] : H extends AsyncSeriesBailHook<infer T, infer E, infer R> ? AsyncSeriesBailHook<T, E, R>['run'] : H extends AsyncSeriesWaterfallHook<infer T, infer E> ? AsyncSeriesWaterfallHook<T, E>['run'] : never;
-export declare type IPluginInstance<HM, C> = {
-    handlers: IPluginHandlers<HM, C>;
-    PLUGIN_SYMBOL: 'PLUGIN_SYMBOL';
-} & Required<PluginOptions>;
-export declare type IPluginHandlers<HM, C> = Partial<IPluginHandlersFullMap<HM, C>>;
-export declare type IPluginHandlersFullMap<HM, C> = {
-    [K in keyof HM]: HM[K] extends SyncHook<infer T, infer E, infer R> ? PatchPluginParameter<SyncHookHandler<T, E, R>, C> : HM[K] extends SyncBailHook<infer T, infer E, infer R> ? PatchPluginParameter<SyncBailHookHandler<T, E, R>, C> : HM[K] extends SyncWaterfallHook<infer T, infer E> ? PatchPluginParameter<SyncWaterfallHookHandler<T, E>, C> : HM[K] extends AsyncParallelHook<infer T, infer E, infer R> ? PatchPluginParameter<AsyncParallelHookHandler<T, E, R>, C> : HM[K] extends AsyncSeriesHook<infer T, infer E, infer R> ? PatchPluginParameter<AsyncSeriesHookHandler<T, E, R>, C> : HM[K] extends AsyncSeriesBailHook<infer T, infer E, infer R> ? PatchPluginParameter<AsyncSeriesBailHookHandler<T, E, R>, C> : HM[K] extends AsyncSeriesWaterfallHook<infer T, infer E> ? PatchPluginParameter<AsyncSeriesWaterfallHookHandler<T, E>, C> : never;
-};
-export declare type PluginOptions = {
-    name?: string;
-    pre?: string[];
-    post?: string[];
-    rivals?: string[];
-    required?: string[];
-    order?: number;
-    group?: number;
-    [x: string]: any;
-};
+import { IPluginHandlers, IPluginInstance, HookManager, HookMap, PluginOptions } from './types';
 export declare const isPluginInstance: <T extends IPluginInstance<any, any> = IPluginInstance<any, any>>(plugin: any) => plugin is T;
 export declare type ArrayElements<T extends {}> = {
     [K in keyof T]: T[K][];
 };
 export declare function createPlugin<HM extends HookMap, C = void>(pluginHandlers: IPluginHandlers<HM, C>, options?: PluginOptions): IPluginInstance<HM, C>;
 export declare const createHookManager: <HM extends HookMap, C = void>(hookMap: HM, hasContext?: boolean) => HookManager<HM, C>;
-export declare type RemoveManagerVoidParameter<T> = T extends (initalValue: infer I, extraArg: infer E, context: infer C) => infer R ? null extends I ? null extends E ? null extends C ? (initialValue: I, extraArg: E, context: C) => R : void extends C ? (initialValue: I, extraArg: E) => R : (initialValue: I, extraArg: E, context: C) => R : void extends E ? null extends C ? (initialValue: I, context: C) => R : void extends C ? (initialValue: I) => R : (initialValue: I, context: C) => R : null extends C ? (initialValue: I, extraArg: E, context: C) => R : void extends C ? (initialValue: I, extraArg: E) => R : (initialValue: I, extraArg: E, context: C) => R : void extends I ? null extends E ? null extends C ? (extraArg: E, context: C) => R : void extends C ? (extraArg: E) => R : (extraArg: E, context: C) => R : void extends E ? null extends C ? (context: C) => R : void extends C ? () => R : (context: C) => R : null extends C ? (extraArg: E, context: C) => R : void extends C ? (extraArg: E) => R : (extraArg: E, context: C) => R : null extends E ? null extends C ? (initialValue: I, extraArg: E, context: C) => R : void extends C ? (initialValue: I, extraArg: E) => R : (initialValue: I, extraArg: E, context: C) => R : void extends E ? null extends C ? (initialValue: I, context: C) => R : void extends C ? (initialValue: I) => R : (initialValue: I, context: C) => R : null extends C ? (initialValue: I, extraArg: E, context: C) => R : void extends C ? (initialValue: I, extraArg: E) => R : (initialValue: I, extraArg: E, context: C) => R : T;

package/lib/hookGroup.js

@@ -2,13 +2,13 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createHookManager = exports.createPlugin = exports.isPluginInstance = void 0;
 const hooks_1 = require("./hooks");
+const utils_1 = require("./utils");
 const DEFAULT_OPTIONS = {
     name: 'untitled',
-    pre: [],
-    post: [],
-    rivals: [],
+    before: [],
+    after: [],
+    conflict: [],
     required: [],
-    order: 0,
     group: 0
 };
 const PLUGIN_SYMBOL = 'PLUGIN_SYMBOL';
@@ -16,70 +16,6 @@ const isPluginInstance = (plugin) => plugin &&
     plugin.hasOwnProperty(PLUGIN_SYMBOL) &&
     plugin.PLUGIN_SYMBOL === PLUGIN_SYMBOL;
 exports.isPluginInstance = isPluginInstance;
-const sortPlugins = (input) => {
-    let plugins = input.slice();
-    plugins.sort((a, b) => {
-        // sort by group first
-        if (a.group === b.group) {
-            return a.order - b.order;
-        }
-        else {
-            return a.group - b.group;
-        }
-    });
-    for (let i = 0; i < plugins.length; i++) {
-        let plugin = plugins[i];
-        if (plugin.pre) {
-            for (const pre of plugin.pre) {
-                for (let j = i + 1; j < plugins.length; j++) {
-                    if (plugins[j].name === pre) {
-                        plugins = [
-                            ...plugins.slice(0, i),
-                            plugins[j],
-                            ...plugins.slice(i, j),
-                            ...plugins.slice(j + 1, plugins.length)
-                        ];
-                    }
-                }
-            }
-        }
-        if (plugin.post) {
-            for (const post of plugin.post) {
-                for (let j = 0; j < i; j++) {
-                    if (plugins[j].name === post) {
-                        plugins = [
-                            ...plugins.slice(0, j),
-                            ...plugins.slice(j + 1, i + 1),
-                            plugins[j],
-                            ...plugins.slice(i + 1, plugins.length)
-                        ];
-                    }
-                }
-            }
-        }
-    }
-    return plugins;
-};
-const checkPlugins = (plugins) => {
-    for (const origin of plugins) {
-        if (origin.rivals) {
-            for (const rival of origin.rivals) {
-                for (const plugin of plugins) {
-                    if (rival === plugin.name) {
-                        throw new Error(`${origin.name} has rival ${plugin.name}`);
-                    }
-                }
-            }
-        }
-        if (origin.required) {
-            for (const required of origin.required) {
-                if (!plugins.some(plugin => plugin.name === required)) {
-                    throw new Error(`The plugin: ${required} is required when plugin: ${origin.name} is exist.`);
-                }
-            }
-        }
-    }
-};
 function uuid() {
     return 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, function (c) {
         var r = (Math.random() * 16) | 0, v = c == 'x' ? r : (r & 0x3) | 0x8;
@@ -141,10 +77,9 @@ const createHookManager = (hookMap, hasContext = true) => {
         _plugins.push(...plugins);
     };
     const load = () => {
-        let plugins = _plugins;
-        plugins = sortPlugins(plugins);
-        checkPlugins(plugins);
-        plugins.forEach(plugin => {
+        (0, utils_1.verifyPlugins)(_plugins);
+        _plugins = (0, utils_1.sortPlugins)(_plugins);
+        _plugins.forEach(plugin => {
             const handlers = plugin.handlers;
             let hookName;
             for (hookName in handlers) {

package/lib/index.d.ts

@@ -1,2 +1,3 @@
 export * from './hooks';
 export * from './hookGroup';
+export * from './types';

package/lib/index.js

@@ -16,3 +16,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./hooks"), exports);
 __exportStar(require("./hookGroup"), exports);
+__exportStar(require("./types"), exports);

package/lib/types.d.ts

@@ -0,0 +1,59 @@
+import { SyncHook, SyncBailHook, SyncWaterfallHook, AsyncParallelHook, AsyncSeriesWaterfallHook, SyncHookHandler, SyncBailHookHandler, SyncWaterfallHookHandler, AsyncParallelHookHandler, AsyncSeriesWaterfallHookHandler, AsyncSeriesHook, AsyncSeriesBailHook, AsyncSeriesHookHandler, AsyncSeriesBailHookHandler } from './hooks';
+export declare type PatchPluginParameter<T, C> = RemoveManagerVoidParameter<AddContextParameter<T, C>>;
+export declare type AddContextParameter<T, C> = T extends (initalValue: infer I, extraArg: infer E) => infer R ? (initalValue: I, extraArg: E, context: C) => R : T;
+export declare type AnyHook = SyncHook<any, any, any> | SyncBailHook<any, any, any> | SyncWaterfallHook<any, any> | AsyncParallelHook<any, any, any> | AsyncSeriesHook<any, any, any> | AsyncSeriesBailHook<any, any, any> | AsyncSeriesWaterfallHook<any, any>;
+export interface HookMap {
+    [x: string]: AnyHook;
+}
+export declare type Setup<HM extends HookMap = {}> = (utils: {
+    addHooks: (hook: Partial<HM>) => void;
+}) => void;
+export declare type CreatePlugin<HM extends HookMap, C> = (pluginHandlers: IPluginHandlers<HM, C> & {
+    setup?: Setup;
+}, options?: PluginOptions) => IPluginInstance<HM, C>;
+export declare type HookManager<HM extends HookMap, C> = {
+    createPlugin: CreatePlugin<HM, C>;
+    usePlugin: (...plugins: IPluginInstance<HM, C>[]) => void;
+    runner: RunnerType<HM>;
+    setContext: (context: C) => void;
+    clear: () => void;
+    addHooks: <EHM extends HookMap>(hook: Partial<EHM>) => void;
+    hooks: HM;
+    getPlugins: () => IPluginInstance<HM, C>[];
+};
+export declare type RunnerType<HM> = {
+    [K in keyof HM]: HookRunnerType<HM[K]>;
+} & {
+    setup: Setup;
+};
+export declare type HookRunnerType<H> = H extends SyncHook<infer T, infer E, infer R> ? SyncHook<T, E, R>['run'] : H extends SyncBailHook<infer T, infer E, infer R> ? SyncBailHook<T, E, R>['run'] : H extends SyncWaterfallHook<infer T, infer E> ? SyncWaterfallHook<T, E>['run'] : H extends AsyncParallelHook<infer T, infer E, infer R> ? AsyncParallelHook<T, E, R>['run'] : H extends AsyncSeriesHook<infer T, infer E, infer R> ? AsyncSeriesHook<T, E, R>['run'] : H extends AsyncSeriesBailHook<infer T, infer E, infer R> ? AsyncSeriesBailHook<T, E, R>['run'] : H extends AsyncSeriesWaterfallHook<infer T, infer E> ? AsyncSeriesWaterfallHook<T, E>['run'] : never;
+export declare type IPluginInstance<HM, C> = {
+    handlers: IPluginHandlers<HM, C>;
+    PLUGIN_SYMBOL: 'PLUGIN_SYMBOL';
+} & Required<PluginOptions>;
+export declare type IPluginHandlers<HM, C> = Partial<IPluginHandlersFullMap<HM, C>>;
+export declare type IPluginHandlersFullMap<HM, C> = {
+    [K in keyof HM]: HM[K] extends SyncHook<infer T, infer E, infer R> ? PatchPluginParameter<SyncHookHandler<T, E, R>, C> : HM[K] extends SyncBailHook<infer T, infer E, infer R> ? PatchPluginParameter<SyncBailHookHandler<T, E, R>, C> : HM[K] extends SyncWaterfallHook<infer T, infer E> ? PatchPluginParameter<SyncWaterfallHookHandler<T, E>, C> : HM[K] extends AsyncParallelHook<infer T, infer E, infer R> ? PatchPluginParameter<AsyncParallelHookHandler<T, E, R>, C> : HM[K] extends AsyncSeriesHook<infer T, infer E, infer R> ? PatchPluginParameter<AsyncSeriesHookHandler<T, E, R>, C> : HM[K] extends AsyncSeriesBailHook<infer T, infer E, infer R> ? PatchPluginParameter<AsyncSeriesBailHookHandler<T, E, R>, C> : HM[K] extends AsyncSeriesWaterfallHook<infer T, infer E> ? PatchPluginParameter<AsyncSeriesWaterfallHookHandler<T, E>, C> : never;
+};
+export declare type PluginOptions = {
+    name?: string;
+    /** current plugin should before these configured plugins.
+     * only works for same group
+     */
+    before?: string[];
+    /** current plugin should after these configured plugins.
+     * only works for same group.
+     */
+    after?: string[];
+    /** current plugin should not be used with these configured plugins */
+    conflict?: string[];
+    /** current plugin should be used with these configured plugins */
+    required?: string[];
+    /** current plugin group.
+     * smaller group will be executed first
+     * 0: default
+     */
+    group?: number;
+    [x: string]: any;
+};
+export declare type RemoveManagerVoidParameter<T> = T extends (initalValue: infer I, extraArg: infer E, context: infer C) => infer R ? null extends I ? null extends E ? null extends C ? (initialValue: I, extraArg: E, context: C) => R : void extends C ? (initialValue: I, extraArg: E) => R : (initialValue: I, extraArg: E, context: C) => R : void extends E ? null extends C ? (initialValue: I, context: C) => R : void extends C ? (initialValue: I) => R : (initialValue: I, context: C) => R : null extends C ? (initialValue: I, extraArg: E, context: C) => R : void extends C ? (initialValue: I, extraArg: E) => R : (initialValue: I, extraArg: E, context: C) => R : void extends I ? null extends E ? null extends C ? (extraArg: E, context: C) => R : void extends C ? (extraArg: E) => R : (extraArg: E, context: C) => R : void extends E ? null extends C ? (context: C) => R : void extends C ? () => R : (context: C) => R : null extends C ? (extraArg: E, context: C) => R : void extends C ? (extraArg: E) => R : (extraArg: E, context: C) => R : null extends E ? null extends C ? (initialValue: I, extraArg: E, context: C) => R : void extends C ? (initialValue: I, extraArg: E) => R : (initialValue: I, extraArg: E, context: C) => R : void extends E ? null extends C ? (initialValue: I, context: C) => R : void extends C ? (initialValue: I) => R : (initialValue: I, context: C) => R : null extends C ? (initialValue: I, extraArg: E, context: C) => R : void extends C ? (initialValue: I, extraArg: E) => R : (initialValue: I, extraArg: E, context: C) => R : T;

package/lib/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/utils.d.ts

@@ -0,0 +1,4 @@
+import { IPluginInstance } from './types';
+export declare const sortPluginsByRelationShip: <T extends IPluginInstance<any, any>[]>(input: T) => T;
+export declare const sortPlugins: <T extends IPluginInstance<any, any>[]>(input: T) => T;
+export declare const verifyPlugins: (plugins: IPluginInstance<any, any>[]) => void;

package/lib/utils.js

@@ -0,0 +1,110 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.verifyPlugins = exports.sortPlugins = exports.sortPluginsByRelationShip = void 0;
+const sortPluginsByRelationShip = (input) => {
+    const plugins = new Map();
+    /**
+     * the key is the end point of the edge
+     * In this way, we can easily find the plugin with zero in-degree
+     */
+    const edges = new Map();
+    const addEdge = (start, end) => {
+        if (!edges.has(end)) {
+            edges.set(end, new Set());
+        }
+        edges.get(end).add(start);
+    };
+    // Firstly, set plugins into map
+    input.forEach(plugin => {
+        plugins.set(plugin.name, plugin);
+    });
+    input.forEach(plugin => {
+        if (!edges.has(plugin.name)) {
+            edges.set(plugin.name, new Set());
+        }
+        if (plugin.before) {
+            plugin.before.forEach(name => {
+                // If the plugin is not in the input, we will ignore it
+                if (plugins.has(name)) {
+                    addEdge(plugin.name, name);
+                }
+            });
+        }
+        if (plugin.after) {
+            plugin.after.forEach(name => {
+                // If the plugin is not in the input, we will ignore it
+                if (plugins.has(name)) {
+                    addEdge(name, plugin.name);
+                }
+            });
+        }
+    });
+    const sorted = [];
+    while (edges.size > 0) {
+        let hasZeroInDegree = false;
+        edges.forEach((value, key) => {
+            if (value.size === 0) {
+                hasZeroInDegree = true;
+                sorted.push(plugins.get(key));
+                edges.delete(key);
+                edges.forEach(v => {
+                    v.delete(key);
+                });
+            }
+        });
+        if (!hasZeroInDegree) {
+            throw new Error(`Plugin circular dependency detected: ${Array.from(edges.keys()).join(', ')}. Please ensure the plugins have correct 'before' and 'after' property.`);
+        }
+    }
+    return sorted;
+};
+exports.sortPluginsByRelationShip = sortPluginsByRelationShip;
+const sortPlugins = (input) => {
+    const groupMap = new Map();
+    input.forEach(plugin => {
+        if (!groupMap.has(plugin.group)) {
+            groupMap.set(plugin.group, []);
+        }
+        groupMap.get(plugin.group).push(plugin);
+    });
+    const groupNumbers = Array.from(groupMap.keys());
+    const sortedGroupNumbers = groupNumbers.sort((a, b) => a - b);
+    const sorted = [];
+    sortedGroupNumbers.forEach(groupNumber => {
+        sorted.push(...(0, exports.sortPluginsByRelationShip)(groupMap.get(groupNumber)));
+    });
+    return sorted;
+};
+exports.sortPlugins = sortPlugins;
+const verifyPlugins = (plugins) => {
+    const names = new Set();
+    for (const current of plugins) {
+        if (typeof current.name !== 'string') {
+            throw new Error(`Plugin name must be string type.`);
+        }
+        if (!current.name) {
+            throw new Error(`Plugin name must be non-empty string.`);
+        }
+        if (names.has(current.name)) {
+            throw new Error(`Plugin name duplication detected: ${current.name}.`);
+        }
+        names.add(current.name);
+        if (current.conflict) {
+            for (const conflict of current.conflict) {
+                for (const plugin of plugins) {
+                    if (conflict === plugin.name) {
+                        throw new Error(`Plugin conflict detected: ${current.name} has conflict with ${plugin.name}.`);
+                    }
+                }
+            }
+        }
+        if (current.required) {
+            for (const required of current.required) {
+                if (!plugins.some(plugin => plugin.name === required)) {
+                    throw new Error(`Plugin missing detected: ${required} is required by ${current.name}.`);
+                }
+            }
+        }
+    }
+};
+exports.verifyPlugins = verifyPlugins;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shuvi/hook",
-  "version": "1.0.22",
+  "version": "1.0.24",
   "license": "MIT",
   "main": "lib/index.js",
   "module": "esm/index.js",