@modern-js/core 1.5.0 → 1.6.0

package/.eslintrc.js

@@ -2,9 +2,7 @@ module.exports = {
   root: true,
   extends: ['@modern-js'],
   parserOptions: {
-    // the base path used to search for `tsconfig.json`
     tsconfigRootDir: __dirname,
-    // the relative path to sub-package's `tsconfig.json`
     project: ['./tsconfig.json'],
   },
 };

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # @modern-js/core
 
+## 1.6.0
+
+### Minor Changes
+
+- 4e2026e4: feat: support new plugin config
+
+### Patch Changes
+
+- 05ce88a0: fix: set default value for type NormalizedConfig to ensure all config keys are required
+- a8df060e: support setup dev middleware first step
+- 6a7acb81: modify devServer type and name
+- Updated dependencies [c2046f37]
+- Updated dependencies [dc88abf9]
+- Updated dependencies [0462ff77]
+  - @modern-js/utils@1.3.6
+  - @modern-js/plugin@1.3.2
+
 ## 1.5.0
 
 ### Minor Changes

package/dist/js/modern/config/defaults.js

@@ -96,5 +96,8 @@ export const defaults = {
   server: serverDefaults,
   dev: devDefaults,
   deploy: deployDefaults,
-  tools: toolsDefaults
+  tools: toolsDefaults,
+  plugins: [],
+  runtime: {},
+  runtimeByEntries: {}
 };

package/dist/js/modern/loadPlugins.js

@@ -1,9 +1,3 @@
-function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
-
-function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
-
-function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
-
 import { isDepExists, createDebugger, compatRequire, INTERNAL_PLUGINS } from '@modern-js/utils';
 import { createPlugin } from "./manager";
 const debug = createDebugger('load-plugins');
@@ -33,7 +27,7 @@ const tryResolve = (name, appDirectory) => {
   return filePath;
 };
 
-export function getAppPlugins(appDirectory, pluginConfig, internalPlugins) {
+export function getAppPlugins(appDirectory, oldPluginConfig, internalPlugins) {
   const allPlugins = internalPlugins || INTERNAL_PLUGINS;
   const appPlugins = [...Object.keys(allPlugins).filter(name => {
     const config = allPlugins[name];
@@ -44,9 +38,31 @@ export function getAppPlugins(appDirectory, pluginConfig, internalPlugins) {
     }
 
     return isDepExists(appDirectory, name);
-  }).map(name => allPlugins[name]), ...pluginConfig];
+  }).map(name => allPlugins[name]), ...oldPluginConfig];
   return appPlugins;
 }
+
+const resolveCliPlugin = (p, appDirectory) => {
+  const pkg = typeof p === 'string' ? p : p[0];
+  const path = tryResolve(pkg, appDirectory);
+  const module = compatRequire(path);
+
+  if (typeof module === 'function') {
+    const pluginOptions = Array.isArray(p) ? p[1] : undefined;
+    const result = module(pluginOptions);
+    return createPlugin(result.setup, result);
+  }
+
+  return module;
+};
+
+const isOldPluginConfig = config => Array.isArray(config) && config.some(item => {
+  if (typeof item === 'string' || Array.isArray(item)) {
+    return true;
+  }
+
+  return 'cli' in item || 'server' in item;
+});
 /**
  * Load internal plugins which in @modern-js scope and user's custom plugins.
  * @param appDirectory - Application root directory.
@@ -55,31 +71,11 @@ export function getAppPlugins(appDirectory, pluginConfig, internalPlugins) {
  * @returns Plugin Objects has been required.
  */
 
-export const loadPlugins = (appDirectory, userConfig, options = {}) => {
-  const {
-    internalPlugins
-  } = options;
-
-  const resolvePlugin = p => {
-    const pkg = typeof p === 'string' ? p : p[0];
-    const path = tryResolve(pkg, appDirectory);
-    let module = compatRequire(path);
-    const pluginOptions = Array.isArray(p) ? p[1] : undefined;
-
-    if (typeof module === 'function') {
-      const plugin = module(pluginOptions);
-      module = createPlugin(plugin.setup, plugin);
-    }
-
-    return {
-      pkg,
-      path,
-      module
-    };
-  };
 
-  const plugins = getAppPlugins(appDirectory, userConfig.plugins || [], internalPlugins);
-  return plugins.map(plugin => {
+export const loadPlugins = (appDirectory, userConfig, options = {}) => {
+  const pluginConfig = userConfig.plugins;
+  const plugins = getAppPlugins(appDirectory, isOldPluginConfig(pluginConfig) ? pluginConfig : [], options.internalPlugins);
+  const loadedPlugins = plugins.map(plugin => {
     const _plugin = typeof plugin === 'string' || Array.isArray(plugin) ? {
       cli: plugin
     } : plugin;
@@ -91,15 +87,7 @@ export const loadPlugins = (appDirectory, userConfig, options = {}) => {
     const loadedPlugin = {};
 
     if (cli) {
-      const {
-        pkg,
-        path,
-        module
-      } = resolvePlugin(cli);
-      loadedPlugin.cli = _objectSpread(_objectSpread({}, module), {}, {
-        pluginPath: path
-      });
-      loadedPlugin.cliPkg = pkg;
+      loadedPlugin.cli = resolveCliPlugin(cli, appDirectory);
     } // server plugins don't support to accept params
 
 
@@ -114,4 +102,16 @@ export const loadPlugins = (appDirectory, userConfig, options = {}) => {
     });
     return loadedPlugin;
   });
+
+  if (!isOldPluginConfig(pluginConfig)) {
+    const cliPlugins = Array.isArray(pluginConfig) ? pluginConfig : pluginConfig === null || pluginConfig === void 0 ? void 0 : pluginConfig.cli;
+
+    if (cliPlugins !== null && cliPlugins !== void 0 && cliPlugins.length) {
+      loadedPlugins.push(...cliPlugins.map(item => ({
+        cli: createPlugin(item.setup, item)
+      })));
+    }
+  }
+
+  return loadedPlugins;
 };

package/dist/js/node/config/defaults.js

@@ -102,6 +102,9 @@ const defaults = {
   server: serverDefaults,
   dev: devDefaults,
   deploy: deployDefaults,
-  tools: toolsDefaults
+  tools: toolsDefaults,
+  plugins: [],
+  runtime: {},
+  runtimeByEntries: {}
 };
 exports.defaults = defaults;

package/dist/js/node/loadPlugins.js

@@ -10,12 +10,6 @@ var _utils = require("@modern-js/utils");
 
 var _manager = require("./manager");
 
-function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
-
-function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
-
-function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
-
 const debug = (0, _utils.createDebugger)('load-plugins');
 
 /**
@@ -43,7 +37,7 @@ const tryResolve = (name, appDirectory) => {
   return filePath;
 };
 
-function getAppPlugins(appDirectory, pluginConfig, internalPlugins) {
+function getAppPlugins(appDirectory, oldPluginConfig, internalPlugins) {
   const allPlugins = internalPlugins || _utils.INTERNAL_PLUGINS;
   const appPlugins = [...Object.keys(allPlugins).filter(name => {
     const config = allPlugins[name];
@@ -54,9 +48,31 @@ function getAppPlugins(appDirectory, pluginConfig, internalPlugins) {
     }
 
     return (0, _utils.isDepExists)(appDirectory, name);
-  }).map(name => allPlugins[name]), ...pluginConfig];
+  }).map(name => allPlugins[name]), ...oldPluginConfig];
   return appPlugins;
 }
+
+const resolveCliPlugin = (p, appDirectory) => {
+  const pkg = typeof p === 'string' ? p : p[0];
+  const path = tryResolve(pkg, appDirectory);
+  const module = (0, _utils.compatRequire)(path);
+
+  if (typeof module === 'function') {
+    const pluginOptions = Array.isArray(p) ? p[1] : undefined;
+    const result = module(pluginOptions);
+    return (0, _manager.createPlugin)(result.setup, result);
+  }
+
+  return module;
+};
+
+const isOldPluginConfig = config => Array.isArray(config) && config.some(item => {
+  if (typeof item === 'string' || Array.isArray(item)) {
+    return true;
+  }
+
+  return 'cli' in item || 'server' in item;
+});
 /**
  * Load internal plugins which in @modern-js scope and user's custom plugins.
  * @param appDirectory - Application root directory.
@@ -67,30 +83,9 @@ function getAppPlugins(appDirectory, pluginConfig, internalPlugins) {
 
 
 const loadPlugins = (appDirectory, userConfig, options = {}) => {
-  const {
-    internalPlugins
-  } = options;
-
-  const resolvePlugin = p => {
-    const pkg = typeof p === 'string' ? p : p[0];
-    const path = tryResolve(pkg, appDirectory);
-    let module = (0, _utils.compatRequire)(path);
-    const pluginOptions = Array.isArray(p) ? p[1] : undefined;
-
-    if (typeof module === 'function') {
-      const plugin = module(pluginOptions);
-      module = (0, _manager.createPlugin)(plugin.setup, plugin);
-    }
-
-    return {
-      pkg,
-      path,
-      module
-    };
-  };
-
-  const plugins = getAppPlugins(appDirectory, userConfig.plugins || [], internalPlugins);
-  return plugins.map(plugin => {
+  const pluginConfig = userConfig.plugins;
+  const plugins = getAppPlugins(appDirectory, isOldPluginConfig(pluginConfig) ? pluginConfig : [], options.internalPlugins);
+  const loadedPlugins = plugins.map(plugin => {
     const _plugin = typeof plugin === 'string' || Array.isArray(plugin) ? {
       cli: plugin
     } : plugin;
@@ -102,15 +97,7 @@ const loadPlugins = (appDirectory, userConfig, options = {}) => {
     const loadedPlugin = {};
 
     if (cli) {
-      const {
-        pkg,
-        path,
-        module
-      } = resolvePlugin(cli);
-      loadedPlugin.cli = _objectSpread(_objectSpread({}, module), {}, {
-        pluginPath: path
-      });
-      loadedPlugin.cliPkg = pkg;
+      loadedPlugin.cli = resolveCliPlugin(cli, appDirectory);
     } // server plugins don't support to accept params
 
 
@@ -125,6 +112,18 @@ const loadPlugins = (appDirectory, userConfig, options = {}) => {
     });
     return loadedPlugin;
   });
+
+  if (!isOldPluginConfig(pluginConfig)) {
+    const cliPlugins = Array.isArray(pluginConfig) ? pluginConfig : pluginConfig === null || pluginConfig === void 0 ? void 0 : pluginConfig.cli;
+
+    if (cliPlugins !== null && cliPlugins !== void 0 && cliPlugins.length) {
+      loadedPlugins.push(...cliPlugins.map(item => ({
+        cli: (0, _manager.createPlugin)(item.setup, item)
+      })));
+    }
+  }
+
+  return loadedPlugins;
 };
 
 exports.loadPlugins = loadPlugins;

package/dist/types/config/defaults.d.ts

@@ -22,4 +22,7 @@ export declare const defaults: {
     terser: undefined;
     minifyCss: undefined;
   };
+  plugins: never[];
+  runtime: {};
+  runtimeByEntries: {};
 };

package/dist/types/config/index.d.ts

@@ -1,5 +1,8 @@
+/// <reference types="node" />
+import http from 'http';
 import { ErrorObject } from 'ajv';
 import { MetaOptions } from '@modern-js/utils';
+import type { NextFunction, ProxyOptions } from '@modern-js/types';
 import { PluginConfig } from '../loadPlugins';
 import { defaults } from './defaults';
 import { mergeConfig, NormalizedConfig } from './mergeConfig';
@@ -95,6 +98,14 @@ interface DeployConfig {
   domainByEntries?: Record<string, string | Array<string>>;
 }
 declare type ConfigFunction = Record<string, unknown> | ((config: Record<string, unknown>) => Record<string, unknown> | void);
+declare type RequestHandler = (req: http.IncomingMessage, res: http.ServerResponse, next: NextFunction) => void;
+declare type DevServerConfig = {
+  proxy?: ProxyOptions;
+  headers?: Record<string, string>;
+  before?: RequestHandler[];
+  after?: RequestHandler[];
+  [propsName: string]: any;
+};
 interface ToolsConfig {
   webpack?: ConfigFunction;
   babel?: ConfigFunction;
@@ -102,7 +113,7 @@ interface ToolsConfig {
   postcss?: ConfigFunction;
   styledComponents?: ConfigFunction;
   lodash?: ConfigFunction;
-  devServer?: Record<string, unknown>;
+  devServer?: DevServerConfig;
   tsLoader?: ConfigFunction;
   terser?: ConfigFunction;
   minifyCss?: ConfigFunction;

package/dist/types/context.d.ts

@@ -27,7 +27,7 @@ export declare const useConfigContext: () => UserConfig;
  */
 
 export declare const useResolvedConfigContext: () => NormalizedConfig;
-export declare const initAppContext: (appDirectory: string, plugins: Array<LoadedPlugin>, configFile: string | false, options?: {
+export declare const initAppContext: (appDirectory: string, plugins: LoadedPlugin[], configFile: string | false, options?: {
   metaName?: string | undefined;
   srcDir?: string | undefined;
   distDir?: string | undefined;

package/dist/types/loadPlugins.d.ts

@@ -1,18 +1,32 @@
 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 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.

package/package.json

@@ -11,7 +11,7 @@
     "modern",
     "modern.js"
   ],
-  "version": "1.5.0",
+  "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.3.0",
-    "@modern-js/utils": "^1.3.5",
+    "@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",

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,9 +34,7 @@ describe('load plugins', () => {
       {
         cli: {
           name: 'a',
-          pluginPath: path.join(fixture, './test-plugin-a.js'),
         },
-        cliPkg: path.join(fixture, './test-plugin-a.js'),
       },
       {
         server: './test-plugin-b',
@@ -54,8 +53,8 @@ describe('load plugins', () => {
       plugins: [{ cli: ['./test-plugin-c', 'c'] }, ['./test-plugin-c', 'c2']],
     });
 
-    expect(plugins[0].cli.name).toEqual('c');
-    expect(plugins[1].cli.name).toEqual('c2');
+    expect(plugins[0].cli!.name).toEqual('c');
+    expect(plugins[1].cli!.name).toEqual('c2');
   });
 
   test('should load user string plugin successfully', () => {
@@ -72,9 +71,7 @@ describe('load plugins', () => {
       {
         cli: {
           name: 'a',
-          pluginPath: path.join(fixture, './test-plugin-a.js'),
         },
-        cliPkg: path.join(fixture, './test-plugin-a.js'),
       },
     ]);
   });
@@ -88,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');
+  });
 });