PSVirtualEnv

0.3.0

Functions/Set-VirtualEnvLocation.ps1

# ===========================================================================
# Set-VirtualEnvLocation.ps1 ----------------------------------------------
# ===========================================================================

# validation --------------------------------------------------------------
# ---------------------------------------------------------------------------
Class ValidateVirtualEnv : System.Management.Automation.IValidateSetValuesGenerator {
    [String[]] GetValidValues() {
        return [String[]] ((Get-VirtualEnv | Select-Object -ExpandProperty Name)+ "")
    }
}

# function ----------------------------------------------------------------
# ---------------------------------------------------------------------------
function Set-VirtualEnvLocation {

    <#
    .SYNOPSIS
        Set the location of the predefined virtual environment directory.
 
    .DESCRIPTION
        Set the location of the predefined virtual environment directory. All available virtual environments can be accesed by autocompletion.
 
    .PARAMETER Name
 
    .EXAMPLE
        PS C:\> Set-VirtualEnvLocation
 
        PS C:\Users\User\PSVirtualEnv>
 
        -----------
        Description
        Set the location of the predefined virtual environment directory.
 
    .EXAMPLE
        PS C:\> cd-venv
 
        PS C:\Users\User\PSVirtualEnv>
 
        -----------
        Description
        Set the location of the predefined virtual environment directory with predefined alias of command.
 
    .EXAMPLE
        PS C:\> Set-VirtualEnvLocation -Name venv
 
        PS C:\Users\User\PSVirtualEnv\venv>
 
        -----------
        Description
        Set the location of the specified virtual environment 'venv'. All available virtual environments can be accesed by autocompletion.
 
    .INPUTS
        None.
     
    .OUTPUTS
        None.
    #>

    [CmdletBinding(PositionalBinding=$True)]

    [OutputType([Void])]

    Param(
        [ValidateSet([ValidateVirtualEnv])]     
        [Parameter(Position=1, ValueFromPipeline=$True, HelpMessage="Name of virtual environment, which should be started.")]
        [System.String] $Name
    )

    Process{
        
        # set location of virtual env working directory
        $path = $PSVirtualEnv.WorkDir
        if ($Name) {
            $path = Get-VirtualEnvPath $Name
        }

        Set-Location -Path $path

    }
}