PowerShell / PowerShell/PSScriptAnalyzer

feature request for formatting rule to have an empty line after brace

Offen
#1,679 2 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Area - Formatter Issue - Enhancement Up-for-Grabs
Vorherrschende Sprache
C#
Sterne
2.2k
Forks
414
Ø Merge
13 Std. 1 Min.
Gemergte PRs (30 T.)
2

Beschreibung

Summary of the new feature
This is a proposal to add additional formatting rule to have an empty line after brace to keep code more readable with OTBS scheme. It's a separate rule comparing to inserting a new line.

Current behaviour:

...
foreach ($account in $Permissions.Keys) {
    foreach ($permission in $Permissions[$account].Keys) {
        foreach ($folder in $Permissions[$account][$permission]) {
            cNtfsPermissionEntry $folder {
                Ensure                   = 'Present'
                Path                     = $folder
                Principal                = $account
                AccessControlInformation = @(
                    cNtfsAccessControlInformation {
                        FileSystemRights  = $permission
                    }
                )
            }
        }
    }
}
...

Proposed behaviour:

...
foreach ($account in $Permissions.Keys) {

    foreach ($permission in $Permissions[$account].Keys) {

        foreach ($folder in $Permissions[$account][$permission]) {

            cNtfsPermissionEntry $folder {
                Ensure                   = 'Present'
                Path                     = $folder
                Principal                = $account
                AccessControlInformation = @(
                    cNtfsAccessControlInformation {
                        FileSystemRights  = $permission
                    }
                )
            }
        }
    }
}
...

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne damit, die Formatierungsregeln und die Logik zur Behandlung von geschweiften Klammern in PSScriptAnalyzer zu lokalisieren, und sieh dir anschließend die vorhandenen Tests für das Formatierungsverhalten an. Die Aufgabe ist abgeschlossen, wenn eine separate Regel die vorgeschlagenen Leerzeilen nach geschweiften Klammern erzeugt und Tests das gezeigte verschachtelte PowerShell-Beispiel abdecken.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
powershell
Bereich
tooling
Issue-Typ
Feature
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.