From cd737a7f3ffec8c88252cf6d34002a324e8cc3ba Mon Sep 17 00:00:00 2001 From: Cora <93145731+Cora093@users.noreply.github.com> Date: Fri, 14 Aug 2026 18:10:41 +0800 Subject: [PATCH] =?UTF-8?q?fix(installer):=E4=BF=AE=E5=A4=8D=20PowerShell?= =?UTF-8?q?=20=E5=AE=89=E8=A3=85=E5=85=A5=E5=8F=A3=E5=92=8C=E7=89=88?= =?UTF-8?q?=E6=9C=AC=E6=A0=A1=E9=AA=8C?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 12 ++- README_EN.md | 12 ++- scripts/install.ps1 | 21 ++++- tests/install-powershell.spec.ts | 130 +++++++++++++++++++++++++++++++ 4 files changed, 167 insertions(+), 8 deletions(-) create mode 100644 tests/install-powershell.spec.ts diff --git a/README.md b/README.md index 3ce38b9..68bc33f 100644 --- a/README.md +++ b/README.md @@ -52,7 +52,10 @@ curl -fsSL https://raw.githubusercontent.com/omdsh-dev/DSH-better-sidebar/main/s **Windows（PowerShell 5.1+ / pwsh）**： ```powershell -irm https://raw.githubusercontent.com/omdsh-dev/DSH-better-sidebar/main/scripts/install.ps1 | iex +$script = ( + irm 'https://raw.githubusercontent.com/omdsh-dev/DSH-better-sidebar/main/scripts/install.ps1' +).TrimStart([char]0xFEFF) +& ([scriptblock]::Create($script)) ``` 装完**硬刷新浏览器**（Cmd/Ctrl+Shift+R）即可看到侧边栏（DSH 对 client 改动热加载，无需重启；仅 host 半更新时需要重启）。 @@ -65,7 +68,10 @@ irm https://raw.githubusercontent.com/omdsh-dev/DSH-better-sidebar/main/scripts/ curl -fsSL https://raw.githubusercontent.com/omdsh-dev/DSH-better-sidebar/main/scripts/install.sh | bash -s 0.10.3 --restart # Windows PowerShell -& ([scriptblock]::Create((irm 'https://raw.githubusercontent.com/omdsh-dev/DSH-better-sidebar/main/scripts/install.ps1'))) -Version 0.10.3 -Restart +$script = ( + irm 'https://raw.githubusercontent.com/omdsh-dev/DSH-better-sidebar/main/scripts/install.ps1' +).TrimStart([char]0xFEFF) +& ([scriptblock]::Create($script)) -Version 0.10.3 -Restart ``` 不确定的话，可先加 `--dry-run`（PowerShell 用 `-DryRun`）预览步骤再执行。 @@ -122,7 +128,7 @@ npx -y --package @deepseek-ai/dsh dsh plugin --profile web add dsh-better-sideba 3. 执行 `dsh plugin --profile web add dsh-better-sidebar`：登记依赖 → 识别包内 `dsh.bundle.patch` → 自动注册进 `dsh.profile.bundles` 挂载； 4. 清理旧版残留的手动挂载行，避免「双挂载」（页面出现两个侧边栏）。 -`curl | bash` / `irm | iex` 会执行远程代码——脚本已随仓库开源（`scripts/install.sh` / `scripts/install.ps1`），可先下载审阅。插件以 npm 包 `dsh-better-sidebar@0.10.3` 发布，通过 `dsh.bundle.patch`（随包的 `cordis.patch.yml`）由官方 CLI 自动挂载，**不修改 DSH 源码**。 +上述一键命令会下载并执行远程代码——脚本已随仓库开源（`scripts/install.sh` / `scripts/install.ps1`），可先下载审阅。PowerShell 入口会先移除 UTF-8 BOM，再创建 ScriptBlock，以确保参数在 PowerShell 5.1 和 pwsh 中都能正确绑定。插件以 npm 包 `dsh-better-sidebar@0.10.3` 发布，通过 `dsh.bundle.patch`（随包的 `cordis.patch.yml`）由官方 CLI 自动挂载，**不修改 DSH 源码**。 diff --git a/README_EN.md b/README_EN.md index a546073..95dc3aa 100644 --- a/README_EN.md +++ b/README_EN.md @@ -53,7 +53,10 @@ curl -fsSL https://raw.githubusercontent.com/omdsh-dev/DSH-better-sidebar/main/s **Windows (PowerShell 5.1+ / pwsh)**: ```powershell -irm https://raw.githubusercontent.com/omdsh-dev/DSH-better-sidebar/main/scripts/install.ps1 | iex +$script = ( + irm 'https://raw.githubusercontent.com/omdsh-dev/DSH-better-sidebar/main/scripts/install.ps1' +).TrimStart([char]0xFEFF) +& ([scriptblock]::Create($script)) ``` Then **hard-refresh the browser** (Cmd/Ctrl+Shift+R) to see the sidebar (DSH hot-reloads client changes; only host-half updates need a restart). @@ -66,7 +69,10 @@ Then **hard-refresh the browser** (Cmd/Ctrl+Shift+R) to see the sidebar (DSH hot curl -fsSL https://raw.githubusercontent.com/omdsh-dev/DSH-better-sidebar/main/scripts/install.sh | bash -s 0.10.3 --restart # Windows PowerShell -& ([scriptblock]::Create((irm 'https://raw.githubusercontent.com/omdsh-dev/DSH-better-sidebar/main/scripts/install.ps1'))) -Version 0.10.3 -Restart +$script = ( + irm 'https://raw.githubusercontent.com/omdsh-dev/DSH-better-sidebar/main/scripts/install.ps1' +).TrimStart([char]0xFEFF) +& ([scriptblock]::Create($script)) -Version 0.10.3 -Restart ``` Not sure? Add `--dry-run` (`-DryRun` in PowerShell) to preview before running. @@ -123,7 +129,7 @@ The one-click script does four things, all idempotent (safe to re-run): 3. Runs `dsh plugin --profile web add dsh-better-sidebar`: registers the dependency → detects `dsh.bundle.patch` → auto-appends the plugin to `dsh.profile.bundles`; 4. Removes any leftover hand-written mount line to avoid double-mounting (two sidebars on the page). -`curl | bash` / `irm | iex` executes remote code — the scripts are open source in the repo (`scripts/install.sh` / `scripts/install.ps1`); download and review them first if you prefer. The plugin ships as npm package `dsh-better-sidebar@0.10.3` and mounts via `dsh.bundle.patch` (the shipped `cordis.patch.yml`), so the DSH source is never modified. +The one-click commands above download and execute remote code. The scripts are open source in the repo (`scripts/install.sh` / `scripts/install.ps1`), so you can download and review them first. The PowerShell entry point removes the UTF-8 BOM before creating the ScriptBlock, which keeps parameter binding correct in both Windows PowerShell 5.1 and pwsh. The plugin ships as npm package `dsh-better-sidebar@0.10.3` and mounts via `dsh.bundle.patch` (the shipped `cordis.patch.yml`), so the DSH source is never modified. diff --git a/scripts/install.ps1 b/scripts/install.ps1 index 70e14e0..0c04d88 100644 --- a/scripts/install.ps1 +++ b/scripts/install.ps1 @@ -11,9 +11,11 @@ # # 用法（任选其一）： # # 默认最新版 -# irm https://raw.githubusercontent.com/omdsh-dev/DSH-better-sidebar/main/scripts/install.ps1 | iex +# $script = (irm 'https://raw.githubusercontent.com/omdsh-dev/DSH-better-sidebar/main/scripts/install.ps1').TrimStart([char]0xFEFF) +# & ([scriptblock]::Create($script)) # # 指定版本 / 装完重启 -# & ([scriptblock]::Create((irm 'https://raw.githubusercontent.com/omdsh-dev/DSH-better-sidebar/main/scripts/install.ps1'))) -Version 0.10.2 -Restart +# $script = (irm 'https://raw.githubusercontent.com/omdsh-dev/DSH-better-sidebar/main/scripts/install.ps1').TrimStart([char]0xFEFF) +# & ([scriptblock]::Create($script)) -Version 0.10.2 -Restart # # 本地保存后运行 # powershell -ExecutionPolicy Bypass -File install.ps1 -Version 0.10.2 -DryRun # @@ -92,6 +94,21 @@ function Get-DshCli { if (-not (Get-Command node -ErrorAction SilentlyContinue)) { Die '未找到 node（DSH 运行需要 Node.js >= 20），请先安装 Node.js 并加入 PATH。' } +if (-not (Get-Command pnpm -ErrorAction SilentlyContinue)) { + Die '未找到 pnpm；安装脚本需要 pnpm >= 10。请先安装或升级 pnpm 并加入 PATH。' +} +$pnpmVersion = (& pnpm --version 2>$null | Select-Object -Last 1) +if ($LASTEXITCODE -ne 0 -or -not $pnpmVersion) { + Die '无法读取 pnpm 版本；安装脚本需要 pnpm >= 10。' +} +$pnpmVersionText = ([string]$pnpmVersion).Trim() +$pnpmMajor = 0 +if (-not [int]::TryParse(($pnpmVersionText -split '\.')[0], [ref]$pnpmMajor)) { + Die "无法解析 pnpm 版本（输出：$pnpmVersionText）；安装脚本需要 pnpm >= 10。" +} +if ($pnpmMajor -lt 10) { + Die "安装脚本需要 pnpm >= 10；当前版本为 $pnpmVersionText。请升级 pnpm 后重试。" +} if (-not (Test-Path $PROFILE_DIR)) { Die "找不到 profile 目录：$PROFILE_DIR（请先安装并运行过一次 dsh web）" } diff --git a/tests/install-powershell.spec.ts b/tests/install-powershell.spec.ts new file mode 100644 index 0000000..bdcd029 --- /dev/null +++ b/tests/install-powershell.spec.ts @@ -0,0 +1,130 @@ +import { spawnSync } from 'node:child_process' +import { mkdtempSync, mkdirSync, readFileSync, rmSync, writeFileSync } from 'node:fs' +import { tmpdir } from 'node:os' +import { delimiter, join, resolve } from 'node:path' +import { fileURLToPath } from 'node:url' +import { afterEach, describe, expect, it } from 'vitest' + +const ROOT = resolve(fileURLToPath(new URL('..', import.meta.url))) +const INSTALLER = resolve(ROOT, 'scripts/install.ps1') +const INSTALLER_URL = 'https://raw.githubusercontent.com/omdsh-dev/DSH-better-sidebar/main/scripts/install.ps1' +const tempDirs: string[] = [] +const hasPwsh = process.platform === 'win32' + && spawnSync('pwsh', ['-NoLogo', '-NoProfile', '-Command', 'exit 0'], { stdio: 'ignore' }).status === 0 + +interface InstallerFixture { + home: string + path: string + workspace: string +} + +function createFixture(pnpmVersion: string): InstallerFixture { + const root = mkdtempSync(join(tmpdir(), 'dshbs-install-')) + tempDirs.push(root) + const home = join(root, 'home') + const profile = join(home, 'profiles', 'web') + const bin = join(root, 'bin') + mkdirSync(profile, { recursive: true }) + mkdirSync(bin) + const workspace = 'packages:\n - .\n' + writeFileSync(join(profile, 'pnpm-workspace.yaml'), workspace) + writeFileSync(join(bin, 'pnpm.cmd'), `@echo off\r\necho ${pnpmVersion}\r\n`) + return { + home, + workspace, + path: `${bin}${delimiter}${process.env.PATH ?? ''}`, + } +} + +function runPowerShell(executable: string, args: string[], fixture: InstallerFixture) { + return spawnSync(executable, ['-NoLogo', '-NoProfile', ...args], { + encoding: 'utf8', + env: { + ...process.env, + DSH_CMD: 'dsh', + DSH_HOME: fixture.home, + INSTALLER_PATH: INSTALLER, + PATH: fixture.path, + }, + }) +} + +function assertInMemoryInvocation(executable: string): void { + const fixture = createFixture('10.34.5') + const command = [ + '$bytes = [IO.File]::ReadAllBytes($env:INSTALLER_PATH)', + '$script = [Text.Encoding]::UTF8.GetString($bytes).TrimStart([char]0xFEFF)', + '& ([scriptblock]::Create($script)) -Version 0.11.0 -DryRun', + ].join('; ') + const result = runPowerShell(executable, ['-Command', command], fixture) + const output = `${result.stdout}\n${result.stderr}` + + expect(result.status, output).toBe(0) + expect(output).toContain('dsh-better-sidebar@0.11.0') + expect(output).toContain('[dry-run]') + expect(output).not.toContain('False False') +} + +afterEach(() => { + for (const dir of tempDirs.splice(0)) rmSync(dir, { recursive: true, force: true }) +}) + +describe('PowerShell installer entry points', () => { + it('keeps the UTF-8 BOM required by Windows PowerShell 5.1 -File decoding', () => { + expect(readFileSync(INSTALLER).subarray(0, 3)).toEqual(Buffer.from([0xef, 0xbb, 0xbf])) + }) + + it('documents only BOM-safe in-memory invocation', () => { + for (const file of ['README.md', 'README_EN.md', 'scripts/install.ps1']) { + const source = readFileSync(resolve(ROOT, file), 'utf8') + expect(source, file).not.toMatch(new RegExp(`irm [^\\r\\n]*${INSTALLER_URL.replace(/[.*+?^${}()|[\]\\]/g, '\\$&')}[^\\r\\n]*\\|\\s*iex`, 'i')) + expect(source, file).not.toMatch(/\[scriptblock\]::Create\(\(irm\b/i) + expect(source.match(/\.TrimStart\(\[char\]0xFEFF\)/g)?.length, file).toBeGreaterThanOrEqual(2) + } + }) + + it('keeps the versioned installer usage example self-contained', () => { + const source = readFileSync(INSTALLER, 'utf8') + const versionedExample = source.slice( + source.indexOf('# # 指定版本 / 装完重启'), + source.indexOf('# # 本地保存后运行'), + ) + + expect(versionedExample).toContain(INSTALLER_URL) + expect(versionedExample).toContain('.TrimStart([char]0xFEFF)') + expect(versionedExample).toContain('-Version 0.10.2 -Restart') + }) + + it.runIf(process.platform === 'win32')('binds parameters when loaded into memory by Windows PowerShell 5.1', () => { + assertInMemoryInvocation('powershell.exe') + }) + + it.runIf(hasPwsh)('binds parameters when loaded into memory by pwsh, when available', () => { + assertInMemoryInvocation('pwsh') + }) + + it.runIf(process.platform === 'win32')('retains the Windows PowerShell 5.1 -File entry point', () => { + const fixture = createFixture('10.34.5') + const result = runPowerShell('powershell.exe', [ + '-ExecutionPolicy', 'Bypass', '-File', INSTALLER, '-Version', '0.11.0', '-DryRun', + ], fixture) + const output = `${result.stdout}\n${result.stderr}` + + expect(result.status, output).toBe(0) + expect(output).toContain('dsh-better-sidebar@0.11.0') + expect(output).toContain('[dry-run]') + }) + + it.runIf(process.platform === 'win32')('rejects pnpm 8 before changing the profile', () => { + const fixture = createFixture('8.15.9') + const workspacePath = join(fixture.home, 'profiles', 'web', 'pnpm-workspace.yaml') + const result = runPowerShell('powershell.exe', [ + '-ExecutionPolicy', 'Bypass', '-File', INSTALLER, '-Version', '0.11.0', '-DryRun', + ], fixture) + const output = `${result.stdout}\n${result.stderr}` + + expect(result.status, output).toBe(1) + expect(output).toContain('pnpm >= 10') + expect(readFileSync(workspacePath, 'utf8')).toBe(fixture.workspace) + }) +})