@modern-js/core 1.4.5 → 1.6.0

package/dist/types/index.d.ts

@@ -1,111 +1,22 @@
 import { INTERNAL_PLUGINS } from '@modern-js/utils';
-import { ParallelWorkflow, AsyncWorkflow, Progresses2Runners, AsyncWaterfall } from '@modern-js/plugin';
 import type { Hooks } from '@modern-js/types';
 import { ErrorObject } from 'ajv';
-import { Command } from './utils/commander';
-import { TransformPlugin } from './loadPlugins';
-import { AppContext, ConfigContext, IAppContext, initAppContext, ResolvedConfigContext, useAppContext, useConfigContext, useResolvedConfigContext } from './context';
-import { NormalizedConfig } from './config/mergeConfig';
+import { IAppContext, initAppContext } from './context';
+import type { NormalizedConfig } from './config/mergeConfig';
 export type { Hooks };
 export * from './config';
 export * from '@modern-js/plugin';
 export * from '@modern-js/plugin/node';
-export declare type HooksRunner = Progresses2Runners<{
-  config: ParallelWorkflow<void>;
-  resolvedConfig: AsyncWaterfall<{
-    resolved: NormalizedConfig;
-  }>;
-  validateSchema: ParallelWorkflow<void>;
-  prepare: AsyncWorkflow<void, void>;
-  commands: AsyncWorkflow<{
-    program: Command;
-  }, void>;
-  watchFiles: ParallelWorkflow<void>;
-  fileChange: AsyncWorkflow<{
-    filename: string;
-    eventType: 'add' | 'change' | 'unlink';
-  }, void>;
-  beforeExit: AsyncWorkflow<void, void>;
-}>;
-export declare const manager: import("@modern-js/plugin").AsyncManager<Hooks, {
-  config: ParallelWorkflow<void, unknown>;
-  resolvedConfig: AsyncWaterfall<{
-    resolved: NormalizedConfig;
-  }>;
-  validateSchema: ParallelWorkflow<void, unknown>;
-  prepare: AsyncWorkflow<void, void>;
-  commands: AsyncWorkflow<{
-    program: Command;
-  }, void>;
-  watchFiles: ParallelWorkflow<void, unknown>;
-  fileChange: AsyncWorkflow<{
-    filename: string;
-    eventType: 'add' | 'change' | 'unlink';
-  }, void>;
-  beforeExit: AsyncWorkflow<void, void>;
-  beforeRestart: AsyncWorkflow<void, void>;
-}>;
-export declare const createPlugin: (initializer: import("@modern-js/plugin").AsyncInitializer<Partial<import("@modern-js/plugin").Progresses2Threads<{
-  config: ParallelWorkflow<void, unknown>;
-  resolvedConfig: AsyncWaterfall<{
-    resolved: NormalizedConfig;
-  }>;
-  validateSchema: ParallelWorkflow<void, unknown>;
-  prepare: AsyncWorkflow<void, void>;
-  commands: AsyncWorkflow<{
-    program: Command;
-  }, void>;
-  watchFiles: ParallelWorkflow<void, unknown>;
-  fileChange: AsyncWorkflow<{
-    filename: string;
-    eventType: 'add' | 'change' | 'unlink';
-  }, void>;
-  beforeExit: AsyncWorkflow<void, void>;
-  beforeRestart: AsyncWorkflow<void, void>;
-} & import("@modern-js/plugin").ClearDraftProgress<Hooks>>>>, options?: import("@modern-js/plugin").PluginOptions | undefined) => import("@modern-js/plugin").AsyncPlugin<Partial<import("@modern-js/plugin").Progresses2Threads<{
-  config: ParallelWorkflow<void, unknown>;
-  resolvedConfig: AsyncWaterfall<{
-    resolved: NormalizedConfig;
-  }>;
-  validateSchema: ParallelWorkflow<void, unknown>;
-  prepare: AsyncWorkflow<void, void>;
-  commands: AsyncWorkflow<{
-    program: Command;
-  }, void>;
-  watchFiles: ParallelWorkflow<void, unknown>;
-  fileChange: AsyncWorkflow<{
-    filename: string;
-    eventType: 'add' | 'change' | 'unlink';
-  }, void>;
-  beforeExit: AsyncWorkflow<void, void>;
-  beforeRestart: AsyncWorkflow<void, void>;
-} & import("@modern-js/plugin").ClearDraftProgress<Hooks>>>>, registerHook: (newShape: Partial<Hooks>) => void, mountHook: () => Progresses2Runners<{
-  config: ParallelWorkflow<void, unknown>;
-  resolvedConfig: AsyncWaterfall<{
-    resolved: NormalizedConfig;
-  }>;
-  validateSchema: ParallelWorkflow<void, unknown>;
-  prepare: AsyncWorkflow<void, void>;
-  commands: AsyncWorkflow<{
-    program: Command;
-  }, void>;
-  watchFiles: ParallelWorkflow<void, unknown>;
-  fileChange: AsyncWorkflow<{
-    filename: string;
-    eventType: 'add' | 'change' | 'unlink';
-  }, void>;
-  beforeExit: AsyncWorkflow<void, void>;
-  beforeRestart: AsyncWorkflow<void, void>;
-} & import("@modern-js/plugin").ClearDraftProgress<Hooks>>;
-export declare const usePlugins: (plugins: string[]) => void;
-export { AppContext, ResolvedConfigContext, useAppContext, useConfigContext, useResolvedConfigContext, ConfigContext };
+export { manager, mountHook, usePlugins, createPlugin, registerHook } from './manager';
+export type { CliHooks, CliPlugin, CliHookCallbacks } from './manager';
+export { AppContext, ConfigContext, ResolvedConfigContext, useAppContext, useConfigContext, useResolvedConfigContext } from './pluginAPI';
+export type { PluginAPI } from './pluginAPI';
 export type { NormalizedConfig, IAppContext };
 declare const initAppDir: (cwd?: string | undefined) => Promise<string>;
 export interface CoreOptions {
   configFile?: string;
   packageJsonConfig?: string;
   plugins?: typeof INTERNAL_PLUGINS;
-  transformPlugin?: TransformPlugin;
   onSchemaError?: (error: ErrorObject) => void;
   options?: {
     metaName?: string;

package/dist/types/initWatcher.d.ts

@@ -1,4 +1,4 @@
 import chokidar from 'chokidar';
 import { LoadedConfig } from './config';
-import { HooksRunner } from '.';
+import { HooksRunner } from './manager';
 export declare const initWatcher: (loaded: LoadedConfig, appDirectory: string, configDir: string | undefined, hooksRunner: HooksRunner, argv: string[]) => Promise<chokidar.FSWatcher | undefined>;

package/dist/types/loadPlugins.d.ts

@@ -1,30 +1,41 @@
 import { INTERNAL_PLUGINS } from '@modern-js/utils';
 import type { UserConfig } from './config';
-declare type Plugin = string | [string, any];
+import { CliPlugin } from './manager';
+declare type PluginItem = string | [string, any];
 export declare type LoadedPlugin = {
-  cli?: any;
-  cliPkg?: string;
-  server?: any;
+  cli?: CliPlugin;
+  server?: string;
   serverPkg?: string;
 };
-export declare type PluginConfigItem = {
-  cli?: Plugin;
-  server?: Plugin;
-} | Plugin;
-export declare type PluginConfig = Array<PluginConfigItem>;
-export declare type TransformPlugin = (plugin: PluginConfig, resolvedConfig: UserConfig, pluginOptions?: any) => PluginConfig;
-export declare function getAppPlugins(appDirectory: string, pluginConfig: PluginConfig, internalPlugins?: typeof INTERNAL_PLUGINS): PluginConfigItem[];
+/**
+ * @deprecated
+ * Using NewPluginConfig insteand.
+ */
+
+declare type OldPluginConfig = Array<PluginItem | {
+  cli?: PluginItem;
+  server?: PluginItem;
+}>;
+declare type NewPluginConfig = CliPlugin[] | {
+  cli?: CliPlugin[];
+  /** Custom server plugin is not supported yet. */
+
+  server?: never;
+};
+export declare type PluginConfig = OldPluginConfig | NewPluginConfig;
+export declare function getAppPlugins(appDirectory: string, oldPluginConfig: OldPluginConfig, internalPlugins?: typeof INTERNAL_PLUGINS): (PluginItem | {
+  cli?: PluginItem | undefined;
+  server?: PluginItem | undefined;
+})[];
 /**
  * Load internal plugins which in @modern-js scope and user's custom plugins.
  * @param appDirectory - Application root directory.
  * @param userConfig - Resolved user config.
  * @param options.internalPlugins - Internal plugins.
- * @param options.transformPlugin - transform plugin before using it.
  * @returns Plugin Objects has been required.
  */
 
 export declare const loadPlugins: (appDirectory: string, userConfig: UserConfig, options?: {
   internalPlugins?: typeof INTERNAL_PLUGINS;
-  transformPlugin?: TransformPlugin;
 }) => LoadedPlugin[];
 export {};

package/dist/types/manager.d.ts

@@ -0,0 +1,74 @@
+import { ToThreads, ToRunners, AsyncSetup, PluginOptions, AsyncWorkflow, AsyncWaterfall, ParallelWorkflow } from '@modern-js/plugin';
+import type { Hooks } from '@modern-js/types';
+import type { Command } from './utils/commander';
+import type { NormalizedConfig } from './config/mergeConfig';
+import { pluginAPI } from './pluginAPI';
+export declare type HooksRunner = ToRunners<{
+  config: ParallelWorkflow<void>;
+  resolvedConfig: AsyncWaterfall<{
+    resolved: NormalizedConfig;
+  }>;
+  validateSchema: ParallelWorkflow<void>;
+  prepare: AsyncWorkflow<void, void>;
+  commands: AsyncWorkflow<{
+    program: Command;
+  }, void>;
+  watchFiles: ParallelWorkflow<void>;
+  fileChange: AsyncWorkflow<{
+    filename: string;
+    eventType: 'add' | 'change' | 'unlink';
+  }, void>;
+  beforeExit: AsyncWorkflow<void, void>;
+  beforeRestart: AsyncWorkflow<void, void>;
+}>;
+declare const baseHooks: {
+  config: ParallelWorkflow<void, unknown>;
+  resolvedConfig: AsyncWaterfall<{
+    resolved: NormalizedConfig;
+  }>;
+  validateSchema: ParallelWorkflow<void, unknown>;
+  prepare: AsyncWorkflow<void, void>;
+  commands: AsyncWorkflow<{
+    program: Command;
+  }, void>;
+  watchFiles: ParallelWorkflow<void, unknown>;
+  fileChange: AsyncWorkflow<{
+    filename: string;
+    eventType: 'add' | 'change' | 'unlink';
+  }, void>;
+  beforeExit: AsyncWorkflow<void, void>;
+  beforeRestart: AsyncWorkflow<void, void>;
+};
+/** All hooks of cli plugin. */
+
+export declare type CliHooks = typeof baseHooks & Hooks;
+/** All hook callbacks of cli plugin. */
+
+export declare type CliHookCallbacks = ToThreads<CliHooks>;
+export declare const manager: import("@modern-js/plugin").AsyncManager<CliHooks, {
+  setAppContext: (value: import("@modern-js/types").IAppContext) => void;
+  useAppContext: () => import("@modern-js/types").IAppContext;
+  useConfigContext: () => import("./config").UserConfig;
+  useResolvedConfigContext: () => NormalizedConfig;
+}>;
+/** Plugin options of a cli plugin. */
+
+export declare type CliPlugin = PluginOptions<CliHooks, AsyncSetup<CliHooks, typeof pluginAPI>>;
+export declare const createPlugin: (setup?: AsyncSetup<CliHooks, {
+  setAppContext: (value: import("@modern-js/types").IAppContext) => void;
+  useAppContext: () => import("@modern-js/types").IAppContext;
+  useConfigContext: () => import("./config").UserConfig;
+  useResolvedConfigContext: () => NormalizedConfig;
+}> | undefined, options?: PluginOptions<CliHooks, AsyncSetup<CliHooks, {
+  setAppContext: (value: import("@modern-js/types").IAppContext) => void;
+  useAppContext: () => import("@modern-js/types").IAppContext;
+  useConfigContext: () => import("./config").UserConfig;
+  useResolvedConfigContext: () => NormalizedConfig;
+}>> | undefined) => import("@modern-js/plugin").AsyncPlugin<CliHooks, {
+  setAppContext: (value: import("@modern-js/types").IAppContext) => void;
+  useAppContext: () => import("@modern-js/types").IAppContext;
+  useConfigContext: () => import("./config").UserConfig;
+  useResolvedConfigContext: () => NormalizedConfig;
+}>, registerHook: (newHooks: Partial<CliHooks>) => void, mountHook: () => ToRunners<CliHooks>;
+export declare const usePlugins: (plugins: string[]) => void;
+export {};

package/dist/types/pluginAPI.d.ts

@@ -0,0 +1,13 @@
+import type { CommonAPI } from '@modern-js/plugin';
+import type { CliHooks } from './manager';
+import { AppContext, ConfigContext, useAppContext, useConfigContext, ResolvedConfigContext, useResolvedConfigContext } from './context';
+export declare const pluginAPI: {
+  setAppContext: (value: import("@modern-js/types/cli").IAppContext) => void;
+  useAppContext: () => import("@modern-js/types/cli").IAppContext;
+  useConfigContext: () => import("./config").UserConfig;
+  useResolvedConfigContext: () => import(".").NormalizedConfig;
+};
+/** all apis for cli plugin */
+
+export declare type PluginAPI = typeof pluginAPI & CommonAPI<CliHooks>;
+export { AppContext, ConfigContext, ResolvedConfigContext, useAppContext, useConfigContext, useResolvedConfigContext };

package/package.json

@@ -11,7 +11,7 @@
     "modern",
     "modern.js"
   ],
-  "version": "1.4.5",
+  "version": "1.6.0",
   "jsnext:source": "./src/index.ts",
   "types": "./dist/types/index.d.ts",
   "main": "./dist/js/node/index.js",
@@ -43,8 +43,8 @@
     "@babel/code-frame": "^7.14.5",
     "@babel/runtime": "^7",
     "@modern-js/load-config": "^1.2.2",
-    "@modern-js/plugin": "^1.2.1",
-    "@modern-js/utils": "^1.3.3",
+    "@modern-js/plugin": "^1.3.2",
+    "@modern-js/utils": "^1.3.6",
     "address": "^1.1.2",
     "ajv": "^8.6.2",
     "ajv-keywords": "^5.0.0",
@@ -61,7 +61,7 @@
   "devDependencies": {
     "btsm": "2.2.2",
     "@types/babel__code-frame": "^7.0.3",
-    "@modern-js/types": "^1.3.4",
+    "@modern-js/types": "^1.3.5",
     "@types/jest": "^26",
     "@types/lodash.clonedeep": "^4.5.6",
     "@types/lodash.mergewith": "^4.6.6",
@@ -82,8 +82,7 @@
   },
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
-    "access": "public",
-    "types": "./dist/types/index.d.ts"
+    "access": "public"
   },
   "scripts": {
     "new": "modern new",

package/tests/initWatcher.test.ts

@@ -8,7 +8,7 @@ const mockAppDirectory = path.join(__dirname, './fixtures/index-test');
 const mockConfigDir = './config';
 const mockSrcDirectory = path.join(mockAppDirectory, './src');
 
-describe('initWatcher', () => {
+describe.skip('initWatcher', () => {
   afterAll(() => {
     const file = path.join(mockSrcDirectory, './index.ts');
     if (fs.existsSync(file)) {

package/tests/loadPlugin.test.ts

@@ -1,4 +1,5 @@
 import path from 'path';
+import { CliPlugin } from '../src';
 import { loadPlugins, getAppPlugins } from '../src/loadPlugins';
 
 describe('load plugins', () => {
@@ -33,14 +34,10 @@ describe('load plugins', () => {
       {
         cli: {
           name: 'a',
-          pluginPath: path.join(fixture, './test-plugin-a.js'),
         },
-        cliPkg: path.join(fixture, './test-plugin-a.js'),
       },
       {
-        server: {
-          pluginPath: path.join(fixture, './test-plugin-b.js'),
-        },
+        server: './test-plugin-b',
         serverPkg: './test-plugin-b',
       },
     ]);
@@ -56,22 +53,8 @@ describe('load plugins', () => {
       plugins: [{ cli: ['./test-plugin-c', 'c'] }, ['./test-plugin-c', 'c2']],
     });
 
-    expect(plugins).toEqual([
-      {
-        cli: {
-          name: 'c',
-          pluginPath: path.join(fixture, './test-plugin-c.js'),
-        },
-        cliPkg: './test-plugin-c',
-      },
-      {
-        cli: {
-          name: 'c2',
-          pluginPath: path.join(fixture, './test-plugin-c.js'),
-        },
-        cliPkg: './test-plugin-c',
-      },
-    ]);
+    expect(plugins[0].cli!.name).toEqual('c');
+    expect(plugins[1].cli!.name).toEqual('c2');
   });
 
   test('should load user string plugin successfully', () => {
@@ -88,33 +71,11 @@ describe('load plugins', () => {
       {
         cli: {
           name: 'a',
-          pluginPath: path.join(fixture, './test-plugin-a.js'),
         },
-        cliPkg: path.join(fixture, './test-plugin-a.js'),
       },
     ]);
   });
 
-  test('should call transformPlugin', () => {
-    const fixture = path.resolve(
-      __dirname,
-      './fixtures/load-plugin/user-plugins',
-    );
-
-    const options = {
-      transformPlugin: jest.fn(),
-    };
-    options.transformPlugin.mockImplementation((plugins, _) => plugins);
-
-    loadPlugins(
-      fixture,
-      { plugins: [{ cli: path.join(fixture, './test-plugin-a.js') }] },
-      options,
-    );
-
-    expect(options.transformPlugin).toHaveBeenCalled();
-  });
-
   test(`should throw error when plugin not found `, () => {
     const fixture = path.resolve(__dirname, './fixtures/load-plugin/not-found');
 
@@ -124,4 +85,32 @@ describe('load plugins', () => {
       });
     }).toThrowError(/^Can not find plugin /);
   });
+
+  test(`should load new plugin array correctly`, () => {
+    const appDirectory = path.resolve(
+      __dirname,
+      './fixtures/load-plugin/user-plugins',
+    );
+    const plugin = (): CliPlugin => ({
+      name: 'foo',
+    });
+    const userConfig = { plugins: [plugin()] };
+    const loadedPlugins = loadPlugins(appDirectory, userConfig);
+
+    expect(loadedPlugins[0].cli?.name).toEqual('foo');
+  });
+
+  test(`should load new plugin object correctly`, () => {
+    const appDirectory = path.resolve(
+      __dirname,
+      './fixtures/load-plugin/user-plugins',
+    );
+    const plugin = (): CliPlugin => ({
+      name: 'foo',
+    });
+    const userConfig = { plugins: { cli: [plugin()] } };
+    const loadedPlugins = loadPlugins(appDirectory, userConfig);
+
+    expect(loadedPlugins[0].cli?.name).toEqual('foo');
+  });
 });

package/tests/pluginAPI.test.ts

@@ -0,0 +1,19 @@
+import { CliPlugin, manager } from '../src';
+
+describe('pluginAPI', () => {
+  it('api.setAppContext', done => {
+    const plugin = (): CliPlugin => ({
+      setup(api) {
+        api.setAppContext({
+          ...api.useAppContext(),
+          packageName: 'foo',
+        });
+
+        expect(api.useAppContext().packageName).toEqual('foo');
+        done();
+      },
+    });
+
+    manager.clone().usePlugin(plugin).init();
+  });
+});