VSCodeBackup.psm1
|
Write-Verbose 'Importing from [C:\MyProjects\VSCodeBackup\VSCodeBackup\private]' # .\VSCodeBackup\private\Close-Application.ps1 function Close-Application { [CmdletBinding()] param ( [Parameter(Mandatory)] [string]$ApplicationName, [Parameter()] $TimeOut = 60 ) begin { } process { $Timeout = New-TimeSpan -Seconds $TimeOut $StopWatch = [diagnostics.stopwatch]::StartNew() while ($true -and ($StopWatch.elapsed -lt $Timeout)) { Try { $ApplicationRunning = Get-Process $ApplicationName -ErrorAction Stop } Catch [Microsoft.PowerShell.Commands.ProcessCommandException] { break; } if ($ApplicationRunning) { if ($PSVersionTable.Platform -notlike "*Unix*") { $ApplicationRunning.CloseMainWindow() | Out-Null } elseif ($PSVersionTable.Platform -notlike "*Windows*") { $ApplicationRunning | Stop-Process -Force } else { Write-Error "Could not determine platform" } } else { break } Start-Sleep -m 500 } if ($null -ne (Get-Process $ApplicationName -ErrorAction SilentlyContinue)) { Write-Error "Could not close $($ApplicationName)" } } end { if ($StopWatch.IsRunning) { $StopWatch.Stop() } } } # .\VSCodeBackup\private\Get-CodeDirectory.ps1 function Get-CodeDirectory { <#Settings file locations By default VS Code shows the Settings editor, but you can still edit the underlying settings.json file by using the Open Settings (JSON) command or by changing your default settings editor with the workbench.settings.editor setting. Depending on your platform, the user settings file is located here: Windows %APPDATA%\Code\User\settings.json macOS $HOME/Library/Application Support/Code/User/settings.json Linux $HOME/.config/Code/User/settings.json #> [CmdletBinding()] param ( ) begin { } process { if ($PSVersionTable.PSVersion.Major -ge 6) { if ($PSVersionTable.OS -like "*linux*") { $ExtensionsDirectory = "$HOME/.vscode" | Resolve-Path $SettingsDirectory = "$HOME/.config/Code/User" | Resolve-Path $SettingsFile = "$SettingsDirectory/settings.json" } elseif ($PSVersionTable.OS -like "*mac*") { $ExtensionsDirectory = "$HOME/.vscode" | Resolve-Path $SettingsDirectory = "$HOME/Library/Application Support/Code/User" | Resolve-Path $SettingsFile = "$SettingsDirectory/settings.json" } elseif ($PSVersionTable.OS -like "*windows*") { $ExtensionsDirectory = "$env:USERPROFILE\.vscode" | Resolve-Path $SettingsDirectory = "$env:APPDATA\Code\User" | Resolve-Path $SettingsFile = "$SettingsDirectory\settings.json" } } else { $ExtensionsDirectory = "$env:USERPROFILE\.vscode" | Resolve-Path $SettingsDirectory = "$env:APPDATA\Code\User" | Resolve-Path $SettingsFile = "$SettingsDirectory\settings.json" } [PSCustomObject]@{ ExtensionsDirectory = $ExtensionsDirectory SettingsDirectory = $SettingsDirectory SettingsFile = $SettingsFile } } end { } } # .\VSCodeBackup\private\Test-AdminElevation.ps1 function Test-AdminElevation { [CmdletBinding()] param ( ) begin { } process { $user = [Security.Principal.WindowsIdentity]::GetCurrent(); (New-Object Security.Principal.WindowsPrincipal $user).IsInRole([Security.Principal.WindowsBuiltinRole]::Administrator) } end { } } Write-Verbose 'Importing from [C:\MyProjects\VSCodeBackup\VSCodeBackup\public]' # .\VSCodeBackup\public\Backup-VSCode.ps1 function Backup-VSCode { <# .SYNOPSIS Backup VS Code settings and extensions .DESCRIPTION Backup VS Code settings and extensions .PARAMETER Path Location to store zip file .PARAMETER Settings Switch to backup settings .PARAMETER Extensions Switch to backup extensions .EXAMPLE Backup-VSCode -Path c:\Users\bobby\Desktop -Settings -Extensions .NOTES General notes #> [CmdletBinding()] param ( # Parameter help description [Parameter(Mandatory)] [ValidateScript( { Test-Path -Path $_ })] [string] $Path, # Parameter help description [Parameter()] [switch] $Settings, # Parameter help description [Parameter()] [switch] $Extensions ) begin { $TimeStamp = Get-Date -Format o | ForEach-Object { $_ -replace ":", "." } $Name = "VSCode-$($TimeStamp).zip" $Path = Resolve-Path -Path $Path } process { #Can't read some files while Code is running try { Close-Application -ApplicationName "code" } catch { $_ } $StartTime = Get-Date -Format o $CodeDir = Get-CodeDirectory if ($Extensions.IsPresent) { try { Compress-Archive -Path $CodeDir.ExtensionsDirectory -DestinationPath $Path\$Name -Update -CompressionLevel NoCompression } catch { throw $_ } } if ($Settings.IsPresent) { if ($CodeDir.SettingsFile) { try { Compress-Archive -LiteralPath $CodeDir.SettingsFile -DestinationPath $Path\$Name -Update -CompressionLevel NoCompression } catch { throw $_ } } else { Write-Error "Settings file is missing, skipping backup" } } $EndTime = Get-Date -Format o $ElapsedTime = New-TimeSpan -Start $StartTime -End $EndTime $ZippedSize = if (Test-Path "$Path\$Name") { [string]([math]::Round((Get-ChildItem $Path\$Name).Length / 1mb)) + "MB" }else { $null } if ($Extensions.IsPresent -or $Settings.IsPresent) { [PSCustomObject]@{ FileName = [string]$Name FilePath = [string]$Path StartTime = [datetime]$StartTime Duration = $ElapsedTime -replace '\.\d+$' EndTime = [datetime]$EndTime Size = $ZippedSize } } else { Write-Warning -Message "Nothing to backup." } } end { } } # .\VSCodeBackup\public\Restore-VSCode.ps1 function Restore-VSCode { <# .SYNOPSIS Restore VS Code from a backup .DESCRIPTION Restore VS Code from a backup .PARAMETER Path Path to backup file .PARAMETER Settings Switch to restore settings .PARAMETER Extensions Switch to restore extensions .EXAMPLE Restore-VSCode -Path .\VSCode-2019-01-31T23.33.58.3351871+01.00.zip -Settings -Extensions .NOTES General notes #> [CmdletBinding(SupportsShouldProcess)] param ( # Path to zip file [Parameter(Mandatory)] [ValidateScript( { Test-Path -Path $_ })] [string] $Path, # Parameter help description [Parameter()] [switch] $Settings, # Parameter help description [Parameter()] [switch] $Extensions ) begin { $Path = Resolve-Path -Path $Path $TempPath = [system.io.path]::GetTempPath() $CodeDir = Get-CodeDirectory $CodeRunning = Get-Process -Name "code" -ErrorAction SilentlyContinue } process { if ($CodeRunning) { #Can't write some files while Code is running Write-Verbose "Closing VS Code" try { if ($Pscmdlet.ShouldProcess("VS Code", "Closing VS Code")) { Close-Application -ApplicationName "code" } } catch { $_ } } try { if ($Pscmdlet.ShouldProcess($TempPath, "Expanding VS Code archive to temp destination")) { Expand-Archive -Path $Path -DestinationPath $TempPath -force } } catch { throw $_ } if ($Extensions.IsPresent) { if ($Pscmdlet.ShouldProcess($CodeDir.ExtensionsDirectory, "Copying extensions to extenions folder")) { Copy-Item -Path "$TempPath\.vscode\extensions" -Destination $CodeDir.ExtensionsDirectory -Force -Recurse } } if ($Settings.IsPresent) { if ($Pscmdlet.ShouldProcess($CodeDir.SettingsFile, "Copying settings")) { Copy-Item -LiteralPath "$TempPath\settings.json" -Destination $CodeDir.SettingsFile -Force } } } end { } } Write-Verbose 'Importing from [C:\MyProjects\VSCodeBackup\VSCodeBackup\classes]' |