Formating issues in WCT codebase

[Rosuavio]

In CommunityToolkit/WindowsCommunityToolkit/pull/3893 we discovered some changes from this tool that seemed change the code to be misleading or less clear.

[JoeRobich]

@RosarioPulella Can you provide some before and after examples? Also, what parameters did you pass when you invoked dotnet-format?

[Rosuavio]

@RosarioPulella Can you provide some before and after examples? Also, what parameters did you pass when you invoked dotnet-format?

I'll try to get a list of examples soon. Just wanted to get this in in case I did not get a chance to.

@Nirmal4G do you know what parameters you used?

[Nirmal4G]

In the PR, the last two commits represents what you asked, the before/after changes.

Here's how I invoked dotnet format…

E:\Projects\GitHub\windows-appkit
> dotnet format -wsa

[JoeRobich]

So, part of the fix will be updating the .editorconfig to specify the indentation behavior that you are expecting.

• Labels are being correctly formatted to be one indentation less the current indentation.

  • Example from the PR
  • Configuration in the .editorconfig
  • Documentation for csharp_indent_labels

• Switch case blocks are being correctly formatted to be indented.

  • Example from the PR
  • Configuration in the .editorconfig
  • Documentation for csharp_indent_case_contents_when_block

The other part will be to disable formatting around blocks of code that the Roslyn formatter cannot reason about.

• Blocks of conditionally compiled code are not formatted as expected. Example from the PR

#783 is an open request to improve formatting of code within these conditional directives. For the time being, I would recommend using #pragma warning disable format and #pragma warning enable format around this code to disable the formatter.

[Nirmal4G]

Is there anyway to format certain blocks of code with column alignment (for lack of a better term!)?

Example:

  var    a   = bd;
  string cfg =  e;

  Func1("123", cfg);
  Func2(  "2",   e);

[JoeRobich]

Is there anyway to format certain blocks of code with column alignment (for lack of a better term!)?

The Roslyn formatter does not currently support column alignment. There are several open issues tracking support for this type of formatting dotnet/roslyn#51389, dotnet/roslyn#28729, and dotnet/roslyn#38241. Please vote them up and add any specific requirements that you might have.

I am going to mark this issue as closed. Please reopen it if I didn't address all the issues you saw in your PR or if there are issues with indentation after updating the .editorconfig.