2022-12-04 10:40:18 +01:00
|
|
|
## The *replace-in-files.ps1* Script
|
2021-11-08 21:36:42 +01:00
|
|
|
|
2022-02-10 09:01:07 +01:00
|
|
|
This PowerShell script searches and replaces a pattern in the given files by the replacement.
|
2021-11-08 21:36:42 +01:00
|
|
|
|
|
|
|
## Parameters
|
|
|
|
```powershell
|
2023-05-26 12:20:18 +02:00
|
|
|
/home/mf/Repos/PowerShell/Scripts/replace-in-files.ps1 [[-pattern] <String>] [[-replacement] <String>] [[-files] <String>] [<CommonParameters>]
|
2021-11-08 21:36:42 +01:00
|
|
|
|
|
|
|
-pattern <String>
|
|
|
|
Specifies the pattern to look for
|
|
|
|
|
|
|
|
Required? false
|
|
|
|
Position? 1
|
|
|
|
Default value
|
|
|
|
Accept pipeline input? false
|
|
|
|
Accept wildcard characters? false
|
|
|
|
|
|
|
|
-replacement <String>
|
|
|
|
Specifies the replacement
|
|
|
|
|
|
|
|
Required? false
|
|
|
|
Position? 2
|
|
|
|
Default value
|
|
|
|
Accept pipeline input? false
|
|
|
|
Accept wildcard characters? false
|
|
|
|
|
|
|
|
-files <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
|
2022-11-17 19:46:02 +01:00
|
|
|
Author: Markus Fleschutz | License: CC0
|
2021-11-08 21:36:42 +01:00
|
|
|
|
|
|
|
## Related Links
|
|
|
|
https://github.com/fleschutz/PowerShell
|
|
|
|
|
2022-11-17 20:02:26 +01:00
|
|
|
## Source Code
|
2022-11-17 20:05:34 +01:00
|
|
|
```powershell
|
2022-11-17 20:02:26 +01:00
|
|
|
<#
|
|
|
|
.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 pattern to look for
|
|
|
|
.PARAMETER replacement
|
|
|
|
Specifies the replacement
|
|
|
|
.PARAMETER files
|
|
|
|
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]$files = "")
|
|
|
|
|
|
|
|
function ReplaceInFile { param([string]$FilePath, [string]$Pattern, [string]$Replacement)
|
|
|
|
|
|
|
|
[System.IO.File]::WriteAllText($FilePath,
|
|
|
|
([System.IO.File]::ReadAllText($FilePath) -replace $Pattern, $Replacement)
|
|
|
|
)
|
|
|
|
}
|
|
|
|
|
|
|
|
try {
|
|
|
|
if ($pattern -eq "" ) { $pattern = read-host "Enter search pattern" }
|
|
|
|
if ($replacement -eq "" ) { $replacement = read-host "Enter replacement" }
|
|
|
|
if ($files -eq "" ) { $files = read-host "Enter files" }
|
|
|
|
|
|
|
|
$StopWatch = [system.diagnostics.stopwatch]::startNew()
|
|
|
|
|
|
|
|
$fileList = (get-childItem -path "$files" -attributes !Directory)
|
|
|
|
foreach($file in $fileList) {
|
|
|
|
ReplaceInFile $file $pattern $replacement
|
|
|
|
}
|
|
|
|
[int]$Elapsed = $StopWatch.Elapsed.TotalSeconds
|
|
|
|
"OK, replaced '$pattern' by '$replacement' in $($fileList.Count) files in $Elapsed sec."
|
|
|
|
exit 0 # success
|
|
|
|
} catch {
|
|
|
|
"⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])"
|
|
|
|
exit 1
|
|
|
|
}
|
2022-11-17 20:05:34 +01:00
|
|
|
```
|
2022-11-17 20:02:26 +01:00
|
|
|
|
2021-11-08 21:36:42 +01:00
|
|
|
*Generated by convert-ps2md.ps1 using the comment-based help of replace-in-files.ps1*
|