PSModule · Marius Storhaug (MariusStorhaug) · Mar 30, 2024 · Mar 30, 2024 · Mar 30, 2024 · Mar 30, 2024
@@ -0,0 +1,17 @@
+#Documentation: https://github.com/PowerShell/PSScriptAnalyzer/blob/master/docs/Cmdlets/Invoke-ScriptAnalyzer.md#-settings
+@{
+    #CustomRulePath='path\to\CustomRuleModule.psm1'
+    #RecurseCustomRulePath='path\of\customrules'
+    #Severity = @(
+    #    'Error'
+    #    'Warning'
+    #)
+    #IncludeDefaultRules=${true}
+    ExcludeRules = @(
+        'PSMissingModuleManifestField'
+    )
+    #IncludeRules = @(
+    #    'PSAvoidUsingWriteHost',
+    #    'MyCustomRuleName'
+    #)
+}
@@ -0,0 +1,16 @@
+Function Get-OtherPSModule {
+    <#
+        .SYNOPSIS
+        A brief description of the function
+
+        .EXAMPLE
+        Get-OtherPSModule -Name "World"
+    #>
+    [CmdletBinding()]
+    param(
+        # The name of the person to greet.
+        [Parameter(Mandatory)]
+        [string] $Name
+    )
+    Write-Output "Hello, $Name!"
+}
@@ -4,7 +4,7 @@
        Performs tests on a module.

        .EXAMPLE
-        Test-PSModule -Name 'World'
+        Get-InternalPSModule -Name 'World'

        "Hello, World!"
    #>

@@ -4,12 +4,12 @@
        Performs tests on a module.

        .EXAMPLE
-        Test-PSModule -Name 'World'
+        Set-InternalPSModule -Name 'World'

        "Hello, World!"
    #>
    [Diagnostics.CodeAnalysis.SuppressMessageAttribute(
-        'PSUseShouldProcessForStateChangingFunctions', '', Scope='Function',
+        'PSUseShouldProcessForStateChangingFunctions', '', Scope = 'Function',
        Justification = 'Reason for suppressing'
    )]
    [CmdletBinding()]

@@ -1,10 +1,10 @@
-Function Test-PSModule {
+Function Get-PSModuleTemplate {
    <#
        .SYNOPSIS
        Performs tests on a module.

        .EXAMPLE
-        Test-PSModule -Name 'World'
+        Get-PSModuleTemplate -Name 'World'

        "Hello, World!"
    #>

@@ -1,15 +1,15 @@
-Function Set-PSModule {
+Function New-PSModuleTemplate {
    <#
        .SYNOPSIS
        Performs tests on a module.

        .EXAMPLE
-        Test-PSModule -Name 'World'
+        New-PSModuleTemplate -Name 'World'

        "Hello, World!"
    #>
    [Diagnostics.CodeAnalysis.SuppressMessageAttribute(
-        'PSUseShouldProcessForStateChangingFunctions', '', Scope='Function',
+        'PSUseShouldProcessForStateChangingFunctions', '', Scope = 'Function',
        Justification = 'Reason for suppressing'
    )]
    [CmdletBinding()]

@@ -1,15 +1,15 @@
-Function New-PSModule {
+Function Set-PSModuleTemplate {
    <#
        .SYNOPSIS
        Performs tests on a module.

        .EXAMPLE
-        Test-PSModule -Name 'World'
+        Set-PSModuleTemplate -Name 'World'

        "Hello, World!"
    #>
    [Diagnostics.CodeAnalysis.SuppressMessageAttribute(
-        'PSUseShouldProcessForStateChangingFunctions', '', Scope='Function',
+        'PSUseShouldProcessForStateChangingFunctions', '', Scope = 'Function',
        Justification = 'Reason for suppressing'
    )]
    [CmdletBinding()]

@@ -1,10 +1,10 @@
-Function Get-PSModule {
+Function Test-PSModuleTemplate {
    <#
        .SYNOPSIS
        Performs tests on a module.

        .EXAMPLE
-        Test-PSModule -Name 'World'
+        Test-PSModuleTemplate -Name 'World'

        "Hello, World!"
    #>

@@ -0,0 +1,27 @@
+[CmdletBinding()]
+Param(
+    # Path to the module to test.
+    [Parameter()]
+    [string] $Path
+)
+
+Write-Verbose "Path to the module: [$Path]" -Verbose
+
+Describe 'PSModuleTemplate' {
+    Context 'Module' {
+        It 'The module should be available' {
+            Get-Module -Name 'PSModuleTemplate' -ListAvailable | Should -Not -BeNullOrEmpty
+            Write-Verbose (Get-Module -Name 'PSModuleTemplate' -ListAvailable | Out-String) -Verbose
+        }
+        It 'The module should be importable' {
+            { Import-Module -Name 'PSModuleTemplate' -Verbose -RequiredVersion 999.0.0 -Force } | Should -Not -Throw
+        }
+    }
+
+    Context "Function 'Test-PSModuleTemplate'" {
+        It 'Should be able to call the function' {
+            Test-PSModuleTemplate -Name 'World' | Should -Be 'Hello, World!'
+            Write-Verbose (Test-PSModuleTemplate -Name 'World' | Out-String) -Verbose
+        }
+    }
+}