Progress Bar Feature?

[salty-flower]

Before encountering this repository, I have been writing a tiny build script myself. I had fun with a progress bar feature with Write-Progress, inspired by docker build .:

I'm curious whether we'll consider anything similar.

Below I'm happy to share what I have:

• class definition

class SubCommand {
    [string] $name
    [string[]] $aliases
    [scriptblock] $action = { Write-Host "No action defined" }
  
    [string] $entry_prompt
    [string] $exit_prompt
  
    [int16] $total_steps
  
    $progress_params
  
    # modified from https://stackoverflow.com/questions/45881037/powershell-convert-unique-string-to-unique-int
    static [Int32]GetFNVHash( [string]$InputString) {
      # Initial prime and offset chosen for 32-bit output
      # See https://en.wikipedia.org/wiki/Fowler–Noll–Vo_hash_function
      [uint32]$FNVPrime = 16777619
      [uint32]$offset = 2166136261
  
      # Convert string to byte array, may want to change based on input collation
      $bytes = [System.Text.Encoding]::UTF8.GetBytes($InputString)
  
      # Copy offset as initial hash value
      [uint32]$hash = $offset
  
      foreach ($octet in $bytes) {
        # Apply XOR, multiply by prime and mod with max output size
        $hash = $hash -bxor $octet
        $hash = $hash * $FNVPrime % [System.Math]::Pow(2, 16) # use 16 here for 16-bit hash
      }
      return $hash
    }
  
    SubCommand([string] $name, [string[]] $aliases, [string] $entry_prompt, [string] $exit_prompt, [scriptblock] $action) {
      $this.name = $name
      $this.aliases = $aliases
      $this.action = $action
      $this.entry_prompt = $entry_prompt
      $this.exit_prompt = $exit_prompt
      $this.total_steps = $action.Ast.EndBlock.Statements | Where-Object { $_.PipelineElements.Expression.Member.Value -eq $this.WriteMilestone.Name } | Measure-Object | Select-Object -ExpandProperty Count
  
      $this.progress_params = @{
        Activity        = $name
        PercentComplete = 0
        Id              = [SubCommand]::GetFNVHash($name)
      }
    }
  
    [void] Invoke() {
      $this.progress_params.Status = "==> $($this.entry_prompt)"
      $this.FlushProgress()
  
      & $this.action
  
      $this.progress_params.Status = "==> $($this.exit_prompt)"
      $this.FlushProgress()
    }
  
    [void] FlushProgress() {
      for () {
        $params = $this.progress_params
        Write-Progress @params
        break
      }
    }
  
    [void] WriteMilestone([string] $status) {
      $this.progress_params.Status = "==> $status"
      $this.progress_params.PercentComplete += 100 / ($this.total_steps )
      $this.FlushProgress()
    }
  }

$commands = @(
  [SubCommand]::new("example", @("e"), "Entering!", "Exited!", {
      Start-Sleep -Seconds 1
      $this.WriteMilestone("Step 1 done")
      Start-Sleep -Seconds 1
      $this.WriteMilestone("Step 2 done")
      Start-Sleep -Seconds 1
      $this.WriteMilestone("Step 3 done")
      Start-Sleep -Seconds 1
    })
)

$name_to_command = @{}
$commands | ForEach-Object -Parallel { ($using:name_to_command)[$_.name] = $_; $obj = $_; $_.aliases | ForEach-Object { ($using:name_to_command)[$_] = $obj } } -ThrottleLimit 16

$subCommand = $args[0]
if (($nonEmpty = $null -ne $subCommand) -and $null -ne ($command = $name_to_command[$subCommand]) ) {
  $command.Invoke()
}
else {
  if ($nonEmpty) {
    Write-Host "==> Unknown subcommand: $subCommand"
  }
  Write-Host "==> Available subcommands:`n$(($commands | ForEach-Object {"  - $($_.name) ($($_.aliases -join ", "))" } ) -join "`n")"
}

[nightroman]

Hi @salty-flower Thank you for the nice code and idea.

I am not yet sure though how it should play in the context of IB. In a way, not literally of course, IB already writes a lot of "progress information" on running.

[salty-flower]

Yeah, tbh this doesn't add functionality and is merely decoration 😁