v1.2.0

Author: jdhitsolutions

ChangeLog.md

@@ -1,10 +1,19 @@
 # ChangeLog for PSFunctionInfo
 
+## 1.2.0
+
++ Added custom error messages to `ValidateScript()` parameter attributes.
++ Added a `NoSource` parameter to `New-PSFunctionInfo` to not include the source path.
++ Added `Set-PSFunctionInfo` and its alias `spfi`.
++ Added `Remove-PSFunctionInfo` and its alias `rpfi`.
++ Help updates.
++ Updated `README.md`.
+
 ## 1.1.0
 
 + Fixed DefaultDisplayPropertySet in types.ps1xml file.
 + Added online help links.
-+ Updated `README`.
++ Updated `README.md`.
 
 ## 1.0.0
 

PSFunctionInfo.psd1

@@ -189,5 +189,4 @@ This module was first described at <https://jdhitsolutions.com/blog/powershell/8
 ## Roadmap
 
 + Add function metadata by file, autodetecting the function name.
-+ Consider a bulk editing command.
 + Consider a bulk removal command to clean PSFunctionInfo metadata from files.

README.md

@@ -39,7 +39,7 @@ The editor choices are VS Code, PowerShell ISE, or Notepad. Of course they are a
 PS C:\> Edit-PSFunctionInfo -name Set-Title -editor ise
 ```
 
-Open the source file for the Set-Title function and open in the PowerShell ISE.
+Open 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.
 
 ### Example 2
 

docs/Edit-PSFunctionInfo.md

@@ -29,7 +29,7 @@ Get-PSFunctionInfo [-Path <String>] [-Tag <String>] [<CommonParameters>]
 
 Get-PSFunctionIfo will display function metadata that was created using New-PSFunctionInfo. The default behavior is to search loaded functions that don't belong to a module and display the custom function metadata.
 
-As an alternative to searching items in the Function: PSDrive, you can also search .ps1 files.
+As an alternative to searching items in the Function: PSDrive, you can also search .ps1 files. If you specify the path to a script file, you will get function metadata for every defined function in the file.
 
 ## EXAMPLES
 
@@ -179,6 +179,20 @@ LastUpdate  : 4/23/2021 9:21:00 AM
 
 The PSFunctionInfo object includes a PropertySet called AuthorInfo.
 
+### Example 8
+
+```powershell
+
+PS C:\> Get-PSFunctionInfo -Path C:\work\sample.ps1
+
+Name                      Version    Alias           Source
+----                      -------    -----           ------
+Get-EventlogInfo          1.0.0
+Test-EventLog             1.0.0                      C:\work\sample.ps1
+```
+
+Get function metadate for every function in the specified file.
+
 ## PARAMETERS
 
 ### -Tag
@@ -254,3 +268,5 @@ Learn more about PowerShell: http://jdhitsolutions.com/blog/essential-powershell
 [Get-PSFunctionInfoTag](Get-PSFunctionInfoTag.md)
 
 [Edit-PSFunctionInfo](Edit-PSFunctionInfo.md)
+
+[Set-PSFunctionInfo](Set-PSFunctionInfo.md)

docs/Get-PSFunctionInfo.md

@@ -298,3 +298,7 @@ Learn more about PowerShell: http://jdhitsolutions.com/blog/essential-powershell
 [Get-PSFunctionInfo](Get-PSFunctionInfo.md)
 
 [Edit-PSFunctionInfo](Edit-PSFunctionInfo.md)
+
+[Remove-PSFunctionInfo](Remove-PSFunctionInfo.md)
+
+[Set-PSFunctionInfo](Set-PSFunctionInfo.md)

docs/New-PSFunctionInfo.md

@@ -0,0 +1,129 @@
+---
+external help file: PSFunctionInfo-help.xml
+Module Name: PSFunctionInfo
+online version:
+schema: 2.0.0
+---
+
+# Remove-PSFunctionInfo
+
+## SYNOPSIS
+
+Remove PSFunctoinInfo metatdata.
+
+## SYNTAX
+
+```yaml
+Remove-PSFunctionInfo [-FunctionName] <String> -Path <String> [-WhatIf] [-Confirm] [<CommonParameters>]
+```
+
+## DESCRIPTION
+
+Use this function to remove the PSFunctionInfo metadata for a given function.
+
+## EXAMPLES
+
+### Example 1
+
+```powershell
+PS C:\> Remove-PSFunctionInfo Test-Eventlog -path c:\work\eventlogtools.ps1
+```
+
+Remove the entry for the given function.
+
+### Example 2
+
+```powershell
+PS C:\> Get-PSFunctioninfo -Path c:\work\tools.ps1 | Remove-PSFunctionInfo
+```
+
+Get PSFUnctionInfo for all functions from the specified file and remove them. This assumes that every function has a source value that reflects c:\work\tools.ps1. Otherwise, you could specify the Path parameter with Remove-PSFunctionInfo.
+
+## PARAMETERS
+
+### -Confirm
+
+Prompts you for confirmation before running the cmdlet.
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases: cf
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -FunctionName
+
+Specify the name of a function that doesn't belong to a module.
+
+```yaml
+Type: String
+Parameter Sets: (All)
+Aliases: Name
+
+Required: True
+Position: 0
+Default value: None
+Accept pipeline input: True (ByPropertyName)
+Accept wildcard characters: False
+```
+
+### -Path
+
+Specify the source .ps1 file for the function.
+
+```yaml
+Type: String
+Parameter Sets: (All)
+Aliases: fullname, source
+
+Required: True
+Position: Named
+Default value: None
+Accept pipeline input: True (ByPropertyName)
+Accept wildcard characters: False
+```
+
+### -WhatIf
+
+Shows what would happen if the cmdlet runs.
+The cmdlet is not run.
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases: wi
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### CommonParameters
+
+This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
+
+## INPUTS
+
+### System.String
+
+## OUTPUTS
+
+### None
+
+## NOTES
+
+Learn more about PowerShell: http://jdhitsolutions.com/blog/essential-powershell-resources/
+
+## RELATED LINKS
+
+[Set-PSFunctionInfo](Set-PSFunctionInfo.md)
+
+[Get-PSFunctionInfo](Get-PSFunctionInfo.md)