fix: Prefix dot-files and dot-directories with an underscore so they are included in the module package, and remove the underscore prefix when copying files to a new repo

docs: Add info about dot-files underscore prefix workaround
test: Add tests to ensure underscore prefix is removed from dot-files and dot-directories

Author: deadlydog

docs/Contributing.md

@@ -23,6 +23,12 @@ If you want to increment the Major or Minor version number, you have 2 options:
    Builds are not triggered on tags, and thus the version tag will be used as the starting point for the next version.
    e.g. Creating a new tag of `v2.4.0` will produce a new version of `2.4.1` on the next commit to the `main` branch.
 
+## Why are the template dot-files filenames prefixed with an underscore?
+
+`Publish-Module` has a bug where it does not include any files or directories starting with `.` in the module NuGet package.
+The newer `Publish-PSResource` has fixed this issue somewhat so the directories and some of the files are included, but it still leaves out some dot-files, like the `.gitignore` and `.editorconfig` files.
+To work around these issues, we prefix the files with an underscore (e.g. `_.gitignore`) so that they are included in the module package, and then remove the underscore prefix during the file copy process of the `New-PowerShellScriptModuleRepository` cmdlet.
+
 ## ⁉ Why was a specific decision made
 
 Curious about some of the choices made in this project?

src/ScriptModuleRepositoryTemplate/ScriptModuleRepositoryTemplate.Tests.ps1

@@ -1,9 +1,16 @@
 using module './ScriptModuleRepositoryTemplate.psm1'
 
 Describe 'New-PowerShellScriptModuleRepository' {
-	It 'Should create a new directory with the module repository files' {
+	BeforeEach {
+		[string] $TemporaryRepoPath = "$TestDrive\NewModule"
+		if (Test-Path -Path $TemporaryRepoPath) {
+			Remove-Item -Path $TemporaryRepoPath -Recurse -Force
+		}
+	}
+
+	It 'Should create a new directory with the module repository files using the specified module name' {
 		# Arrange.
-		$repositoryDirectoryPath = "$TestDrive\NewModule"
+		$repositoryDirectoryPath = $TemporaryRepoPath
 		$moduleName = 'NewModule'
 		$organizationName = 'My Organization'
 
@@ -21,4 +28,30 @@ Describe 'New-PowerShellScriptModuleRepository' {
 		$expectedModuleManifestFilePath | Should -Exist
 		$expectedModuleTestsFilePath | Should -Exist
 	}
+
+	It 'Should replace all dot-files and directories prefixed with an underscore to remove the underscore' {
+		# Arrange.
+		$repositoryDirectoryPath = $TemporaryRepoPath
+		$moduleName = 'NewModule'
+		$organizationName = 'My Organization'
+
+		$expectedDotDirectoryPath = Join-Path -Path $repositoryDirectoryPath -ChildPath ".vscode"
+		$expectedDotFilePath = Join-Path -Path $repositoryDirectoryPath -ChildPath ".gitignore"
+
+		# Act.
+		New-PowerShellScriptModuleRepository -RepositoryDirectoryPath $repositoryDirectoryPath -ModuleName $moduleName -OrganizationName $organizationName
+
+		# Assert.
+
+		# No files should start with '_.'
+		$repoFilePaths = Get-ChildItem -Path $repositoryDirectoryPath -Recurse -Force
+		$repoFilePaths | ForEach-Object {
+			[string] $fileName = $_.Name
+			$fileName | Should -Not -Match '^_\.'
+		}
+
+		# Verify at least one Dot directory and file were renamed properly.
+		$expectedDotDirectoryPath | Should -Exist
+		$expectedDotFilePath | Should -Exist
+	}
 }

src/ScriptModuleRepositoryTemplate/ScriptModuleRepositoryTemplate.psm1

@@ -71,6 +71,16 @@ function CopyTemplateFilesToRepositoryRoot([string] $repositoryDirectoryPath)
 		Write-Verbose "Copying the template repository files from '$templateModuleDirectoryPath' to the repository directory '$repositoryDirectoryPath'."
 		Copy-Item -Path $templateModuleDirectoryPath\* -Destination $repositoryDirectoryPath -Recurse -Force
 	}
+
+	# Rename all dot-files prefixed with an underscore to remove the underscore.
+	# The underscore prefix is a workaround to a bug with Publish-Module and Publish-PSResource the excludes dot-files
+	# and dot-directories from being included in the module package.
+	$repoDotFiles = Get-ChildItem -Path $repositoryDirectoryPath -Recurse -Force -Filter '_.*'
+	$repoDotFiles | ForEach-Object {
+		[string] $filePath = $_.FullName
+		[string] $newFileName = $_.Name -replace '^_\.', '.'
+		Rename-Item -Path $filePath -NewName $newFileName -Force
+	}
 }
 
 function SetModuleFileNames([string] $repositoryDirectoryPath, [string] $moduleName)