@modern-js/plugin 1.1.2 → 1.3.0

package/dist/types/manager/types.d.ts

@@ -0,0 +1,41 @@
+import type { Pipeline, Container, MaybeAsync, Middleware, AsyncPipeline } from 'farrow-pipeline';
+import type { Brook, Waterfall, AsyncBrook, AsyncWaterfall } from '../waterfall';
+import type { Worker, Workflow, AsyncWorker, AsyncWorkflow, ParallelWorkflow } from '../workflow';
+/** All hook types. */
+
+export declare type Hook = Waterfall<any> | AsyncWaterfall<any> | Workflow<any, any> | AsyncWorkflow<any, any> | ParallelWorkflow<any> | Pipeline<any, any> | AsyncPipeline<any, any>;
+export declare type HooksMap = Record<string, Hook>;
+/** Extract the type of callback function from a hook. */
+
+export declare type ToThread<P extends Hook> = P extends Workflow<infer I, infer O> ? Worker<I, O> : P extends AsyncWorkflow<infer I, infer O> ? AsyncWorker<I, O> : P extends ParallelWorkflow<infer I, infer O> ? AsyncWorker<I, O> : P extends Waterfall<infer I> ? Brook<I> : P extends AsyncWaterfall<infer I> ? AsyncBrook<I> : P extends Pipeline<infer I, infer O> ? Middleware<I, O> : P extends AsyncPipeline<infer I, infer O> ? Middleware<I, MaybeAsync<O>> : never;
+/** Extract types of callback function from hooks. */
+
+export declare type ToThreads<PS> = { [K in keyof PS]: PS[K] extends Hook ? ToThread<PS[K]> : PS[K] extends void ? void : never };
+/** Extract run method from a hook. */
+
+export declare type RunnerFromHook<P extends Hook> = P extends Waterfall<infer I> ? Waterfall<I>['run'] : P extends AsyncWaterfall<infer I> ? AsyncWaterfall<I>['run'] : P extends Workflow<infer I, infer O> ? Workflow<I, O>['run'] : P extends AsyncWorkflow<infer I, infer O> ? AsyncWorkflow<I, O>['run'] : P extends ParallelWorkflow<infer I, infer O> ? ParallelWorkflow<I, O>['run'] : P extends Pipeline<infer I, infer O> ? Pipeline<I, O>['run'] : P extends AsyncPipeline<infer I, infer O> ? AsyncPipeline<I, O>['run'] : never;
+/** Extract all run methods from hooks. */
+
+export declare type ToRunners<PS> = { [K in keyof PS]: PS[K] extends Hook ? RunnerFromHook<PS[K]> : PS[K] extends void ? void : never };
+/** All options to define a plugin. */
+
+export declare type PluginOptions<Hooks, Setup = undefined> = {
+  name?: string;
+  pre?: string[];
+  post?: string[];
+  setup?: Setup;
+  rivals?: string[];
+  required?: string[];
+  usePlugins?: PluginOptions<Hooks, Setup>[];
+  registerHook?: Partial<Hooks>;
+};
+/** Options of manager.init method. */
+
+export declare type InitOptions = {
+  container?: Container;
+};
+/** Common api of setup function. */
+
+export declare type CommonAPI<Hooks> = {
+  useHookRunners: () => ToRunners<Hooks>;
+};

package/dist/types/waterfall/async.d.ts

@@ -2,7 +2,7 @@ import { MaybeAsync, Container } from 'farrow-pipeline';
 declare const ASYNC_WATERFALL_SYMBOL: unique symbol;
 export declare type AsyncBrook<I = unknown> = (I: I) => MaybeAsync<I>;
 export declare type AsyncBrookInput<I = unknown> = AsyncBrook<I> | {
-  middlware: AsyncBrook<I>;
+  middleware: AsyncBrook<I>;
 };
 export declare type AsyncBrooks<I = unknown> = AsyncBrook<I>[];
 export declare type AsyncBrookInputs<I = unknown> = AsyncBrookInput<I>[];
@@ -14,7 +14,7 @@ export declare type RunAsyncWaterfallOptions<I = unknown> = {
 export declare type AsyncWaterfall<I> = {
   run: (input: I, options?: RunAsyncWaterfallOptions<I>) => MaybeAsync<I>;
   use: (...I: AsyncBrookInputs<I>) => AsyncWaterfall<I>;
-  middlware: AsyncBrook<I>;
+  middleware: AsyncBrook<I>;
   [ASYNC_WATERFALL_SYMBOL]: true;
 };
 export declare type AsyncWaterfall2AsyncBrook<P extends AsyncWaterfall<any>> = P extends AsyncWaterfall<infer I> ? AsyncBrook<I> : never;

package/jest.config.js

@@ -0,0 +1,8 @@
+const sharedConfig = require('@scripts/jest-config');
+
+/** @type {import('@jest/types').Config.InitialOptions} */
+module.exports = {
+  // eslint-disable-next-line node/no-unsupported-features/es-syntax
+  ...sharedConfig,
+  rootDir: __dirname,
+};

package/modern.config.js

@@ -1,10 +1,2 @@
 /** @type {import('@modern-js/module-tools').UserConfig} */
-module.exports = {
-  testing: {
-    jest: {
-      collectCoverage: true,
-      collectCoverageFrom: ['./src/**/*.ts'],
-      coveragePathIgnorePatterns: ['/node_modules/'],
-    },
-  },
-};
+module.exports = {};

package/package.json

@@ -11,7 +11,7 @@
     "modern",
     "modern.js"
   ],
-  "version": "1.1.2",
+  "version": "1.3.0",
   "jsnext:source": "./src/index.ts",
   "types": "./dist/types/index.d.ts",
   "main": "./dist/js/node/index.js",
@@ -20,12 +20,14 @@
   "exports": {
     ".": {
       "node": {
+        "jsnext:source": "./src/index.ts",
         "import": "./dist/js/modern/index.js",
         "require": "./dist/js/node/index.js"
       },
       "default": "./dist/js/treeshaking/index.js"
     },
     "./node": {
+      "jsnext:source": "./node.js",
       "default": "./node.js"
     }
   },
@@ -37,8 +39,9 @@
     "@types/jest": "^26",
     "@types/node": "^14",
     "typescript": "^4",
-    "@modern-js/plugin-testing": "^1.1.0",
-    "@modern-js/module-tools": "^1.1.0"
+    "@scripts/build": "0.0.0",
+    "jest": "^27",
+    "@scripts/jest-config": "0.0.0"
   },
   "sideEffects": false,
   "publishConfig": {
@@ -47,7 +50,9 @@
   },
   "scripts": {
     "new": "modern new",
+    "dev": "modern build --watch",
     "build": "modern build",
-    "test": "modern test --passWithNoTests"
-  }
+    "test": "jest --passWithNoTests"
+  },
+  "readme": "\n<p align=\"center\">\n  <a href=\"https://modernjs.dev\" target=\"blank\"><img src=\"https://lf3-static.bytednsdoc.com/obj/eden-cn/ylaelkeh7nuhfnuhf/modernjs-cover.png\" width=\"300\" alt=\"Modern.js Logo\" /></a>\n</p>\n<p align=\"center\">\n现代 Web 工程体系\n  <br/>\n  <a href=\"https://modernjs.dev\" target=\"blank\">\n    modernjs.dev\n  </a>\n</p>\n<p align=\"center\">\n  The meta-framework suite designed from scratch for frontend-focused modern web development\n</p>\n\n# Introduction\n\n> The doc site ([modernjs.dev](https://modernjs.dev)) and articles are only available in Chinese for now, we are planning to add English versions soon.\n\n- [Modern.js: Hello, World!](https://zhuanlan.zhihu.com/p/426707646)\n\n## Getting Started\n\n- [Quick Start](https://modernjs.dev/docs/start)\n- [Guides](https://modernjs.dev/docs/guides)\n- [API References](https://modernjs.dev/docs/apis)\n\n## Contributing\n\n- [Contributing Guide](https://github.com/modern-js-dev/modern.js/blob/main/CONTRIBUTING.md)\n"
 }

package/tests/async.test.ts

@@ -7,19 +7,20 @@ import {
   createContext,
   createContainer,
 } from 'farrow-pipeline';
-import { main } from './fixtures/async/core';
+import type { PluginOptions, AsyncSetup } from '../src';
+import { createManager, createAsyncManager, useRunner } from '../src/manager';
+import { createWaterfall, createAsyncWaterfall } from '../src/waterfall';
+import {
+  createWorkflow,
+  createAsyncWorkflow,
+  createParallelWorkflow,
+} from '../src/workflow';
+import { main, TestAsyncHooks, TestAsyncPlugin } from './fixtures/async/core';
 import foo from './fixtures/async/base/foo';
 import bar, { getBar } from './fixtures/async/base/bar';
 import dFoo from './fixtures/async/dynamic/foo';
 import dBar, { getNumber } from './fixtures/async/dynamic/bar';
 import { sleep } from './helpers';
-import { createManager, createAsyncManager, useRunner } from '@/manager';
-import { createWaterfall, createAsyncWaterfall } from '@/waterfall';
-import {
-  createWorkflow,
-  createAsyncWorkflow,
-  createParallelWorkflow,
-} from '@/workflow';
 
 describe('async manager', () => {
   it('base usage', async () => {
@@ -40,7 +41,7 @@ describe('async manager', () => {
     expect(getBar()).toBe(3);
   });
 
-  it('should support async initializer', async () => {
+  it('should support async setup function', async () => {
     const manager = createAsyncManager();
 
     const countContext = createContext(0);
@@ -397,6 +398,22 @@ describe('async manager', () => {
     expect(count).toBe(2);
   });
 
+  it('should support manager clone and override pluginAPI', done => {
+    const myAPI = { hello: () => 1 };
+    const manager = createAsyncManager({}, myAPI);
+    const plugin = {
+      setup(api: typeof myAPI) {
+        expect(api.hello()).toEqual(2);
+        done();
+      },
+    };
+    const clonedManager = manager.clone({
+      hello: () => 2,
+    });
+
+    clonedManager.usePlugin(() => plugin).init();
+  });
+
   it('isPlugin if exclusive plugins of manager', () => {
     const manager0 = createManager();
     const manager1 = createAsyncManager();
@@ -501,11 +518,11 @@ describe('async manager', () => {
 
     runner.pipeline({});
     await runner.asyncPipeline({});
-    runner.waterfall({});
-    await runner.asyncWaterfall({});
-    runner.workflow({});
-    await runner.asyncWorkflow({});
-    await runner.parallelWorkflow({});
+    runner.waterfall();
+    await runner.asyncWaterfall();
+    runner.workflow();
+    await runner.asyncWorkflow();
+    await runner.parallelWorkflow();
 
     expect(list).toStrictEqual([
       'pipeline',
@@ -591,4 +608,105 @@ describe('async manager', () => {
       );
     });
   });
+
+  describe('setup api', () => {
+    it('should allow to access api.useHookRunners by default', done => {
+      const manager = createAsyncManager<TestAsyncHooks>();
+      const plugin: TestAsyncPlugin = {
+        name: 'plugin',
+        setup: api => {
+          expect(api.useHookRunners).toBeTruthy();
+          done();
+        },
+      };
+      manager.usePlugin(() => plugin);
+      manager.init();
+    });
+
+    it('should allow to register extra api', done => {
+      type API = { foo: () => void };
+
+      const manager = createAsyncManager<TestAsyncHooks, API>(
+        {},
+        // eslint-disable-next-line @typescript-eslint/no-empty-function
+        { foo: () => {} },
+      );
+
+      const plugin: PluginOptions<
+        TestAsyncHooks,
+        AsyncSetup<TestAsyncHooks, API>
+      > = {
+        name: 'plugin',
+        setup: api => {
+          expect(api.foo).toBeTruthy();
+          done();
+        },
+      };
+
+      manager.usePlugin(() => plugin);
+      manager.init();
+    });
+  });
+
+  describe('usePlugins option', () => {
+    it('should allow to use single plugin', async () => {
+      const manager = createAsyncManager<TestAsyncHooks>();
+
+      const list: number[] = [];
+      const plugin0: TestAsyncPlugin = {
+        name: 'plugin0',
+        setup: () => {
+          list.push(0);
+        },
+      };
+
+      const plugin1: TestAsyncPlugin = {
+        name: 'plugin1',
+        usePlugins: [plugin0],
+        setup: () => {
+          list.push(1);
+        },
+      };
+
+      manager.usePlugin(() => plugin1);
+
+      await manager.init();
+
+      expect(list).toStrictEqual([0, 1]);
+    });
+
+    it('should allow to use multiple plugins', async () => {
+      const manager = createAsyncManager<TestAsyncHooks>();
+
+      const list: number[] = [];
+      const plugin0: TestAsyncPlugin = {
+        name: 'plugin0',
+        setup: () => {
+          list.push(0);
+        },
+      };
+
+      const plugin1 = {
+        name: 'plugin1',
+        usePlugins: [plugin0],
+        setup: () => {
+          list.push(1);
+        },
+      };
+
+      const plugin2 = {
+        name: 'plugin2',
+        usePlugins: [plugin1],
+        setup: () => {
+          list.push(2);
+        },
+      };
+
+      manager.usePlugin(() => plugin2);
+
+      await manager.init();
+
+      expect(list).toStrictEqual([0, 1, 2]);
+    });
+  });
 });

package/tests/fixtures/async/core/index.ts

@@ -3,6 +3,8 @@ import {
   createWaterfall,
   createWorkflow,
   createContext,
+  PluginOptions,
+  AsyncSetup,
 } from '../../../../src';
 
 // eslint-disable-next-line @typescript-eslint/ban-types
@@ -99,9 +101,15 @@ const lifecircle = {
   preBuild,
   postBuild,
 };
-export const main = createAsyncManager<ExternalProgress, typeof lifecircle>(
-  lifecircle,
-);
+
+export type TestAsyncHooks = ExternalProgress & typeof lifecircle;
+
+export const main = createAsyncManager<TestAsyncHooks>(lifecircle);
+
+export type TestAsyncPlugin = PluginOptions<
+  TestAsyncHooks,
+  AsyncSetup<TestAsyncHooks>
+>;
 
 export const { createPlugin } = main;
 
@@ -111,7 +119,7 @@ export const { usePlugin } = main;
 
 export const initPlugins = main.init;
 
-export const registeManager = main.registe;
+export const { registerHook } = main;
 
 export const { useRunner } = main;
 

package/tests/fixtures/async/dynamic/foo.ts

@@ -1,5 +1,5 @@
 import { createAsyncWaterfall } from '../../../../src';
-import { createPlugin, registeManager, useRunner } from '../core';
+import { createPlugin, registerHook, useRunner } from '../core';
 
 // declare new lifecircle type
 declare module '../core' {
@@ -13,7 +13,7 @@ const fooWaterfall = createAsyncWaterfall();
 
 const foo = createPlugin(() => {
   // registe new lifecircle
-  registeManager({ fooWaterfall });
+  registerHook({ fooWaterfall });
 
   return {
     preDev: () => {

package/tests/fixtures/sync/core/index.ts

@@ -1,8 +1,10 @@
 import {
+  Setup,
   createManager,
   createWaterfall,
   createWorkflow,
   createContext,
+  PluginOptions,
 } from '../../../../src';
 
 // eslint-disable-next-line @typescript-eslint/ban-types
@@ -99,9 +101,12 @@ const lifecircle = {
   preBuild,
   postBuild,
 };
-export const main = createManager<ExternalProgress, typeof lifecircle>(
-  lifecircle,
-);
+
+export type TestHooks = ExternalProgress & typeof lifecircle;
+
+export const main = createManager<TestHooks>(lifecircle);
+
+export type TestPlugin = PluginOptions<TestHooks, Setup<TestHooks>>;
 
 export const { createPlugin } = main;
 
@@ -111,7 +116,7 @@ export const { usePlugin } = main;
 
 export const initPlugins = main.init;
 
-export const registeManager = main.registe;
+export const { registerHook } = main;
 
 export const { useRunner } = main;
 

package/tests/fixtures/sync/dynamic/foo.ts

@@ -1,5 +1,5 @@
 import { createAsyncWaterfall } from '../../../../src';
-import { createPlugin, registeManager, useRunner } from '../core';
+import { createPlugin, registerHook, useRunner } from '../core';
 
 // declare new lifecircle type
 declare module '../core' {
@@ -13,7 +13,7 @@ const fooWaterfall = createAsyncWaterfall();
 
 const foo = createPlugin(() => {
   // registe new lifecircle
-  registeManager({ fooWaterfall });
+  registerHook({ fooWaterfall });
 
   return {
     preDev: () => {

package/tests/pipeline.test.ts

@@ -1,7 +1,6 @@
 // eslint-disable-next-line eslint-comments/disable-enable-pair
 /* eslint-disable max-lines */
 import * as asyncHooksImpl from 'farrow-pipeline/asyncHooks.node';
-import { sleep } from './helpers';
 import {
   createContext,
   createContainer,
@@ -10,7 +9,8 @@ import {
   usePipeline,
   useContainer,
   isPipeline,
-} from '@/index';
+} from '../src';
+import { sleep } from './helpers';
 
 describe('createPipeline', () => {
   it('basic usage', async () => {

package/tests/sync.test.ts

@@ -6,18 +6,19 @@ import {
   createContext,
   createContainer,
 } from 'farrow-pipeline';
-import { main } from './fixtures/sync/core';
-import foo from './fixtures/sync/base/foo';
-import bar, { getBar } from './fixtures/sync/base/bar';
-import dFoo from './fixtures/sync/dynamic/foo';
-import dBar, { getNumber, setNumber } from './fixtures/sync/dynamic/bar';
-import { createManager, createAsyncManager, useRunner } from '@/manager';
-import { createWaterfall, createAsyncWaterfall } from '@/waterfall';
+import type { PluginOptions, Setup } from '../src';
+import { createManager, createAsyncManager, useRunner } from '../src/manager';
+import { createWaterfall, createAsyncWaterfall } from '../src/waterfall';
 import {
   createWorkflow,
   createAsyncWorkflow,
   createParallelWorkflow,
-} from '@/workflow';
+} from '../src/workflow';
+import { main, TestHooks, TestPlugin } from './fixtures/sync/core';
+import foo from './fixtures/sync/base/foo';
+import bar, { getBar } from './fixtures/sync/base/bar';
+import dFoo from './fixtures/sync/dynamic/foo';
+import dBar, { getNumber, setNumber } from './fixtures/sync/dynamic/bar';
 
 describe('sync manager', () => {
   it('base useage', () => {
@@ -391,6 +392,22 @@ describe('sync manager', () => {
     expect(count).toBe(1);
   });
 
+  it('should support manager clone and override pluginAPI', done => {
+    const myAPI = { hello: () => 1 };
+    const manager = createManager({}, myAPI);
+    const plugin = {
+      setup(api: typeof myAPI) {
+        expect(api.hello()).toEqual(2);
+        done();
+      },
+    };
+    const clonedManager = manager.clone({
+      hello: () => 2,
+    });
+
+    clonedManager.usePlugin(() => plugin).init();
+  });
+
   it('isPlugin: exclusive plugins of manager', () => {
     const manager0 = createAsyncManager();
     const manager1 = createManager();
@@ -497,11 +514,11 @@ describe('sync manager', () => {
 
     runner.pipeline({});
     await runner.asyncPipeline({});
-    runner.waterfall({});
-    await runner.asyncWaterfall({});
-    runner.workflow({});
-    await runner.asyncWorkflow({});
-    await runner.parallelWorkflow({});
+    runner.waterfall();
+    await runner.asyncWaterfall();
+    runner.workflow();
+    await runner.asyncWorkflow();
+    await runner.parallelWorkflow();
 
     expect(list).toStrictEqual([
       'pipeline',
@@ -561,4 +578,100 @@ describe('sync manager', () => {
       );
     });
   });
+
+  describe('setup api', () => {
+    it('should allow to access api.useHookRunners by default', done => {
+      const manager = createManager<TestHooks>();
+      const plugin: TestPlugin = {
+        name: 'plugin',
+        setup: api => {
+          expect(api.useHookRunners).toBeTruthy();
+          done();
+        },
+      };
+      manager.usePlugin(() => plugin);
+      manager.init();
+    });
+
+    it('should allow to register extra api', done => {
+      type API = { foo: () => void };
+
+      const manager = createAsyncManager<TestHooks, API>(
+        {},
+        // eslint-disable-next-line @typescript-eslint/no-empty-function
+        { foo: () => {} },
+      );
+
+      const plugin: PluginOptions<TestHooks, Setup<TestHooks, API>> = {
+        name: 'plugin',
+        setup: api => {
+          expect(api.foo).toBeTruthy();
+          done();
+        },
+      };
+
+      manager.usePlugin(() => plugin);
+      manager.init();
+    });
+  });
+
+  describe('usePlugins option', () => {
+    it('should allow to use single plugin', async () => {
+      const manager = createManager<TestHooks>();
+
+      const list: number[] = [];
+      const plugin0: TestPlugin = {
+        name: 'plugin0',
+        setup: () => {
+          list.push(0);
+        },
+      };
+
+      const plugin1: TestPlugin = {
+        name: 'plugin1',
+        usePlugins: [plugin0],
+        setup: () => {
+          list.push(1);
+        },
+      };
+
+      manager.usePlugin(() => plugin1);
+      manager.init();
+
+      expect(list).toStrictEqual([0, 1]);
+    });
+
+    it('should allow to use multiple plugins', async () => {
+      const manager = createManager<TestHooks>();
+
+      const list: number[] = [];
+      const plugin0: TestPlugin = {
+        name: 'plugin0',
+        setup: () => {
+          list.push(0);
+        },
+      };
+
+      const plugin1: TestPlugin = {
+        name: 'plugin1',
+        usePlugins: [plugin0],
+        setup: () => {
+          list.push(1);
+        },
+      };
+
+      const plugin2: TestPlugin = {
+        name: 'plugin2',
+        usePlugins: [plugin1],
+        setup: () => {
+          list.push(2);
+        },
+      };
+
+      manager.usePlugin(() => plugin2);
+      manager.init();
+
+      expect(list).toStrictEqual([0, 1, 2]);
+    });
+  });
 });

package/tests/tsconfig.json

@@ -7,9 +7,7 @@
     "isolatedModules": true,
     "target": "ES5",
     "esModuleInterop": true,
-    "paths": {
-      "@/*": ["../src/*"]
-    },
+    "paths": {},
     "types": ["node", "jest"]
   }
 }

package/tests/waterfall.test.ts

@@ -1,5 +1,4 @@
 import { enable, disable } from 'farrow-pipeline/asyncHooks.node';
-import { sleep } from './helpers';
 import {
   createWaterfall,
   createAsyncWaterfall,
@@ -7,7 +6,8 @@ import {
   createContainer,
   isWaterfall,
   isAsyncWaterfall,
-} from '@/index';
+} from '../src';
+import { sleep } from './helpers';
 
 describe('waterfall', () => {
   it('base usage', () => {

package/tests/workflow.test.ts

@@ -1,4 +1,3 @@
-import { sleep } from './helpers';
 import {
   createWorkflow,
   createAsyncWorkflow,
@@ -6,7 +5,8 @@ import {
   isWorkflow,
   isAsyncWorkflow,
   isParallelWorkflow,
-} from '@/workflow';
+} from '../src/workflow';
+import { sleep } from './helpers';
 
 describe('workflow', () => {
   describe('sync', () => {

package/tsconfig.json

@@ -7,9 +7,7 @@
     "isolatedModules": true,
     "target": "ES5",
     "esModuleInterop": true,
-    "paths": {
-      "@/*": ["./src/*"]
-    },
+    "paths": {},
     "types": ["node", "jest"]
   },
   "include": ["src"]

package/src/index.ts

@@ -1,5 +0,0 @@
-export * from 'farrow-pipeline';
-
-export * from './waterfall';
-export * from './workflow';
-export * from './manager';