<#

.SYNOPSIS

Tell `uv` to store the Python virtual environment outside the project folder.

.DESCRIPTION

Write an .env file inside the project root folder with an environment variable

that tells `uv` to store the Python virtual environment under the $VenvRootFolder

defined below.

Placing the environment outside the project folder avoids synchronization issues

with Microsoft OneDrive, e.g. <https://github.com/astral-sh/uv/issues/7906>.

Errors if the .env file already exists.

.EXAMPLE

PS> .\scripts\Set-VenvOutsideProject.ps1

#>

Param (

# Where to put the Python virtual environment.

[string]$VenvRootFolder = "C:\venvs"

)

#Requires -Version 7.4

$ErrorActionPreference = "Stop"

$PSNativeCommandUseErrorActionPreference = $true

Import-Module -Name "$PSScriptRoot\Utils.psm1"

$VenvFolder = Join-Path $VenvRootFolder $(Get-ProjectName)

# uv accepts here only forward slashes as path separator.

$Setting = "UV_PROJECT_ENVIRONMENT=$VenvFolder".Replace("\", "/")

$EnvFilePath = Get-EnvFilePath

if (Test-Path $EnvFilePath -PathType Leaf) {

throw "$EnvFilePath already exists. Edit it by hand to include $Setting. Quitting."

}

else {

$Setting | Out-File $EnvFilePath

"Written $EnvFilePath" | Write-Host

}