PowerShell / PowerShell/PSScriptAnalyzer
formatting partial / dot sourced ps1 dsc scripts
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- C#
- Sterne
- 2.2k
- Forks
- 414
- Ø Merge
- 13 Std. 1 Min.
- Gemergte PRs (30 T.)
- 2
Beschreibung
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.
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Reproduziere das Formatter-Verhalten in PSScriptAnalyzer mit der eigenständigen DisableLocalMachineRunOnce.ps1-Ressource und vergleiche es mit derselben Ressource innerhalb des bereitgestellten Konfigurationsbeispiels. Beginne damit nachzuverfolgen, wie der Formatter DSC-Ressourcen in dot-sourced Dateien erkennt; die Aufgabe ist abgeschlossen, wenn die eigenständige Ressource Ensure und die anderen Zuweisungen wie im erwarteten Verhalten ausrichtet.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- powershell
- Bereich
- tooling
- Issue-Typ
- Bug
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100