Root/Add-QuickFunction.ps1
|
<#
.SYNOPSIS Adds a User-Defined function to a QuickModuleCLI submodule. .DESCRIPTION Adds a User-Defined function to a QuickModuleCLI submodule to later be used globally. Once the function is part of a QuickModuleCLI submodule, it will be imported every time you open a new PowerShell Session. .NOTES This function is intended to create a short function spanning only a few Semi-Colon delimited lines. Therefore, the function does not support multi-line strings. It is highly recommended that if your function is to be more complex, consider using "Add-QuickFunctionWithEditor" instead. .INPUTS None. You cannot pipe objects to Add-QuickFunction. .OUTPUTS None. Add-QuickFunction creates a new function that you can later use. .EXAMPLE PS> Add-QuickFunction Please enter the name of the new function: Write-Echo Please enter the Function: Write-Output (Read-Host "Are you my echo?") .EXAMPLE PS> Add-QuickFunction Write-Echo 'Please enter the Function: Write-Output (Read-Host "Are you my echo?")' .LINK https://github.com/EdLichtman/QuickModuleCLI #> function Add-QuickFunction { param( [Parameter(Mandatory=$true)] [string] #Specifies the name of the Module this functions should be added to. This helps keep a separation of #concern over which functions belong with which module behaviors. $NestedModule, [Parameter(Mandatory=$true)] [string] #Specifies the name of the new function $functionName, [string] #Specifies the content that should go in the function. Line breaks will automatically #be added after semi semicolons. If the -Raw flag is added after, #it will specify the content that should go in the newly-created file. $functionText, [Switch] #Specifies that the file text should contain the -functionText value as is, with no function shell #and no additional line breaks. $Raw ) Invoke-Expression ". '$PSScriptRoot\Reserved\Get-QuickEnvironment.ps1'" Invoke-Expression ". '$PrivateFunctionsFolder\New-FileWithContent.ps1'" Invoke-Expression ". '$FunctionsFolder\New-QuickModule.ps1'" Invoke-Expression ". '$FunctionsFolder\Update-QuickModule.ps1'" Invoke-Expression ". '$PrivateFunctionsFolder\Update-QuickModuleCLI'" if (Exit-AfterImport) { Test-ImportCompleted return; } $ApprovedVerbs = [System.Collections.Generic.HashSet[String]]::new(); (Get-Verb | Select-Object -Property Verb) | ForEach-Object {$ApprovedVerbs.Add($_.Verb)} | Out-Null; $chosenVerb = $functionName.Split('-')[0] if (!$ApprovedVerbs.Contains($chosenVerb)) { throw [System.ArgumentException] "$chosenVerb is not a common accepted verb. Please find an appropriate verb by using the command 'Get-Verb'." return; } if (!(Test-Path $NestedModulesFolder\$NestedModule)) { $Continue = $Host.UI.PromptForChoice("No Module by the name '$NestedModule' exists.", "Would you like to create a new one?", @('&Yes','&No'), 0) if ($Continue -eq 0) { New-QuickModule -NestedModule $NestedModule; } else { return; } } $newCode = $functionText $newFunctionText = "" if (!$Raw) { $NumberOfSingleQuotes = 0 $NumberOfDoubleQuotes = 0 foreach($character in [char[]]$functionText) { if ($character -eq "'") { $NumberOfSingleQuotes++ } if ($character -eq '"') { $NumberOfDoubleQuotes++ } if (($NumberOfDoubleQuotes % 2 -eq 0) -and ($NumberOfSingleQuotes % 2 -eq 0) -and ($character -eq ';')) { $newFunctionText += ";`r`n " } else { $newFunctionText += $character } } $newCode = @" function $FunctionName { $newFunctionText } "@ } New-FileWithContent -filePath "$NestedModulesFolder\$NestedModule\Functions\$FunctionName.ps1" -fileText $newCode if ([String]::IsNullOrWhiteSpace($newCode)) { powershell_ise.exe "$NestedModulesFolder\$NestedModule\Functions\$FunctionName.ps1" Write-Host -NoNewline -Object 'Press any key when you are finished editing...' -ForegroundColor Yellow $null = $Host.UI.RawUI.ReadKey('NoEcho,IncludeKeyDown') } Update-QuickModule -NestedModule $NestedModule Update-QuickModuleCLI Reset-QuickCommand -NestedModule $NestedModule -commandName $FunctionName } |