@modern-js/core 1.5.0 → 1.7.0

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

@@ -0,0 +1,10 @@
+/// <reference types="less" />
+import type { LoaderContext } from 'webpack';
+export declare type LessLoaderOptions = {
+  lessOptions?: Less.Options;
+  additionalData?: string | ((content: string, loaderContext: LoaderContext<LessLoaderOptions>) => string);
+  sourceMap?: boolean;
+  webpackImporter?: boolean;
+  implementation?: boolean;
+};
+export declare type LessConfig = LessLoaderOptions | ((options: LessLoaderOptions, utils?: any) => LessLoaderOptions | void);

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

@@ -0,0 +1,8 @@
+import type { LegacyFileOptions } from 'sass';
+export interface SassLoaderOptions {
+  sassOptions?: LegacyFileOptions<'sync'>;
+  sourceMap?: boolean;
+  implementation?: string;
+  additionalData?: string | ((content: string, filename: string) => string);
+}
+export declare type SassConfig = SassLoaderOptions | ((options: SassLoaderOptions, utils?: any) => SassLoaderOptions | void);

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

@@ -0,0 +1,13 @@
+export declare type SSGRouteOptions = string | {
+  url: string;
+  output?: string;
+  params?: Record<string, any>[];
+  headers?: Record<string, any>;
+};
+export declare type SSGSingleEntryOptions = boolean | {
+  preventDefault?: string[];
+  headers?: Record<string, any>;
+  routes?: SSGRouteOptions[];
+};
+export declare type SSGMultiEntryOptions = Record<string, SSGSingleEntryOptions>;
+export declare type SSGConfig = boolean | SSGSingleEntryOptions | SSGMultiEntryOptions | ((entryName: string) => SSGSingleEntryOptions);

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

@@ -0,0 +1,15 @@
+import type { Config as JestConfigTypes } from '@jest/types';
+export declare type JestConfig = JestConfigTypes.InitialOptions;
+export interface TestConfig {
+  /**
+   * Decide which transformer will be used to compile file
+   * Default: babel-jest
+   */
+  transformer?: 'babel-jest' | 'ts-jest';
+  /**
+   * Original jest config
+   * Doc: https://jestjs.io/docs/configuration
+   */
+
+  jest?: JestConfig | ((jestConfig: JestConfig) => JestConfig);
+}

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

@@ -0,0 +1,28 @@
+export declare type UnbundleConfig = {
+  /**
+   * Some package A may require another package B that is intended for Node.js
+   * use only. In such a case, if package B cannot be converted to ESM, it will
+   * cause package A to fail during unbundle development, even though package B
+   * is not really required. Package B can thus be safely ignored via this option
+   * to ensure transpilation of package A to ESM
+   */
+  ignore?: string | string[];
+  /**
+   * ignores cached esm modules and recompiles dependencies not available
+   * from PDN host on dev start.
+   * default: false
+   */
+
+  ignoreModuleCache?: boolean;
+  /**
+   * clears cache of downloaded esm modules (from PDN) on dev start.
+   * default: false
+   */
+
+  clearPdnCache?: boolean;
+  /**
+   * modifies host to attempt to download esm modules from
+   */
+
+  pdnHost?: string;
+};

package/dist/types/context.d.ts

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

package/dist/types/index.d.ts

@@ -15,6 +15,7 @@ export type { NormalizedConfig, IAppContext };
 declare const initAppDir: (cwd?: string | undefined) => Promise<string>;
 export interface CoreOptions {
   configFile?: string;
+  serverConfigFile?: string;
   packageJsonConfig?: string;
   plugins?: typeof INTERNAL_PLUGINS;
   onSchemaError?: (error: ErrorObject) => void;
@@ -25,6 +26,24 @@ export interface CoreOptions {
     sharedDir?: string;
   };
 }
+export declare const mergeOptions: (options?: CoreOptions | undefined) => {
+  configFile?: string | undefined;
+  serverConfigFile: string;
+  packageJsonConfig?: string | undefined;
+  plugins?: {
+    [name: string]: {
+      cli?: string | undefined;
+      server?: string | undefined;
+    };
+  } | undefined;
+  onSchemaError?: ((error: ErrorObject) => void) | undefined;
+  options?: {
+    metaName?: string | undefined;
+    srcDir?: string | undefined;
+    distDir?: string | undefined;
+    sharedDir?: string | undefined;
+  } | undefined;
+};
 export declare const cli: {
   init: (argv?: string[], options?: CoreOptions | undefined) => Promise<{
     loadedConfig: import("./config").LoadedConfig;

package/dist/types/initWatcher.d.ts

@@ -1,4 +1,3 @@
-import chokidar from 'chokidar';
 import { LoadedConfig } from './config';
 import { HooksRunner } from './manager';
-export declare const initWatcher: (loaded: LoadedConfig, appDirectory: string, configDir: string | undefined, hooksRunner: HooksRunner, argv: string[]) => Promise<chokidar.FSWatcher | undefined>;
+export declare const initWatcher: (loaded: LoadedConfig, appDirectory: string, configDir: string | undefined, hooksRunner: HooksRunner, argv: string[]) => Promise<import("@modern-js/utils").FSWatcher | 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/dist/types/manager.d.ts

@@ -1,6 +1,6 @@
 import { ToThreads, ToRunners, AsyncSetup, PluginOptions, AsyncWorkflow, AsyncWaterfall, ParallelWorkflow } from '@modern-js/plugin';
+import { Command } from '@modern-js/utils';
 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<{

package/dist/types/utils/commander.d.ts

@@ -1,7 +1,8 @@
-import { program, Command } from 'commander';
-declare module 'commander' {
+import { program } from '@modern-js/utils';
+declare module '@modern-js/utils/compiled/commander' {
   interface Command {
     commandsMap: Map<string, Command>;
   }
 }
-export { program, Command };
+export declare function initCommandsMap(): void;
+export { program };

package/jest.config.js

@@ -2,7 +2,6 @@ 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/package.json

@@ -11,7 +11,7 @@
     "modern",
     "modern.js"
   ],
-  "version": "1.5.0",
+  "version": "1.7.0",
   "jsnext:source": "./src/index.ts",
   "types": "./dist/types/index.d.ts",
   "main": "./dist/js/node/index.js",
@@ -42,37 +42,37 @@
   "dependencies": {
     "@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/load-config": "^1.3.0",
+    "@modern-js/plugin": "^1.3.2",
+    "@modern-js/utils": "^1.4.0",
     "address": "^1.1.2",
     "ajv": "^8.6.2",
     "ajv-keywords": "^5.0.0",
     "better-ajv-errors": "^0.7.0",
-    "chokidar": "^3.5.2",
-    "commander": "^8.1.0",
     "dotenv": "^10.0.0",
     "dotenv-expand": "^5.1.0",
-    "lodash.clonedeep": "^4.5.0",
-    "lodash.mergewith": "^4.6.2",
-    "signale": "^1.4.0",
     "v8-compile-cache": "^2.3.0"
   },
   "devDependencies": {
-    "btsm": "2.2.2",
+    "@jest/types": "^27.0.6",
+    "@modern-js/types": "^1.4.0",
+    "@scripts/build": "0.0.0",
+    "@scripts/jest-config": "0.0.0",
     "@types/babel__code-frame": "^7.0.3",
-    "@modern-js/types": "^1.3.5",
+    "@types/babel__core": "^7.1.16",
     "@types/jest": "^26",
-    "@types/lodash.clonedeep": "^4.5.6",
-    "@types/lodash.mergewith": "^4.6.6",
+    "@types/less": "^3.0.3",
     "@types/node": "^14",
     "@types/react": "^17",
     "@types/react-dom": "^17",
-    "@types/signale": "^1.4.2",
-    "typescript": "^4",
+    "autoprefixer": "^10.3.1",
+    "btsm": "2.2.2",
     "jest": "^27",
-    "@scripts/build": "0.0.0",
-    "@scripts/jest-config": "0.0.0"
+    "sass": "^1.45.0",
+    "terser-webpack-plugin": "^5.1.4",
+    "typescript": "^4",
+    "webpack": "^5.71.0",
+    "webpack-chain": "^6.5.1"
   },
   "sideEffects": false,
   "modernConfig": {

package/tests/config.test.ts

@@ -1,7 +1,7 @@
 import path from 'path';
 // import os from 'os';
-import { isDev, getPort } from '@modern-js/utils';
-import { resolveConfig } from '../src/config';
+import { isDev, getPort, DEFAULT_SERVER_CONFIG } from '@modern-js/utils';
+import { resolveConfig, addServerConfigToDeps } from '../src/config';
 import {
   cli,
   loadUserConfig,
@@ -26,7 +26,7 @@ jest.mock('@modern-js/utils', () => ({
 
 describe('config', () => {
   /**
-   * Typescript Type annotations cannot be used for esbuild-jest
+   * TypeScript Type annotations cannot be used for esbuild-jest
    * test files that use jest.mock('@some/module')
    * refer to this esbuild-jest issue:
    * https://github.com/aelbore/esbuild-jest/issues/57
@@ -133,5 +133,14 @@ describe('config', () => {
   });
 });
 
-// type TEST = Parameters<typeof resolveConfig>;
-// type TypeC = TEST[1];
+describe('addServerConfigToDeps', () => {
+  it('should add server config to deps', async () => {
+    const appDirectory = path.join(__dirname, './fixtures/index-test');
+    const deps: string[] = [];
+    await addServerConfigToDeps(deps, appDirectory, DEFAULT_SERVER_CONFIG);
+    expect(deps.length).toBe(1);
+    expect(deps[0]).toBe(
+      path.join(appDirectory, `${DEFAULT_SERVER_CONFIG}.js`),
+    );
+  });
+});

package/tests/context.test.ts

@@ -1,4 +1,5 @@
 import path from 'path';
+import { DEFAULT_SERVER_CONFIG } from '@modern-js/utils';
 import { initAppContext } from '../src/context';
 
 describe('context', () => {
@@ -7,10 +8,17 @@ describe('context', () => {
       __dirname,
       './fixtures/load-plugin/user-plugins',
     );
-    const appContext = initAppContext(appDirectory, [], false);
+    const appContext = initAppContext({
+      appDirectory,
+      plugins: [],
+      configFile: false,
+      serverConfigFile: DEFAULT_SERVER_CONFIG,
+    });
+
     expect(appContext).toEqual({
       appDirectory,
       configFile: false,
+      serverConfigFile: DEFAULT_SERVER_CONFIG,
       ip: expect.any(String),
       port: 0,
       packageName: expect.any(String),
@@ -44,10 +52,17 @@ describe('context', () => {
       metaName: 'jupiter',
     };
 
-    const appContext = initAppContext(appDirectory, [], false, customOptions);
+    const appContext = initAppContext({
+      appDirectory,
+      plugins: [],
+      configFile: false,
+      options: customOptions,
+      serverConfigFile: DEFAULT_SERVER_CONFIG,
+    });
     expect(appContext).toEqual({
       appDirectory,
       configFile: false,
+      serverConfigFile: DEFAULT_SERVER_CONFIG,
       ip: expect.any(String),
       port: 0,
       packageName: 'user-plugins',

package/tests/index.test.ts

@@ -1,5 +1,5 @@
 import path from 'path';
-import { cli } from '../src';
+import { cli, mergeOptions } from '../src';
 import { resolveConfig, loadUserConfig } from '../src/config';
 import { loadEnv } from '../src/loadEnv';
 
@@ -67,3 +67,17 @@ describe('@modern-js/core test', () => {
     // TODO: add more test cases
   });
 });
+
+describe('test mergeOptions', () => {
+  it('serverConfigFile must exist', () => {
+    const options = mergeOptions({});
+    expect(options).toHaveProperty('serverConfigFile');
+  });
+
+  it('serverConfigFile can be overwritten', () => {
+    const options = mergeOptions({
+      serverConfigFile: 'test',
+    });
+    expect(options.serverConfigFile).toBe('test');
+  });
+});

package/tests/initWatcher.test.ts

@@ -16,7 +16,7 @@ describe('initWatcher', () => {
     }
   });
 
-  test('will trigger add event', async () => {
+  xtest('will trigger add event', async () => {
     let triggeredType = '';
     let triggeredFile = '';
     const loaded = {

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');
+  });
 });

package/tests/utils.test.ts

@@ -1,8 +1,7 @@
-import { program, Command } from '../src/utils/commander';
+import { program } from '../src/utils/commander';
 
 describe('utils', () => {
   it('default', () => {
     expect(program).toBeDefined();
-    expect(Command).toBeDefined();
   });
 });