PowerShell/docs/replace-in-files.md
2024-01-25 13:58:49 +01:00

109 lines
3.1 KiB
Markdown

Script: *replace-in-files.ps1*
========================
This PowerShell script searches and replaces a pattern in the given files by the replacement.
Parameters
----------
```powershell
PS> ./replace-in-files.ps1 [[-pattern] <String>] [[-replacement] <String>] [[-filePattern] <String>] [<CommonParameters>]
-pattern <String>
Specifies the text pattern to look for
Required? false
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-replacement <String>
Specifies the text replacement
Required? false
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-filePattern <String>
Specifies the file to scan
Required? false
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters? false
[<CommonParameters>]
This script supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction,
WarningVariable, OutBuffer, PipelineVariable, and OutVariable.
```
Example
-------
```powershell
PS> ./replace-in-files NSA "No Such Agency" C:\Temp\*.txt
```
Notes
-----
Author: Markus Fleschutz | License: CC0
Related Links
-------------
https://github.com/fleschutz/PowerShell
Script Content
--------------
```powershell
<#
.SYNOPSIS
Search and replace a pattern in the given files by the replacement
.DESCRIPTION
This PowerShell script searches and replaces a pattern in the given files by the replacement.
.PARAMETER pattern
Specifies the text pattern to look for
.PARAMETER replacement
Specifies the text replacement
.PARAMETER filePattern
Specifies the file to scan
.EXAMPLE
PS> ./replace-in-files NSA "No Such Agency" C:\Temp\*.txt
.LINK
https://github.com/fleschutz/PowerShell
.NOTES
Author: Markus Fleschutz | License: CC0
#>
param([string]$pattern = "", [string]$replacement = "", [string]$filePattern = "")
function ReplaceInFile { param([string]$path, [string]$pattern, [string]$replacement)
[System.IO.File]::WriteAllText($path,
([System.IO.File]::ReadAllText($path) -replace $pattern, $replacement)
)
}
try {
if ($pattern -eq "" ) { $pattern = Read-Host "Enter the text pattern to look for" }
if ($replacement -eq "" ) { $replacement = Read-Host "Enter the text replacement" }
if ($filePattern -eq "" ) { $filePattern = Read-Host "Enter the file pattern" }
$stopWatch = [system.diagnostics.stopwatch]::startNew()
$files = (Get-ChildItem -path "$filePattern" -attributes !Directory)
foreach($file in $files) {
ReplaceInFile $file $pattern $replacement
}
[int]$elapsed = $stopWatch.Elapsed.TotalSeconds
"✔️ Replaced '$pattern' by '$replacement' in $($files.Count) files in $elapsed sec"
exit 0 # success
} catch {
"⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])"
exit 1
}
```
*(generated by convert-ps2md.ps1 using the comment-based help of replace-in-files.ps1 as of 01/25/2024 13:58:41)*