chore: Remove module function that just displayed module description.

feat: Add proper help to module function.
test: Update tests to test the module function for creating new repos.
docs: Remove completed TODOs from ReadMe

Author: deadlydog

ReadMe.md

@@ -108,18 +108,17 @@ Buy me a hot apple cider for providing this template open source and for free 
 
 Things to still do:
 
+- Allow using a custom PowerShell Gallery feed URL.
 - Create new deployment on tag creation maybe
 - Add instructions for how to assign version number in the contributing docs depending on if they are using actions or pipelines
 - Prompt user for module name, org name, pipelines or actions, PowerShell gallery or custom feed with an option to leave it blank to - fill it in later
-- Show instructions for granting GitHub permissions etc. during the prompt script
-- Rename function to Get-TemplateDescription or similar and have it explain the module and a link to it.
 - Make azure DevOps and GitHub steps in the ReadMe collapsible.
   Have screenshots and link to recording of the setup in both, since they involve clicking around in the UI.
   Perhaps link to [this tutorial](https://dev.to/olalekan_oladiran_d74b7a6/how-to-enable-continuous-integration-with-azure-pipelines-1doi)?
 - In the ReadMe setup instructions or above, have a sentence or two explaining the layout of the ReadMe, or maybe a table of contents
 - Add some badges as well to the ReadMe.
 - Look at improving GitHub issue and PR templates: https://raw.githubusercontent.com/PowerShell/vscode-powershell/main/.github/ISSUE_TEMPLATE/bug-report.yml
-- Update the module to be able to create new repos without using GitHub template. Have a New-PowerShellScriptModuleRepository cmdlet
 - To prevent having to store CI/CD manual setup images in the repo, maybe have them as an external link to a GitHub branch.
   - Also create videos showing how to do the setup.
+- Maybe show instructions for setting up GitHub / Azure DevOps CI/CD during the initialization script. Or mention to follow the ReadMe instructions.
 - Add a simple PowerShell devcontainer for both this repo and the template.

deploy/Invoke-SmokeTests.ps1

@@ -13,9 +13,25 @@ BeforeAll {
 	# Import-Module "$PSScriptRoot\..\src\Template.PowerShell.ScriptModule" -Force
 }
 
-Describe 'Get-TemplateDescription' {
-	It 'Should return "Hello, World!"' {
-		$result = Get-TemplateDescription
-		$result | Should -Not -BeNullOrEmpty
+Describe 'New-PowerShellScriptModuleRepository' {
+	It 'Should create a new directory with the module repository files' {
+		# Arrange.
+		$repositoryDirectoryPath = "$TestDrive\NewModule"
+		$moduleName = 'NewModule'
+		$organizationName = 'My Organization'
+
+		$expectedModuleDirectoryPath = Join-Path -Path $repositoryDirectoryPath -ChildPath "src\$moduleName"
+		$expectedModuleFilePath = Join-Path -Path $expectedModuleDirectoryPath -ChildPath "$moduleName.psm1"
+		$expectedModuleManifestFilePath = Join-Path -Path $expectedModuleDirectoryPath -ChildPath "$moduleName.psd1"
+		$expectedModuleTestsFilePath = Join-Path -Path $expectedModuleDirectoryPath -ChildPath "$moduleName.Tests.ps1"
+
+		# Act.
+		New-PowerShellScriptModuleRepository -RepositoryDirectoryPath $repositoryDirectoryPath -ModuleName $moduleName -OrganizationName $organizationName
+
+		# Assert.
+		$expectedModuleDirectoryPath | Should -Exist
+		$expectedModuleFilePath | Should -Exist
+		$expectedModuleManifestFilePath | Should -Exist
+		$expectedModuleTestsFilePath | Should -Exist
 	}
 }

src/Template.PowerShell.ScriptModule/Template.PowerShell.ScriptModule.Tests.ps1

@@ -1,8 +1,24 @@
 using module './Template.PowerShell.ScriptModule.psm1'
 
-Describe 'Get-TemplateDescription' {
-	It 'Should return "Hello, World!"' {
-		$result = Get-TemplateDescription
-		$result | Should -Not -BeNullOrEmpty
+Describe 'New-PowerShellScriptModuleRepository' {
+	It 'Should create a new directory with the module repository files' {
+		# Arrange.
+		$repositoryDirectoryPath = "$TestDrive\NewModule"
+		$moduleName = 'NewModule'
+		$organizationName = 'My Organization'
+
+		$expectedModuleDirectoryPath = Join-Path -Path $repositoryDirectoryPath -ChildPath "src\$moduleName"
+		$expectedModuleFilePath = Join-Path -Path $expectedModuleDirectoryPath -ChildPath "$moduleName.psm1"
+		$expectedModuleManifestFilePath = Join-Path -Path $expectedModuleDirectoryPath -ChildPath "$moduleName.psd1"
+		$expectedModuleTestsFilePath = Join-Path -Path $expectedModuleDirectoryPath -ChildPath "$moduleName.Tests.ps1"
+
+		# Act.
+		New-PowerShellScriptModuleRepository -RepositoryDirectoryPath $repositoryDirectoryPath -ModuleName $moduleName -OrganizationName $organizationName
+
+		# Assert.
+		$expectedModuleDirectoryPath | Should -Exist
+		$expectedModuleFilePath | Should -Exist
+		$expectedModuleManifestFilePath | Should -Exist
+		$expectedModuleTestsFilePath | Should -Exist
 	}
 }

src/Template.PowerShell.ScriptModule/Template.PowerShell.ScriptModule.psd1

@@ -68,7 +68,6 @@ Checkout the template repository at https://github.com/deadlydog/Template.PowerS
 
   # Functions to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export.
   FunctionsToExport = @(
-    'Get-TemplateDescription'
     'New-PowerShellScriptModuleRepository'
   )
 

src/Template.PowerShell.ScriptModule/Template.PowerShell.ScriptModule.psm1

@@ -1,26 +1,45 @@
-# This is just example code. Run the _InitializeRepository.ps1 script to replace this file with your module.
-
-function Get-TemplateDescription
+function New-PowerShellScriptModuleRepository
 {
-	[CmdletBinding()]
-	Param ()
+<#
+	.SYNOPSIS
+		Creates a new PowerShell script module repository directory with boilerplate files and CI/CD workflows already defined.
 
-	[string] $description = @'
-This module is part of a template git repository that you can use to create new PowerShell script module repos quickly and easily with boilerplate files and CI/CD workflows already defined.
+	.DESCRIPTION
+		This function creates a new PowerShell script module repository with boilerplate files and CI/CD workflows already defined. This allows you to create new PowerShell script modules quickly and easily.
 
-For more information, visit the repository at https://github.com/deadlydog/Template.PowerShell.ScriptModule.
-'@
+		Once the directory is created, you can run `git init` in it to initialize it as a git repository, and then push it to your own git server.
 
-	Write-Output $description
-}
+		You will then need to follow the instructions in the ReadMe.md file to finish setting up the repository.
 
-function New-PowerShellScriptModuleRepository
-{
+	.PARAMETER RepositoryDirectoryPath
+		The path to the new directory that should be created for the module repository.
+
+	.PARAMETER ModuleName
+		The name of the module to create.
+
+	.PARAMETER OrganizationName
+		The name of the individual or organization that owns the module.
+
+	.EXAMPLE
+		PS> New-PowerShellScriptModuleRepository -RepositoryDirectoryPath 'C:\MyNewModule' -ModuleName 'MyNewModule' -OrganizationName 'My Name'
+
+		Creates a new module repository at 'C:\MyNewModule' with the module name 'MyNewModule' and the organization name 'My Name'.
+
+	.INPUTS
+		None. You cannot pipe objects to New-PowerShellScriptModuleRepository.
+
+	.OUTPUTS
+		None. New-PowerShellScriptModuleRepository does not return any output.
+		It creates a new directory with the module repository files.
+
+	.LINK
+		https://github.com/deadlydog/Template.PowerShell.ScriptModule
+#>
 	[CmdletBinding()]
 	[Alias('New-PSRepository')]
 	Param
 	(
-		[Parameter(Mandatory = $true, HelpMessage = "The path to the directory where the module repository should be created.")]
+		[Parameter(Mandatory = $true, HelpMessage = "The path to the new directory that should be created for the module repository.")]
 		[ValidateNotNullOrEmpty()]
 		[string] $RepositoryDirectoryPath,