| external help file | Module Name | online version | schema |
|---|---|---|---|
PSFunctionInfo-help.xml |
PSFunctionInfo |
2.0.0 |
Open a source file in your preferred editor.
Edit-PSFunctionInfo [-Name] <String> [-Editor <String>] [<CommonParameters>]Edit-PSFunctionInfo [-Source <String>] [[-Name] <String>] [-Editor <String>] [<CommonParameters>]You can use Edit-PSFunctionInfo to open the source file for a given function with PSFunctionInfo metadata. You can either specify a loaded function by name, or pipe a Get-PSFunctionInfo expression to Edit-PSFunctionInfo. Once the function is opened in the editor, you will need to navigate to the function itself.
The editor choices are VS Code, PowerShell ISE, or Notepad. Of course they are also dependent on your operating system and if you have installed it.
PS C:\> Edit-PSFunctionInfo -name Set-Title -editor iseOpen the source file for the Set-Title function and open in the PowerShell ISE. This assumes the Set-Title function is currently loaded into your PowerShell session.
PS C:\> Get-PSFunctionInfo *git* | Edit-PSFunctionInfoGet all functions with git in the name and edit them with the default editor.
Specify the editor you want to use. On non-Windows systems enter the value in lower case.
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: code, ise, notepad
Required: False
Position: Named
Default value: code
Accept pipeline input: False
Accept wildcard characters: FalseThe name of a loaded function, presumably with PSFunctionInfo metadata.
Type: String
Parameter Sets: name
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseType: String
Parameter Sets: source
Aliases:
Required: False
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecify the path to the source file.
Type: String
Parameter Sets: source
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
This command has an alias of epfi.
Learn more about PowerShell: https://jdhitsolutions.com/yourls/newsletter