Skip to content

Latest commit

 

History

History
80 lines (51 loc) · 1.87 KB

Format-FunctionName.md

File metadata and controls

80 lines (51 loc) · 1.87 KB
external help file Module Name online version schema
PSFunctionTools-help.xml
PSFunctionTools
2.0.0

Format-FunctionName

SYNOPSIS

Format a function name to proper case.

SYNTAX

Format-FunctionName [[-Name] <String>] [<CommonParameters>]

DESCRIPTION

Format-FunctionName is intended to be used as a helper function in your scripting automation. This is a simple function that will format a verb-noun function name into proper case. It will take an input such as test-data and format it as Test-Data. It will not format as PascalCase. The command also will not verify that the verb component is acceptable. Use Test-FunctionName for that process.

EXAMPLES

Example 1

PS C:\> Format-FunctionName test-data
Test-Data

Format the lower-case command name to proper case.

Example 2

PS C:\> Format-FunctionName try-pssystem
Try-Pssystem

The command does not validate the verb nor can it produce a PascalCase result like Try-PsSystem.

PARAMETERS

-Name

What is the name of your function? It should follow the Verb-Noun naming convention. Although the verb will not be validated.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: byValue
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.

INPUTS

None

OUTPUTS

System.String

NOTES

Learn more about PowerShell: http://jdhitsolutions.com/blog/essential-powershell-resources/

RELATED LINKS

Test-FunctionName