Add new code formatting preset "OTPS": OTBS with else on new line

[o-l-a-v]

PR Summary

• Linked PR in PowerShellEditorServices: Add new code formatting preset "OTPS": OTBS with else on new line PowerShellEditorServices#2269
• PR that can be merged after this in vscode-powershell: Add new code formatting preset "OTPS": OTBS with else on new line vscode-powershell#5413

This PR adds a new code formatting preset, "OTPS" (One True PowerShell Style): OTBS with else on new line.

Thoughts behind the name:

• To mock the idea of one true formatting style, even though there are none.
• We do ONE change from OTBS (else on new line), also in the name (change B with P).

Feature request:

• New formatting preset: OTBS with else on a new line #2045

Context:

• "There is no One True Brace Style": There is no One True Brace Style PoshCode/PowerShellPracticeAndStyle#177
  • About OTBS with else on a new line:
    • There is no One True Brace Style PoshCode/PowerShellPracticeAndStyle#177 (comment)
    • There is no One True Brace Style PoshCode/PowerShellPracticeAndStyle#177 (comment)

PR Checklist

• PR has a meaningful title
  • Use the present tense and imperative mood when describing your changes
• Summarized changes
• Change is not breaking
• Make sure all .cs, .ps1 and .psm1 files have the correct copyright header
• Make sure you've added a new test if existing tests do not effectively test the code changed and/or updated documentation
• This PR is ready to merge and is not Work in Progress.
  • If the PR is work in progress, please add the prefix WIP: to the beginning of the title and remove the prefix when the PR is ready.

Tested like so

# Build
.\build.ps1 -PSVersion 7 -Configuration Release

# Import built module
Import-Module -Name './out/PSScriptAnalyzer\1.24.0\PSScriptAnalyzer.psd1'

# Test new preset with OTBS as input
Invoke-Formatter -Settings 'CodeFormattingOTPS' -ScriptDefinition (@'
enum Color {
    Black, 
    White
}

function Test-Code {
    [CmdletBinding()]
    param(
        [int]$ParameterOne
    )
    end {
        if (10 -gt $ParameterOne) {
            "Greater"
        } else {
            "Lesser"
        }
    }
}
'@)

[bergmeister]

Happy to add it but can you please add a test that specifically tests the OTPS part of else being on new line?
@liamjpeters Are you happy with those properties since you added new ones and potentially other ones in pending PRs? Or would we need to take a note to add certain properties later here?

[o-l-a-v]

I don't see where I should add a test like that.

There seems to be no such test for other presets, only the specific settings seems to be tested.

Also, there are some of the tests that make no sense. Like:

PSScriptAnalyzer/Tests/Rules/PlaceOpenBrace.tests.ps1

Line 43 in aba29c3

Context "Handling of comments when using Invoke-Formatter" {

No comments are involved in those tests.

---

Idea: Should be create a new test file that has all the samble codes from:

PoshCode/PowerShellPracticeAndStyle#177

And just say that they are the expected output from the various presets?

[o-l-a-v]

I added some suggestions for tests now @bergmeister. 😊

[Copilot]

Pull request overview

This PR adds a new code formatting preset called "OTPS" (One True PowerShell Style), which is identical to OTBS but places else on a new line (similar to Stroustrup style). The key difference from OTBS is the NewLineAfter = $true setting on PSPlaceCloseBrace.

Changes:

• New CodeFormattingOTPS.psd1 settings file defining the OTPS preset.
• New CodeFormattingPresets.tests.ps1 test file covering all preset cross-conversion scenarios.
• Updates to existing brace placement tests to include the OTPS preset.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

File	Description
Engine/Settings/CodeFormattingOTPS.psd1	Defines the new OTPS formatting preset rules
Tests/Rules/CodeFormattingPresets.tests.ps1	New test file verifying all formatting preset conversions including OTPS
Tests/Rules/PlaceOpenBrace.tests.ps1	Adds OTPS to existing open brace formatting tests
Tests/Rules/PlaceCloseBrace.tests.ps1	Adds new context block testing if/else formatting across all presets

Comments suppressed due to low confidence (1)

Tests/Rules/CodeFormattingPresets.tests.ps1:1

• The $OTPSAndStroustrupDefinition test fixture in PlaceCloseBrace.tests.ps1 uses double-quoted strings ("yes", "no"), while the equivalent $OTPS fixture in CodeFormattingPresets.tests.ps1 uses single-quoted strings ('yes', 'no'). If the formatter normalizes string quoting, these fixtures could diverge in meaning or lead to test confusion. Consider aligning the quoting style between the two fixtures for consistency.

# Copyright (c) Microsoft Corporation. All rights reserved.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

The variable $OTPSAndStroustrupDefinition implies that this definition is identical for both OTPS and Stroustrup. However, based on the full preset definitions and tests in CodeFormattingPresets.tests.ps1, OTPS and Stroustrup differ in other formatting aspects (e.g., function brace placement, param block spacing). This naming may be misleading in a broader context. Consider naming it more specifically, such as $ElseOnNewLineDefinition, to avoid implying full equivalence between the two presets.

[o-l-a-v]

I don't agree. For this particular test, OTPS and Stroustrup will create the same result.

[o-l-a-v]

Hmm, may these tests have found a bug in the Stroustrup preset? No, two bugs?

1. The opening brace after function definition is not on a new line.
2. Paranthese after param should be on the same line.

PS > $Allman = @'
enum Color
{
    Black,
    White
}

function Test-Code
{
    [CmdletBinding()]
    param
    (
        [int] $ParameterOne
    )
    end
    {
        if (10 -gt $ParameterOne)
        {
            "Greater"
        }
        else
        {
            "Lesser"
        }
    }
}
'@

PS > Invoke-Formatter -ScriptDefinition $Allman -Settings 'CodeFormattingStroustrup'
enum Color {
    Black,
    White
}

function Test-Code {
    [CmdletBinding()]
    param
    (
        [int] $ParameterOne
    )
    end {
        if (10 -gt $ParameterOne) {
            "Greater"
        }
        else {
            "Lesser"
        }
    }
}

---

Edit: These are probably shortcomings with PSSA?

[liamjpeters]

Happy to add it but can you please add a test that specifically tests the OTPS part of else being on new line? @liamjpeters Are you happy with those properties since you added new ones and potentially other ones in pending PRs? Or would we need to take a note to add certain properties later here?

All good with me 😊. I should look over the settings presets once #2132 is merged, to add in the enum alignment, but that can wait. Good reminder, thanks!

@o-l-a-v - Thanks for the new tests 👍

[o-l-a-v]

If I understand it correctly, PSSA code formatting only handles curly brackets, thus there will be no difference between Stroustrup and this new proposed preset. As the new test file shows, PSSA does not touch param(), or differentiates on function {} vs. if {} else {}.

If I'm not missing anything here I don't think this proposal makes sense anymore.

What do you guys think we should do? Remove the new preset, keep the closing brackets tests, remove or move to disabled the new test file I made for preset tests?