@modern-js/core 1.8.0 → 1.9.0

package/dist/config/schema/tools.d.ts

@@ -0,0 +1,36 @@
+export declare const tools: {
+    type: string;
+    additionalProperties: boolean;
+    properties: {
+        webpack: {
+            typeof: string[];
+        };
+        babel: {
+            typeof: string[];
+        };
+        postcss: {
+            typeof: string[];
+        };
+        lodash: {
+            typeof: string[];
+        };
+        devServer: {
+            type: string;
+        };
+        tsLoader: {
+            typeof: string[];
+        };
+        autoprefixer: {
+            typeof: string[];
+        };
+        terser: {
+            typeof: string[];
+        };
+        minifyCss: {
+            typeof: string[];
+        };
+        styledComponents: {
+            typeof: string[];
+        };
+    };
+};

package/dist/config/schema/tools.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.tools = void 0;
+exports.tools = {
+    type: 'object',
+    additionalProperties: false,
+    properties: {
+        webpack: { typeof: ['object', 'function'] },
+        babel: { typeof: ['object', 'function'] },
+        postcss: { typeof: ['object', 'function'] },
+        lodash: { typeof: ['object', 'function'] },
+        devServer: { type: 'object' },
+        tsLoader: { typeof: ['object', 'function'] },
+        autoprefixer: { typeof: ['object', 'function'] },
+        terser: { typeof: ['object', 'function'] },
+        minifyCss: { typeof: ['object', 'function'] },
+        styledComponents: { typeof: ['object', 'function'] },
+    },
+};

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

@@ -0,0 +1,13 @@
+import { TransformOptions } from '@babel/core';
+import { Configuration } from 'electron-builder';
+export declare type BuildConfig = {
+    baseConfig: Configuration;
+    macConfig?: Configuration;
+    winConfig?: Configuration;
+    win64Config?: Configuration;
+    linuxConfig?: Configuration;
+};
+export declare type ElectronConfig = {
+    builder?: BuildConfig;
+    babel?: TransformOptions | ((defaultBabelConfig: TransformOptions) => TransformOptions);
+};

package/dist/config/types/electron.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,240 @@
+/// <reference types="node" />
+import type { IncomingMessage, ServerResponse } from 'http';
+import type { NextFunction, BffProxyOptions } from '@modern-js/types';
+import type { MetaOptions } from '@modern-js/utils';
+import type { TransformOptions } from '@babel/core';
+import type webpack from 'webpack';
+import type { Configuration as WebpackConfiguration } from 'webpack';
+import autoprefixer from 'autoprefixer';
+import type { BasePluginOptions, TerserOptions as RawTerserOptions } from 'terser-webpack-plugin';
+import type { PluginConfig } from '../../loadPlugins';
+import type { TestConfig, JestConfig } from './test';
+import type { SassConfig, SassLoaderOptions } from './sass';
+import type { LessConfig, LessLoaderOptions } from './less';
+import type { UnbundleConfig } from './unbundle';
+import type { SSGConfig, SSGRouteOptions, SSGMultiEntryOptions, SSGSingleEntryOptions } from './ssg';
+import { ElectronConfig } from './electron';
+declare type AutoprefixerOptions = autoprefixer.Options;
+declare type TerserOptions = BasePluginOptions & RawTerserOptions;
+export type { TestConfig, JestConfig, UnbundleConfig, SassConfig, SassLoaderOptions, LessConfig, LessLoaderOptions, SSGConfig, SSGRouteOptions, SSGMultiEntryOptions, SSGSingleEntryOptions, TransformOptions, AutoprefixerOptions, TerserOptions, };
+export 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>) => void) | ((scopes: Array<string | RegExp>) => Array<string | RegExp>);
+    include?: Array<string | RegExp>;
+    /**
+     * The configuration of `source.designSystem` is provided by plugin `@modern-js/plugin-tailwindcss`.
+     * Please use `yarn new` to enable the corresponding capability.
+     * @requires `@modern-js/plugin-tailwindcss`
+     */
+    designSystem?: Record<string, any>;
+}
+export 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?: Array<Record<string, unknown> & {
+        from: string;
+    }>;
+    scriptExt?: Record<string, unknown>;
+    disableTsChecker?: boolean;
+    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;
+    /**
+     * Disables lazy import support for styles, currently supports antd and arco-design.
+     * The configuration of `output.disableAutoImportStyle` is provided by plugin `@modern-js/plugin-unbundle`.
+     * Please use `yarn new` to enable the corresponding capability.
+     * @requires `@modern-js/plugin-unbundle`
+     */
+    disableAutoImportStyle?: boolean;
+    /**
+     * The configuration of `output.ssg` is provided by plugin `@modern-js/plugin-ssg`.
+     * Please use `yarn new` to enable the corresponding capability.
+     * @requires `@modern-js/plugin-ssg`
+     */
+    ssg?: SSGConfig;
+}
+export interface ServerConfig {
+    routes?: Record<string, 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?: boolean | Record<string, any>;
+    metrics?: boolean | Record<string, any>;
+    enableMicroFrontendDebug?: boolean;
+}
+export declare type DevProxyOptions = string | Record<string, string>;
+export interface DevConfig {
+    assetPrefix?: string | boolean;
+    https?: boolean;
+    /**
+     * The configuration of `dev.proxy` is provided by plugin `@modern-js/plugin-proxy`.
+     * Please use `yarn new` to enable the corresponding capability.
+     * @requires `@modern-js/plugin-proxy`
+     */
+    proxy?: DevProxyOptions;
+    /**
+     * The configuration of `dev.unbundle` is provided by plugin `@modern-js/plugin-unbundle`.
+     * Please use `yarn new` to enable the corresponding capability.
+     * @requires `@modern-js/plugin-unbundle`
+     */
+    unbundle?: UnbundleConfig;
+}
+export interface MicroFrontend {
+    enableHtmlEntry?: boolean;
+    externalBasicLibrary?: boolean;
+    moduleApp?: string;
+}
+export interface DeployConfig {
+    microFrontend?: false | MicroFrontend;
+    domain?: string | Array<string>;
+    domainByEntries?: Record<string, string | Array<string>>;
+}
+declare type ConfigFunction = Record<string, unknown> | ((config: Record<string, unknown>, utils?: any) => Record<string, unknown> | void);
+export declare type RequestHandler = (req: IncomingMessage, res: ServerResponse, next: NextFunction) => void;
+export declare type DevServerConfig = {
+    proxy?: BffProxyOptions;
+    headers?: Record<string, string>;
+    before?: RequestHandler[];
+    after?: RequestHandler[];
+    [propsName: string]: any;
+};
+export declare type WebpackConfig = WebpackConfiguration | ((config: WebpackConfiguration, utils: {
+    env: string;
+    webpack: typeof webpack;
+    [key: string]: any;
+}) => WebpackConfiguration | void);
+export declare type BabelConfig = TransformOptions | ((config: TransformOptions, utils?: any) => TransformOptions | void);
+export declare type AutoprefixerConfig = AutoprefixerOptions | ((config: AutoprefixerOptions) => AutoprefixerOptions | void);
+export declare type TerserConfig = TerserOptions | ((config: TerserOptions) => TerserOptions | void);
+export interface ToolsConfig {
+    webpack?: WebpackConfig;
+    babel?: BabelConfig;
+    autoprefixer?: AutoprefixerConfig;
+    postcss?: ConfigFunction;
+    styledComponents?: ConfigFunction;
+    lodash?: ConfigFunction;
+    devServer?: DevServerConfig;
+    tsLoader?: ConfigFunction;
+    terser?: TerserConfig;
+    minifyCss?: ConfigFunction;
+    esbuild?: Record<string, unknown>;
+    /**
+     * The configuration of `tools.tailwindcss` is provided by plugin `@modern-js/plugin-tailwindcss`.
+     * Please use `yarn new` to enable the corresponding capability.
+     * @requires `@modern-js/plugin-tailwindcss`
+     */
+    tailwindcss?: Record<string, any> | ((options: Record<string, any>) => Record<string, any> | void);
+    /**
+     * The configuration of `tools.jest` is provided by plugin `@modern-js/plugin-testing`.
+     * Please use `yarn new` to enable the corresponding capability.
+     * @requires `@modern-js/plugin-testing`
+     */
+    jest?: TestConfig['jest'];
+    /**
+     * The configuration of `tools.sass` is provided by plugin `@modern-js/plugin-sass`.
+     * Please use `yarn new` to enable the corresponding capability.
+     * @requires `@modern-js/plugin-sass`
+     */
+    sass?: SassConfig;
+    /**
+     * The configuration of `tools.less` is provided by plugin `@modern-js/plugin-less`.
+     * Please use `yarn new` to enable the corresponding capability.
+     * @requires `@modern-js/plugin-less`
+     */
+    less?: LessConfig;
+}
+export declare type RuntimeConfig = Record<string, any>;
+export interface RuntimeByEntriesConfig {
+    [name: string]: RuntimeConfig;
+}
+export declare type BffConfig = Partial<{
+    prefix: string;
+    requestCreator: string;
+    fetcher: string;
+    proxy: Record<string, any>;
+}>;
+export interface UserConfig {
+    source?: SourceConfig;
+    output?: OutputConfig;
+    server?: ServerConfig;
+    dev?: DevConfig;
+    deploy?: DeployConfig;
+    tools?: ToolsConfig;
+    plugins?: PluginConfig;
+    runtime?: RuntimeConfig;
+    runtimeByEntries?: RuntimeByEntriesConfig;
+    /**
+     * The configuration of `bff` is provided by plugin `@modern-js/plugin-bff`.
+     * Please use `yarn new` to enable the corresponding capability.
+     * @requires `@modern-js/plugin-bff`
+     */
+    bff?: BffConfig;
+    /**
+     * The configuration of `testing` is provided by plugin `@modern-js/plugin-testing`.
+     * Please use `yarn new` to enable the corresponding capability.
+     * @requires `@modern-js/plugin-testing`
+     */
+    testing?: TestConfig;
+    /**
+     * The configuration of `electron` is provided by plugin `@modern-js/plugin-electron`.
+     * Please use `yarn new` to enable the corresponding capability.
+     * @requires `@modern-js/plugin-electron`
+     */
+    electron?: ElectronConfig;
+}
+export declare type ConfigParam = UserConfig | Promise<UserConfig> | ((env: any) => UserConfig | Promise<UserConfig>);
+export interface LoadedConfig {
+    config: UserConfig;
+    filePath: string | false;
+    dependencies: string[];
+    pkgConfig: UserConfig;
+    jsConfig: UserConfig;
+}

package/dist/config/types/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/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/config/types/less.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/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/config/types/sass.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/{types/config → config}/types/ssg.d.ts

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

package/dist/config/types/ssg.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,14 @@
+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/config/types/test.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,25 @@
+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/config/types/unbundle.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/{types/context.d.ts → context.d.ts}

@@ -10,38 +10,28 @@ export declare const ResolvedConfigContext: import("@modern-js/plugin").Context<
  * Set app context.
  * @param value new app context. It will override previous app context.
  */
-
 export declare const setAppContext: (value: IAppContext) => void;
 /**
  * Get app context, including directories, plugins and some static infos.
  */
-
 export declare const useAppContext: () => IAppContext;
 /**
  * Get original content of user config.
  */
-
 export declare const useConfigContext: () => UserConfig;
 /**
  * Get normalized content of user config.
  */
-
 export declare const useResolvedConfigContext: () => NormalizedConfig;
-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;
+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/context.js

@@ -0,0 +1,59 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.initAppContext = exports.useResolvedConfigContext = exports.useConfigContext = exports.useAppContext = exports.setAppContext = exports.ResolvedConfigContext = exports.ConfigContext = exports.AppContext = void 0;
+const path_1 = __importDefault(require("path"));
+const utils_1 = require("@modern-js/utils");
+const plugin_1 = require("@modern-js/plugin");
+exports.AppContext = (0, plugin_1.createContext)({});
+exports.ConfigContext = (0, plugin_1.createContext)({});
+exports.ResolvedConfigContext = (0, plugin_1.createContext)({});
+/**
+ * Set app context.
+ * @param value new app context. It will override previous app context.
+ */
+const setAppContext = (value) => exports.AppContext.set(value);
+exports.setAppContext = setAppContext;
+/**
+ * Get app context, including directories, plugins and some static infos.
+ */
+const useAppContext = () => exports.AppContext.use().value;
+exports.useAppContext = useAppContext;
+/**
+ * Get original content of user config.
+ */
+const useConfigContext = () => exports.ConfigContext.use().value;
+exports.useConfigContext = useConfigContext;
+/**
+ * Get normalized content of user config.
+ */
+const useResolvedConfigContext = () => exports.ResolvedConfigContext.use().value;
+exports.useResolvedConfigContext = useResolvedConfigContext;
+const initAppContext = ({ appDirectory, plugins, configFile, options, serverConfigFile, }) => {
+    const { metaName = 'modern-js', srcDir = 'src', distDir = '', sharedDir = 'shared', } = options || {};
+    return {
+        metaName,
+        appDirectory,
+        configFile,
+        serverConfigFile,
+        ip: utils_1.address.ip(),
+        port: 0,
+        packageName: require(path_1.default.resolve(appDirectory, './package.json')).name,
+        srcDirectory: path_1.default.resolve(appDirectory, srcDir),
+        distDirectory: distDir,
+        sharedDirectory: path_1.default.resolve(appDirectory, sharedDir),
+        nodeModulesDirectory: path_1.default.resolve(appDirectory, './node_modules'),
+        internalDirectory: path_1.default.resolve(appDirectory, `./node_modules/.${metaName}`),
+        plugins,
+        htmlTemplates: {},
+        serverRoutes: [],
+        entrypoints: [],
+        checkedEntries: [],
+        apiOnly: false,
+        internalDirAlias: `@_${metaName.replace(/-/g, '_')}_internal`,
+        internalSrcAlias: `@_${metaName.replace(/-/g, '_')}_src`,
+    };
+};
+exports.initAppContext = initAppContext;

package/dist/index.d.ts

@@ -0,0 +1,64 @@
+import { INTERNAL_PLUGINS } from '@modern-js/utils';
+import type { Hooks } from '@modern-js/types';
+import type { ErrorObject } from '../compiled/ajv';
+import { TransformPlugin } from './loadPlugins';
+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 { 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;
+    serverConfigFile?: string;
+    packageJsonConfig?: string;
+    plugins?: typeof INTERNAL_PLUGINS;
+    transformPlugin?: TransformPlugin;
+    onSchemaError?: (error: ErrorObject) => void;
+    options?: {
+        metaName?: string;
+        srcDir?: string;
+        distDir?: string;
+        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;
+    transformPlugin?: TransformPlugin | 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;
+        appContext: IAppContext;
+        resolved: NormalizedConfig;
+    }>;
+    run: (argv: string[], options?: CoreOptions | undefined) => Promise<void>;
+    restart: () => Promise<void>;
+};
+export { initAppDir, initAppContext };
+declare module '@modern-js/utils/compiled/commander' {
+    interface Command {
+        commandsMap: Map<string, Command>;
+    }
+}