Merge pull request #18 from krymtkts:feature/ci

Add GitHub Actions workflow for testing module.

Author: krymtkts

.github/workflows/test.yml

@@ -0,0 +1,27 @@
+name: Test module
+
+on:
+  push:
+    branches: ["main"]
+  pull_request:
+    branches: ["main"]
+
+permissions:
+  contents: read
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Install modules from PSGallery (pwsh)
+        shell: pwsh
+        run: |
+          Set-PSResourceRepository PSGallery -Trusted
+          Install-PSResource Psake,Pester,PSScriptAnalyzer -Quiet -Reinstall -Scope CurrentUser
+      - name: Execute All Tests
+        shell: pwsh
+        run: |
+          Invoke-Psake -taskList TestAll
+          if (-not $psake.build_success) { exit 1 }

PSScriptAnalyzerSettings.psd1

@@ -0,0 +1,57 @@
+# Based on the `CodeFormatting.psd1` settings for PSScriptAnalyzer 1.23.0.
+# https://github.com/PowerShell/PSScriptAnalyzer/blob/1.21.0/Engine/Settings/CodeFormatting.psd1
+@{
+    IncludeRules = @(
+        'PSPlaceOpenBrace',
+        'PSPlaceCloseBrace',
+        'PSUseConsistentWhitespace',
+        'PSUseConsistentIndentation',
+        'PSAlignAssignmentStatement',
+        'PSUseCorrectCasing'
+    )
+
+    Rules = @{
+        PSPlaceOpenBrace = @{
+            Enable = $true
+            OnSameLine = $true
+            NewLineAfter = $true
+            IgnoreOneLineBlock = $true
+        }
+
+        PSPlaceCloseBrace = @{
+            Enable = $true
+            NewLineAfter = $true
+            IgnoreOneLineBlock = $true
+            NoEmptyLineBefore = $false
+        }
+
+        PSUseConsistentIndentation = @{
+            Enable = $true
+            Kind = 'space'
+            PipelineIndentation = 'IncreaseIndentationForFirstPipeline'
+            IndentationSize = 4
+        }
+
+        PSUseConsistentWhitespace = @{
+            Enable = $true
+            CheckInnerBrace = $true
+            CheckOpenBrace = $true
+            CheckOpenParen = $true
+            CheckOperator = $true
+            CheckPipe = $true
+            CheckPipeForRedundantWhitespace = $false
+            CheckSeparator = $true
+            CheckParameter = $false
+            IgnoreAssignmentOperatorInsideHashTable = $true
+        }
+
+        PSAlignAssignmentStatement = @{
+            Enable = $false
+            CheckHashtable = $true
+        }
+
+        PSUseCorrectCasing = @{
+            Enable = $true
+        }
+    }
+}

psakefile.ps1

@@ -0,0 +1,27 @@
+[Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseDeclaredVarsMoreThanAssignments', 'ModuleName')]
+param()
+Properties {
+    $ModuleName = Get-ChildItem -File -Path ./ -Recurse -Name '*.psm1' | Split-Path -Parent
+}
+
+Task default -Depends TestAll
+
+Task TestAll -Depends Lint, Test
+
+Task Lint {
+    $warn = Invoke-ScriptAnalyzer -Path "./${ModuleName}" -Settings PSScriptAnalyzerSettings.psd1
+    if ($warn) {
+        $warn
+        throw 'Invoke-ScriptAnalyzer for {ModuleName} failed.'
+    }
+    $warn = Invoke-ScriptAnalyzer -Path ./*.ps1 -Settings PSScriptAnalyzerSettings.psd1
+    if ($warn) {
+        $warn
+        throw 'Invoke-ScriptAnalyzer for ops scripts failed.'
+    }
+}
+
+Task Test {
+    'Test is running!'
+    # TODO: add Pester tests
+}