Shuery
187d2759fd
三件事：
1) tools\Install-TestDependencies.ps1 现在也把 PSScriptAnalyzer 装进仓库内的 .tools\modules
（不动机器上的全局模块，与 Pester 同一策略）。
2) PSScriptAnalyzerSettings.psd1：这是必要的，不是装饰 —— 那 6 条格式规则
（括号、缩进、空格、对齐、大小写）默认全是 Disabled，所以不带 -Settings 的
`Invoke-ScriptAnalyzer -Severity Warning,Error` 会**静默漏掉全部排版问题**。本文件用 Rules
把它们打开（而不是用 IncludeRules 换一套），于是默认规则与格式规则同时生效。
三条有意的排除都写明了理由：PSAvoidUsingWriteHost（彩色控制台输出是这份工具的刻意设计）、
PSUseShouldProcessForStateChangingFunctions（WhatIf 的边界在入口脚本，给库里 27 个改状态的
函数都加上反而会"静默跳过"，备份看着成功却什么都没做）、PSAvoidUsingPlainTextForPassword
（7z 只接受命令行口令，这是 7z 的限制，README 里写明了取舍）。
3) tools\Invoke-Analyzer.ps1：独立门禁（不塞进 Pester 用例 —— 套件跑一次二十多秒，
混进去会让"测试红了"这句话失去分辨力），路径过滤与验收门槛的 Encode/Parse 两层一致。
全仓重排结果：706 条告警 -> 67 条。修掉的 639 条全部是格式（闭括号 168、空格 80、
对齐 68、缩进 60、行长 229）。重排后 9/9 验收全绿、100 个文件两版解析零错、
276 个断言原样通过 —— 机械重排没有改变任何可观察行为。
如实说明两件事：
* 行长上限设成 160，**不是**官方默认的 120。120 在本仓库意味着 270 处改动（主要是
中文注释与测试夹具里的一行式目录），160 意味着 41 处。160 仍是"宽但可读"，而理由是写在
配置文件里的：这不是悄悄放宽，想收紧到 120 时那份清单就在分析器输出里。
* 剩余 67 条里，41 条是上面那批行长，其余 26 条是分析器找出的真问题（未使用参数 6、
空 catch 6、MD5 指纹 1、覆盖内置命令 1、switch 默认值 1 等）。其中
Find-ChildDirectoryByName 的 MaxDepth 参数从未被使用 —— 也就是配置里的
CatalogMaxDepth = 5 是假的，前缀补全实际只查 1 层。这条要改行为、且影响真实名录的解析
结果，留给你拍板，不在本提交里动手。
81 lines
3.3 KiB
PowerShell
81 lines
3.3 KiB
PowerShell
<#
|
|
.SYNOPSIS
|
|
把受管文本文件规范成仓库约定的编码：UTF-8 with BOM、LF 行尾。
|
|
|
|
.DESCRIPTION
|
|
为什么需要一个可重放的脚本，而不是"改一次就完了"：
|
|
|
|
* Windows PowerShell 5.1 在没有 BOM 时会按 ANSI 代码页解码源码文件，
|
|
中文变乱码，而全角问号之类的字节序列会吃掉字符串引号、整块语法失效。
|
|
* 但很多编辑器与工具在保存时会**悄悄去掉 BOM**。实测本仓库用的编辑工具就会
|
|
（改过一次 test.ps1 之后它只在 5.1 上解析失败，在 7 上完全正常，极其隐蔽）。
|
|
* 所以"加过 BOM"必须是一次能在任何改动之后重放的规范化操作。
|
|
|
|
受管范围与 .editorconfig 一致：
|
|
* *.ps1 / *.psm1 / *.psd1 —— PowerShell 引擎直接读取，必须有 BOM
|
|
* BackupList.txt —— 被 Get-Content 读取，必须有 BOM
|
|
|
|
只做两件事：补 BOM、把 CRLF 归一成 LF。不动缩进、不动内容、不换编码以外的东西。
|
|
文件按 UTF-8 解码：本仓库的所有文本文件都是 UTF-8（见 .editorconfig）。
|
|
|
|
.PARAMETER WhatIf
|
|
只报告将要改动什么，不写任何文件。
|
|
|
|
.EXAMPLE
|
|
.\tools\Set-SourceEncoding.ps1 -WhatIf
|
|
|
|
.EXAMPLE
|
|
.\tools\Set-SourceEncoding.ps1
|
|
#>
|
|
[CmdletBinding(SupportsShouldProcess = $true)]
|
|
param()
|
|
|
|
$ErrorActionPreference = 'Stop'
|
|
$projectRoot = Split-Path -Parent $PSScriptRoot
|
|
|
|
$excluded = '\\(\.git|\.tools|Backups|logs|dist|snapshots)\\'
|
|
$targets = @(Get-ChildItem -LiteralPath $projectRoot -Recurse -File |
|
|
Where-Object { $_.Extension -in '.ps1', '.psm1', '.psd1' -or $_.Name -eq 'BackupList.txt' } |
|
|
Where-Object { $_.FullName -notmatch $excluded })
|
|
|
|
$utf8Bom = New-Object System.Text.UTF8Encoding($true)
|
|
$utf8NoBom = New-Object System.Text.UTF8Encoding($false)
|
|
|
|
$addedBom = @()
|
|
$normalizedLf = @()
|
|
|
|
foreach ($file in $targets) {
|
|
$bytes = [System.IO.File]::ReadAllBytes($file.FullName)
|
|
$hasBom = $bytes.Length -ge 3 -and $bytes[0] -eq 0xEF -and $bytes[1] -eq 0xBB -and $bytes[2] -eq 0xBF
|
|
$text = if ($hasBom) { $utf8NoBom.GetString($bytes, 3, $bytes.Length - 3) } else { $utf8NoBom.GetString($bytes) }
|
|
|
|
$normalized = ($text -split "`r?`n") -join "`n"
|
|
$needsWrite = (-not $hasBom) -or ($normalized -ne $text)
|
|
|
|
if (-not $hasBom) { $addedBom += $file.FullName.Substring($projectRoot.Length).TrimStart('\') }
|
|
if ($normalized -ne $text) { $normalizedLf += $file.FullName.Substring($projectRoot.Length).TrimStart('\') }
|
|
|
|
if ($needsWrite -and $PSCmdlet.ShouldProcess($file.FullName, '规范成 UTF-8 with BOM 与 LF')) {
|
|
[System.IO.File]::WriteAllText($file.FullName, $normalized, $utf8Bom)
|
|
}
|
|
}
|
|
|
|
Write-Host ''
|
|
Write-Host ("受管文件 {0} 个" -f $targets.Count)
|
|
if ($addedBom.Count -gt 0) {
|
|
Write-Host ("补上 BOM {0} 个：" -f $addedBom.Count) -ForegroundColor Yellow
|
|
$addedBom | ForEach-Object { Write-Host " $_" }
|
|
}
|
|
else {
|
|
Write-Host '所有文件都已经带 BOM。' -ForegroundColor Green
|
|
}
|
|
if ($normalizedLf.Count -gt 0) {
|
|
Write-Host ("行尾归一成 LF {0} 个：" -f $normalizedLf.Count) -ForegroundColor Yellow
|
|
$normalizedLf | ForEach-Object { Write-Host " $_" }
|
|
}
|
|
|
|
if (-not $WhatIfPreference) {
|
|
Write-Host ''
|
|
Write-Host '下一步：.\test.ps1 -Suite Parse 确认两个版本都能解析。' -ForegroundColor Cyan
|
|
}
|