🌟 [Major]: Module folder restructure to support variables (#68)

## Description

<!-- Add your description here -->

## Type of change

<!-- Use the check-boxes [x] on the options that are relevant. -->

- [ ] 📖 [Docs]
- [ ] 🪲 [Fix]
- [ ] 🩹 [Patch]
- [ ] ⚠️ [Security fix]
- [ ] 🚀 [Feature]
- [x] 🌟 [Breaking change]

## Checklist

<!-- Use the check-boxes [x] on the options that are relevant. -->

- [x] I have performed a self-review of my own code
- [x] I have commented my code, particularly in hard-to-understand areas

Author: MariusStorhaug

.github/dependabot.yml

@@ -9,7 +9,3 @@ updates:
     directory: / # Location of package manifests
     schedule:
       interval: weekly
-  - package-ecosystem: nuget # See documentation for possible values
-    directory: / # Location of package manifests
-    schedule:
-      interval: weekly

.github/workflows/Action-Test-Src-Default.yml

@@ -16,20 +16,14 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
-        shell: [pwsh]
-        include:
-          - os: windows-latest
-            shell: powershell
-    name: Action-Test [Src-Default] - [${{ matrix.os }}@${{ matrix.shell }}]
+    name: Action-Test [Src-Default] - [${{ matrix.os }}]
     runs-on: ${{ matrix.os }}
     steps:
       - name: Checkout repo
         uses: actions/checkout@v4
 
       - name: Initialize environment
         uses: PSModule/Initialize-PSModule@main
-        with:
-          Shell: ${{ matrix.shell }}
 
       - name: Action-Test
         uses: ./
@@ -38,5 +32,4 @@ jobs:
         with:
           Name: PSModuleTest
           Path: tests/src
-          Shell: ${{ matrix.shell }}
           TestType: SourceCode

.github/workflows/Action-Test-Src-WithManifest.yml

@@ -16,20 +16,14 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
-        shell: [pwsh]
-        include:
-          - os: windows-latest
-            shell: powershell
-    name: Action-Test [Src-WithManifest] - [${{ matrix.os }}@${{ matrix.shell }}]
+    name: Action-Test [Src-WithManifest] - [${{ matrix.os }}]
     runs-on: ${{ matrix.os }}
     steps:
       - name: Checkout repo
         uses: actions/checkout@v4
 
       - name: Initialize environment
         uses: PSModule/Initialize-PSModule@main
-        with:
-          Shell: ${{ matrix.shell }}
 
       - name: Action-Test
         uses: ./
@@ -38,5 +32,4 @@ jobs:
         with:
           Name: PSModuleTest
           Path: tests/srcWithManifest
-          Shell: ${{ matrix.shell }}
           TestType: SourceCode

.github/workflows/Action-Test-outputs.yml

@@ -16,20 +16,14 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
-        shell: [pwsh]
-        include:
-          - os: windows-latest
-            shell: powershell
-    name: Action-Test [outputs] - [${{ matrix.os }}@${{ matrix.shell }}]
+    name: Action-Test [outputs] - [${{ matrix.os }}]
     runs-on: ${{ matrix.os }}
     steps:
       - name: Checkout repo
         uses: actions/checkout@v4
 
       - name: Initialize environment
         uses: PSModule/Initialize-PSModule@main
-        with:
-          Shell: ${{ matrix.shell }}
 
       - name: Action-Test
         uses: ./
@@ -38,5 +32,4 @@ jobs:
         with:
           Name: PSModuleTest
           Path: tests/outputs/modules
-          Shell: ${{ matrix.shell }}
           TestType: Module

.github/workflows/Linter.yml

@@ -28,3 +28,5 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ github.token }}
           VALIDATE_JSCPD: false
+          VALIDATE_MARKDOWN_PRETTIER: false
+          VALIDATE_YAML_PRETTIER: false

action.yml

@@ -33,21 +33,22 @@ runs:
   using: composite
   steps:
     - name: Run Test-PSModule
+      uses: PSModule/GitHub-Script@v1
       id: test
-      shell: ${{ inputs.Shell }}
       env:
         GITHUB_ACTION_INPUT_Name: ${{ inputs.Name }}
         GITHUB_ACTION_INPUT_Path: ${{ inputs.Path }}
         GITHUB_ACTION_INPUT_TestType: ${{ inputs.TestType }}
         GITHUB_ACTION_INPUT_TestsPath: ${{ inputs.TestsPath }}
-      run: |
-        # Test-PSModule
-        $passed = . "$env:GITHUB_ACTION_PATH\scripts\main.ps1" -Verbose
-        "passed=$passed" | Out-File -FilePath $env:GITHUB_OUTPUT -Append
+      with:
+        Script: |
+          # Test-PSModule
+          $passed = . "${{ github.action_path }}\scripts\main.ps1" -Verbose
+          "passed=$passed" | Out-File -FilePath $env:GITHUB_OUTPUT -Append
 
-        if (-not $passed) {
-          exit 1
-        }
+          if (-not $passed) {
+            exit 1
+          }
 
     - name: Upload test results
       uses: actions/upload-artifact@v4

scripts/helpers/Test-PSModule.ps1

@@ -42,7 +42,7 @@ function Test-PSModule {
     #region Add test - Common - PSScriptAnalyzer
     Start-LogGroup 'Add test - Common - PSScriptAnalyzer'
     $containers = @()
-    $PSSATestsPath = Join-Path -Path $env:GITHUB_ACTION_PATH -ChildPath 'scripts\tests\PSScriptAnalyzer'
+    $PSSATestsPath = Join-Path -Path $PSScriptRoot -ChildPath '..\tests\PSScriptAnalyzer'
     $settingsFileName = if ($testModule) { 'Settings.Module.psd1' } else { 'Settings.SourceCode.psd1' }
     $settingsFilePath = Join-Path -Path $PSSATestsPath -ChildPath $settingsFileName
     $containerParams = @{
@@ -62,7 +62,7 @@ function Test-PSModule {
     #region Add test - Common - PSModule
     Start-LogGroup 'Add test - Common - PSModule'
     $containerParams = @{
-        Path = Join-Path -Path $env:GITHUB_ACTION_PATH -ChildPath 'scripts\tests\PSModule\Common.Tests.ps1'
+        Path = Join-Path -Path $PSScriptRoot -ChildPath '..\tests\PSModule\Common.Tests.ps1'
         Data = @{
             Path    = $Path
             Verbose = $true
@@ -78,7 +78,7 @@ function Test-PSModule {
     if ($testModule) {
         Start-LogGroup 'Add test - Module - PSModule'
         $containerParams = @{
-            Path = Join-Path -Path $env:GITHUB_ACTION_PATH -ChildPath 'scripts\tests\PSModule\Module.Tests.ps1'
+            Path = Join-Path -Path $PSScriptRoot -ChildPath '..\tests\PSModule\Module.Tests.ps1'
             Data = @{
                 Path    = $Path
                 Verbose = $true
@@ -95,7 +95,7 @@ function Test-PSModule {
     if ($testSourceCode) {
         Start-LogGroup 'Add test - SourceCode - PSModule'
         $containerParams = @{
-            Path = Join-Path -Path $env:GITHUB_ACTION_PATH -ChildPath 'scripts\tests\PSModule\SourceCode.Tests.ps1'
+            Path = Join-Path -Path $PSScriptRoot -ChildPath '..\tests\PSModule\SourceCode.Tests.ps1'
             Data = @{
                 Path      = $Path
                 TestsPath = $moduleTestsPath

scripts/main.ps1

@@ -1,12 +1,13 @@
-#REQUIRES -Modules Utilities
-
-[CmdletBinding()]
+[CmdletBinding()]
 param()
 
-Start-LogGroup 'Loading helper scripts'
-Get-ChildItem -Path (Join-Path -Path $env:GITHUB_ACTION_PATH -ChildPath 'scripts\helpers') -Filter '*.ps1' -Recurse |
-    ForEach-Object { Write-Verbose "[$($_.FullName)]"; . $_.FullName }
-Stop-LogGroup
+$path = (Join-Path -Path $PSScriptRoot -ChildPath 'helpers')
+LogGroup "Loading helper scripts from [$path]" {
+    Get-ChildItem -Path $path -Filter '*.ps1' -Recurse | ForEach-Object {
+        Write-Verbose "[$($_.FullName)]"
+        . $_.FullName
+    }
+}
 
 Start-LogGroup 'Loading inputs'
 $moduleName = if ($env:GITHUB_ACTION_INPUT_Name | IsNullOrEmpty) { $env:GITHUB_REPOSITORY_NAME } else { $env:GITHUB_ACTION_INPUT_Name }
@@ -26,16 +27,16 @@ if (-not (Test-Path -Path $codeToTest)) {
 Write-Verbose "Test type to run:  [$env:GITHUB_ACTION_INPUT_TestType]"
 
 $testsPath = $env:GITHUB_ACTION_INPUT_TestsPath
-Write-Verbose "Path to tests:    [$testsPath]"
+Write-Verbose "Path to tests:     [$testsPath]"
 if (-not (Test-Path -Path $testsPath)) {
     throw "Path [$testsPath] does not exist."
 }
 
 Stop-LogGroup
 
 $params = @{
-    Path     = $codeToTest
-    TestType = $env:GITHUB_ACTION_INPUT_TestType
+    Path      = $codeToTest
+    TestType  = $env:GITHUB_ACTION_INPUT_TestType
     TestsPath = $testsPath
 }
 $results = Test-PSModule @params

scripts/tests/PSModule/SourceCode.Tests.ps1

@@ -13,11 +13,14 @@ Param(
 
 BeforeAll {
     $scriptFiles = Get-ChildItem -Path $Path -Include *.psm1, *.ps1 -Recurse -File
-    $functionFiles = Get-ChildItem -Directory -Path $Path |
-        Where-Object { $_.Name -in 'public', 'private' } |
-        Get-ChildItem -Filter '*.ps1' -File
-
-    $publicFunctionFiles = Get-ChildItem -Directory -Path (Join-Path -Path $Path -ChildPath 'public') -File -Filter '*.ps1'
+    $functionsPath = Join-Path -Path $Path -ChildPath 'functions'
+    # $privateFunctionsPath = Join-Path -Path $functionsPath -ChildPath 'private'
+    $publicFunctionsPath = Join-Path -Path $functionsPath -ChildPath 'public'
+    # $variablesPath = Join-Path -Path $Path -ChildPath 'variables'
+    # $privateVariablesPath = Join-Path -Path $variablesPath -ChildPath 'private'
+    # $publicVariablesPath = Join-Path -Path $variablesPath -ChildPath 'public'
+    $functionFiles = (Test-Path -Path $functionsPath) ? (Get-ChildItem -Path $functionsPath -Filter '*.ps1' -File) : $null
+    $publicFunctionFiles = (Test-Path -Path $publicFunctionsPath) ? (Get-ChildItem -Path $publicFunctionsPath -File -Filter '*.ps1' -Recurse) : $null
 
     Write-Verbose "Found $($scriptFiles.Count) script files in $Path"
     Write-Verbose "Found $($functionFiles.Count) function files in $Path"

tests/src/classes/private/SecretWriter.ps1

@@ -0,0 +1,15 @@
+class SecretWriter {
+    [string] $Alias
+    [string] $Name
+    [string] $Secret
+
+    SecretWriter([string] $alias, [string] $name, [string] $secret) {
+        $this.Alias = $alias
+        $this.Name = $name
+        $this.Secret = $secret
+    }
+
+    [string] GetAlias() {
+        return $this.Alias
+    }
+}