xshell 1.3.80 → 1.4.2

package/builder.d.ts

@@ -1,5 +1,39 @@
-import type Webpack from 'webpack';
-import { Lock } from './utils.ts';
+import type * as Rolldown from 'rolldown';
+export interface RolldownOptions {
+    cjs?: boolean;
+    single_chunk?: boolean;
+    dynamic_import?: boolean;
+    externals?: (string | RegExp)[];
+    globals?: Record<string, string>;
+    plugins?: (Rolldown.Plugin | Promise<Rolldown.Plugin>)[];
+    styles?: boolean;
+    assets?: boolean;
+    defines?: Record<string, string>;
+    production?: boolean | null;
+    analyze?: boolean;
+    print?: boolean;
+}
+/** 通过 rolldown 从入口文件打包所有依赖生成单个 index.{mjs,cjs} 文件
+    - target: 目标环境 nodejs | web
+    - fpd_root: 项目根目录
+    - fpd_out: 输出文件目录
+    - entries: 入口文件 Record<输出文件路径, 输入文件路径>
+    - options?:
+        - cjs?: `false`
+        - single_chunk?: `true` 对于 await import(), 或者多个 entry 公用的部分，
+            不要创建分块，总是打包到一个 .js 中
+        - dynamic_import?: `true` 设置为 false 时可以忽略打包这些依赖
+        - externals?: string[] 或 RegExp[] 哪些导入模块不打包
+        - globals?: Record<包名, 全局变量名>, 替换模块为 globalThis 上的变量，避免打包
+        - plugins?: rolldown 插件
+        - styles?: `false` 加上 styles_plugin 插件，支持 .sass, .css 等样式导入
+        - assets?: `false` 加上 inline_assets 插件，支持 .svg, .png, 等资源导入为 data url
+        - defines?: Record<string, string> 定义如 process.env.NODE_ENV 的值为常数
+        - production?: `true` 如果设置了 true / false，则会定义 process.env.NODE_ENV 为 'production' / 'development'
+        - analyze?: `false` 生成 stats.html 用于生成文件大小分析
+        - print?: `true` 打印生成的文件
+@example await rolldown('web', 'D:/0/web/', 'T:/test/', { 'react.js': 'react.ts' }) */
+export declare function rolldown(target: 'web' | 'nodejs', fpd_root: string, fpd_out: string, entries: Record<string, string>, { cjs, single_chunk, dynamic_import, externals, globals, plugins, styles, assets, production, defines, analyze, print }?: RolldownOptions): Promise<void>;
 /** target web 时的 npm 包依赖管理
     有 productions 但无 devs 时，大部分情况是相同配置，因此在 dev 模式下会用 productions
     也可以手动设置 [ ] 禁用 fallback */
@@ -25,7 +59,19 @@ export interface Dependency {
         devs?: (string | AssetOption)[];
     };
 }
-type DependencyId = 'react' | 'lodash' | 'jquery' | 'xterm' | 'swiper' | 'dayjs' | 'antd' | 'antd-icons' | 'vscode-oniguruma' | 'antd-plots' | 'gridstack' | 'quill' | 'monaco' | 'echarts' | 'plotly';
+type DependencyId = 'react' | 'lodash' | 'jquery' | 'xterm' | 'swiper' | 'antd' | 'vscode-oniguruma' | 'antd-plots' | 'gridstack' | 'quill' | 'monaco' | 'echarts';
+interface AssetOption {
+    /** 相对 fpd_root 的路径，或者绝对路径 */
+    src: string;
+    /** 相对 fpd_out 的路径，或者绝对路径，默认等于 src 的值 */
+    out?: string;
+    /** 直接设置 html 的路径，强制覆盖 */
+    value?: string;
+}
+interface Assets {
+    productions?: (string | AssetOption)[];
+    devs?: (string | AssetOption)[];
+}
 export interface HtmlOptions {
     title: string;
     /** `index.js` 也可以设置 entries 中的其他项, 应填写相对于 fpd_out 的路径 */
@@ -33,7 +79,7 @@ export interface HtmlOptions {
     device_viewport?: boolean;
     /** 也会在 copy_files 中一并被复制，应填写相对于 fpd_root 和 fpd_out 的路径 */
     icon?: string | AssetOption;
-    /** 仅用于生成 html 中 script 标签，文件复制由 BundlerOptions['dependencies'] 决定 */
+    /** 仅用于生成 html 中 script 标签，文件复制由 copy_assets 的 dependencies 参数决定 */
     dependencies?: DependencyId[];
     manifest?: string | AssetOption;
     /** 额外需要加载的脚本 */
@@ -42,169 +88,24 @@ export interface HtmlOptions {
         before?: (string | AssetOption)[];
         /** 在 index.js 之后加载 */
         after?: (string | AssetOption)[];
+        /** 在 index.js 之后通过 defer 而非 module 加载 */
+        after_legacy?: (string | AssetOption)[];
     };
-    /** 额外需要加载的 module 脚本, 在 index.js 之前 */
-    mscripts?: (string | AssetOption)[];
     heads?: string[];
     notice?: boolean;
 }
-interface AssetOption {
-    /** 相对 fpd_root 的路径，或者绝对路径 */
-    src: string;
-    /** 相对 fpd_out 的路径，或者绝对路径，默认等于 src 的值 */
-    out?: string;
-    /** 直接设置 html 的路径，强制覆盖 */
-    value?: string;
-}
-type Assets = {
-    productions?: (string | AssetOption)[];
-    devs?: (string | AssetOption)[];
-};
-/** 从 tsconfig.json 中解析 paths 配置为 resolve alias
-    文件不存在或无 paths alias 配置时返回 null */
-export declare function get_resolve_alias(fpd_root: string): Promise<Record<string, string> | null>;
-export interface BundlerOptions {
-    dependencies?: DependencyId[];
-    source_map?: boolean;
-    production?: boolean;
-    external_dayjs?: boolean;
-    externals?: Record<string, string | string[]>;
-    dynamic_import?: boolean;
-    commonjs2?: boolean;
-    expose?: boolean;
-    assets_stats?: boolean;
-    globals?: Record<string, string>;
-    resolve_alias?: Record<string, string>;
-    resolve_fallback?: Record<string, any>;
-    analyzer?: boolean;
-    dts?: boolean;
-    cache_version?: string;
-    single_chunk?: boolean;
-    exclude_modules?: RegExp;
-    assets?: Assets;
+interface BuildHtmlOptions {
     assets_root?: string;
     template?: boolean;
-    license?: boolean;
-    htmls?: Record<string, HtmlOptions>;
-    single_js?: {
-        js: string;
-        entry: string;
-    };
-    plugins?: Webpack.Configuration['plugins'];
-    polyfill_node_sea?: boolean;
-}
-export declare class Bundler {
-    name: string;
-    target: 'nodejs' | 'web';
-    fpd_root: string;
-    fpd_out: string;
-    fpdt_cache: string;
-    entry: Record<string, string>;
-    production: boolean;
-    dependencies: DependencyId[];
-    source_map: boolean;
-    globals?: BundlerOptions['globals'];
-    external_dayjs: boolean;
-    externals: BundlerOptions['externals'];
-    htmls?: BundlerOptions['htmls'];
-    assets?: Assets;
-    assets_root: string;
-    template: boolean;
-    single_js?: BundlerOptions['single_js'];
-    commonjs2: boolean;
-    expose: boolean;
-    single_chunk: boolean;
-    dynamic_import: boolean;
-    resolve_alias?: BundlerOptions['resolve_alias'];
-    resolve_fallback?: BundlerOptions['resolve_fallback'];
-    assets_stats: boolean;
-    analyzer: boolean;
-    dts: boolean;
-    exclude_modules?: BundlerOptions['exclude_modules'];
-    cache_version?: string;
-    plugins?: BundlerOptions['plugins'];
-    license?: boolean;
-    polyfill_node_sea?: boolean;
-    config: Webpack.Configuration;
-    lcompiler: Lock<Webpack.Compiler>;
-    /** 通过 webpack 从入口文件打包所有依赖生成单个 index.{mjs,cjs} 文件
-        - name: 项目名称
-        - target: 目标环境 nodejs | web
-        - fpd_root: 项目根目录
-        - fpd_out: 输出文件目录
-        - fpdt_cache?: webpack 缓存目录，可以设置为 undefined 使用默认路径 node_modules/.cache/webpack/
-        - entry: 入口文件
-        - options?: 打包配置, 按常用顺序排列
-            - production?: `true` webpack mode 设置为 'production'
-            - dependencies?: DependencyId[], 决定 bundler 在 build_all (copy_files) 时需要复制到 fpd_out 的资源
-            - source_map?: `true` 启用源码映射 .map 文件
-            - globals?: 全局变量定义
-            - external_dayjs?: `false` 配置 dayjs 为 external 来配合 antd 使用, 减小一点体积
-            - externals?: 配置外部模块
-            - htmls?: 配置要生成的 html, 比如 { 'index.html', { title: '文件', ... } }
-            - assets?: 项目中需要直接复制到输出目录的资源，有 productions 但无 devs 时 (是同一套)，
-                在 dev 模式下会用 productions 中的资源，如果不需要 productions 资源， devs 可以设置为 [ ],
-                每一项是  string 或者 { src: '...', out: '...' }，路径相对于 fpd_root 和 fpd_out
-            - assets_root?: `'/'` 生成的 html 中替换 {root} 作为部署路径，以支持 browser router 路由能力
-                assets, html 中的 icon, scripts 路径直接在前面添加 assets_root 来生成最终 html href
-                未启用时使用相对 html 路径来生成最终 html href
-            - template?: `false` 除了生成对应的 html 之外，还生成所有路径为 `{root}/...` 的模板 html 文件, 方便后续 server 替换渲染
-            - single_js?: 设置生成的单个 js 入口文件，无其他依赖，通过 script module 作为入口加载，含有 import 加载其他 externals 和某个 entry，类似 htmls 配置要生成的 html
-                - js: js 入口文件名
-                - entry: 使用的 entry
-            - commonjs2?: `false` 打包为 commonjs2 (.cjs) 的文件
-            - expose?: `false` 入口模块所有导出的属性赋值到全局对象 globalThis 上
-            - single_chunk?: `true` 输出为单个文件，将依赖也打包到其中，不要生成多个 chunk
-            - dynamic_import?: `true` 对于 await import('...') 要不要打包外部模块到输出文件中
-            - resolve_alias?: 配置 resolve alias，会自动从项目 tsconfig.json 的 paths 中读取，用户配置作为覆盖
-            - resolve_fallback?: 配置 resolve fallback
-            - assets_stats?: `true` 打印输出的文件信息
-            - analyzer?: `false` 启用 WebpackBundleAnalyzer 插件分析构建产物大小
-            - dts?: `false` 生成 .d.ts 文件
-            - exclude_modules?: 传入正则表达式 ，匹配时使用 IgnorePlugin 强制不打包这个模块，但是一旦导入就会报错
-            - cache_version?: webpack cache version, 用于区分同一个 name 的不同版本
-            - plugins?: 可选传入的额外的 webpack 插件
-            - license?: 使用 license-webpack-plugin 构建 ThirdPartyNotice.txt
-            - polyfill_node_sea?: 避免依赖 node:sea 模块以兼容旧版本 node.js */
-    constructor(name: string, target: 'web' | 'nodejs', fpd_root: string, fpd_out: string, fpdt_cache: string | undefined, entry: Record<string, string>, options?: BundlerOptions);
-    build(print?: boolean): Promise<void>;
-    close(): Promise<void>;
-    build_all(print?: boolean): Promise<void>;
-    /** 打包构建 js, 构建 html, 复制依赖文件 */
-    build_all_and_close(print?: boolean): Promise<void>;
-    /** 仅打包构建 js, 不复制依赖 */
-    build_and_close(print?: boolean): Promise<void>;
-    build_htmls(print?: {
+    css?: boolean;
+    print?: {
         info: boolean;
         files: boolean;
-    }): Promise<void>;
-    build_single_js(print?: {
-        info: boolean;
-        files: boolean;
-    }): Promise<void>;
-    resolve_dependencies(dependency_ids: DependencyId[], resolveds?: Set<DependencyId>): Set<DependencyId>;
-    /** 解析依赖的文件
-        - dependencies: 依赖 id
-        - assets: false 时只包括在 script 标签加载的文件;  true 时包括 assets, maps 等 */
-    resolve_dependency_assets(_dependencies: DependencyId[], assets: boolean, { production, source_map }?: {
-        production?: boolean;
-        source_map?: BundlerOptions['source_map'];
-    }): (string | AssetOption)[];
-    copy_files({ dependencies: _dependencies, production, assets, fpd_root, fpd_out, print }?: {
-        dependencies?: DependencyId[];
-        production?: boolean;
-        assets?: Assets;
-        fpd_root?: string;
-        fpd_out?: string;
-        print?: {
-            info: boolean;
-            files: boolean;
-        };
-    }): Promise<void>;
-    /** 为空时返回空数组 */
-    resolve_config(config: {
-        productions?: string[];
-        devs?: string[];
-    } | Assets | undefined, production: boolean): (string | AssetOption)[];
+    };
 }
+export declare function build_htmls(fpd_out: string, production: boolean, htmls: Record<string, HtmlOptions>, { print, assets_root, template, css, }?: BuildHtmlOptions): Promise<void>;
+export declare function copy_assets(fpd_root: string, fpd_out: string, production: boolean, _dependencies: DependencyId[], htmls?: Record<string, HtmlOptions>, assets?: Assets, source_map?: boolean, print?: {
+    info: boolean;
+    files: boolean;
+}): Promise<void>;
 export {};