PowerShell / PowerShell/PSScriptAnalyzer
formatting partial / dot sourced ps1 dsc scripts
Nobody has claimed this yet.
- Dominant language
- C#
- Stars
- 2.2k
- Forks
- 414
- Avg merge
- 13h 1m
- Merged PRs (30d)
- 2
Description
Steps to reproduce
I originally opened this on the vscode-powershell#1583 project, but I've been directed to open an issue here directly.
I'm currently creating DSC Resource modules to apply settings in our environment, I'm breaking down the actual settings to individual files to make managing the settings easier and to have an easy structure of those settings.
The issue is that the formatter is not performing the align dsc resource / hash table function on the files to import.
It's not really relevant but i'm using the following code in my policy.schema.psm1 file
Configuration Win10CustomComputerPolicy
{
Param(
[Parameter(Mandatory = $false)]
[array]
$excludeImports = @()
)
Import-DscResource -ModuleName PSDesiredStateConfiguration
$importParams = @{
Path = $PSScriptRoot
Exclude = $excludeImports
Filter = '*.ps1'
ErrorAction = 'SilentlyContinue'
Recurse = $true
}
$imports = @(Get-ChildItem @importParams)
#Dot source the files
Foreach ($import in $imports) {
Try {
. $import.fullname
}
Catch {
Write-Error -Message "Failed to import function $($import.fullname): $_"
}
}
}
each individual file then looks like this:
DisableLocalMachineRunOnce.ps1
#\System\Logon\Do not process the run once list
Registry DisableLocalMachineRunOnce {
Ensure = "Present"
Key = "HKLM:\Software\Microsoft\Windows\CurrentVersion\Policies\Explorer"
Force = $true
ValueName = "DisableLocalMachineRunOnce"
ValueType = "DWord"
ValueData = "1"
}
most of the formatting works, but not the alignment, if I add a configuration section around the code it works, but that would break my import.
#\System\Logon\Do not process the run once list
configuration test {
Registry DisableLocalMachineRunOnce {
Ensure = "Present"
Key = "HKLM:\Software\Microsoft\Windows\CurrentVersion\Policies\Explorer"
Force = $true
ValueName = "DisableLocalMachineRunOnce"
ValueType = "DWord"
ValueData = "1"
}
}
I can provide a bit more information when I'm back in the office tomorrow if any is needed, but I wanted to make sure I'd opened the issue since I was aware.
Expected behavior
Registry DisableLocalMachineRunOnce {
Ensure = "Present"
Key = "HKLM:\Software\Microsoft\Windows\CurrentVersion\Policies\Explorer"
Force = $true
ValueName = "DisableLocalMachineRunOnce"
ValueType = "DWord"
ValueData = "1"
}
Actual behavior
Registry DisableLocalMachineRunOnce {
Ensure = "Present"
Key = "HKLM:\Software\Microsoft\Windows\CurrentVersion\Policies\Explorer"
Force = $true
ValueName = "DisableLocalMachineRunOnce"
ValueType = "DWord"
ValueData = "1"
}
Environment data
| Name | Value |
|---|---|
| PSVersion | 5.1.17134.228 |
| PSEdition | Desktop |
| PSCompatibleVersions | 1.0 2.0 3.0 4.0 5.0 5.1.17134.228 |
| BuildVersion | 10.0.17134.228 |
| CLRVersion | 4.0.30319.42000 |
| WSManStackVersion | 3.0 |
| PSRemotingProtocolVersion | 2.3 |
| SerializationVersion | 1.1.0.1 |
(Get-Module -ListAvailable PSScriptAnalyzer).Version | ForEach-Object { $_.ToString() }
I'm using PSScriptAnalyzer as part of vscode-powershell using the current version.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Reproduce the formatter behavior in PSScriptAnalyzer with the standalone DisableLocalMachineRunOnce.ps1 resource and compare it with the same resource inside the provided configuration example. Start by tracing how the formatter recognizes DSC resources in dot-sourced files; done means the standalone resource aligns Ensure and the other assignments as shown in the expected behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- powershell
- Domain
- tooling
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100