xshell 1.0.129 → 1.0.131

package/builder.d.ts

@@ -4,23 +4,30 @@ export interface BundlerOptions {
     source_map?: boolean;
     production?: boolean;
     external_dayjs?: boolean;
-    externals?: Record<string, string>;
+    externals?: Record<string, string | string[]>;
     sass?: typeof import('sass');
     dynamic_import?: boolean;
     commonjs2?: boolean;
     assets_stats?: boolean;
     globals?: Record<string, string>;
+    resolve_alias?: Record<string, string>;
     analyzer?: boolean;
     dts?: boolean;
     cache_version?: string;
     single_chunk?: boolean;
     exclude_modules?: RegExp;
+    license?: {
+        ignores?: string[];
+    };
 }
 export declare class Bundler {
     name: string;
     fpd_root: string;
     config: Webpack.Configuration;
     analyzer: boolean;
+    license?: {
+        ignores?: string[];
+    };
     lcompiler: Lock<Webpack.Compiler>;
     /** 通过 webpack 从入口文件打包所有依赖生成单个 index.{mjs,cjs} 文件
         - name: 项目名称
@@ -36,15 +43,24 @@ export declare class Bundler {
             - externals?: 配置外部模块
             - commonjs2?: `false` 打包为 commonjs2 (.cjs) 的文件
             - single_chunk?: `true` 输出为单个文件，将依赖也打包到其中，不要生成多个 chunk
-            - dynamic_import: `true` 对于 await import('...') 要不要打包外部模块到输出文件中
+            - dynamic_import?: `true` 对于 await import('...') 要不要打包外部模块到输出文件中
+            - resolve_alias?: 配置 resolve alias
             - assets_stats?: `true` 打印输出的文件信息
             - analyzer?: `false` 启用 WebpackBundleAnalyzer 插件分析构建产物大小
             - dts?: `false` 生成 .d.ts 文件
             - exclude_modules?: 传入正则表达式 ，匹配时使用 IgnorePlugin 强制不打包这个模块，但是一旦导入就会报错
             - cache_version?: webpack cache version, 用于区分同一个 name 的不同版本
             - production?: `true` webpack mode 设置为 'production'
-            - sass?: 传入 sass 实例避免 webpack 重复加载 .cjs 版本 */
-    constructor(name: string, target: 'web' | 'nodejs', fpd_root: string, fpd_out: string, fpdt_cache: string, entry: Record<string, string>, { source_map, globals, external_dayjs, externals, commonjs2, single_chunk, dynamic_import, assets_stats, analyzer, dts, exclude_modules, cache_version, production, sass, }?: BundlerOptions);
+            - sass?: 传入 sass 实例避免 webpack 重复加载 .cjs 版本
+            - license?: 使用 license-webpack-plugin 构建 ThirdPartyNotice.txt */
+    constructor(name: string, target: 'web' | 'nodejs', fpd_root: string, fpd_out: string, fpdt_cache: string, entry: Record<string, string>, { source_map, globals, external_dayjs, externals, commonjs2, single_chunk, dynamic_import, resolve_alias, assets_stats, analyzer, dts, exclude_modules, cache_version, production, sass, license, }?: BundlerOptions);
+    /** 获取构建时 git 仓库的最新提交、分支信息 */
+    get_git_info(version?: string): Promise<{
+        version: string;
+        branch: string;
+        time: string;
+        commit: string;
+    }>;
     build(print?: boolean): Promise<void>;
     close(): Promise<void>;
     build_and_close(print?: boolean): Promise<void>;

package/builder.js

@@ -1,11 +1,13 @@
 import { fileURLToPath } from 'url';
 import Webpack from 'webpack';
 import { Lock, Timer, filter_values } from './utils.js';
+import { Git } from './git.js';
 export class Bundler {
     name;
     fpd_root;
     config;
     analyzer;
+    license;
     lcompiler;
     /** 通过 webpack 从入口文件打包所有依赖生成单个 index.{mjs,cjs} 文件
         - name: 项目名称
@@ -21,17 +23,20 @@ export class Bundler {
             - externals?: 配置外部模块
             - commonjs2?: `false` 打包为 commonjs2 (.cjs) 的文件
             - single_chunk?: `true` 输出为单个文件，将依赖也打包到其中，不要生成多个 chunk
-            - dynamic_import: `true` 对于 await import('...') 要不要打包外部模块到输出文件中
+            - dynamic_import?: `true` 对于 await import('...') 要不要打包外部模块到输出文件中
+            - resolve_alias?: 配置 resolve alias
             - assets_stats?: `true` 打印输出的文件信息
             - analyzer?: `false` 启用 WebpackBundleAnalyzer 插件分析构建产物大小
             - dts?: `false` 生成 .d.ts 文件
             - exclude_modules?: 传入正则表达式 ，匹配时使用 IgnorePlugin 强制不打包这个模块，但是一旦导入就会报错
             - cache_version?: webpack cache version, 用于区分同一个 name 的不同版本
             - production?: `true` webpack mode 设置为 'production'
-            - sass?: 传入 sass 实例避免 webpack 重复加载 .cjs 版本 */
-    constructor(name, target, fpd_root, fpd_out, fpdt_cache, entry, { source_map = true, globals, external_dayjs = false, externals, commonjs2 = false, single_chunk = true, dynamic_import = true, assets_stats = true, analyzer = false, dts = false, exclude_modules, cache_version, production = true, sass, } = {}) {
+            - sass?: 传入 sass 实例避免 webpack 重复加载 .cjs 版本
+            - license?: 使用 license-webpack-plugin 构建 ThirdPartyNotice.txt */
+    constructor(name, target, fpd_root, fpd_out, fpdt_cache, entry, { source_map = true, globals, external_dayjs = false, externals, commonjs2 = false, single_chunk = true, dynamic_import = true, resolve_alias, assets_stats = true, analyzer = false, dts = false, exclude_modules, cache_version, production = true, sass, license, } = {}) {
         this.name = name;
         this.analyzer = analyzer;
+        this.license = license;
         // let smp = new SpeedMeasurePlugin()
         // const config: Webpack.Configuration = smp.wrap({
         let resolve_cache = {};
@@ -65,6 +70,8 @@ export class Bundler {
             target: [target === 'web' ? 'web' : 'node22', 'es2024'],
             // 结合 output.globalObject, 会生成 globalThis['React'] 这样的引用
             externalsType: target === 'nodejs' ? 'commonjs2' : 'global',
+            // 以 react: 'React', 为例，含义为
+            // 取全局变量 window.React 的值作为 import { useState } from 'react' 中 { ... } 这部分的结果，再解构里面的 useState 属性
             externals: filter_values({
                 react: 'React',
                 'react-dom': 'ReactDOM',
@@ -92,6 +99,7 @@ export class Bundler {
                 extensionAlias: {
                     '.js': ['.js', '.ts', '.tsx']
                 },
+                ...resolve_alias ? { alias: resolve_alias } : {},
                 // modules: [
                 //     '',
                 // ],
@@ -179,9 +187,7 @@ export class Bundler {
                                     test: /\.icon\.svg$/,
                                     issuer: /\.[jt]sx?$/,
                                     loader: get_loader('@svgr/webpack'),
-                                    options: {
-                                        icon: true,
-                                    }
+                                    options: { icon: true }
                                 },
                                 {
                                     test: /\.(svg|ico|png|jpe?g|gif|woff2?|ttf|eot|otf|mp4|webm|ogg|mp3|wav|flac|aac)$/,
@@ -256,6 +262,21 @@ export class Bundler {
             }
         };
     }
+    /** 获取构建时 git 仓库的最新提交、分支信息 */
+    async get_git_info(version) {
+        let git = new Git(this.fpd_root);
+        const branch = await git.get_branch();
+        const { hash, time } = (await git.get_last_commits(1))[0];
+        version ||= branch;
+        const timestr = time.to_formal_str();
+        const commit = hash.slice(0, 6);
+        return {
+            version: version,
+            branch,
+            time: timestr,
+            commit
+        };
+    }
     async build(print = true) {
         let timer = new Timer();
         if (!this.lcompiler) {
@@ -266,6 +287,30 @@ export class Bundler {
                     openAnalyzer: false,
                 }));
             }
+            if (this.license) {
+                const { LicenseWebpackPlugin } = await import('license-webpack-plugin');
+                const ignores = new Set([
+                    'xshell',
+                    'react-object-model',
+                    '@ant-design/icons-svg',
+                    '@ant-design/pro-layout',
+                    '@ant-design/pro-provider',
+                    '@ant-design/pro-table',
+                    '@ant-design/pro-utils',
+                    '@ant-design/pro-form',
+                    '@ant-design/pro-card',
+                    '@ant-design/pro-field',
+                    'toggle-selection',
+                    'ahooks',
+                    'size-sensor',
+                    ...this.license.ignores || []
+                ]);
+                this.config.plugins.push(new LicenseWebpackPlugin({
+                    perChunkOutput: false,
+                    outputFilename: 'ThirdPartyNotice.txt',
+                    excludedPackageTest: pkgname => ignores.has(pkgname),
+                }));
+            }
             this.lcompiler = new Lock(Webpack(this.config));
         }
         const stats = await this.lcompiler.request(async (compiler) => new Promise((resolve, reject) => {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "xshell",
-    "version": "1.0.129",
+    "version": "1.0.131",
     "type": "module",
     "main": "./index.js",
     "bin": {
@@ -84,6 +84,7 @@
         "i18next-scanner": "^4.4.0",
         "koa": "^2.15.3",
         "koa-compress": "^5.1.1",
+        "license-webpack-plugin": "^4.0.2",
         "lodash": "^4.17.21",
         "map-stream": "^0.0.7",
         "mime-types": "^2.1.35",