@modern-js/core 1.3.1 → 1.3.2

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @modern-js/core
 
+## 1.3.2
+
+### Patch Changes
+
+- 83166714: change .npmignore
+- c3de9882: fix: internalDirectory path
+- 33ff48af: feat: extend CoreOptions
+- Updated dependencies [83166714]
+  - @modern-js/load-config@1.2.1
+  - @modern-js/plugin@1.2.1
+  - @modern-js/utils@1.2.2
+
 ## 1.3.1
 
 ### Patch Changes

package/dist/js/modern/context.js

@@ -7,19 +7,27 @@ export const ResolvedConfigContext = createContext({});
 export const useAppContext = () => AppContext.use().value;
 export const useConfigContext = () => ConfigContext.use().value;
 export const useResolvedConfigContext = () => ResolvedConfigContext.use().value;
-export const initAppContext = (appDirectory, plugins, configFile) => ({
-  appDirectory,
-  configFile,
-  ip: address.ip(),
-  port: 0,
-  packageName: require(path.resolve(appDirectory, './package.json')).name,
-  srcDirectory: path.resolve(appDirectory, './src'),
-  distDirectory: '',
-  sharedDirectory: path.resolve(appDirectory, './shared'),
-  nodeModulesDirectory: path.resolve(appDirectory, './node_modules'),
-  internalDirectory: path.resolve(appDirectory, './node_modules/.modern-js'),
-  plugins,
-  htmlTemplates: {},
-  serverRoutes: [],
-  entrypoints: []
-});
+export const initAppContext = (appDirectory, plugins, configFile, options) => {
+  const {
+    srcDir = 'src',
+    distDir = '',
+    sharedDir = 'shared',
+    internalDir = '.modern-js'
+  } = options || {};
+  return {
+    appDirectory,
+    configFile,
+    ip: address.ip(),
+    port: 0,
+    packageName: require(path.resolve(appDirectory, './package.json')).name,
+    srcDirectory: path.resolve(appDirectory, srcDir),
+    distDirectory: distDir,
+    sharedDirectory: path.resolve(appDirectory, sharedDir),
+    nodeModulesDirectory: path.resolve(appDirectory, './node_modules'),
+    internalDirectory: path.resolve(appDirectory, `./node_modules/${internalDir}`),
+    plugins,
+    htmlTemplates: {},
+    serverRoutes: [],
+    entrypoints: []
+  };
+};

package/dist/js/modern/index.js

@@ -74,7 +74,7 @@ const createCli = () => {
     }
 
     plugins.forEach(plugin => plugin.cli && manager.usePlugin(plugin.cli));
-    const appContext = initAppContext(appDirectory, plugins, loaded.filePath);
+    const appContext = initAppContext(appDirectory, plugins, loaded.filePath, options === null || options === void 0 ? void 0 : options.options);
     manager.run(() => {
       ConfigContext.set(loaded.config);
       AppContext.set(appContext);

package/dist/js/node/context.js

@@ -32,21 +32,29 @@ const useResolvedConfigContext = () => ResolvedConfigContext.use().value;
 
 exports.useResolvedConfigContext = useResolvedConfigContext;
 
-const initAppContext = (appDirectory, plugins, configFile) => ({
-  appDirectory,
-  configFile,
-  ip: _address.default.ip(),
-  port: 0,
-  packageName: require(_path.default.resolve(appDirectory, './package.json')).name,
-  srcDirectory: _path.default.resolve(appDirectory, './src'),
-  distDirectory: '',
-  sharedDirectory: _path.default.resolve(appDirectory, './shared'),
-  nodeModulesDirectory: _path.default.resolve(appDirectory, './node_modules'),
-  internalDirectory: _path.default.resolve(appDirectory, './node_modules/.modern-js'),
-  plugins,
-  htmlTemplates: {},
-  serverRoutes: [],
-  entrypoints: []
-});
+const initAppContext = (appDirectory, plugins, configFile, options) => {
+  const {
+    srcDir = 'src',
+    distDir = '',
+    sharedDir = 'shared',
+    internalDir = '.modern-js'
+  } = options || {};
+  return {
+    appDirectory,
+    configFile,
+    ip: _address.default.ip(),
+    port: 0,
+    packageName: require(_path.default.resolve(appDirectory, './package.json')).name,
+    srcDirectory: _path.default.resolve(appDirectory, srcDir),
+    distDirectory: distDir,
+    sharedDirectory: _path.default.resolve(appDirectory, sharedDir),
+    nodeModulesDirectory: _path.default.resolve(appDirectory, './node_modules'),
+    internalDirectory: _path.default.resolve(appDirectory, `./node_modules/${internalDir}`),
+    plugins,
+    htmlTemplates: {},
+    serverRoutes: [],
+    entrypoints: []
+  };
+};
 
 exports.initAppContext = initAppContext;

package/dist/js/node/index.js

@@ -195,7 +195,7 @@ const createCli = () => {
     }
 
     plugins.forEach(plugin => plugin.cli && manager.usePlugin(plugin.cli));
-    const appContext = (0, _context.initAppContext)(appDirectory, plugins, loaded.filePath);
+    const appContext = (0, _context.initAppContext)(appDirectory, plugins, loaded.filePath, options === null || options === void 0 ? void 0 : options.options);
     manager.run(() => {
       _context.ConfigContext.set(loaded.config);
 

package/dist/types/context.d.ts

@@ -11,4 +11,9 @@ export declare const useResolvedConfigContext: () => NormalizedConfig;
 export declare const initAppContext: (appDirectory: string, plugins: Array<{
   cli: any;
   server: any;
-}>, configFile: string | false) => IAppContext;
+}>, configFile: string | false, options?: {
+  srcDir?: string | undefined;
+  distDir?: string | undefined;
+  sharedDir?: string | undefined;
+  internalDir?: string | undefined;
+} | undefined) => IAppContext;

package/dist/types/index.d.ts

@@ -100,6 +100,12 @@ export interface CoreOptions {
     server: any;
     serverPath: any;
   }[];
+  options?: {
+    srcDir?: string;
+    distDir?: string;
+    sharedDir?: string;
+    internalDir?: string;
+  };
 }
 export declare const cli: {
   init: (argv?: string[], options?: CoreOptions | undefined) => Promise<{

package/package.json

@@ -11,7 +11,7 @@
     "modern",
     "modern.js"
   ],
-  "version": "1.3.1",
+  "version": "1.3.2",
   "jsnext:source": "./src/index.ts",
   "types": "./dist/types/index.d.ts",
   "main": "./dist/js/node/index.js",
@@ -42,9 +42,9 @@
   "dependencies": {
     "@babel/code-frame": "^7.14.5",
     "@babel/runtime": "^7",
-    "@modern-js/load-config": "^1.2.0",
-    "@modern-js/plugin": "^1.2.0",
-    "@modern-js/utils": "^1.2.1",
+    "@modern-js/load-config": "^1.2.1",
+    "@modern-js/plugin": "^1.2.1",
+    "@modern-js/utils": "^1.2.2",
     "address": "^1.1.2",
     "ajv": "^8.6.2",
     "ajv-keywords": "^5.0.0",
@@ -62,7 +62,7 @@
   "devDependencies": {
     "btsm": "2.2.2",
     "@types/babel__code-frame": "^7.0.3",
-    "@modern-js/types": "^1.2.0",
+    "@modern-js/types": "^1.2.1",
     "@types/jest": "^26",
     "@types/lodash.clonedeep": "^4.5.6",
     "@types/lodash.mergewith": "^4.6.6",

package/tests/context.test.ts

@@ -25,4 +25,39 @@ describe('context', () => {
       entrypoints: [],
     });
   });
+
+  it('custom AppContext', () => {
+    const appDirectory = path.resolve(
+      __dirname,
+      './fixtures/load-plugin/user-plugins',
+    );
+
+    const customOptions = {
+      srcDir: 'source',
+      distDir: 'dist',
+      sharedDir: 'myShared',
+      internalDir: 'myInternal',
+    };
+
+    const appContext = initAppContext(appDirectory, [], false, customOptions);
+    expect(appContext).toEqual({
+      appDirectory,
+      configFile: false,
+      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/myInternal',
+      ),
+      plugins: [],
+      htmlTemplates: {},
+      serverRoutes: [],
+      entrypoints: [],
+    });
+  });
 });

package/src/cli.ts

@@ -1,36 +0,0 @@
-// 这个文件跟 bin/modern-js.js 基本一样
-// 在开发阶段，因为 package.json 的 exports['./bin']['jsnext:source'] 配置
-// 了这个文件，所以需要保留, 后续如果找到更好的方式之后会移除这个文件
-
-import path from 'path';
-import { cli } from '.';
-
-const { version } = require('../package.json');
-
-// XXX: 通过这个方式去掉了 package.json 里面对于 @modern-js/module-tools 的 devDependencies 依赖
-// 然后可以正常的执行 modern build
-const kModuleToolsCliPath = path.resolve(
-  __dirname,
-  '../../../solutions/module-tools/src/index.ts',
-);
-
-process.env.MODERN_JS_VERSION = version;
-if (!process.env.NODE_ENV) {
-  process.env.NODE_ENV =
-    // eslint-disable-next-line no-nested-ternary
-    ['build', 'start', 'deploy'].includes(process.argv[2])
-      ? 'production'
-      : process.argv[2] === 'test'
-      ? 'test'
-      : 'development';
-}
-
-cli.run(process.argv.slice(2), {
-  plugins: {
-    '@modern-js/module-tools': {
-      cli: kModuleToolsCliPath,
-      // 是否需要强制加载这个组件，跳过 loadPlugins 里面 filter 的检测逻辑
-      forced: true,
-    } as any,
-  },
-});

package/src/config/defaults.ts

@@ -1,101 +0,0 @@
-import { OutputConfig, ServerConfig, SourceConfig } from '.';
-
-const sourceDefaults: SourceConfig = {
-  entries: undefined,
-  disableDefaultEntries: false,
-  entriesDir: './src',
-  configDir: './config',
-  apiDir: './api',
-  envVars: [],
-  globalVars: undefined,
-  alias: undefined,
-  moduleScopes: undefined,
-  include: [],
-};
-
-const outputDefaults: OutputConfig = {
-  assetPrefix: '/',
-  htmlPath: 'html',
-  jsPath: 'static/js',
-  cssPath: 'static/css',
-  mediaPath: 'static/media',
-  path: 'dist',
-  title: '',
-  titleByEntries: undefined,
-  meta: {
-    charset: { charset: 'utf-8' },
-    viewport:
-      'width=device-width, initial-scale=1.0, shrink-to-fit=no, viewport-fit=cover, minimum-scale=1.0, maximum-scale=1.0, user-scalable=no',
-    'http-equiv': { 'http-equiv': 'x-ua-compatible', content: 'ie=edge' },
-    renderer: 'webkit',
-    layoutmode: 'standard',
-    imagemode: 'force',
-    'wap-font-scale': 'no',
-    'format-detection': 'telephone=no',
-  },
-  metaByEntries: undefined,
-  inject: 'head',
-  injectByEntries: undefined,
-  mountId: 'root',
-  favicon: '',
-  faviconByEntries: undefined,
-  copy: undefined,
-  scriptExt: undefined,
-  disableHtmlFolder: false,
-  disableCssModuleExtension: false,
-  disableCssExtract: false,
-  enableCssModuleTSDeclaration: false,
-  disableMinimize: false,
-  enableInlineStyles: false,
-  enableInlineScripts: false,
-  disableSourceMap: false,
-  disableInlineRuntimeChunk: false,
-  disableAssetsCache: false,
-  enableLatestDecorators: false,
-  polyfill: 'entry',
-  dataUriLimit: 10000,
-  templateParameters: {},
-  templateParametersByEntries: undefined,
-  cssModuleLocalIdentName: '[name]__[local]--[hash:base64:5]',
-  enableModernMode: false,
-  federation: undefined,
-  disableNodePolyfill: false,
-  enableTsLoader: false,
-};
-
-const serverDefaults: ServerConfig = {
-  routes: undefined,
-  publicRoutes: undefined,
-  ssr: undefined,
-  ssrByEntries: undefined,
-  baseUrl: '/',
-  port: 8080,
-};
-
-const devDefaults = { assetPrefix: false, https: false };
-
-const deployDefaults = {
-  domain: '',
-  domainByEntries: undefined,
-};
-
-const toolsDefaults = {
-  webpack: undefined,
-  babel: undefined,
-  postcss: undefined,
-  autoprefixer: undefined,
-  lodash: undefined,
-  devServer: undefined,
-  tsLoader: undefined,
-  terser: undefined,
-  minifyCss: undefined,
-};
-
-export const defaults = {
-  source: sourceDefaults,
-  output: outputDefaults,
-  server: serverDefaults,
-  dev: devDefaults,
-  deploy: deployDefaults,
-  tools: toolsDefaults,
-};

package/src/config/index.ts

@@ -1,322 +0,0 @@
-import { loadConfig } from '@modern-js/load-config';
-import Ajv, { ErrorObject } from 'ajv';
-import ajvKeywords from 'ajv-keywords';
-import logger from 'signale';
-import {
-  createDebugger,
-  getPort,
-  isDev,
-  MetaOptions,
-  PLUGIN_SCHEMAS,
-  chalk,
-} from '@modern-js/utils';
-import mergeWith from 'lodash.mergewith';
-import betterAjvErrors from 'better-ajv-errors';
-import { codeFrameColumns } from '@babel/code-frame';
-import { PluginConfig } from '../loadPlugins';
-import { repeatKeyWarning } from '../utils/repeatKeyWarning';
-import { defaults } from './defaults';
-import { mergeConfig, NormalizedConfig } from './mergeConfig';
-import { patchSchema, PluginValidateSchema } from './schema';
-
-const debug = createDebugger('resolve-config');
-
-export { defaults as defaultsConfig };
-export { mergeConfig };
-
-interface SourceConfig {
-  entries?: Record<
-    string,
-    | string
-    | {
-        entry: string;
-        enableFileSystemRoutes?: boolean;
-        disableMount?: boolean;
-      }
-  >;
-  disableDefaultEntries?: boolean;
-  entriesDir?: string;
-  configDir?: string;
-  apiDir?: string;
-  envVars?: Array<string>;
-  globalVars?: Record<string, string>;
-  alias?:
-    | Record<string, string>
-    | ((aliases: Record<string, string>) => Record<string, unknown>);
-  moduleScopes?:
-    | Array<string | RegExp>
-    | ((scopes: Array<string | RegExp>) => Array<string | RegExp>);
-  include?: Array<string | RegExp>;
-}
-
-interface OutputConfig {
-  assetPrefix?: string;
-  htmlPath?: string;
-  jsPath?: string;
-  cssPath?: string;
-  mediaPath?: string;
-  path?: string;
-  title?: string;
-  titleByEntries?: Record<string, string>;
-  meta?: MetaOptions;
-  metaByEntries?: Record<string, MetaOptions>;
-  inject?: 'body' | 'head' | boolean;
-  injectByEntries?: Record<string, 'body' | 'head' | boolean>;
-  mountId?: string;
-  favicon?: string;
-  faviconByEntries?: Record<string, string | undefined>;
-  copy?: Record<string, unknown>;
-  scriptExt?: Record<string, unknown>;
-  disableHtmlFolder?: boolean;
-  disableCssModuleExtension?: boolean;
-  disableCssExtract?: boolean;
-  enableCssModuleTSDeclaration?: boolean;
-  disableMinimize?: boolean;
-  enableInlineStyles?: boolean;
-  enableInlineScripts?: boolean;
-  disableSourceMap?: boolean;
-  disableInlineRuntimeChunk?: boolean;
-  disableAssetsCache?: boolean;
-  enableLatestDecorators?: boolean;
-  polyfill?: 'off' | 'usage' | 'entry' | 'ua';
-  dataUriLimit?: number;
-  templateParameters?: Record<string, unknown>;
-  templateParametersByEntries?: Record<
-    string,
-    Record<string, unknown> | undefined
-  >;
-  cssModuleLocalIdentName?: string;
-  enableModernMode?: boolean;
-  federation?: boolean;
-  disableNodePolyfill?: boolean;
-  enableTsLoader?: boolean;
-}
-
-interface ServerConfig {
-  routes?: Record<
-    string,
-    | string
-    | {
-        route: string | string[];
-        disableSpa?: boolean;
-      }
-  >;
-  publicRoutes?: { [filepath: string]: string };
-  ssr?: boolean | Record<string, unknown>;
-  ssrByEntries?: Record<string, boolean | Record<string, unknown>>;
-  baseUrl?: string | Array<string>;
-  port?: number;
-  logger?: Record<string, any>;
-  metrics?: Record<string, any>;
-  enableMicroFrontendDebug?: boolean;
-}
-
-interface DevConfig {
-  assetPrefix?: string | boolean;
-  https?: boolean;
-}
-
-interface DeployConfig {
-  microFrontend?: boolean & Record<string, unknown>;
-  domain?: string | Array<string>;
-  domainByEntries?: Record<string, string | Array<string>>;
-}
-
-type ConfigFunction =
-  | Record<string, unknown>
-  // eslint-disable-next-line @typescript-eslint/no-invalid-void-type
-  | ((config: Record<string, unknown>) => Record<string, unknown> | void);
-interface ToolsConfig {
-  webpack?: ConfigFunction;
-  babel?: ConfigFunction;
-  autoprefixer?: ConfigFunction;
-  postcss?: ConfigFunction;
-  lodash?: ConfigFunction;
-  devServer?: Record<string, unknown>;
-  tsLoader?: ConfigFunction;
-  terser?: ConfigFunction;
-  minifyCss?: ConfigFunction;
-  esbuild?: Record<string, unknown>;
-}
-
-type RuntimeConfig = Record<string, any>;
-
-interface RuntimeByEntriesConfig {
-  [name: string]: RuntimeConfig;
-}
-
-interface UserConfig {
-  source?: SourceConfig;
-  output?: OutputConfig;
-  server?: ServerConfig;
-  dev?: DevConfig;
-  deploy?: DeployConfig;
-  tools?: ToolsConfig;
-  plugins?: PluginConfig;
-  runtime?: RuntimeConfig;
-  runtimeByEntries?: RuntimeByEntriesConfig;
-}
-
-type ConfigParam =
-  | UserConfig
-  | Promise<UserConfig>
-  | ((env: any) => UserConfig | Promise<UserConfig>);
-
-interface LoadedConfig {
-  config: UserConfig;
-  filePath: string | false;
-  dependencies: string[];
-  pkgConfig: UserConfig;
-  jsConfig: UserConfig;
-}
-
-export const defineConfig = (config: ConfigParam): ConfigParam => config;
-
-export const loadUserConfig = async (
-  appDirectory: string,
-  filePath?: string,
-  packageJsonConfig?: string,
-): Promise<LoadedConfig> => {
-  const loaded = await loadConfig<ConfigParam>(
-    appDirectory,
-    filePath,
-    packageJsonConfig,
-  );
-
-  const config = !loaded
-    ? {}
-    : await (typeof loaded.config === 'function'
-        ? loaded.config(0)
-        : loaded.config);
-
-  return {
-    config: mergeWith({}, config || {}, loaded?.pkgConfig || {}),
-    jsConfig: (config || {}) as any,
-    pkgConfig: (loaded?.pkgConfig || {}) as UserConfig,
-    filePath: loaded?.path,
-    dependencies: loaded?.dependencies || [],
-  };
-};
-
-const showAdditionalPropertiesError = (error: ErrorObject) => {
-  if (
-    error.keyword === 'additionalProperties' &&
-    error.instancePath &&
-    error.params.additionalProperty
-  ) {
-    const target = `${error.instancePath.substr(1)}.${
-      error.params.additionalProperty
-    }`;
-
-    const name = Object.keys(PLUGIN_SCHEMAS).find(key =>
-      (PLUGIN_SCHEMAS as Record<string, any>)[key].some(
-        (schemaItem: any) => schemaItem.target === target,
-      ),
-    );
-
-    if (name) {
-      logger.warn(
-        `The configuration of ${chalk.bold(
-          target,
-        )} is provided by plugin ${chalk.bold(name)}. Please use ${chalk.bold(
-          'yarn new',
-        )} to enable the corresponding capability.\n`,
-      );
-    }
-  }
-};
-
-/* eslint-disable max-statements, max-params */
-export const resolveConfig = async (
-  loaded: LoadedConfig,
-  configs: UserConfig[],
-  schemas: PluginValidateSchema[],
-  restartWithExistingPort: number,
-  argv: string[],
-): Promise<NormalizedConfig> => {
-  const { config: userConfig, jsConfig, pkgConfig } = loaded;
-
-  const ajv = new Ajv({ $data: true, strict: false });
-
-  ajvKeywords(ajv);
-
-  const validateSchema = patchSchema(schemas);
-
-  const validate = ajv.compile(validateSchema);
-
-  repeatKeyWarning(validateSchema, jsConfig, pkgConfig);
-
-  // validate user config.
-  const valid = validate(userConfig);
-
-  if (!valid && validate.errors?.length) {
-    showAdditionalPropertiesError(validate?.errors[0]);
-    const errors = betterAjvErrors(
-      validateSchema,
-      userConfig,
-      validate.errors?.map(e => ({
-        ...e,
-        dataPath: e.instancePath,
-      })),
-      {
-        format: 'js',
-        indent: 2,
-      },
-    );
-
-    logger.log(
-      codeFrameColumns(
-        JSON.stringify(userConfig, null, 2),
-        {
-          start: errors?.[0].start as any,
-          end: errors?.[0].end as any,
-        },
-        {
-          highlightCode: true,
-          message: errors?.[0].error,
-        },
-      ),
-    );
-    throw new Error(`Validate configuration error`);
-  }
-
-  // validate config from plugins.
-  for (const config of configs) {
-    if (!validate(config)) {
-      logger.error(validate.errors);
-      throw new Error(`Validate configuration error.`);
-    }
-  }
-  const resolved = mergeConfig([defaults as any, ...configs, userConfig]);
-
-  resolved._raw = loaded.config;
-
-  if (isDev() && argv[0] === 'dev') {
-    if (restartWithExistingPort > 0) {
-      // dev server is restarted, should use existing port number
-      resolved.server.port = restartWithExistingPort;
-    } else {
-      // get port for new dev server
-      resolved.server.port = await getPort(resolved.server.port!);
-    }
-  }
-
-  debug('resolved %o', resolved);
-
-  return resolved;
-};
-/* eslint-enable max-statements, max-params */
-
-export type {
-  SourceConfig,
-  OutputConfig,
-  ServerConfig,
-  DevConfig,
-  DeployConfig,
-  ToolsConfig,
-  RuntimeConfig,
-  RuntimeByEntriesConfig,
-  UserConfig,
-  ConfigParam,
-  LoadedConfig,
-};