PowerShell/docs/what-is.md

87 lines
2.2 KiB
Markdown
Raw Normal View History

2024-11-08 12:38:20 +01:00
The *what-is.ps1* Script
===========================
2021-11-08 21:36:42 +01:00
2024-03-27 17:36:59 +01:00
This PowerShell script queries the meaning of the given term/abbreviation/etc. and prints it.
2021-11-08 21:36:42 +01:00
2023-07-29 10:04:38 +02:00
Parameters
----------
2021-11-08 21:36:42 +01:00
```powershell
2024-11-08 12:35:11 +01:00
/home/markus/Repos/PowerShell/scripts/what-is.ps1 [[-term] <String>] [<CommonParameters>]
2021-11-08 21:36:42 +01:00
2024-03-27 17:36:59 +01:00
-term <String>
Specifies the term to query
2021-11-08 21:36:42 +01:00
Required? false
Position? 1
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.
```
2023-07-29 10:04:38 +02:00
Example
-------
2021-11-08 21:36:42 +01:00
```powershell
2023-09-01 17:53:03 +02:00
PS> ./what-is VTOL
2024-08-15 09:51:46 +02:00
💡 VTOL in aviation refers to: Vertical Take-Off and Landing
2021-11-08 21:36:42 +01:00
```
2023-07-29 10:04:38 +02:00
Notes
-----
2022-11-17 19:46:02 +01:00
Author: Markus Fleschutz | License: CC0
2021-11-08 21:36:42 +01:00
2023-07-29 10:04:38 +02:00
Related Links
-------------
2021-11-08 21:36:42 +01:00
https://github.com/fleschutz/PowerShell
2023-07-29 10:04:38 +02:00
Script Content
--------------
2022-11-17 20:05:34 +01:00
```powershell
2022-11-17 20:02:26 +01:00
<#
.SYNOPSIS
2024-03-27 17:36:59 +01:00
Explains a term/abbreviation/etc.
2022-11-17 20:02:26 +01:00
.DESCRIPTION
2024-03-27 17:36:59 +01:00
This PowerShell script queries the meaning of the given term/abbreviation/etc. and prints it.
.PARAMETER term
Specifies the term to query
2022-11-17 20:02:26 +01:00
.EXAMPLE
2023-09-01 17:53:03 +02:00
PS> ./what-is VTOL
2024-08-15 09:51:46 +02:00
💡 VTOL in aviation refers to: Vertical Take-Off and Landing
2022-11-17 20:02:26 +01:00
.LINK
https://github.com/fleschutz/PowerShell
.NOTES
Author: Markus Fleschutz | License: CC0
#>
2024-03-27 17:36:59 +01:00
param([string]$term = "")
2022-11-17 20:02:26 +01:00
try {
2024-11-08 12:35:11 +01:00
if ($term -eq "" ) { $term = Read-Host "Enter the term to query" }
2024-08-15 09:51:46 +02:00
2024-11-08 12:35:11 +01:00
$files = Get-ChildItem "$PSScriptRoot/../data/dicts/*.csv"
2023-09-01 17:53:03 +02:00
$basename = ""
foreach($file in $files) {
$table = Import-CSV "$file"
foreach($row in $table) {
2024-03-27 17:36:59 +01:00
if ($row.TERM -ne $term) { continue }
2023-09-01 17:53:03 +02:00
$basename = (Get-Item "$file").Basename -Replace "_"," "
2024-03-27 17:36:59 +01:00
"💡 $($row.TERM) in $basename refers to: $($row.MEANING)"
2022-11-17 20:02:26 +01:00
}
}
2024-08-15 09:51:46 +02:00
if ($basename -eq "") {
2024-11-08 12:35:11 +01:00
Write-Host "🤷‍ Sorry, '$term' is unknown to me. Ctrl + click here to google it: " -noNewline
Write-Host "https://www.google.com/search?q=what+is+$term" -foregroundColor blue
2024-08-15 09:51:46 +02:00
}
2022-11-17 20:02:26 +01:00
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
2024-11-20 11:52:20 +01:00
*(generated by convert-ps2md.ps1 as of 11/20/2024 11:52:01)*