Skip to content

Commit 7fe0ae6

Browse files
committed
Use private function naming convention to avoid triggering PSScriptAnalyzer unnecessarily and to make private functions explicit
1 parent accd61a commit 7fe0ae6

File tree

2 files changed

+11
-13
lines changed

2 files changed

+11
-13
lines changed

_InitializeRepository.ps1

+4-6
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
# Run this script to setup the repository for your module.
22

33
[System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidUsingWriteHost', '')]
4-
[System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseShouldProcessForStateChangingFunctions', '')]
5-
[System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseSingularNouns', '')]
64
Param()
75

86
Process
@@ -17,15 +15,15 @@ If you have made changes to any files you may want to commit them before continu
1715
[string] $organizationName = Read-Host -Prompt "Enter your name, or the the name of your organization (e.g. 'My Company'). This will be used in the module manifest and repository license"
1816

1917
Write-Information "Removing all files from this repository so they can be replaced with template repository files."
20-
Remove-AllRepositoryFilesExceptTemplateModuleFiles -repositoryDirectoryPath $RepositoryDirectoryPath
18+
RemoveAllRepositoryFilesExceptTemplateModuleFiles -repositoryDirectoryPath $RepositoryDirectoryPath
2119

2220
Write-Information "Creating the template repository files."
2321
Import-Module -Name $TemplateModuleDirectoryPath -Force
2422
New-PowerShellScriptModuleRepository -RepositoryDirectoryPath $RepositoryDirectoryPath -ModuleName $moduleName -OrganizationName $organizationName
2523
Remove-Module -Name ScriptModuleRepositoryTemplate -Force
2624

2725
Write-Information "Removing the template module files since we are done using it to create the template repository files."
28-
Remove-TemplateModuleFiles -templateModuleDirectoryPath $TemplateModuleDirectoryPath
26+
RemoveTemplateModuleFiles -templateModuleDirectoryPath $TemplateModuleDirectoryPath
2927

3028
Write-Host -ForegroundColor Green "Repo initialization complete. You can now commit the changes to your repository."
3129
}
@@ -36,7 +34,7 @@ Begin
3634
[string] $RepositoryDirectoryPath = Resolve-Path -Path $PSScriptRoot
3735
[string] $TemplateModuleDirectoryPath = "$RepositoryDirectoryPath\src\ScriptModuleRepositoryTemplate"
3836

39-
function Remove-AllRepositoryFilesExceptTemplateModuleFiles([string] $repositoryDirectoryPath)
37+
function RemoveAllRepositoryFilesExceptTemplateModuleFiles([string] $repositoryDirectoryPath)
4038
{
4139
# Delete all files except the ones we want to keep.
4240
Get-ChildItem -Path $repositoryDirectoryPath -Recurse -File |
@@ -54,7 +52,7 @@ Begin
5452
Remove-Item -Force
5553
}
5654

57-
function Remove-TemplateModuleFiles([string] $templateModuleDirectoryPath)
55+
function RemoveTemplateModuleFiles([string] $templateModuleDirectoryPath)
5856
{
5957
if (Test-Path -Path $templateModuleDirectoryPath -PathType Container)
6058
{

src/ScriptModuleRepositoryTemplate/ScriptModuleRepositoryTemplate.psm1

+7-7
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ function New-PowerShellScriptModuleRepository
3535
.LINK
3636
https://github.com/deadlydog/PowerShell.ScriptModuleRepositoryTemplate
3737
#>
38-
[CmdletBinding(SupportsShouldProcess = $true)]
38+
[CmdletBinding(SupportsShouldProcess)]
3939
[Alias('New-PSRepository')]
4040
Param
4141
(
@@ -52,12 +52,12 @@ function New-PowerShellScriptModuleRepository
5252
[string] $OrganizationName
5353
)
5454

55-
Copy-TemplateFilesToRepositoryRoot -repositoryDirectoryPath $RepositoryDirectoryPath
56-
Set-ModuleFileNames -repositoryDirectoryPath $RepositoryDirectoryPath -moduleName $ModuleName
57-
Set-TemplateTokenValuesInAllRepositoryFiles -repositoryDirectoryPath $RepositoryDirectoryPath -moduleName $ModuleName -organizationName $OrganizationName
55+
CopyTemplateFilesToRepositoryRoot -repositoryDirectoryPath $RepositoryDirectoryPath
56+
SetModuleFileNames -repositoryDirectoryPath $RepositoryDirectoryPath -moduleName $ModuleName
57+
SetTemplateTokenValuesInAllRepositoryFiles -repositoryDirectoryPath $RepositoryDirectoryPath -moduleName $ModuleName -organizationName $OrganizationName
5858
}
5959

60-
function Copy-TemplateFilesToRepositoryRoot([string] $repositoryDirectoryPath)
60+
function CopyTemplateFilesToRepositoryRoot([string] $repositoryDirectoryPath)
6161
{
6262
if (-not (Test-Path -Path $repositoryDirectoryPath -PathType Container))
6363
{
@@ -72,7 +72,7 @@ function Copy-TemplateFilesToRepositoryRoot([string] $repositoryDirectoryPath)
7272
}
7373
}
7474

75-
function Set-ModuleFileNames([string] $repositoryDirectoryPath, [string] $moduleName)
75+
function SetModuleFileNames([string] $repositoryDirectoryPath, [string] $moduleName)
7676
{
7777
[string] $moduleDirectoryPath = "$repositoryDirectoryPath\src\__NewModuleName__"
7878
[string] $moduleFilePath = "$moduleDirectoryPath\__NewModuleName__.psm1"
@@ -101,7 +101,7 @@ function Set-ModuleFileNames([string] $repositoryDirectoryPath, [string] $module
101101
}
102102
}
103103

104-
function Set-TemplateTokenValuesInAllRepositoryFiles([string] $repositoryDirectoryPath, [string] $moduleName, [string] $organizationName)
104+
function SetTemplateTokenValuesInAllRepositoryFiles([string] $repositoryDirectoryPath, [string] $moduleName, [string] $organizationName)
105105
{
106106
$repositoryFiles = Get-ChildItem -Path $repositoryDirectoryPath -Recurse -File
107107
foreach ($file in $repositoryFiles)

0 commit comments

Comments
 (0)