xshell 1.2.29 → 1.2.31

package/file.d.ts

@@ -1,4 +1,5 @@
 import { promises as fsp, default as fs } from 'fs';
+import type { UnzipFileFilter } from './fflate.ts';
 export { fsp };
 export type Encoding = 'utf-8' | 'gb18030' | 'shift-jis' | 'utf-16le';
 export type FileHandle = fsp.FileHandle & {
@@ -71,7 +72,7 @@ export interface FWriteOptions {
         - any: 通过 JSON.stringify 转为文本后写入文件
     - options?:
         - print?: `true`
-        - mtime?: 在写入后设置修改时间 */
+        - mtime?: 在写入后设置修改时间 (utc 毫秒数) */
 export declare function fwrite(fp: string, data: string | Uint8Array | any, options?: FWriteOptions): Promise<string>;
 export declare function fwrite(fp: FileHandle, data: string | Uint8Array | any, options?: FWriteOptions): Promise<FileHandle>;
 export declare function fwrite(fp: string | FileHandle, data: string | Uint8Array | any, options?: FWriteOptions): Promise<string | FileHandle>;
@@ -220,6 +221,46 @@ export declare function fzip(data: string | Record<string, string | Uint8Array>,
             - info?: `true` 开始压缩、压缩完成
             - files?: `true` 打印压缩文件列表 */
 export declare function zip(data: string | Record<string, string | Uint8Array>, options?: ZipOptions): Promise<Buffer>;
+export interface UnzipOptions {
+    encoding?: Encoding;
+    dryrun?: boolean;
+    print?: {
+        info: boolean;
+        files: boolean;
+    };
+    strip?: boolean;
+    clean?: boolean;
+    filter?: UnzipFileFilter;
+}
+/** 解压 zip 包至文件夹，返回 fpd_out
+     - zip:
+        - 包路径 (string) 或
+        - 包数据 (Uint8Array | ArrayBuffer)
+     - fpd_out: 解压到文件夹的完整路径 (string)
+    - options?:
+        - encoding?: `utf-8` 压缩包文件名编码
+        - dryrun?: 只是打印一下文件名列表，看看编码是否正确，不实际解压
+        - print?:
+            - info?: `true` 开始解压、解压完成
+            - files?: `true` 打印解压缩的文件列表
+        - strip?: `true` 压缩包内只有一个顶层文件夹时自动去除该层级
+        - clean?: `true` 忽略解压 ftrashes 这些垃圾文件
+        - filter?: 用于过滤要解压的文件, 返回 falsy 值时忽略这个文件，要注意 file.name 为完整的相对路径（没有 strip） */
+export declare function funzip(zip: string | Uint8Array | ArrayBuffer, fpd_out: string, options?: UnzipOptions): Promise<string>;
+/** 解压 zip 包至内存，返回解压后的数据 (Record<文件或文件夹 (以 / 结尾) 的相对路径, Uint8Array>)
+     - zip:
+        - 压缩文件路径 (string) 或
+        - 压缩文件内容 (buffer)
+    - options?:
+        - encoding?: `utf-8` 压缩包文件名编码
+        - dryrun?: 只是打印一下文件名列表，看看编码是否正确，不实际解压
+        - print?:
+            - info?: `true` 开始解压、解压完成
+            - files?: `true` 打印解压缩的文件列表
+        - strip?: `true` 压缩包内只有一个顶层文件夹时自动去除该层级
+        - clean?: `true` 忽略解压 ftrashes 这些垃圾文件
+        - filter?: 用于过滤要解压的文件, 返回 falsy 值时忽略这个文件，要注意 file.name 为完整的相对路径（没有 strip） */
+export declare function unzip(zip: string | Uint8Array | ArrayBuffer, options?: UnzipOptions): Promise<Record<string, Uint8Array>>;
 export declare let fwatchers: Record<string, fs.FSWatcher>;
 /** 跟踪文本文件追加的内容，类似 tail -f */
 export declare function ftail(fp: string, handler: (lines: string[]) => void | Promise<void>, { print }?: {

package/file.js

@@ -1,10 +1,10 @@
 import { promises as fsp, default as fs } from 'fs';
-import { isUint8Array } from 'util/types';
+import { isArrayBuffer, isUint8Array } from 'util/types';
 import { t } from "./i18n/instance.js";
-import { to_json } from "./prototype.js";
+import { noop, to_json } from "./prototype.js";
 import { pack, parse } from "./io.js";
 import { path } from "./path.js";
-import { check, Lock, WritableMemoryStream, url_width, throttle } from "./utils.js";
+import { check, Lock, WritableMemoryStream, url_width, throttle, decode } from "./utils.js";
 import { noprint } from "./process.js";
 export { fsp };
 export const encodings = ['utf-8', 'gb18030', 'shift-jis', 'utf-16le'];
@@ -100,7 +100,8 @@ export async function fwrite(fp, data, { print = true, mtime } = {}) {
         let handle = await fopen(fp, 'w', noprint);
         try {
             await handle.write(data, 0);
-            await handle.utimes(mtime, mtime);
+            const mseconds = mtime / 1000;
+            await handle.utimes(mseconds, mseconds);
         }
         finally {
             await handle.close();
@@ -544,6 +545,223 @@ async function _zip(data, fp_zip, { dirname, print = { files: true, info: true }
         console.log(`压缩完成，总大小 ${size.to_fsize_str()}`);
     return fp_zip || ostream.pbuffer;
 }
+/** 解压 zip 包至文件夹，返回 fpd_out
+     - zip:
+        - 包路径 (string) 或
+        - 包数据 (Uint8Array | ArrayBuffer)
+     - fpd_out: 解压到文件夹的完整路径 (string)
+    - options?:
+        - encoding?: `utf-8` 压缩包文件名编码
+        - dryrun?: 只是打印一下文件名列表，看看编码是否正确，不实际解压
+        - print?:
+            - info?: `true` 开始解压、解压完成
+            - files?: `true` 打印解压缩的文件列表
+        - strip?: `true` 压缩包内只有一个顶层文件夹时自动去除该层级
+        - clean?: `true` 忽略解压 ftrashes 这些垃圾文件
+        - filter?: 用于过滤要解压的文件, 返回 falsy 值时忽略这个文件，要注意 file.name 为完整的相对路径（没有 strip） */
+export async function funzip(zip, fpd_out, options) {
+    await _unzip(zip, fpd_out, options);
+    return fpd_out;
+}
+/** 解压 zip 包至内存，返回解压后的数据 (Record<文件或文件夹 (以 / 结尾) 的相对路径, Uint8Array>)
+     - zip:
+        - 压缩文件路径 (string) 或
+        - 压缩文件内容 (buffer)
+    - options?:
+        - encoding?: `utf-8` 压缩包文件名编码
+        - dryrun?: 只是打印一下文件名列表，看看编码是否正确，不实际解压
+        - print?:
+            - info?: `true` 开始解压、解压完成
+            - files?: `true` 打印解压缩的文件列表
+        - strip?: `true` 压缩包内只有一个顶层文件夹时自动去除该层级
+        - clean?: `true` 忽略解压 ftrashes 这些垃圾文件
+        - filter?: 用于过滤要解压的文件, 返回 falsy 值时忽略这个文件，要注意 file.name 为完整的相对路径（没有 strip） */
+export async function unzip(zip, options) {
+    return _unzip(zip, undefined, options);
+}
+async function _unzip(zip, fpd_out, { encoding = 'utf-8', dryrun = false, print = {
+    files: true,
+    info: true
+}, strip = true, clean = true, filter: _filter } = {}) {
+    const str_out = typeof fpd_out === 'string' ? fpd_out : '内存';
+    let fp_zip = 'buffer';
+    let nfiles = 0;
+    let size_uncompressed = 0;
+    if (isArrayBuffer(zip))
+        zip = new Uint8Array(zip);
+    else if (typeof zip === 'string') {
+        check(['zip', 'apk', 'crx', 'vsix'].includes(zip.fext), 'fp_src 应该以 zip 等后缀结尾');
+        fp_zip = zip;
+        zip = await fread(zip, { encoding: 'binary', print: false });
+    }
+    if (print.info)
+        log_action(`开始${dryrun ? '测试' : ''}解压`, `${fp_zip} (${zip.length.to_fsize_str()})`, str_out);
+    if (!dryrun && fpd_out)
+        await fmkdir(fpd_out, { print: print.info });
+    let dryrun_unzipped = {};
+    const { unzipSync } = await import("./fflate.js");
+    let unzipped = unzipSync(zip, {
+        decoder: encoding === 'utf-8'
+            ? decode
+            : (() => {
+                let text_decoder = new TextDecoder(encoding);
+                return buf => text_decoder.decode(buf);
+            })(),
+        filter(file) {
+            const { name, originalSize } = file;
+            // 需要递归的清理 LICENSE, .husky/, .husky/pre-commit 等文件
+            if (clean) {
+                const lname = name.toLowerCase();
+                let to_clean = false;
+                // xxx/xxx/xxx/a.txt
+                // xxx/xxx/
+                // a.txt
+                // xxx/
+                // 处理每个文件夹部分
+                let ileft = 0, iright = 0;
+                for (; (iright = lname.indexOf('/', ileft) + 1) !== 0; ileft = iright)
+                    if (ftrashes.has(lname.slice(ileft, iright))) {
+                        to_clean = true;
+                        break;
+                    }
+                // 处理最后剩下的文件名
+                if (!to_clean && ileft < lname.length && ftrashes.has(lname.slice(ileft)))
+                    to_clean = true;
+                if (to_clean) {
+                    if (print.files)
+                        console.log(`清理了 ${name}`);
+                    return false;
+                }
+            }
+            if (!clean && name.startsWith('__MACOSX/') ||
+                _filter && !_filter(file))
+                return false;
+            else {
+                nfiles++;
+                size_uncompressed += originalSize;
+                if (dryrun) {
+                    dryrun_unzipped[name] = null;
+                    return false;
+                }
+                else
+                    return true;
+            }
+        }
+    });
+    if (dryrun)
+        unzipped = dryrun_unzipped;
+    if (strip) {
+        let top_common_dir = '';
+        for (const key in unzipped) {
+            const islash = key.indexOf('/');
+            if (islash === -1) { // 顶层有文件
+                top_common_dir = '';
+                break;
+            }
+            else {
+                const top_dir = key.slice(0, islash + 1);
+                if (top_common_dir) {
+                    if (top_common_dir !== top_dir) {
+                        top_common_dir = '';
+                        break;
+                    }
+                }
+                else
+                    top_common_dir = top_dir;
+            }
+        }
+        if (top_common_dir) {
+            let unzipped_ = {};
+            for (const key in unzipped) {
+                const key_ = key.slice(top_common_dir.length);
+                if (key_)
+                    unzipped_[key_] = unzipped[key];
+            }
+            unzipped = unzipped_;
+        }
+    }
+    let pwrites = [];
+    for (const key in unzipped) {
+        const value = unzipped[key];
+        if (fpd_out && !dryrun) {
+            const fp = fpd_out + key;
+            if (fp.isdir)
+                await fmkdir(fp, noprint);
+            else {
+                let pwrite = fwrite(fp, value, noprint);
+                pwrite.catch(noop); // suppress PromiseRejectionHandledWarning: Promise rejection was handled asynchronously
+                pwrites.push(pwrite);
+            }
+        }
+        if (print.files)
+            console.log(`解压出 ${key}`);
+    }
+    if (fpd_out && !dryrun)
+        await Promise.all(pwrites);
+    if (print.info)
+        console.log(`解压了 ${nfiles} 个文件，解压后文件总大小为 ${size_uncompressed.to_fsize_str()}`);
+    if (!fpd_out || dryrun)
+        return unzipped;
+}
+const ftrashes = new Set([
+    '__MACOSX/',
+    '.babelrc.js',
+    '.babelrc',
+    '.ci',
+    '.circleci',
+    '.dockerignore',
+    '.DS_Store',
+    '.editorconfig',
+    '.eslintignore',
+    '.eslintrc.js',
+    '.eslintrc.json',
+    '.eslintrc.yaml',
+    '.eslintrc.yml',
+    '.eslintrc',
+    '.gitattributes',
+    '.github',
+    '.gitignore',
+    '.husky/',
+    '.jsbeautifyrc',
+    '.jshintrc',
+    '.mailmap',
+    '.markdownlint.js',
+    '.node-version',
+    '.npmignore',
+    '.prettierignore',
+    '.prettierrc.js',
+    '.prettierrc.json',
+    '.prettierrc.yaml',
+    '.prettierrc',
+    '.project',
+    '.releaserc.json',
+    '.stylelintrc.json',
+    '.travis.yml',
+    '.vscode/',
+    'AUTHORS.txt',
+    'AUTHORS',
+    'bower',
+    'CODE_OF_CONDUCT.md',
+    'codecov.yml',
+    'commitlint.config.js',
+    'CONTRIBUTING.md',
+    'COPING.md',
+    'husky.config.js',
+    'LICENCE.md',
+    'LICENCE.txt',
+    'LICENCE',
+    'LICENSE.md',
+    'LICENSE.txt',
+    'LICENSE',
+    'lint-staged.config.js',
+    'open-bot.yaml',
+    'package-lock.json',
+    'pnpm-lock.yaml',
+    'prettier.config.js',
+    'stylelint.config.js',
+    'tslint.json',
+    'yarn.lock',
+].map(f => f.toLowerCase()));
 export let fwatchers = {};
 /** 跟踪文本文件追加的内容，类似 tail -f */
 export async function ftail(fp, handler, { print = true } = {}) {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "xshell",
-    "version": "1.2.29",
+    "version": "1.2.31",
     "type": "module",
     "main": "./index.js",
     "bin": {
@@ -67,14 +67,14 @@
         "commander": "^13.1.0",
         "css-loader": "^7.1.2",
         "emoji-regex": "^10.4.0",
-        "eslint": "^9.23.0",
+        "eslint": "^9.24.0",
         "eslint-plugin-import": "^2.31.0",
-        "eslint-plugin-react": "^7.37.4",
+        "eslint-plugin-react": "^7.37.5",
         "gulp-sort": "^2.0.0",
         "https-proxy-agent": "^7.0.6",
         "i18next": "^24.2.3",
         "i18next-scanner": "^4.6.0",
-        "koa": "^2.16.0",
+        "koa": "^2.16.1",
         "koa-compress": "^5.1.1",
         "license-webpack-plugin": "^4.0.2",
         "map-stream": "^0.0.7",
@@ -84,7 +84,7 @@
         "react-i18next": "^15.4.1",
         "react-object-model": "^1.2.23",
         "resolve-path": "^1.4.0",
-        "sass": "^1.86.2",
+        "sass": "^1.86.3",
         "sass-loader": "^16.0.5",
         "source-map-loader": "^5.0.0",
         "strip-ansi": "^7.1.0",
@@ -93,7 +93,7 @@
         "tough-cookie": "^5.1.2",
         "ts-loader": "^9.5.2",
         "tslib": "^2.8.1",
-        "typescript": "^5.8.2",
+        "typescript": "^5.8.3",
         "ua-parser-js": "^2.0.3",
         "undici": "^7.7.0",
         "vinyl": "^3.0.0",
@@ -118,7 +118,7 @@
         "@types/tough-cookie": "^4.0.5",
         "@types/ua-parser-js": "^0.7.39",
         "@types/vinyl-fs": "^3.0.5",
-        "@types/vscode": "^1.98.0",
+        "@types/vscode": "^1.99.0",
         "@types/webpack-bundle-analyzer": "^4.7.0"
     },
     "pnpm": {