🌟 [Release]: PowerShell-Lua data conversion now available via ConvertTo-Lua and ConvertFrom-Lua

.github/linters/.codespellrc

@@ -1,3 +1,3 @@
 [codespell]
 skip = ./.github/linters
-ignore-words-list = afterall
+ignore-words-list = afterall,simpy

.github/linters/.luacheckrc

@@ -0,0 +1,4 @@
+-- Test data files are Lua data/config files (e.g. WoW SavedVariables format)
+-- that define top-level globals and are not executed as scripts.
+files["**/tests/data/Assignments.lua"].ignore = {"111", "112"}
+files["**/tests/data/WoWSavedVariables.lua"].ignore = {"111", "112"}

.github/workflows/Process-PSModule.yml

@@ -27,6 +27,6 @@ permissions:
 
 jobs:
   Process-PSModule:
-    uses: PSModule/Process-PSModule/.github/workflows/workflow.yml@60bdf8a5a4c92c53fcf2a8d23f7d5f5c93e6864e # v5.4.3
+    uses: PSModule/Process-PSModule/.github/workflows/workflow.yml@11117919e65242d3388727819a751f74ad24ea9e # v5.5.0
     secrets:
       APIKEY: ${{ secrets.APIKEY }}

README.md

@@ -1,69 +1,106 @@
-# {{ NAME }}
+# Lua
 
-{{ DESCRIPTION }}
+A PowerShell module for converting between PowerShell objects and Lua table notation.
 
 ## Prerequisites
 
 This uses the following external resources:
+
 - The [PSModule framework](https://github.com/PSModule/Process-PSModule) for building, testing and publishing the module.
 
 ## Installation
 
 To install the module from the PowerShell Gallery, you can use the following command:
 
 ```powershell
-Install-PSResource -Name {{ NAME }}
-Import-Module -Name {{ NAME }}
+Install-PSResource -Name Lua
+Import-Module -Name Lua
 ```
 
 ## Usage
 
-Here is a list of example that are typical use cases for the module.
+Here is a list of examples that are typical use cases for the module.
+
+### Example 1: Convert a PowerShell hashtable to Lua
+
+```powershell
+@{ name = "ElvUI"; version = "13.74"; enabled = $true } | ConvertTo-Lua
+
+{
+    name = "ElvUI",
+    version = "13.74",
+    enabled = true
+}
+```
+
+### Example 2: Convert a Lua table string to a PowerShell object
+
+```powershell
+$lua = '{ name = "ElvUI", version = "13.74", enabled = true }'
+$config = $lua | ConvertFrom-Lua
+$config.name     # ElvUI
+$config.enabled  # True
+```
+
+### Example 3: Read a Lua file and convert to PowerShell
 
-### Example 1: Greet an entity
+```powershell
+$luaContent = Get-Content -Path 'config.lua' -Raw
+$config = ConvertFrom-Lua -InputObject $luaContent
+$config.unitframes.playerWidth  # 270
+```
 
-Provide examples for typical commands that a user would like to do with the module.
+### Example 4: Convert a PowerShell object to compressed Lua
 
 ```powershell
-Greet-Entity -Name 'World'
-Hello, World!
+@(1, 2, 3) | ConvertTo-Lua -Compress
+
+{1,2,3}
 ```
 
-### Example 2
+### Example 5: Round-trip JSON to Lua
+
+```powershell
+$data = Get-Content -Path 'settings.json' -Raw | ConvertFrom-Json
+$luaOutput = $data | ConvertTo-Lua
+$luaOutput | Set-Content -Path 'settings.lua'
+```
 
-Provide examples for typical commands that a user would like to do with the module.
+### Example 6: Convert Lua to PSCustomObject
 
 ```powershell
-Import-Module -Name PSModuleTemplate
+$result = '{ server = "localhost", port = 8080 }' | ConvertFrom-Lua
+$result.server  # localhost
+$result.port    # 8080
 ```
 
 ### Find more examples
 
 To find more examples of how to use the module, please refer to the [examples](examples) folder.
 
-Alternatively, you can use the Get-Command -Module 'This module' to find more commands that are available in the module.
-To find examples of each of the commands you can use Get-Help -Examples 'CommandName'.
+Alternatively, you can use `Get-Command -Module 'Lua'` to find commands available in the module.
+To find examples of each command, use `Get-Help -Examples 'CommandName'`.
 
 ## Documentation
 
-Link to further documentation if available, or describe where in the repository users can find more detailed documentation about
-the module's functions and features.
+For detailed documentation on each function, use the built-in help system:
+
+```powershell
+Get-Help ConvertTo-Lua -Full
+Get-Help ConvertFrom-Lua -Full
+```
 
 ## Contributing
 
 Coder or not, you can contribute to the project! We welcome all contributions.
 
-### For Users
+### For users
 
 If you don't code, you still sit on valuable information that can make this project even better. If you experience that the
 product does unexpected things, throw errors or is missing functionality, you can help by submitting bugs and feature requests.
 Please see the issues tab on this project and submit a new issue that matches your needs.
 
-### For Developers
+### For developers
 
 If you do code, we'd love to have your contributions. Please read the [Contribution guidelines](CONTRIBUTING.md) for more information.
 You can either help by picking up an existing issue or submit a new one if you have an idea for a new feature or improvement.
-
-## Acknowledgements
-
-Here is a list of people and projects that helped this project in some way.

examples/General.ps1

@@ -1,19 +1,43 @@
 <#
-  .SYNOPSIS
-    This is a general example of how to use the module.
+    .SYNOPSIS
+    Examples of how to use the Lua module.
 #>
 
 # Import the module
-Import-Module -Name 'PSModule'
+Import-Module -Name 'Lua'
 
-# Define the path to the font file
-$FontFilePath = 'C:\Fonts\CodeNewRoman\CodeNewRomanNerdFontPropo-Regular.tff'
+# Convert a PowerShell hashtable to Lua table notation
+$config = [ordered]@{
+    name    = 'ElvUI'
+    version = '13.74'
+    enabled = $true
+    scaling = 0.85
+    authors = @('Elv', 'Simpy', 'Blazeflack')
+}
+$luaOutput = $config | ConvertTo-Lua
+Write-Output $luaOutput
 
-# Install the font
-Install-Font -Path $FontFilePath -Verbose
+# Convert a Lua table string to a PowerShell object
+$luaString = @'
+{
+    name = "ElvUI",
+    version = "13.74",
+    enabled = true,
+    unitframes = {
+        playerWidth = 270,
+        playerHeight = 54
+    }
+}
+'@
+$result = $luaString | ConvertFrom-Lua
+Write-Output "Name: $($result.name)"
+Write-Output "Player Width: $($result.unitframes.playerWidth)"
 
-# List installed fonts
-Get-Font -Name 'CodeNewRomanNerdFontPropo-Regular'
+# Convert Lua to PSCustomObject
+$obj = '{ server = "localhost", port = 8080 }' | ConvertFrom-Lua
+Write-Output "Server: $($obj.server), Port: $($obj.port)"
+
+# Compressed output
+$compressed = @(1, 2, 3, 4, 5) | ConvertTo-Lua -Compress
+Write-Output "Compressed: $compressed"
 
-# Uninstall the font
-Get-Font -Name 'CodeNewRomanNerdFontPropo-Regular' | Uninstall-Font -Verbose