Add initial module structure and helper functions

.github/copilot-commit-message-instructions.md

@@ -0,0 +1,34 @@
+# Semantic Commit Messages
+
+See how a minor change to your commit message style can make you a better programmer.
+
+Format: `<type>(<scope>): <subject>`
+
+`<scope>` is optional
+
+## Example
+
+```
+feat: add hat wobble
+^--^  ^------------^
+|     |
+|     +-> Summary in present tense.
+|
++-------> Type: chore, docs, feat, fix, refactor, style, or test.
+```
+
+More Examples:
+
+- `feat`: (new feature for the user, not a new feature for build script)
+- `fix`: (bug fix for the user, not a fix to a build script)
+- `docs`: (changes to the documentation)
+- `style`: (formatting, missing semi colons, etc; no production code change)
+- `refactor`: (refactoring production code, eg. renaming a variable)
+- `test`: (adding missing tests, refactoring tests; no production code change)
+- `chore`: (updating grunt tasks etc; no production code change)
+
+References:
+
+- https://www.conventionalcommits.org/
+- https://seesparkbox.com/foundry/semantic_commit_messages
+- http://karma-runner.github.io/1.0/dev/git-commit-msg.html

.github/copilot-instructions.md

@@ -0,0 +1,44 @@
+# Copilot Instructions
+
+## Powershell Modules Code Instructions
+
+### PowerShell Functions Instructions
+
+Every powershell function will contain the `CmdletBinding` attribute and the `parm`iven if there are no parameters. 
+If the function is on the public folder of the module, we will add the Èxport-ModuleFunction` statement in the same line as the closing `}` of the function
+
+Sample of function will be:
+
+```powershell
+
+function Get-UserName{
+    [CmdletBinding()]
+    param()
+
+    #Logic of the function
+} Export-ModuleFunction -FunctionName 'Get-UserName'
+```
+
+### PowerShell Test Instructions
+
+Every public function on the Test module will have the following format
+
+- Name will start with `Test_` will follow the name of the function that we are testing with no '-'. It will follow the intention of the test splited with a '_'
+- Every time we create a new function with no body we will add the `Assert-NotImplemented` statement at the end
+- We will add the 3 sections as with comments `Arrange`, `Act` and `Assert` to make the test more readable.
+- Sample of a test function to test `Get-UserName` function  will be `Test_GetUserName_UserNotFound`
+
+Full sample will be as follows
+
+```powershell
+function Test_GetUserName_UserNotFound{
+
+    # Arrange
+
+    # Act
+
+    # Assert
+
+    Assert-NotImplemented
+} 
+```

.github/workflows/powershell.yml

@@ -41,6 +41,6 @@ jobs:
 
       # Upload the SARIF file generated in the previous step
       - name: Upload SARIF results file
-        uses: github/codeql-action/upload-sarif@v2
+        uses: github/codeql-action/upload-sarif@v3
         with:
           sarif_file: results.sarif

CsvHelper.psd1

@@ -51,7 +51,7 @@ Copyright = '(c) rulasg. All rights reserved.'
 # ProcessorArchitecture = ''
 
 # Modules that must be imported into the global environment prior to importing this module
-# RequiredModules = @()
+RequiredModules = @(@{ModuleName="InvokeHelper"; ModuleVersion="1.2.2"})
 
 # Assemblies that must be loaded prior to importing this module
 # RequiredAssemblies = @()

CsvHelper.psm1

@@ -3,25 +3,11 @@ Write-Information -Message ("Loading {0} ..." -f ($PSCommandPath | Split-Path -L
 #Module path is where resides the RootModule file. This file. :)
 $MODULE_PATH = $PSScriptRoot
 
-#Get public and private function definition files.
-$Public  = @( Get-ChildItem -Path $MODULE_PATH\public\*.ps1 -ErrorAction SilentlyContinue )
-$Private = @( Get-ChildItem -Path $MODULE_PATH\private\*.ps1 -ErrorAction SilentlyContinue )
+# Load ps1 files on code folders in order
+"config","helper","include","private","public" | ForEach-Object {
 
-#Dot source the files
-Foreach($import in @($Public + $Private))
-{
-    Try
-    {
-        . $import.fullname
+    Get-ChildItem -Path $MODULE_PATH\$_\*.ps1 -Recurse -ErrorAction SilentlyContinue | ForEach-Object {
+        try { . $_.fullname }
+        catch { Write-Error -Message "Failed to import function $($import.fullname): $_" }
     }
-    Catch
-    {
-        Write-Error -Message "Failed to import function $($import.fullname): $_"
-    }
-}
-
-# Here I might...
-# Read in or create an initial config file and variable
-# Export Public functions ($Public.BaseName) for WIP modules
-# Set variables visible to the module and its functions only
-
+}

Test/Test.psd1

@@ -3,7 +3,7 @@
 #
 # Generated by: rulasg
 #
-# Generated on: 19/3/2025
+# Generated on: 9/3/2025
 #
 
 @{
@@ -18,7 +18,7 @@ ModuleVersion = '0.0.1'
 # CompatiblePSEditions = @()
 
 # ID used to uniquely identify this module
-GUID = '170ed18a-e725-462b-8236-3eadd3adcb79'
+GUID = '6b1a63eb-2d81-4424-8b7f-9f72e3979319'
 
 # Author of this module
 Author = 'rulasg'
@@ -30,7 +30,7 @@ CompanyName = 'Unknown'
 Copyright = '(c) rulasg. All rights reserved.'
 
 # Description of the functionality provided by this module
-# Description = ''
+Description = 'Module for testing and hosting shared functionality between modules'
 
 # Minimum version of the PowerShell engine required by this module
 # PowerShellVersion = ''

Test/Test.psm1

@@ -1,27 +1,16 @@
-Write-Information -Message ("Loading {0} ..." -f ($PSCommandPath | Split-Path -LeafBase)) -InformationAction continue
+Write-Information -Message ("Loading {0} ..." -f ($PSScriptRoot | Split-Path -Leaf)) -InformationAction continue
 
 #Module path is where resides the RootModule file. This file. :)
 $MODULE_PATH = $PSScriptRoot
 
-#Get public and private function definition files.
-$Public  = @( Get-ChildItem -Path $MODULE_PATH\public\*.ps1 -ErrorAction SilentlyContinue )
-$Private = @( Get-ChildItem -Path $MODULE_PATH\private\*.ps1 -ErrorAction SilentlyContinue )
+# Load ps1 files on code folders in order
+"config","helper","include","private","public" | ForEach-Object {
 
-#Dot source the files
-Foreach($import in @($Public + $Private))
-{
-    Try
-    {
-        . $import.fullname
-    }
-    Catch
-    {
-        Write-Error -Message "Failed to import function $($import.fullname): $_"
+    Get-ChildItem -Path $MODULE_PATH\$_\*.ps1 -Recurse -ErrorAction SilentlyContinue | ForEach-Object {
+        try { . $_.fullname }
+        catch { Write-Error -Message "Failed to import function $($import.fullname): $_" }
     }
 }
 
-# Here I might...
-# Read in or create an initial config file and variable
-# Export Public functions ($Public.BaseName) for WIP modules
-# Set variables visible to the module and its functions only
+Export-ModuleMember -Function Test_*
 

helper/mySetInvokeCommandAlias.config.ps1

@@ -0,0 +1,6 @@
+
+# This file is required for include mySetInvokeCommandAlias to work
+# The value need to be unique to avoid collisions with other modules
+#
+
+$MODULE_INVOKATION_TAG = "CsvHelperModule"

helper/mySetInvokeCommandAlias.ps1

@@ -0,0 +1,25 @@
+
+# SET MY INVOKE COMMAND ALIAS
+#
+# Allows calling constitely InvokeHelper with the module tag
+# Need to define a variable called $MODULE_INVOKATION_TAG
+#
+# Sample:
+# $MODULE_INVOKATION_TAG = "SfHelperModule"
+
+function Set-MyInvokeCommandAlias{
+    [CmdletBinding(SupportsShouldProcess)]
+    param(
+        [Parameter(Mandatory,Position=0)][string]$Alias,
+        [Parameter(Mandatory,Position=1)][string]$Command
+    )
+
+    # throw if MODULE_INVOKATION_TAG is not set or is "MyModuleModule"
+    if (-not $MODULE_INVOKATION_TAG -or $MODULE_INVOKATION_TAG -eq "MyModuleModule") {
+        throw "MODULE_INVOKATION_TAG is not set or has an invalid value ('MyModuleModule'). Please set it to a unique value before calling Set-MyInvokeCommandAlias."
+    }
+
+    if ($PSCmdlet.ShouldProcess("InvokeCommandAliasList", ("Add Command Alias [{0}] = [{1}]" -f $Alias, $Command))) {
+        InvokeHelper\Set-InvokeCommandAlias -Alias $Alias -Command $Command -Tag $MODULE_INVOKATION_TAG
+    }
+}

include/config.config.ps1

@@ -0,0 +1,91 @@
+# CONFIG - PUBLIC
+#
+# This script defines aliases and functions for configuration management specific to "MyModule".
+# It is intended to be included in public-facing scripts.
+
+# Define unique aliases for "MyModule"
+$CONFIG_INVOKE_GET_ROOT_PATH_ALIAS = "CsvGetConfigRootPath"
+$CONFIG_INVOKE_GET_ROOT_PATH_CMD = "Invoke-CsvGetConfigRootPath"
+
+# Set the alias for the root path command
+Set-MyInvokeCommandAlias -Alias $CONFIG_INVOKE_GET_ROOT_PATH_ALIAS -Command $CONFIG_INVOKE_GET_ROOT_PATH_CMD
+
+# Define the function to get the configuration root path
+function Invoke-CsvHelperGetConfigRootPath {
+    [CmdletBinding()]
+    param()
+
+    $configRoot = GetConfigRootPath
+    return $configRoot
+}
+
+Export-ModuleMember -Function Invoke-CsvHelperGetConfigRootPath
+
+# Extra functions not needed by INCLUDE CONFIG
+
+function Get-CsvHelperConfig{
+    [CmdletBinding()]
+    param()
+
+    $config = Get-Configuration
+
+    return $config
+} Export-ModuleMember -Function Get-CsvHelperConfig
+
+function Save-CsvHelperConfig{
+    [CmdletBinding()]
+    param(
+        [Parameter(Mandatory, ValueFromPipeline, Position = 0)][Object]$Config
+    )
+
+    return Save-Configuration -Config $Config
+} Export-ModuleMember -Function Save-CsvHelperConfig
+
+function Open-CsvHelperConfig{
+    [CmdletBinding()]
+    param()
+
+    $path = GetConfigFile -Key "config"
+
+    code $path
+
+} Export-ModuleMember -Function Open-CsvHelperConfig
+
+function Add-CsvHelperConfigAttribute{
+    [CmdletBinding()]
+    param(
+        [Parameter(Mandatory,Position=0)][ValidateSet("Account", "User", "Opportunity")][string]$objectType,
+
+        [Parameter(Mandatory, ValueFromPipeline, Position = 1)][string]$Attribute
+
+    )
+
+    begin{
+        $config = Get-Configuration
+        $configAttribute = ($objectType + "_attributes").ToLower()
+
+        if(-Not $config){
+            $config = @{}
+        }
+
+        if(-Not $config.$configAttribute){
+            $config.$configAttribute = @()
+        }
+    }
+
+    process{
+        $config.$configAttribute += $Attribute
+    }
+
+    End{
+        $ret = Save-Configuration -Config $config
+        if(-Not $ret){
+            throw "Error saving configuration"
+        }
+
+        $config = Get-CsvHelperConfig
+        Write-Output $config.$configAttribute
+
+    }
+
+} Export-ModuleMember -Function Add-CsvHelperConfigAttribute