Skip to content

Export-Image.ps1 compatibility with PowerShell 5.1 #31

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
NeuroThom wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Export-Image.ps1 compatibility with PowerShell 5.1 #31

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 14 additions & 5 deletions modules/Export-Image.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,15 @@
[string]$documentationRoot="" # Only relevant when outputFolder is set
)

Set-StrictMode -Version 3.0
Set-StrictMode -Version 2.0
$ErrorActionPreference = 'Stop'
$PSNativeCommandUseErrorActionPreference = $true

function Get-RelativePath([string]$basePath, [string]$targetPath) {

@glopesdev glopesdev Mar 9, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Resolve-Path has a built-in replacement for this which does work on PS 5.0+ so we likely don't need to define a new function.

Resolve-Path -Relative abspath

$baseUri = New-Object System.Uri(($basePath.TrimEnd('\', '/') + '\'))
$targetUri = New-Object System.Uri($targetPath)
$relUri = $baseUri.MakeRelativeUri($targetUri)
return [System.Uri]::UnescapeDataString($relUri.ToString()) -replace '/', [IO.Path]::DirectorySeparatorChar
}

function Export-Svg([string[]]$libPath, [string]$svgPath, [string]$workflowFile) {
$bootstrapperArgs = @()
Expand All @@ -20,13 +26,17 @@ function Export-Svg([string[]]$libPath, [string]$svgPath, [string]$workflowFile)
$bootstrapperArgs += "$svgPath"
$bootstrapperArgs += "$workflowFile"

if (!$IsWindows) {
$isWindowsPlatform = if ($null -eq (Get-Variable 'IsWindows' -ErrorAction SilentlyContinue)) { $true } else { $IsWindows }

@glopesdev glopesdev Mar 9, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@NeuroThom why was it necessary to redefine this part of the implementation? It wasn't clear from the PR description.

if (!$isWindowsPlatform) {
$bootstrapperArgs = @($bootstrapperPath) + $bootstrapperArgs
$bootstrapperPath = 'mono'
}

Write-Verbose "$($bootstrapperPath) $($bootstrapperArgs)"
&$bootstrapperPath $bootstrapperArgs
if ($LASTEXITCODE -ne 0) {

@glopesdev glopesdev Mar 9, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is the difference in error output with PSNativeCommandUseErrorActionPreference versus this error check? Do you still get the error stack trace printed by the Bonsai bootstrapper?

A good way to check would be to get a workflow which fails to export and check the output of one version versus the other.

throw "Export failed for '$workflowFile' with exit code $LASTEXITCODE."
}
}

if (-not $documentationRoot) {
Expand All @@ -35,10 +45,9 @@ if (-not $documentationRoot) {

Import-Module (Join-Path $PSScriptRoot "Export-Tools.psm1") -Verbose:$false

$sessionPath = $ExecutionContext.SessionState.Path
foreach ($workflowFile in Get-ChildItem -File -Recurse (Join-Path $workflowPath "*.bonsai")) {
$svgPath = Join-Path $workflowFile.DirectoryName "$($workflowFile.BaseName).svg"
$svgPathRelative = [IO.Path]::GetRelativePath($documentationRoot, $svgPath)
$svgPathRelative = Get-RelativePath $documentationRoot $svgPath

@glopesdev glopesdev Mar 9, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like PS 5+ does not have -RelativeBasePath and always works relative to the current directory so we would need to push and pop location:

Suggested change
$svgPathRelative = Get-RelativePath $documentationRoot $svgPath
Push-Location $documentationRoot
$svgPathRelative = Resolve-Path $svgPath -Relative
Pop-Location

This could probably even be done outside the loop since we are probably fine running the script from the context of $documentationRoot.


if ($outputFolder) {
$svgPath = Join-Path $outputFolder $svgPathRelative
Expand Down