PSTemplateMaker.psm1
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 |
# # # PSTemplateMaker # # $ErrorActionPreference = 'Stop' Function New-PSModuleTemplate { <# .SYNOPSIS Create a new module template .DESCRIPTION Create a new module template and choose the type of structure, single or dynamic. Single means one module (psm1) containing all the functions, dynamic means dot-sourcing indvidual functions (ps1). .PARAMETER ModuleName The name of the new module .PARAMETER Path The location where the module (psm1) will be created .PARAMETER FunctionName The list of functions to be created .PARAMETER Dynamic Use this switch to create a dynamic module .EXAMPLE New-PSModuleTemplate -ModuleName MyAwesomeModule -Path C:\MyPowershellProjects .EXAMPLE New-PSModuleTemplate -ModuleName MyAwesomeModule -Path C:\MyPowershellProjects -Dynamic .EXAMPLE New-PSModuleTemplate -ModuleName MyAwesomeModule -Path C:\MyPowershellProjects -FunctionName Get-MyInfo, Set-MyInfo, Update-MyInfo .EXAMPLE New-PSModuleTemplate -ModuleName MyAwesomeModule -Path C:\MyPowershellProjects -FunctionName Get-MyInfo, Set-MyInfo, Update-MyInfo -Dynamic .NOTES - If a list of functions is entered, these will be added to the body of the module but if the -Dynamic switch is used then individual scripts will be created in the 'Scripts' directory - This cmdlet will also create a basic module manifest (psd1) .LINK N/A #> [CmdletBinding ()] Param ( [Parameter (Mandatory = $True, ValueFromPipeline = $False, ValueFromPipelineByPropertyName = $False, HelpMessage = 'Enter module name' ) ] [String]$ModuleName, [Parameter (Mandatory = $True, ValueFromPipeline = $False, ValueFromPipelineByPropertyName = $False, HelpMessage = 'Enter module path' ) ] [String]$Path, [Parameter (Mandatory = $False, ValueFromPipeline = $False, ValueFromPipelineByPropertyName = $False, HelpMessage = 'Enter function name' ) ] [String[]]$FunctionName, [Switch]$Dynamic ) BEGIN { [String]$ModuleDynamicTemplate = @(' # # # [NAME] module description # # $ErrorActionPreference = ''Stop'' # Get all the scripts $ScriptsPath = Get-ChildItem -Path $PSScriptRoot\Scripts\*.ps1 # Dot-source the scripts ForEach ($Script In $ScriptsPath) { . $Script.FullName }' ) [String]$ModuleSingleTemplate = @(' # # # [NAME] module description # # $ErrorActionPreference = ''Stop'' # # Module functions # ' ) [String]$FunctionTemplate = @(' Function [NAME] { <# .SYNOPSIS .DESCRIPTION .PARAMETER .EXAMPLE .NOTES .LINK #> [CmdletBinding ()] Param () BEGIN {} PROCESS {} END {} }' ) } PROCESS { If ((Test-Path $Path\$ModuleName) -eq $False) { $FunctionToExport = @() Write-Verbose -Message "Created $ModuleName module directory" New-Item -Path $Path\$ModuleName -ItemType Directory | Out-Null If ($Dynamic) { Write-Verbose -Message "Created Scripts directory" New-Item -Path $Path\$ModuleName\Scripts -ItemType Directory | Out-Null If ($FunctionName) { ForEach ($Function In $FunctionName) { Write-Verbose -Message "Created script template $Function" $TempCode = $FunctionTemplate.Replace('[NAME]', $Function) Set-Content -Path $Path\$ModuleName\Scripts\$Function.ps1 -Value $TempCode $FunctionToExport += $Function } } Write-Verbose -Message "Created $ModuleName module template" $TempCode = $ModuleDynamicTemplate.Replace('[NAME]', $ModuleName) Set-Content -Path $Path\$ModuleName\$ModuleName.psm1 -Value $TempCode } Else { If ($FunctionName) { $TempCode = @() ForEach ($Function In $FunctionName) { Write-Verbose -Message "Added function template $Function to module $ModuleName" $TempCode += $FunctionTemplate.Replace('[NAME]', $Function) + "`r`n" $FunctionToExport += $Function } } Write-Verbose -Message "Created $ModuleName module template" $TempCode = $ModuleSingleTemplate.Replace('[NAME]', $ModuleName) + $TempCode Set-Content -Path $Path\$ModuleName\$ModuleName.psm1 -Value $TempCode } } Else { Write-Warning -Message "Module $ModuleName ($Path\$ModuleName) already exists" Break } } END { Write-Verbose -Message "Created $ModuleName module manifest" New-ModuleManifest -Path $Path\$ModuleName\$ModuleName.psd1 -RootModule $ModuleName'.psm1' -ModuleVersion 1.0.0 -FunctionsToExport $FunctionToExport -CmdletsToExport '' -AliasesToExport '' Write-Verbose -Message 'Creation complete' } } Function New-PSFunctionTemplate { <# .SYNOPSIS Create a new function template .DESCRIPTION Create a new function template (ps1) .PARAMETER FunctionName The name of the function .PARAMETER Path The location where the function (ps1) will be created .EXAMPLE New-PSFunctionTemplate -FunctionName Get-SomeStuff -Path C:\MyPowershellProjects\MyCoolModule .NOTES If you are creating a dynamic module the path for the functions must be 'Scripts' directory e.g: New-PSFunctionTemplate -FunctionName Get-SomeStuff -Path C:\MyPowershellProjects\MyCoolModule\Scripts .LINK N/A #> [CmdletBinding ()] Param ( [Parameter (Mandatory = $True, ValueFromPipeline = $False, ValueFromPipelineByPropertyName = $False, HelpMessage = 'Enter function name' ) ] [String[]]$FunctionName, [Parameter (Mandatory = $True, ValueFromPipeline = $False, ValueFromPipelineByPropertyName = $False, HelpMessage = 'Enter function path' ) ] [String]$Path ) BEGIN { [String]$FunctionTemplate = @(' Function [NAME] { <# .SYNOPSIS .DESCRIPTION .PARAMETER .EXAMPLE .NOTES .LINK #> [CmdletBinding ()] Param () BEGIN {} PROCESS {} END {} }' ) } PROCESS { ForEach ($Function In $FunctionName) { $FunctionPath = $Path + '\' + $Function + '.ps1' If ((Test-Path $FunctionPath) -eq $False) { $FunctionCode = $FunctionTemplate.Replace('[NAME]', $Function) Write-Verbose -Message "Created $FunctionPath template" Set-Content -Path $FunctionPath -Value $FunctionCode.Trim() } Else { Write-Warning -Message "Function $FunctionPath already exists" Break } } } END { Write-Verbose -Message 'Creation complete' } } |