Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kzrnm/kurukuru-powershell
PowerShell wrapper of Kurukuru
https://github.com/kzrnm/kurukuru-powershell
Last synced: 26 days ago
JSON representation
PowerShell wrapper of Kurukuru
- Host: GitHub
- URL: https://github.com/kzrnm/kurukuru-powershell
- Owner: kzrnm
- License: mit
- Created: 2021-12-12T11:32:41.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-08-05T14:02:47.000Z (5 months ago)
- Last Synced: 2024-08-06T13:56:45.870Z (5 months ago)
- Language: PowerShell
- Size: 55.7 KB
- Stars: 5
- Watchers: 2
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# kurukuru-pwsh
[](https://www.powershellgallery.com/packages/kurukuru-pwsh)
PowerShell wrapper of [Kurukuru](https://github.com/mayuki/Kurukuru).
https://user-images.githubusercontent.com/32071278/145768756-23f1ab90-5e54-45cc-aedc-8bb7f353043b.mp4
## Get Started
[PowerShell Gallery](https://www.powershellgallery.com/packages/kurukuru-pwsh).
```powershell
Install-Module kurukuru-pwsh
```
## Usage
### Simple
```powershell
Start-Kurukuru {
param($spinner)
$spinner.Text = "Start"
Start-Sleep -Seconds 1.5
$spinner.Text = "Foo"
Start-Sleep -Seconds 1.5
$spinner.Text = "End"
}
```
### Many Params
```powershell
Start-Kurukuru -Text "Initialize" -SucceedText "Success" -Pattern Moon -SymbolFailed ([Kurukuru.SymbolDefinition]::new("🌑", "O")) {
param([Kurukuru.Spinner]$spinner)
if ((([datetime]::Now.Hour + 18) % 24) -gt 12) {
$spinner.SymbolSucceed = [Kurukuru.SymbolDefinition]::new("🌕️", "O")
}
else {
$spinner.SymbolSucceed = [Kurukuru.SymbolDefinition]::new("🌅", "O")
}
} {
param([Kurukuru.Spinner]$spinner)
Start-Sleep -Seconds 1.5
$spinner.Text = "Foo"
Start-Sleep -Seconds 1.5
}
```
### Custom pattern
```powershell
Start-Kurukuru -Pattern ([Kurukuru.Pattern]::new(@("＿", "￣"), 150)) {
param($spinner)
$spinner.Text = "Start"
Start-Sleep -Seconds 1.5
$spinner.Text = "Foo"
Start-Sleep -Seconds 1.5
$spinner.Text = "End"
}
```
### Parallel
```powershell
1..20 | ForEach-Object {
$i = $_
New-Spinner -Text "Start: $i and Wait: 300 ms" -Pattern (Get-Random (Get-KurukuruPattern)) -SucceedText "Finish:$i" -FailedText "Failed:$i" -ScriptBlock ({
param([Kurukuru.Spinner]$s)
$s.Text = "Starting: $i"
if ($i % 2 -eq 0) {
$waitMills = 250 * $i
}
else {
$waitMills = 500 + 100 * $i
}
Start-Sleep -Milliseconds 300
$s.Text = "Running: $i Wait: $waitMills ms"
Start-Sleep -Milliseconds $waitMills
if ($i -eq 2) {
throw "Error 2"
}
$s.Text = "Closing: $i"
}).GetNewClosure()
} | Start-Kurukuru
```
### Start-Sleep
```powershell
function Start-KurukuruSleep {
[CmdletBinding(DefaultParameterSetName = 'Seconds')]
param (
[Parameter(ParameterSetName = 'FromTimeSpan', Mandatory, Position = 0, ValueFromPipeline, ValueFromPipelineByPropertyName)]
[Alias('ts')]
[timespan]
$Duration,
[Parameter(ParameterSetName = 'Milliseconds', Mandatory, ValueFromPipelineByPropertyName)]
[Alias('ms')]
[int]
$Milliseconds,
[Parameter(ParameterSetName = 'Seconds', Mandatory, Position = 0, ValueFromPipeline, ValueFromPipelineByPropertyName)]
[double]
$Seconds,
$Pattern = $null
)
switch ($PSCmdlet.ParameterSetName) {
'Milliseconds' {
$Duration = [timespan]::FromMilliseconds($Milliseconds)
}
'Seconds' {
$Duration = [timespan]::FromSeconds($Seconds)
}
}
$until = [datetime]::Now.Add($Duration)
$untilText = "Waiting until $($until.ToString())..."
Start-Kurukuru -Pattern $Pattern -Text $untilText -SucceedText 'Finish.' {
param($s)
try {
do {
$remaining = $until - (Get-Date)
$s.Text = "$untilText Ramaining $remaining"
Start-Sleep -Milliseconds 300
}while ($remaining -gt 0)
}
catch {
}
}
}
Register-ArgumentCompleter -CommandName Start-KurukuruSleep -ParameterName Pattern -ScriptBlock {
param(
$commandName,
$parameterName,
$wordToComplete,
$commandAst,
$fakeBoundParameter
)
foreach ($p in ($KurukuruPatterns)) {
if ($p.Name.ToLower().StartsWith($wordToComplete.ToLower())) {
[System.Management.Automation.CompletionResult]::new(
$p.Name,
$p.Name,
[System.Management.Automation.CompletionResultType]::ParameterValue,
"$($p.Frames) Interval=$($p.Interval)"
)
}
}
}
```