Public/New-ScriptFromTemplate.ps1

function New-ScriptFromTemplate {
    <#
        .SYNOPSIS
        Create a new advanced function from a template.
 
        .DESCRIPTION
        This function creates a new function from a template and saves it to a file with the name of the function.
        It takes values for the function's synopsis, description, and alias as parameters and populates comment-
        based help for the new function automatically.
 
        .PARAMETER Name
        The name of the new function to create. It is recommended to use ApprovedVerb-Noun for names.
 
        .PARAMETER Synopsis
        A synopsis of the new function.
 
        .PARAMETER Description
        A description of the new function.
 
        .PARAMETER Alias
        Optionally define an alias for the new function.
 
        .PARAMETER Path
        The path of the directory to save the new script in.
 
        .PARAMETER SkipValidation
        Optionally skip validation of the script name. This will not check for use of approved verbs or restricted characters.
 
        .EXAMPLE
        New-ScriptFromTemplate -Name "Get-Demo" -Synopsis "Get a demo." -Description "This function gets a demo." -Alias "Get-Sample"
 
        .EXAMPLE
        New-ScriptFromTemplate -Verb Get -Noun Something
 
    #>


    [CmdletBinding()]
    [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseShouldProcessForStateChangingFunctions', '', Justification = 'OK')]
    [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidUsingWriteHost', '', Justification = 'Making it pretty.')]
    [Alias('New-Script')]
    param (
        # The name of the new function.
        [Parameter(Mandatory, ParameterSetName = 'Named')]
        [string]
        $Name,

        # The verb to use for the function name.
        [Parameter(Mandatory, ParameterSetName = 'VerbNoun')]
        [string]
        $Verb,

        # The noun to use for the function name.
        [Parameter(Mandatory, ParameterSetName = 'VerbNoun')]
        [string]
        $Noun,

        # Optionally skip name validation checks.
        [Parameter()]
        [switch]
        $SkipValidation,

        # Synopsis of the new function.
        [Parameter()]
        [string]
        $Synopsis,

        # Description of the new function.
        [Parameter()]
        [string]
        $Description,

        # Optional alias for the new function.
        [Parameter()]
        [string]
        $Alias,

        # Path of the directory to save the new function in.
        [Parameter()]
        [string]
        $Path
    )

    if ($PSBoundParameters.ContainsKey('Verb') -and -not $SkipValidation -and $Verb -notin (Get-Verb).Verb) {
        Write-Warning "`"$Verb`" is not an approved verb. Please run `"Get-Verb`" to see a list of approved verbs."
        break
    }

    if ($PSBoundParameters.ContainsKey('Verb') -and $PSBoundParameters.ContainsKey('Noun')) {
        $Name = "$Verb-$Noun"
        Write-Host "Name: $Name."
    }

    if ($PSBoundParameters.ContainsKey('Name') -and -not $SkipValidation -and
        $Name -match '\w-\w' -and $Name.Split('-')[0] -notin (Get-Verb).Verb ) {
        Write-Warning "It looks like you are not using an approved verb: `"$($Name.Split('-')[0]).`" Please run `"Get-Verb`" to see a list of approved verbs."
    }

    # Set the script path and filename. Use current directory if no path specified.
    if (Test-Path -Path $Path -PathType Container) {
        $ScriptPath = [System.IO.Path]::Combine($Path, "$Name.ps1")
    } else {
        $ScriptPath = ".\$Name.ps1"
    }

    # Create the function builder string builder and function body string.
    $FunctionBuilder = [System.Text.StringBuilder]::New()
    $FunctionBody = @'
function New-Function {
    <#
        .SYNOPSIS
        __SYNOPSIS__
 
        .DESCRIPTION
        __DESCRIPTION__
 
        .PARAMETER Parameter1
        __PARAMETER1__
 
        .PARAMETER Parameter2
        __PARAMETER2__
 
        .EXAMPLE
        __EXAMPLE__
 
        .NOTES
        Author: Sam Erde
        Version: 0.0.1
        Modified: __DATE__
    #>
 
    [CmdletBinding()]
    __ALIAS__
    param (
 
    )
 
    begin {
 
    } # end begin block
 
    process {
 
    } # end process block
 
    end {
 
    } # end end block
 
} # end function New-Function
'@


    # Replace template placeholders with strings from parameter inputs.
    $FunctionBody = $FunctionBody -Replace 'New-Function', $Name
    $FunctionBody = $FunctionBody -Replace '__SYNOPSIS__', $Synopsis
    $FunctionBody = $FunctionBody -Replace '__DESCRIPTION__', $Description
    $FunctionBody = $FunctionBody -Replace '__DATE__', (Get-Date -Format 'yyyy-MM-dd')
    # Set an alias for the new function if one is given in parameters.
    if ($PSBoundParameters.ContainsKey('Alias')) {
        $FunctionBody = $FunctionBody -Replace '__ALIAS__', "[Alias(`'$Alias`')]"
    } else {
        $FunctionBody = $FunctionBody -Replace '__ALIAS__', ''
    }

    # Create the new file.
    [void]$FunctionBuilder.Append($FunctionBody)
    $FunctionBuilder.ToString() | Out-File -FilePath $ScriptPath -Encoding utf8 -Force

} # end function New-ScriptFromTemplate