@empjs/cli 3.0.0-rc.8 → 3.0.0

package/dist/index.d.cts

@@ -0,0 +1,691 @@
+import { InspectOptions } from 'node:util';
+import * as _rspack_core from '@rspack/core';
+import { Configuration, Output, RspackOptions, Externals, Resolve, SwcJsMinimizerRspackPluginOptions, HtmlRspackPluginOptions, RuleSetRule } from '@rspack/core';
+export { rspack } from '@rspack/core';
+import { Configuration as Configuration$1 } from '@rspack/dev-server';
+import { Options } from 'sass-embedded';
+import { ModuleFederationPlugin } from '@module-federation/enhanced/rspack';
+import WPChain from 'webpack-chain';
+export { default as HtmlWebpackPlugin } from 'html-webpack-plugin';
+import * as chalk from 'chalk';
+import chalk__default from 'chalk';
+import { glob } from 'glob';
+
+type externalAssetsType = {
+    js: string[];
+    css: string[];
+};
+type ModuleFederationPluginOptions = ConstructorParameters<typeof ModuleFederationPlugin>[0];
+type ImportMapType = {
+    imports: {
+        [key: string]: any;
+    };
+};
+declare class EMPShareLib {
+    externals: Configuration['externals'] | any;
+    externalAssets: externalAssetsType;
+    private exp;
+    config: EMPShareType;
+    importMap: ImportMapType;
+    isEmpshare: boolean;
+    setup(): Promise<void>;
+    /**
+     * 是否取用 importMap
+     */
+    get useImportMap(): boolean | undefined;
+    get pluginConfig(): ModuleFederationPluginOptions;
+    prepareEsm(): void;
+    setShareLib(): Promise<void>;
+    private setExternalAssets;
+}
+
+type LifeCycleOptions = Partial<LifeCycle>;
+declare class LifeCycle {
+    op: LifeCycleOptions;
+    constructor(op?: LifeCycleOptions);
+    afterGetEmpOptions(): Promise<void>;
+    beforePlugin(): Promise<void>;
+    afterPlugin(): Promise<void>;
+    beforeModule(): Promise<void>;
+    afterModule(): Promise<void>;
+    beforeEmpPlugin(): Promise<void>;
+    afterEmpPlugin(): Promise<void>;
+    beforeBuild(): Promise<void>;
+    afterBulid(): Promise<void>;
+    beforeDevServe(): Promise<void>;
+    afterDevServe(): Promise<void>;
+    beforeServe(): Promise<void>;
+    afterServe(): Promise<void>;
+}
+
+declare const getLanIp: () => string;
+declare const getPkgVersion: (pkgPath: string) => any;
+declare function clearConsole(): void;
+declare function deepAssign<T>(target: any, ...sources: any): T;
+declare const ensureArray: <T>(params: T | T[]) => T[];
+/**
+ * json Filter
+ * @param d
+ * @param keys
+ * @returns
+ */
+declare const jsonFilter: (d?: any, notIncludeKeys?: string[]) => any;
+declare const vCompare: (preVersion?: string, lastVersion?: string) => number;
+declare const timeFormat: (seconds: number) => string;
+declare const importJsVm: (content: string) => string;
+
+declare const utils_clearConsole: typeof clearConsole;
+declare const utils_deepAssign: typeof deepAssign;
+declare const utils_ensureArray: typeof ensureArray;
+declare const utils_getLanIp: typeof getLanIp;
+declare const utils_getPkgVersion: typeof getPkgVersion;
+declare const utils_importJsVm: typeof importJsVm;
+declare const utils_jsonFilter: typeof jsonFilter;
+declare const utils_timeFormat: typeof timeFormat;
+declare const utils_vCompare: typeof vCompare;
+declare namespace utils {
+  export { utils_clearConsole as clearConsole, utils_deepAssign as deepAssign, utils_ensureArray as ensureArray, utils_getLanIp as getLanIp, utils_getPkgVersion as getPkgVersion, utils_importJsVm as importJsVm, utils_jsonFilter as jsonFilter, utils_timeFormat as timeFormat, utils_vCompare as vCompare };
+}
+
+declare class EmpShareFastMode {
+    fastMode: Required<EMPShareFastModeType>;
+    externalMF: {
+        '@module-federation/runtime': string;
+        '@module-federation/sdk': string;
+    };
+    externalReact: {
+        react: string;
+        'react-dom': string;
+        'react-router-dom': string;
+    };
+    externals: any;
+    getRuntimeLib(runtimeHost: string): string;
+    setup(): void;
+    injectLib(): void;
+    setExternals(): void;
+}
+
+declare class EmpConfig {
+    private store;
+    /**
+     * 项目代码路径
+     * @default 'src'
+     */
+    appSrc: string;
+    /**
+     * 项目代码入口文件 如 `src/index.js`
+     * (*)entries 设置后 该选项失效
+     * @default 'index.js'
+     */
+    appEntry: string;
+    /**
+     * publicPath 根路径 可参考webpack,业务模式默认为 auto
+     * html 部分 publicPath 默认为 undefined,可设置全量域名或子目录适配，也可以单独在html设置 Public
+     *
+     * @default undefined
+     */
+    base: string;
+    target: RsTarget;
+    private assign;
+    empShareFastMode: EmpShareFastMode;
+    empShareLib: EMPShareLib;
+    /**
+     * 是否启动 esm 模块
+     * @default true
+     */
+    isESM: boolean;
+    autoDevSet(): Promise<void>;
+    checkIsESM(target: string): boolean;
+    lifeCycle: LifeCycle;
+    setup(store: GlobalStore): Promise<void>;
+    chain(): Promise<void>;
+    plugins(): Promise<void>;
+    get debug(): DebugType;
+    get build(): Required<BuildType>;
+    get html(): HtmlType;
+    get entries(): EntriesType;
+    get server(): ServerType;
+    get empShare(): EMPShareType;
+    get css(): Required<EmpOptions['css']>;
+    get output(): Output;
+    get define(): {
+        [k: string]: string;
+    };
+    private setDefine;
+    get externals(): any;
+    get resolve(): _rspack_core.ResolveOptions;
+    syncEmpOptions(): Promise<void>;
+    get moduleTransformRule(): any;
+    get cacheDir(): string;
+    get ignoreWarnings(): (RegExp | ((args_0: Error, args_1: _rspack_core.Compilation, ...args_2: unknown[]) => boolean))[];
+    get autoPages(): {
+        path: string;
+    } | undefined;
+}
+
+type EMPModeType = 'development' | 'production';
+
+declare class GlobalStore {
+    /**
+     * EMP Version
+     * @default package version
+     */
+    empPkg: any;
+    /**
+     * 项目pkg信息
+     */
+    pkg: any;
+    /**
+     * 项目根目录绝对路径
+     * @default process.cwd()
+     */
+    root: string;
+    /**
+     * emp 内部根路径
+     * @default empRoot
+     */
+    empRoot: string;
+    /**
+     * emp 执行代码路径
+     */
+    empSource: string;
+    /**
+     * 获取项目 根目录绝对路径
+     * (*) relativePath 可以是绝对路径
+     * @param relativePath
+     * @returns
+     */
+    resolve: (relativePath: string) => string;
+    /**
+     * 获取项目 emp内部根目录绝对路径
+     * @param relativePath
+     * @returns
+     */
+    empResolve: (relativePath: string) => string;
+    /**
+     * 源码地址 绝对路径
+     */
+    appSrc: string;
+    /**
+     * 源码生成目录 绝对路径
+     */
+    outDir: string;
+    /**
+     * 静态文件目录 绝对路径
+     */
+    publicDir: string;
+    /**
+     * 静态资源
+     */
+    resource: {
+        dir: string;
+        key: string;
+        cert: string;
+    };
+    /**
+     * 缓存目录 绝对路径
+     */
+    cacheDir: string;
+    mode: EMPModeType;
+    cliMode: 'dev' | 'prod';
+    isDev: boolean;
+    /**
+     * 项目配置
+     */
+    cliOptions: any;
+    chain: WPChain;
+    rsConfig: Configuration;
+    empOptions: EmpOptions;
+    empConfig: EmpConfig;
+    vCompare: (preVersion?: string, lastVersion?: string) => number;
+    deepAssign: typeof deepAssign;
+    getLanIp: () => string;
+    entries: {
+        [chunkName: string]: RspackOptions['entry'];
+    };
+    debug: EmpConfig['debug'];
+    setup(mode: string, cliOptions: any): Promise<void>;
+    /**
+     * 初始化 基础变量
+     * @param mode cli名称
+     * @param cliOptions cli配置
+     */
+    initVars(mode: string, cliOptions: any): Promise<void>;
+    /**
+     * 初始化 基础路径
+     */
+    initPaths(): void;
+    /**
+     * 设置 日志等级
+     */
+    setLogger(): void;
+    merge(o: RspackOptions): void;
+    /**
+     * 同步 chain 配置到 rsConfig
+     */
+    toConfig(): void;
+    /**
+     * 打印 config
+     */
+    logConfig(): void;
+    get browserslistOptions(): {
+        default: string[];
+        h5: string[];
+        node: string[];
+    };
+}
+declare const _default$3: GlobalStore;
+
+type EMP3PluginType = {
+    name: string;
+    rsConfig: (store: GlobalStore) => Promise<void>;
+};
+type EMP3PluginFnType = (o: any) => EMP3PluginType;
+
+type LoggerType = 'debug' | 'info' | 'warn' | 'error';
+type DebugType = {
+    loggerLevel?: LoggerType;
+    clearLog?: boolean;
+    progress?: boolean;
+    showRsconfig?: boolean | string | InspectOptions;
+    showPerformance?: boolean;
+    rspackCache?: boolean;
+    newTreeshaking?: boolean;
+    /**
+     * 是否显示执行日志
+     * @default false
+     */
+    infrastructureLogging?: Configuration['infrastructureLogging'];
+};
+type ServerType = Configuration$1 & {
+    /**
+     * 访问 host
+     * @default '0.0.0.0'
+     */
+    host?: string;
+    /**
+     * 访问 端口
+     * @default 8000
+     */
+    port?: number;
+    /**
+     * 自动打开
+     * @default false
+     */
+    open?: Configuration$1['open'];
+    /**
+     * 热重载
+     * @default true
+     */
+    hot?: Configuration$1['hot'];
+};
+type BuildType = {
+    /**
+     * 生成代码目录
+     * @default 'dist'
+     */
+    outDir?: string;
+    /**
+     * 生成静态目录
+     * @default 'assets'
+     */
+    assetsDir?: string;
+    /**
+     * 生成包含 js,css,asset 合集目录
+     * @default ''
+     */
+    staticDir?: string;
+    /**
+     * 静态文件路径
+     * @default 'public'
+     */
+    publicDir?: string;
+    /**
+     * named 使用有意义、方便调试的内容当作模块 id。此选项会在开发环境下默认开启。
+     * deterministic 使用对模块标识符哈希后的数字当作模块 id，有益于长期缓存。此选项会在生产环境下默认开启。
+     */
+    moduleIds?: 'named' | 'deterministic';
+    /**
+     * chunkIds
+     * @default named|deterministic
+     */
+    chunkIds?: false | 'natural' | 'named' | 'deterministic' | 'size' | 'total-size';
+    /**
+     * 是否生成 source map
+     * @default true
+     */
+    sourcemap?: boolean;
+    /**
+     * sourcemap 类型
+     * 默认 source-map
+     */
+    devtool?: Configuration['devtool'];
+    /**
+     * 是否压缩
+     * @default true
+     */
+    minify?: boolean;
+    /**
+     * 设置内置压缩器配置
+     * @default {}
+     */
+    minOptions?: SwcJsMinimizerRspackPluginOptions;
+    /**
+     * 生成代码 参考 https://swc.rs/docs/configuring-swc#jsctarget
+     */
+    target?: JscTarget;
+    /**
+     * 注入兼容代码
+     * module federation 入口 建议使用  entry
+     * @default false
+     */
+    polyfill?: 'entry' | 'usage' | false;
+    /**
+     * 手动注入兼容代码,避免usage出现分析纰漏问题
+     * @default ['es.object.values', 'es.object.entries', 'es.array.flat']
+     */
+    polyfillInclude?: string[];
+    /**
+     * 选择core-js的兼容版本有助于切换适当的代码体积
+     * @default stable
+     */
+    coreJsFeatures?: 'full' | 'actual' | 'stable' | 'es';
+    /**
+     * @swc/helpers 外置
+     * @default false
+     */
+    externalHelpers?: boolean;
+    /**
+     * 浏览器 兼容版本
+     */
+    browserslist?: string[];
+    /**
+     * swc 配置
+     */
+    swcConfig?: {
+        transform?: {
+            useDefineForClassFields?: boolean;
+        };
+        preserveAllComments?: boolean;
+    };
+};
+type JscTarget = 'es3' | 'es5' | 'es2015' | 'es2016' | 'es2017' | 'es2018' | 'es2019' | 'es2020' | 'es2021' | 'es2022';
+interface HtmlType extends HtmlRspackPluginOptions {
+    /**
+     * 基于项目的根目录 index.html url
+     * @default src/index.html
+     */
+    template?: string;
+    /**
+     * 基于项目的根目录 favicon url
+     * @default src/favicon.ico
+     */
+    favicon?: string;
+    /**
+     * 网站语言
+     */
+    lang?: string;
+    /**
+     * externals 文件插入到html
+     */
+    files?: {
+        /**
+         * 插入 css
+         */
+        css?: string[];
+        /**
+         * 插入 js
+         */
+        js?: string[];
+    };
+    /**
+     * 自定义 头部脚步内容 headTags[] bodyTags[]
+     */
+    tags?: {
+        headTags?: any[];
+        bodyTags?: any[];
+    };
+}
+type EntriesType = {
+    [entryFilename: string]: HtmlType;
+};
+interface ModuleTransform {
+    exclude?: RuleSetRule['exclude'][];
+    include?: RuleSetRule['include'][];
+    /**
+     * 默认exclude /(node_modules|bower_components)/
+     * @default false
+     */
+    defaultExclude?: boolean;
+}
+type CssSassOptionsType = {
+    api?: 'modern' | 'modern-compiler';
+    sassOptions?: Options<'async'>;
+    mode?: 'default' | 'modern' | 'legacy';
+    implementation?: object | string;
+};
+type EMPShareFastModeType = {
+    /**
+     * 共享库目录 优先读取 runtimeLib
+     */
+    runtimeHost?: string;
+    /**
+     * 共享库全路径
+     */
+    runtimeLib?: string;
+    /**
+     * 额外的库添加
+     */
+    externals?: any;
+    /**
+     * 当为 UMD时 暴露到 window 的全局变量
+     */
+    globalVal?: string;
+    /**
+     * 默认支持React
+     */
+    framework?: 'react';
+};
+type EMPShareType = ModuleFederationPluginOptions & {
+    /**
+     * emp 基于库共享模块
+     */
+    shareLib?: EMPshareLibItemType;
+    /**
+     * TODO
+     * 是否使用 importMap
+     */
+    useImportMap?: boolean;
+    /**
+     * 快速模式
+     */
+    fastMode?: EMPShareFastModeType;
+};
+type EMPshareLibItemType = {
+    [module: string]: {
+        entry: string;
+        global?: string;
+        type?: 'js' | 'css';
+    } | string | string[];
+};
+type RsTarget = Configuration['target'];
+type AutoPagesType = {
+    /**
+     * 基于src寻找入口目录
+     * @default pages
+     */
+    path?: string;
+};
+type EmpOptions = {
+    /**
+     * publicPath 根路径 可参考webpack,业务模式默认为 auto
+     * html 部分 publicPath 默认为 undefined,可设置全量域名或子目录适配，也可以单独在html设置 Public
+     *
+     * @default undefined
+     */
+    base?: string;
+    /**
+     * 构建target
+     */
+    target?: Configuration['target'];
+    /**
+     * 启动后 自动设置 base 为当前 Ip+port的路径如 base = http://127.0.0.1:8080/ 并且固定 ws 方便代理调试
+     */
+    autoDevBase?: boolean;
+    /**
+     * 启动后 进入自动搜寻入口的方式
+     * 可以通过 html 或 entries 设置 模版配置
+     */
+    autoPages?: boolean | AutoPagesType;
+    /**
+     * 项目代码路径
+     * @default 'src'
+     */
+    appSrc?: string;
+    /**
+     * 项目代码入口文件 如 `src/index.js`
+     * (*)entries 设置后 该选项失效
+     * @default 'index.js'
+     */
+    appEntry?: string;
+    build?: BuildType;
+    plugins?: EMP3PluginType[];
+    html?: HtmlType;
+    entries?: EntriesType;
+    server?: ServerType;
+    debug?: DebugType;
+    chain?: (chain: WPChain) => void;
+    empShare?: EMPShareType;
+    /**
+     * css 相关设置
+     */
+    css?: {
+        sass?: CssSassOptionsType;
+    };
+    /**
+     * 模块编译
+     * 如 node_modules 模块 是否加入编译
+     */
+    moduleTransform?: ModuleTransform;
+    /**
+     * 缓存目录
+     * @default 'node_modules/.emp-cache'
+     */
+    cacheDir?: string;
+    /**
+     * 全局环境替换
+     */
+    define?: Record<string, any>;
+    /**
+     * 是否创建 cjs 的 process.env 或者 esm 的 import.meta.env
+     * all 两者创建
+     * esm 创建 import.meta.env
+     * cjs 创建 process.env
+     * none 不创建
+     * @default cjs
+     */
+    defineFix?: 'all' | 'esm' | 'cjs' | 'none';
+    /**
+     * externals
+     */
+    externals?: Externals;
+    /**
+     * resolve
+     */
+    resolve?: Resolve;
+    /**
+     * output
+     */
+    output?: Output;
+    /**
+     * emp 执行周期
+     */
+    lifeCycle?: LifeCycleOptions;
+    /**
+     * ignoreWarnings
+     * @default [/Conflicting order/]
+     */
+    ignoreWarnings?: Configuration['ignoreWarnings'];
+};
+
+declare function runScript(): void;
+
+declare class DTSBundle {
+    list: string[];
+    outDir: string;
+    aliasName: string;
+    setup(outDir: string, aliasName: string): Promise<void>;
+    readDts(): Promise<any[]>;
+    readFile(src: string): Promise<{
+        src: string;
+        code: string;
+    }>;
+    replaceAliasPath({ src, code }: {
+        src: string;
+        code: string;
+    }): {
+        code: string;
+        src: string;
+        mod: string;
+    };
+    warpDeclareModule(mod: string, code: string): string;
+    writeCode(bs: {
+        src: string;
+        code: string;
+        mod: string;
+    }[]): Promise<void>;
+}
+declare const _default$2: DTSBundle;
+
+declare const _default$1: {
+    lightGreen: chalk.ChalkInstance;
+    green: chalk.ChalkInstance;
+    lightCyan: chalk.ChalkInstance;
+    cyan: chalk.ChalkInstance;
+    lightRed: chalk.ChalkInstance;
+    red: chalk.ChalkInstance;
+    yellow: chalk.ChalkInstance;
+    orange: chalk.ChalkInstance;
+    lightBlue: chalk.ChalkInstance;
+    blue: chalk.ChalkInstance;
+    white: chalk.ChalkInstance;
+    lightMagenta: chalk.ChalkInstance;
+    magenta: chalk.ChalkInstance;
+    gray: chalk.ChalkInstance;
+};
+
+declare class Logger {
+    brandName: string;
+    fullName: string;
+    logLevel: string;
+    isLogTime: boolean;
+    setup({ brandName, logLevel, fullName }: any): void;
+    time: (...args: any[]) => false | void;
+    timeEnd: (...args: any[]) => false | void;
+    debug: (...args: any[]) => false | void;
+    info: (...args: any[]) => false | void;
+    warn: (...args: any[]) => false | void;
+    error: (...args: any[]) => false | void;
+    blue: (msg: string) => void;
+    cyan: (msg: string) => void;
+    magenta: (msg: string) => void;
+    green: (msg: string) => void;
+    yellow: (msg: string) => void;
+    red: (msg: string) => void;
+    sysError: (msg: string) => void;
+    link: (msg: string) => string;
+    title: (msg: string) => void;
+}
+declare const _default: Logger;
+
+declare const index_glob: typeof glob;
+declare const index_utils: typeof utils;
+declare namespace index {
+  export { chalk__default as chalk, _default$1 as color, index_glob as glob, _default as logger, index_utils as utils };
+}
+
+type EMPConfigFn = (store: GlobalStore) => EmpOptions | Promise<EmpOptions>;
+type EMPConfigExport = EmpOptions | EMPConfigFn;
+declare function defineConfig(config: EMPConfigExport): EMPConfigExport;
+
+export { type EMP3PluginFnType, type EMP3PluginType, type EMPConfigExport, type EMPConfigFn, type EmpOptions, GlobalStore, defineConfig, _default$2 as dts, index as empHelper, runScript, _default$3 as store };