@modern-js/core 1.7.1 → 1.9.1

package/dist/types/manager.d.ts

@@ -1,74 +0,0 @@
-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/modern.config.js

@@ -1,6 +0,0 @@
-/** @type {import('@modern-js/module-tools').UserConfig} */
-module.exports = {
-  output: {
-    disableSourceMap: true,
-  },
-};

package/tests/.eslintrc.js

@@ -1,6 +0,0 @@
-module.exports = {
-  extends: ['@modern-js'],
-  parserOptions: {
-    project: require.resolve('./tsconfig.json'),
-  },
-};

package/tests/btsm.test.ts

@@ -1,20 +0,0 @@
-import path from 'path';
-import { spawnSync } from 'child_process';
-
-const kPackageDir = path.resolve(__dirname, '..');
-
-describe('jsnext:source', () => {
-  test('process exit status is 0', () => {
-    const { status, stdout, stderr } = spawnSync(
-      process.execPath,
-      ['--conditions=jsnext:source', '-r', 'btsm', 'src/cli.ts'],
-      {
-        cwd: kPackageDir,
-        encoding: 'utf-8',
-      },
-    );
-    expect(stdout).toBe('');
-    expect(stderr.startsWith('Usage: modern <command> [options]')).toBe(true);
-    expect(status).toBe(1);
-  });
-});

package/tests/config.test.ts

@@ -1,146 +0,0 @@
-import path from 'path';
-// import os from 'os';
-import { isDev, getPort, DEFAULT_SERVER_CONFIG } from '@modern-js/utils';
-import { resolveConfig, addServerConfigToDeps } from '../src/config';
-import {
-  cli,
-  loadUserConfig,
-  initAppContext,
-  initAppDir,
-  manager,
-  createPlugin,
-  registerHook,
-  useRunner,
-} from '../src';
-import { defaults } from '../src/config/defaults';
-
-jest.mock('@modern-js/utils', () => ({
-  __esModule: true,
-  ...jest.requireActual('@modern-js/utils'),
-  isDev: jest.fn(),
-  getPort: jest.fn(),
-}));
-
-// const kOSRootDir =
-//   os.platform() === 'win32' ? process.cwd().split(path.sep)[0] : '/';
-
-describe('config', () => {
-  /**
-   * 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
-   * TODO: find a better solution to solve this problem while allowing us
-   * to use esbuild, and have good TypeScript support
-   */
-  let loaded = {
-    config: {},
-    filePath: '',
-    dependencies: [],
-    pkgConfig: {},
-    jsConfig: {},
-  };
-  let schemas: any[] = [];
-  let restartWithExistingPort = 0;
-  let argv: string[] = ['dev'];
-  let configs: any[] = [];
-
-  const getResolvedConfig = async () =>
-    resolveConfig(loaded, configs, schemas, restartWithExistingPort, argv);
-
-  const resetParams = () => {
-    loaded = {
-      config: {},
-      filePath: '',
-      dependencies: [],
-      pkgConfig: {},
-      jsConfig: {},
-    };
-    schemas = [];
-    restartWithExistingPort = 0;
-    argv = ['dev'];
-    configs = [];
-  };
-  const resetMock = () => {
-    jest.resetAllMocks();
-    (isDev as jest.Mock).mockReturnValue(true);
-    (getPort as jest.Mock).mockReturnValue(
-      Promise.resolve(defaults.server.port),
-    );
-  };
-  beforeEach(() => {
-    resetParams();
-    resetMock();
-  });
-
-  it('default', () => {
-    expect(resolveConfig).toBeDefined();
-    expect(cli).toBeDefined();
-    expect(loadUserConfig).toBeDefined();
-    expect(initAppContext).toBeDefined();
-    expect(initAppDir).toBeDefined();
-    expect(manager).toBeDefined();
-    expect(createPlugin).toBeDefined();
-    expect(registerHook).toBeDefined();
-    expect(useRunner).toBeDefined();
-  });
-
-  it('initAppDir', async () => {
-    expect(await initAppDir(__dirname)).toBe(path.resolve(__dirname, '..'));
-    // expect(await initAppDir()).toBe(path.resolve(__dirname, '..'));
-
-    // FIXME: windows 下面会失败，先忽略这个测试
-    // try {
-    //   await initAppDir(kOSRootDir);
-    //   expect(true).toBe(false); // SHOULD NOT BE HERE
-    // } catch (err: any) {
-    //   expect(err.message).toMatch(/no package.json found in current work dir/);
-    // }
-  });
-
-  test('should use default port if not restarting in dev mode', async () => {
-    let resolved = await getResolvedConfig();
-    expect(resolved.server.port).toEqual(defaults.server.port);
-    expect(getPort).toHaveBeenCalledWith(defaults.server.port);
-
-    // getResolvedConfig should use the value givin by getPort
-    restartWithExistingPort = -1;
-    (getPort as jest.Mock).mockClear();
-    (getPort as jest.Mock).mockReturnValue(1111);
-    resolved = await getResolvedConfig();
-    expect(resolved.server.port).toEqual(1111);
-    expect(getPort).toHaveBeenCalledWith(defaults.server.port);
-
-    argv = ['start'];
-    (isDev as jest.Mock).mockReturnValue(false);
-    restartWithExistingPort = 0;
-    resolved = await getResolvedConfig();
-    expect(resolved.server.port).toEqual(defaults.server.port);
-
-    restartWithExistingPort = 1234;
-    resolved = await getResolvedConfig();
-    expect(resolved.server.port).toEqual(defaults.server.port);
-
-    restartWithExistingPort = -1;
-    resolved = await getResolvedConfig();
-    expect(resolved.server.port).toEqual(defaults.server.port);
-  });
-
-  test('should reuse existing port if restarting in dev mode', async () => {
-    restartWithExistingPort = 1234;
-    const resolved = await getResolvedConfig();
-    expect(resolved.server.port).toEqual(1234);
-  });
-});
-
-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,85 +0,0 @@
-import path from 'path';
-import { DEFAULT_SERVER_CONFIG } from '@modern-js/utils';
-import { initAppContext } from '../src/context';
-
-describe('context', () => {
-  it('initAppContext', () => {
-    const appDirectory = path.resolve(
-      __dirname,
-      './fixtures/load-plugin/user-plugins',
-    );
-    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),
-      srcDirectory: expect.any(String),
-      distDirectory: expect.any(String),
-      sharedDirectory: expect.any(String),
-      nodeModulesDirectory: expect.any(String),
-      internalDirectory: expect.any(String),
-      plugins: [],
-      htmlTemplates: {},
-      serverRoutes: [],
-      entrypoints: [],
-      checkedEntries: [],
-      existSrc: true,
-      internalDirAlias: '@_modern_js_internal',
-      internalSrcAlias: '@_modern_js_src',
-      metaName: 'modern-js',
-    });
-  });
-
-  it('custom AppContext', () => {
-    const appDirectory = path.resolve(
-      __dirname,
-      './fixtures/load-plugin/user-plugins',
-    );
-
-    const customOptions = {
-      srcDir: 'source',
-      distDir: 'dist',
-      sharedDir: 'myShared',
-      metaName: 'jupiter',
-    };
-
-    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',
-      srcDirectory: path.resolve(appDirectory, './source'),
-      distDirectory: 'dist',
-      sharedDirectory: path.resolve(appDirectory, './myShared'),
-      nodeModulesDirectory: expect.any(String),
-      internalDirectory: path.resolve(appDirectory, './node_modules/.jupiter'),
-      plugins: [],
-      htmlTemplates: {},
-      serverRoutes: [],
-      entrypoints: [],
-      checkedEntries: [],
-      existSrc: true,
-      internalDirAlias: '@_jupiter_internal',
-      internalSrcAlias: '@_jupiter_src',
-      metaName: 'jupiter',
-    });
-  });
-});

package/tests/fixtures/index-test/package.json

@@ -1,3 +0,0 @@
-{
-  "name": "index-test"
-}

package/tests/fixtures/load-plugin/not-found/package.json

@@ -1,3 +0,0 @@
-{
-  "name": "not-found"
-}

package/tests/fixtures/load-plugin/not-found/test-plugin-a.js

@@ -1 +0,0 @@
-module.exports = { name: 'a' };

package/tests/fixtures/load-plugin/user-plugins/package.json

@@ -1,3 +0,0 @@
-{
-  "name": "user-plugins"
-}

package/tests/fixtures/load-plugin/user-plugins/test-plugin-a.js

@@ -1 +0,0 @@
-module.exports = { name: 'a' };

package/tests/fixtures/load-plugin/user-plugins/test-plugin-b.js

@@ -1,3 +0,0 @@
-Object.defineProperty(exports, '__esModule', { value: true });
-
-exports.default = { name: 'b' };

package/tests/fixtures/load-plugin/user-plugins/test-plugin-c.js

@@ -1,3 +0,0 @@
-Object.defineProperty(exports, '__esModule', { value: true });
-
-exports.default = name => ({ name });

package/tests/index.test.ts

@@ -1,83 +0,0 @@
-import path from 'path';
-import { cli, mergeOptions } from '../src';
-import { resolveConfig, loadUserConfig } from '../src/config';
-import { loadEnv } from '../src/loadEnv';
-
-jest.mock('../src/config', () => ({
-  __esModule: true,
-  ...jest.requireActual('../src/config'),
-  loadUserConfig: jest.fn(),
-  resolveConfig: jest.fn(),
-}));
-
-jest.mock('../src/loadEnv', () => ({
-  __esModule: true,
-  ...jest.requireActual('../src/loadEnv'),
-  loadEnv: jest.fn(),
-}));
-
-describe('@modern-js/core test', () => {
-  let mockResolveConfig: any = {};
-  let mockLoadedConfig: any = {};
-  const cwdSpy = jest.spyOn(process, 'cwd');
-  const cwd = path.join(__dirname, './fixtures/index-test');
-
-  const resetMock = () => {
-    jest.resetAllMocks();
-    cwdSpy.mockReturnValue(cwd);
-    (resolveConfig as jest.Mock).mockReturnValue(
-      Promise.resolve(mockResolveConfig),
-    );
-    (loadUserConfig as jest.Mock).mockImplementation(() =>
-      Promise.resolve(mockLoadedConfig),
-    );
-  };
-
-  const resetValues = () => {
-    mockLoadedConfig = {
-      config: {},
-      filePath: false,
-      dependencies: [],
-      pkgConfig: {},
-      jsConfig: {},
-    };
-    mockResolveConfig = {
-      server: {
-        port: 8080,
-      },
-      output: {
-        path: './my/test/path',
-      },
-    };
-  };
-
-  beforeEach(() => {
-    resetValues();
-    resetMock();
-  });
-
-  it('test cli create', () => {
-    expect(cli).toBeTruthy();
-  });
-
-  it('test cli init dev', async () => {
-    cwdSpy.mockReturnValue(path.join(cwd, 'nested-folder'));
-    await cli.init(['dev']);
-    expect(loadEnv).toHaveBeenCalledWith(cwd, undefined);
-    // 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

@@ -1,63 +0,0 @@
-import * as path from 'path';
-import { fs, wait } from '@modern-js/utils';
-import { initWatcher } from '../src/initWatcher';
-
-jest.useRealTimers();
-
-const mockAppDirectory = path.join(__dirname, './fixtures/index-test');
-const mockConfigDir = './config';
-const mockSrcDirectory = path.join(mockAppDirectory, './src');
-
-describe('initWatcher', () => {
-  afterAll(() => {
-    const file = path.join(mockSrcDirectory, './index.ts');
-    if (fs.existsSync(file)) {
-      fs.unlinkSync(file);
-    }
-  });
-
-  xtest('will trigger add event', async () => {
-    let triggeredType = '';
-    let triggeredFile = '';
-    const loaded = {
-      filePath: '',
-      dependencies: [],
-    };
-    const hooksRunner = {
-      watchFiles: async () => [mockSrcDirectory],
-      fileChange: jest.fn(({ filename, eventType }) => {
-        triggeredType = eventType;
-        triggeredFile = filename;
-      }),
-    };
-
-    if (await fs.pathExists(mockSrcDirectory)) {
-      await fs.remove(mockSrcDirectory);
-    }
-
-    const watcher = await initWatcher(
-      loaded as any,
-      mockAppDirectory,
-      mockConfigDir,
-      hooksRunner as any,
-      ['dev'],
-    );
-    await wait(100);
-
-    const file = path.join(mockSrcDirectory, './index.ts');
-    await fs.outputFile(file, '');
-    await wait(100);
-    // expect(hooksRunner.fileChange).toBeCalledTimes(1);
-    // expect(triggeredType).toBe('add');
-    expect(file.includes(triggeredFile)).toBeTruthy();
-
-    await wait(100);
-    await fs.remove(file);
-    await wait(200);
-    expect(hooksRunner.fileChange).toBeCalledTimes(2);
-    expect(triggeredType).toBe('unlink');
-    expect(file.includes(triggeredFile)).toBeTruthy();
-
-    watcher?.close();
-  });
-});

package/tests/loadEnv.test.ts

@@ -1,173 +0,0 @@
-import fs from 'fs';
-import path from 'path';
-import { loadEnv } from '../src/loadEnv';
-
-const fixture = path.resolve(__dirname, './fixtures/load-env');
-
-fs.mkdirSync(fixture);
-
-const createFixtures = (
-  dir: string,
-  files: {
-    name: string;
-    content: string;
-  }[],
-) => {
-  fs.mkdirSync(path.join(fixture, dir));
-  for (const { name, content } of files) {
-    fs.writeFileSync(path.join(fixture, dir, name), content, 'utf8');
-  }
-};
-
-describe('load environment variables', () => {
-  const defaultEnv = process.env;
-
-  beforeEach(() => (process.env = { ...defaultEnv }));
-
-  afterAll(() => {
-    process.env = { ...defaultEnv };
-    fs.rmSync(fixture, { force: true, recursive: true });
-  });
-
-  test(`support .env file`, () => {
-    createFixtures('base', [
-      {
-        name: '.env',
-        content: `DB_HOST=localhost
-        DB_USER=root
-        DB_PASS=root
-        `,
-      },
-    ]);
-    loadEnv(path.join(fixture, 'base'));
-
-    expect(process.env.DB_HOST).toBe('localhost');
-
-    expect(process.env.DB_USER).toBe('root');
-
-    expect(process.env.DB_PASS).toBe('root');
-  });
-
-  test(`support "environment" .env file`, () => {
-    createFixtures('environment', [
-      {
-        name: '.env',
-        content: `DB_HOST=localhost
-        DB_USER=root
-        DB_PASS=root
-        `,
-      },
-      {
-        name: '.env.production',
-        content: `DB_HOST=localhost
-        DB_USER=root-local-dev
-        `,
-      },
-    ]);
-
-    process.env.NODE_ENV = 'production';
-
-    loadEnv(path.join(fixture, 'environment'));
-
-    expect(process.env.DB_HOST).toBe('localhost');
-
-    expect(process.env.DB_USER).toBe('root-local-dev');
-
-    expect(process.env.DB_PASS).toBe('root');
-
-    delete process.env.NODE_ENV;
-  });
-
-  test(`should have correct priority`, () => {
-    createFixtures('priority', [
-      {
-        name: '.env',
-        content: `DB_HOST=localhost
-        DB_USER=user
-        DB_PASS=pass
-        `,
-      },
-      {
-        name: '.env.production',
-        content: `DB_USER=user_production
-        DB_PASS=pass_production
-        FOO=foo
-        BAR=bar
-        `,
-      },
-      {
-        name: '.env.local',
-        content: `FOO=foo_local
-        BAR=bar_local
-        `,
-      },
-      {
-        name: '.env.production.local',
-        content: `BAR=bar_production_local`,
-      },
-    ]);
-
-    process.env.NODE_ENV = 'production';
-
-    loadEnv(path.join(fixture, 'priority'));
-
-    expect(process.env.DB_HOST).toBe('localhost');
-
-    expect(process.env.DB_USER).toBe('user_production');
-
-    expect(process.env.DB_PASS).toBe('pass_production');
-
-    expect(process.env.FOO).toBe('foo_local');
-
-    expect(process.env.BAR).toBe('bar_production_local');
-
-    delete process.env.NODE_ENV;
-  });
-
-  test(`get custom .env file by MODERN_ENV`, () => {
-    createFixtures('custom_environment', [
-      {
-        name: '.env',
-        content: `DB_HOST=localhost
-        DB_USER=root
-        DB_PASS=root
-        `,
-      },
-      {
-        name: '.env.staging',
-        content: `DB_HOST=localhost
-        DB_USER=root-local-dev
-        `,
-      },
-    ]);
-
-    loadEnv(path.join(fixture, 'custom_environment'), 'staging');
-
-    expect(process.env.DB_HOST).toBe('localhost');
-
-    expect(process.env.DB_USER).toBe('root-local-dev');
-
-    expect(process.env.DB_PASS).toBe('root');
-
-    delete process.env.MODERN_ENV;
-  });
-
-  test(`support dotenv-expand`, () => {
-    createFixtures('expand', [
-      {
-        name: '.env',
-        content: `DB_HOST=localhost
-        DB_USER=\${DB_HOST}001
-        DB_PASS=root
-        `,
-      },
-    ]);
-    loadEnv(path.join(fixture, 'expand'));
-
-    expect(process.env.DB_HOST).toBe('localhost');
-
-    expect(process.env.DB_USER).toBe('localhost001');
-
-    expect(process.env.DB_PASS).toBe('root');
-  });
-});