🎨 Convert many System.IO.Path features to Split-Path

Author: brianary

Backup-File.ps1

@@ -33,6 +33,7 @@ Backup-File.ps1 logfile.log
 Copies logfile.log to logfile-201612311159.log (on that date & time).
 #>
 
+#Requires -Version 7
 [CmdletBinding()][OutputType([void])] Param(
 <#
 Specifies a path to the items being removed. Wildcards are permitted.
@@ -43,7 +44,6 @@ The parameter name ("-Path") is optional.
 )
 Process
 {
-	$name = Split-Path $Path -Leaf
-	$name = "$([IO.Path]::GetFileNameWithoutExtension($name))-$(Get-Date -Format yyyyMMddHHmmss)$([IO.Path]::GetExtension($name))"
+	$name = "$(Split-Path $Path -LeafBase)-$(Get-Date -Format yyyyMMddHHmmss)$(Split-Path $Path -Extension)"
 	Copy-Item $Path (Resolve-Path $Path |Split-Path |Join-Path -ChildPath $name)
 }

Backup-SchTasks.ps1

@@ -39,7 +39,7 @@ Saves scheduled tasks to tasks-backup.xml using tasks.css as a display styleshee
 '<?xml version="1.0"?>' |Out-File $Path -Encoding utf8
 if($Stylesheet)
 {
-	"<?xml-stylesheet href=`"$Stylesheet`" type=`"text/$([io.path]::GetExtension($Stylesheet).Trim('.'))`"?>" |
+	"<?xml-stylesheet href=`"$Stylesheet`" type=`"text/$((Split-Path $Stylesheet -Extension).Trim('.'))`"?>" |
 		Out-File $Path -Encoding utf8 -Append
 }
 schtasks /query /xml |

Convert-Xml.ps1

@@ -77,7 +77,7 @@ Process
 	}
 	else
 	{
-		$absOutFile = [IO.Path]::Combine($PWD,$OutFile)
+		$absOutFile = Join-Path "$PWD" $OutFile
 		if((Test-Path $absOutFile) -and
 			!$PSCmdlet.ShouldContinue("$(Get-Item $absOutFile |Select-Object FullName,LastWriteTime,Length)","Overwrite File?"))
 		{Write-Warning "Skipping transform from $absPath to $OutFile"; return}

ConvertTo-SafeEntities.ps1

@@ -39,19 +39,4 @@ the 7-bit ASCII range.
 #>
 [Parameter(Position=0,Mandatory=$true,ValueFromPipeline=$true)][string] $InputObject
 )
-Process
-{
-	[char[]] $chars =
-		for ($i = 0; $i -lt $InputObject.Length; $i++)
-		{
-			[int] $c = [char]$InputObject[$i]
-			Write-Verbose "$i : $c"
-			if([char]::IsSurrogatePair($InputObject,$i))
-			{ ('&#x{0:X};' -f [char]::ConvertToUtf32($InputObject,$i++)).GetEnumerator() }
-			elseif(0x7F -lt $c)
-			{ ('&#x{0:X};' -f $c).GetEnumerator() }
-			else
-			{ [char]$c }
-		}
-	New-Object String $chars,0,$chars.Length
-}
+Process {return [Text.Encodings.Web.HtmlEncoder]::Default.Encode($InputObject)}

Export-Readme.ps1

@@ -6,7 +6,7 @@ Generate README.md file for the scripts repo.
 https://www.microsoft.com/download/details.aspx?id=40760
 #>
 
-#Requires -Version 3
+#Requires -Version 7
 #Requires -Modules SqlServer
 [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseSingularNouns','',
 Justification='This script deals with lists, and this is a pretty questionable rule.')]
@@ -60,7 +60,7 @@ function Export-Dependencies($image)
 	Write-Progress 'Creating dependency image'
 	$gv = Join-Path $PSScriptRoot ([IO.Path]::ChangeExtension($image,'gv'))
 	Format-Dependencies |Out-File $gv -Encoding ascii -Width ([int]::MaxValue)
-	$ext = [IO.Path]::GetExtension($image).Trim('.')
+	$ext = (Split-Path $image -Extension).Trim('.')
 	dot "-T$ext" -o $PSScriptRoot\$image $gv
 	Remove-Item $gv
 	Write-Progress 'Creating dependency image' -Completed
@@ -448,7 +448,7 @@ function Export-PSScriptPages
 	Import-Module platyPS
 	Write-Progress 'Export PowerShell script help pages' 'Removing docs for old scripts'
 	Get-Item $PSScriptRoot\docs\*.ps1.md |
-		Where-Object {!(Test-Path "$PSScriptRoot\$([IO.Path]::GetFileNameWithoutExtension($_.Name))" -Type Leaf)} |
+		Where-Object {!(Test-Path "$PSScriptRoot\$(Split-Path $_.Name -LeafBase)" -Type Leaf)} |
 		Remove-Item
 	Write-Progress 'Export PowerShell script help pages' 'Updating script docs'
 	Update-MarkdownHelp $PSScriptRoot\docs\*.ps1.md -ErrorAction Ignore |Write-Verbose

Find-Lines.ps1

@@ -69,7 +69,7 @@ function ConvertTo-DateTimeOffset([Parameter(Position=0)][int] $UnixTime,[Parame
 $culturetextinfo = (Get-Culture).TextInfo
 function Get-LineBlameInfo([Parameter(Position=0)][string] $Path,[Parameter(Position=1)][int] $LineNumber)
 {
-    Push-Location "$([IO.Path]::GetDirectoryName($Path))"
+    Split-Path $Path |Push-Location
     $lineinfo = [Collections.Generic.List[string]]@(git blame -l -p -L "$LineNumber,$LineNumber" -- $Path)
     Pop-Location
     ($sha1,$linetext) = ($lineinfo[0],$lineinfo[$lineinfo.Count -1])

Get-CommandPath.ps1

@@ -46,7 +46,7 @@ Process
     if($FindAllInPath)
     {
         $files =
-            if([io.path]::GetExtension($ApplicationName)) {$ApplicationName}
+            if((Split-Path $ApplicationName -Extension)) {$ApplicationName}
             else {$env:PATHEXT.ToLower() -split ';' |ForEach-Object {[io.path]::ChangeExtension($ApplicationName,$_)}}
         Write-Verbose "Searching Path for $($files -join ', ')"
         foreach($p in $env:Path -split ';')

Get-NuGetConfigs.ps1

@@ -28,7 +28,7 @@ C:\ProgramData\NuGet\NuGetDefaults.config
 
 function Get-Parent([Parameter(Position=0)][string] $Directory)
 {
-	if($Directory -eq [io.path]::GetPathRoot($Directory)) {$Directory}
+	if($Directory -eq "$(Join-Path (Split-Path $Directory -Qualifier) '')") {$Directory}
 	else {$Directory; Get-Parent (Split-Path $Directory)}
 }
 

Get-RepoName.ps1

@@ -31,7 +31,7 @@ Process
         if(!$?) {Stop-ThrowError.ps1 "The path $Path is not a git repo."-Argument Path}
         $remote = git remote |Select-Object -First 1
         if($remote) {return ([uri](git remote get-url $remote)).Segments[-1] -replace '\.git\z',''}
-        else {return [io.path]::GetFileName($Path)}
+        else {return Split-Path $Path -Leaf}
     }
     finally {Pop-Location}
 }

Import-VsCodeDatabaseConnections.ps1

@@ -20,9 +20,6 @@ Add-VsCodeDatabaseConnection.ps1
 .LINK
 Get-ConfigConnectionStringBuilders.ps1
 
-.LINK
-Split-FileName.ps1
-
 .LINK
 Import-Variables.ps1
 
@@ -45,7 +42,7 @@ function Get-ConfigConnections
 	{
 		foreach($cs in (Get-ConfigConnectionStringBuilders.ps1 $config))
 		{
-			$name = $cs.Name + '.' + ($config |Split-FileName.ps1 |Split-FileName.ps1 -Extension).Trim('.')
+			$name = $cs.Name + '.' + ($config |Split-Path -LeafBase |Split-Path -Extension).Trim('.')
 			if($connections -and $name -in $connections.profileName){Write-Verbose "A '$name' connection already exists."; continue}
 			Import-Variables.ps1 $cs.ConnectionString
 			$vsconn = @{

Join-FileName.ps1

@@ -42,8 +42,8 @@ Process
 	if($AppendText -like '.*') { [IO.Path]::ChangeExtension($Path,$AppendText) }
 	else
 	{
-		$name = [IO.Path]::GetFileNameWithoutExtension($Path) + $AppendText;
-		if($AppendText -notlike '*.*'){$name+=[IO.Path]::GetExtension($Path)}
+		$name = (Split-Path $Path -LeafBase) + $AppendText
+		if($AppendText -notlike '*.*'){ $name += Split-Path $Path -Extension }
 		if(Split-Path $Path) { Join-Path (Split-Path $Path) $name }
 		else { $name }
 	}

New-PesterTests.ps1

@@ -92,7 +92,7 @@ $('"@')
 		[Parameter(Mandatory=$true,ValueFromPipelineByPropertyName=$true)][string] $Synopsis,
 		[Parameter(Mandatory=$true,ValueFromPipelineByPropertyName=$true)][psobject[]] $Examples
 		)
-		$shortname = [io.path]::GetFileNameWithoutExtension($Name)
+		$shortname = Split-Path $Name -LeafBase
 		$Local:OFS = $NL
 		return @"
 <#

New-Shortcut.ps1

@@ -47,7 +47,7 @@ $sh = New-Object -ComObject WScript.Shell
 $folder = Split-Path ([IO.Path]::GetFullPath($Path))
 # the old WshShortcut COM component doesn't support Unicode
 $file = [Net.WebUtility]::UrlEncode((Split-Path $Path -Leaf))
-if(![IO.Path]::HasExtension($file)) {$file += if([uri]::IsWellFormedUriString($TargetPath,'Absolute')){'.url'}else{'.lnk'}}
+if(!(Split-Path $file -Extension)) {$file += if([uri]::IsWellFormedUriString($TargetPath,'Absolute')){'.url'}else{'.lnk'}}
 $fullname = Join-Path $folder $file
 $lnk = $sh.CreateShortcut($fullname)
 $lnk.TargetPath = $TargetPath

PS5/Convert-ScheduledTasksToJobs.ps1

@@ -250,8 +250,8 @@ $CommandParam = @'
             $workdir,$filepath = $a.WorkingDirectory,$Matches.FilePath.Trim('"')
             Write-Verbose "Converting '$($Task.TaskName)' as a PowerShell file task ($filePath; $workdir)."
             $file =
-                if([io.path]::IsPathRooted($filepath)) {$filepath}
-                else { [io.path]::Combine($workdir,$filepath) }
+                if([io.path]::IsPathRooted($filepath)) { $filepath }
+                else { Join-Path $workdir $filepath }
             Convert-ScheduledTaskToJob $Task $file $Matches.Params
         }
         elseif($a.Arguments -match $CommandParam)

Split-FileName.ps1 renamed to PS5/Split-FileName.ps1

@@ -1,55 +1,55 @@
-<#
-.SYNOPSIS
-Returns the specified part of the filename.
-
-.DESCRIPTION
-Split-FileName returns only the specified part of a filename:
-either the filename without extension (default) or extension.
-It can also tell whether the filename has an extension.
-
-.INPUTS
-System.String file path to parse.
-
-.OUTPUTS
-System.String containing the base file name (or extension),
-or System.Boolean if the -HasAttribute switch is present.
-
-.FUNCTIONALITY
-Files
-
-.EXAMPLE
-Split-FileName.ps1 readme.txt
-
-readme
-
-.EXAMPLE
-Split-FileName.ps1 readme.txt -Extension
-
-․txt
-(the leading . is included, but can't be entered as such in this example)
-
-.EXAMPLE
-Split-FileName.ps1 readme.txt -HasExtension
-
-True
-#>
-
-[CmdletBinding(DefaultParameterSetName='__AllParameterSets')]
-[OutputType([string],ParameterSetName='__AllParameterSets')]
-[OutputType([bool],ParameterSetName='HasExtension')] Param(
-# A file path to extract a part of; the base name without extension by default.
-[Parameter(Position=0,Mandatory=$true,ValueFromPipeline=$true)][string] $Path,
-<#
-Indicates that the path should be checked for the presence of an extension,
-returning a boolean value.
-#>
-[Parameter(ParameterSetName='HasExtension')][switch] $HasExtension,
-# Indicates the path's extension should be returned.
-[Parameter(ParameterSetName='Extension')][switch] $Extension
-)
-Process
-{
-	if($HasExtension) { [IO.Path]::HasExtension($Path) }
-	elseif($Extension) { [IO.Path]::GetExtension($Path) }
-	else { [IO.Path]::GetFileNameWithoutExtension($Path) }
-}
+<#
+.SYNOPSIS
+Returns the specified part of the filename.
+
+.DESCRIPTION
+Split-FileName returns only the specified part of a filename:
+either the filename without extension (default) or extension.
+It can also tell whether the filename has an extension.
+
+.INPUTS
+System.String file path to parse.
+
+.OUTPUTS
+System.String containing the base file name (or extension),
+or System.Boolean if the -HasAttribute switch is present.
+
+.FUNCTIONALITY
+Files
+
+.EXAMPLE
+Split-FileName.ps1 readme.txt
+
+readme
+
+.EXAMPLE
+Split-FileName.ps1 readme.txt -Extension
+
+․txt
+(the leading . is included, but can't be entered as such in this example)
+
+.EXAMPLE
+Split-FileName.ps1 readme.txt -HasExtension
+
+True
+#>
+
+[CmdletBinding(DefaultParameterSetName='__AllParameterSets')]
+[OutputType([string],ParameterSetName='__AllParameterSets')]
+[OutputType([bool],ParameterSetName='HasExtension')] Param(
+# A file path to extract a part of; the base name without extension by default.
+[Parameter(Position=0,Mandatory=$true,ValueFromPipeline=$true)][string] $Path,
+<#
+Indicates that the path should be checked for the presence of an extension,
+returning a boolean value.
+#>
+[Parameter(ParameterSetName='HasExtension')][switch] $HasExtension,
+# Indicates the path's extension should be returned.
+[Parameter(ParameterSetName='Extension')][switch] $Extension
+)
+Process
+{
+	if($HasExtension) { [IO.Path]::HasExtension($Path) }
+	elseif($Extension) { [IO.Path]::GetExtension($Path) }
+	else { [IO.Path]::GetFileNameWithoutExtension($Path) }
+}

Rename-Script.ps1

@@ -42,7 +42,7 @@ Write-Progress "Renaming $OldName to $NewName" -Completed
 Write-Progress "Updating uses of $OldName to $NewName" 'Finding uses'
 $scope = $ScriptDirectory |ForEach-Object {"$_\*.ps1"}
 [Microsoft.PowerShell.Commands.MatchInfo[]] $uses =
-	@(Select-String "\b$([regex]::Escape([io.path]::GetFileNameWithoutExtension($OldName)))(?:\.ps1)?\b" $scope -List)
+	@(Select-String "\b$([regex]::Escape((Split-Path $OldName -LeafBase)))(?:\.ps1)?\b" $scope -List)
 if($uses.Length -eq 0)
 {
 	Write-Warning "No uses of $OldName found!"

Save-PodcastEpisodes.ps1

@@ -54,7 +54,7 @@ Process
 		{
 			$filename = if($episode.PSObject.Properties.Match('episode')) {$episode.episode + ' '} else {''}
 			$filename += $title -replace $invalidchars,'_'
-			$filename += [io.path]::GetExtension($episode.enclosure.url)
+			$filename += Split-Uri.ps1 $episode.enclosure.url -Extension
 			Invoke-WebRequest $episode.enclosure.url -OutFile $filename
 			(Get-Item $filename).CreationTime = $episode.published
 		}

Save-WebRequest.ps1

@@ -37,7 +37,8 @@ Saves f1040.pdf (or else a filename specified in the Content-Disposition header)
 
 [CmdletBinding()][OutputType([void])] Param(
 # The URL to download.
-[Parameter(Position=0,Mandatory=$true,ValueFromPipelineByPropertyName=$true)][Alias('Url')][uri] $Uri,
+[Parameter(Position=0,Mandatory=$true,ValueFromPipeline=$true,ValueFromPipelineByPropertyName=$true)]
+[Alias('Url','Href','Src')][uri] $Uri,
 # Sets the creation time on the file to the given value.
 [datetime] $CreationTime,
 # Sets the creation time on the file to the given value.

Update-Files.ps1

@@ -28,7 +28,7 @@ Process
 {
     foreach($file in Resolve-Path $Path)
     {
-        $destfile = Join-Path $Destination ([IO.Path]::GetFileName($file))
+        $destfile = Join-Path $Destination (Split-Path $file -Leaf)
         if(!(Test-Path $destfile -PathType Leaf)) {continue}
         if((!$NewerOnly -or (Test-NewerFile.ps1 "$destfile" "$file")) -and
             $PSCmdlet.ShouldProcess("'$file' over '$destfile'",'copy'))

Use-Command.ps1

@@ -259,7 +259,7 @@ switch($PSCmdlet.ParameterSetName)
 		$dir = Split-Path $Path
 		if($PSCmdlet.ShouldProcess("$DownloadZip to $dir",'download/unzip'))
 		{
-			$filename = [IO.Path]::GetFileName($DownloadZip.LocalPath)
+			$filename = Split-Uri.ps1 $DownloadZip.LocalPath -Leaf
 			if (!(Test-Path $dir -PathType Container)) { mkdir $dir |Out-Null }
 			$zippath = Join-Path $env:TEMP $filename
 			Write-Verbose "Downloading $DownloadZip to $path"