Files
BakNRet/BakNRet/BakNRet.psd1
T
Shuery 2ad7987ffe refactor: Common.psm1 拆成 BakNRet/{Public,Private},一函数一文件 + 薄加载器
3152 行、66 个函数的单文件模块拆成:
  BakNRet\BakNRet.psd1   模块清单:FunctionsToExport 是显式白名单(62 个名字)
  BakNRet\BakNRet.psm1   加载器:点源顺序的唯一一处声明
  BakNRet\Public\*.ps1   62 个对外函数,一函数一文件,文件名 = 函数名
  BakNRet\Private\*.ps1  4 个内部函数 + State.ps1(模块级状态集中一处)

为什么是一函数一文件:这是社区里脚本模块的主流形态(调研实测:winutil 79 个、
Terminal-Icons 24 个、ModuleBuilder 23 个,全部如此)。收益是改动落在小文件里、diff 按职责
可读、模块级状态有唯一去处。

为什么这不算"打散":模块内 dot-source 的文件共享同一个模块作用域(实测确认),所以
"按顺序点源 67 个文件"与"点源一个大文件"在语义上等价;顺序只在加载器里出现一次,
tools\Build-BakNRetModule.ps1 从那里读出顺序就能拼回单文件 —— 本次产物 dist\BakNRet.psm1
3240 行、两个版本都解析零错。

新增一条断言把这条承诺钉住:加载器点源的文件集合必须与磁盘一致、导出名单必须与
Public\ 一一对应。漏一个文件或漏一个名字就是静默少一个函数 —— 而那种错在运行时只表现为
"找不到命令"。

引用更新:11 个文件里的 Common.psm1 改成 BakNRet\BakNRet.psd1(走清单导入,
FunctionsToExport 才真的说了算);Common.psm1 直接删除,不留转发垫片。

验收:test.ps1 9/9 全绿(7 与 5.1),98 个文件两版解析零错,276 个断言原样通过 ——
这次搬家没有改变任何可观察行为。
2026-09-27 09:34:10 +08:00

94 lines
3.4 KiB
PowerShell

<#
模块清单。
为什么需要它:把"这个模块对外提供什么"变成一份可读的契约。这里 FunctionsToExport 是
**显式白名单**(官方性能指南明确要求不用通配符;PSUseToExportFieldsInManifest 也是恒开
的规则、关不掉)。名字少写一个,对应函数就不会被导出 —— 这是有意的:宁可导入方报
"找不到命令",也不要静默少一个函数。
CompatiblePSEditions 声明"桌面版与核心版都能导入":本模块兼容 Windows PowerShell 5.1
与 PowerShell 7.x。代价是放弃 PS 4.0 及以下,那是刻意的。
#>
@{
RootModule = 'BakNRet.psm1'
ModuleVersion = '1.0.0'
GUID = '9bc892ed-f852-4468-b1e7-d71a91cf2913'
Author = 'Shuery'
Description = 'BakNRet 公共模块:日志、外部命令调用、清单与名录解析、归档命名与暂存、manifest、安全描述符。兼容 Windows PowerShell 5.1 与 PowerShell 7.x。'
PowerShellVersion = '5.1'
CompatiblePSEditions = @('Desktop', 'Core')
FunctionsToExport = @(
'Enter-BaknretRunLock',
'Exit-BaknretRunLock',
'Get-BaknretRunLockPath',
'Set-BaknretDebug',
'Start-BaknretLog',
'Stop-BaknretLog',
'Get-BaknretLogPath',
'Write-Log',
'Test-Administrator',
'Get-BaknretFreeSpaceGB',
'ConvertTo-NativeArgumentString',
'Invoke-ExternalCommand',
'Resolve-CompressionTool',
'Get-Optimized7zArgument',
'Split-BaknretToken',
'Remove-BaknretQuote',
'Test-BaknretMarker',
'ConvertFrom-BaknretPatternList',
'ConvertFrom-BackupListLine',
'Test-LiteralPath',
'Get-BaknretRegexExclude',
'Get-BaknretExcludeArgument',
'Split-BaknretPatternScope',
'Merge-BaknretExcludeArgument',
'Resolve-CatalogPath',
'Get-SoftwareCatalog',
'Find-ChildDirectoryByName',
'Format-CatalogName',
'Expand-CatalogPathText',
'Get-ArchiveTopLevelNames',
'Get-BaknretArchiveTopName',
'New-BaknretArchiveItem',
'New-BaknretJunction',
'Remove-BaknretJunction',
'New-BaknretArchiveStaging',
'Remove-BaknretArchiveStaging',
'Get-ItemArchiveName',
'Resolve-BackupEntry',
'Write-BackupEntryPlan',
'Get-BackupBaseName',
'Convert-BackupFileNameToPath',
'Get-FolderSummary',
'Read-BaknretManifest',
'Write-BaknretManifest',
'Sync-BaknretManifestArchive',
'Move-BaknretArchiveIntoPlace',
'Enable-BaknretPrivilege',
'ConvertTo-BaknretWildcardPattern',
'Test-BaknretPathExcluded',
'Get-BaknretAceSignatureList',
'Get-BaknretSecuritySddlWithStale',
'Get-BaknretSecurityRecord',
'Test-BaknretSecurityRecordNeeded',
'Get-BaknretSecurityRecords',
'Write-BaknretAtomicText',
'Save-BaknretSecuritySidecar',
'Read-BaknretSecuritySidecar',
'Convert-BaknretSidMap',
'Set-BaknretObjectSecurity',
'Restore-BaknretSecurity',
'Get-BaknretConfig',
'Get-BaknretPassword'
)
CmdletsToExport = @()
VariablesToExport = @()
AliasesToExport = @()
PrivateData = @{
PSData = @{ Tags = @('Backup', 'Restore', '7zip', 'Windows', 'PSEdition_Desktop', 'PSEdition_Core') }
}
}