PowerShell/docs/search-files.md
2024-11-20 11:52:20 +01:00

102 lines
2.9 KiB
Markdown

The *search-files.ps1* Script
===========================
This PowerShell script searches for the given text pattern in the given files.
Parameters
----------
```powershell
/home/markus/Repos/PowerShell/scripts/search-files.ps1 [[-textPattern] <String>] [[-filePattern] <String>] [<CommonParameters>]
-textPattern <String>
Specifies the text pattern to search for
Required? false
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-filePattern <String>
Specifies the files to search
Required? false
Position? 2
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> ./search-files.ps1 UFO *.ps1
FILE LINE
---- ----
/home/Markus/PowerShell/scripts/check-month.ps1 17: $MonthName = (Get-Date -UFormat %B)
...
```
Notes
-----
Author: Markus Fleschutz | License: CC0
Related Links
-------------
https://github.com/fleschutz/PowerShell
Script Content
--------------
```powershell
<#
.SYNOPSIS
Searches for text in files
.DESCRIPTION
This PowerShell script searches for the given text pattern in the given files.
.PARAMETER textPattern
Specifies the text pattern to search for
.PARAMETER filePattern
Specifies the files to search
.EXAMPLE
PS> ./search-files.ps1 UFO *.ps1
FILE LINE
---- ----
/home/Markus/PowerShell/scripts/check-month.ps1 17: $MonthName = (Get-Date -UFormat %B)
...
.LINK
https://github.com/fleschutz/PowerShell
.NOTES
Author: Markus Fleschutz | License: CC0
#>
param([string]$textPattern = "", [string]$filePattern = "")
function ListLocations { param([string]$textPattern, [string]$filePattern)
$list = Select-String -path $filePattern -pattern "$textPattern"
foreach($item in $list) { New-Object PSObject -Property @{ 'FILE'="$($item.Path)"; 'LINE'="$($item.LineNumber):$($item.Line)" } }
"✅ Found $($list.Count) lines containing '$textPattern' in $filePattern."
}
try {
if ($textPattern -eq "" ) { $textPattern = Read-Host "Enter the text pattern, e.g. 'UFO'" }
if ($filePattern -eq "" ) { $filePattern = Read-Host "Enter the file pattern, e.g. '*.ps1'" }
ListLocations $textPattern $filePattern | Format-Table -property FILE,LINE -autoSize
exit 0 # success
} catch {
"⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])"
exit 1
}
```
*(generated by convert-ps2md.ps1 as of 11/20/2024 11:52:00)*