Nuget lint

[trejjam]

Dotnet has task format, using that, we can format and enforce some codestyle

[JoeRobich]

Thanks for opening this PR and helping us stay clean with our codestyle.

Unfortunately the Roslyn formatter does not give us an options to control the formatting of all code structures and there are some intentional formatting decisions that are not captured in the .editorconfig. This is typically not an issue as dotnet format will not change the formatting of this code. However, there are some changes that the Rider/Resharper formatter made that go against our intention as the formatting configuration is not complete.

Would you be willing to update the Rider configuration to ignore object and list initializers as well as line length? Otherwise, we will need to work out the appropriate configuration.

[trejjam]

Thank you for the review I will process it shortly

[JoeRobich]

Thanks for updating this.

After thinking about this more the quickest way to get these changes in is to ask you to revert the Resharper formatting changes and remove the Resharper config. Since the maintainers of this C# do not use this formatter, it would take a bit of work to get the configuration right so that it broke up long lines in a familiar and expected way.

If this is something you feel passionately about, I would be happy to work with you in a separate issue/pr to figure out what the correct Resharper configuration would be.

[trejjam]

The added Resharper config is there to conform with the existing code. If I remove it, anyone who makes an update with VS + Resharper / Rider will create style changes, which are again used code style.

It only makes the life of contributors easier, the default tooling does not need to understand it.

I aim to have such a configuration for dotnet format that it conforms with the current code.

Of course, we can spend hours writing formatters that will ensure strictness. That will undoubtedly be awesome, but I do not see a real value.

If you insist that all configurations must be used by tooling, there are some possibilities. The easier one is to use Resharper CLI, which comes as a Nuget package. It's stricter than the dotnet format, but also slower and requires more configuration.

Another option is to use, e.g., csharpier (I am not a fan of it, but it's an option).

---

About current changes, the only one I am aware of is an indention of raw string literals, which was written in many different ways in this codebase. I only unified it into one style.

[JoeRobich]

I aim to have such a configuration for dotnet format that it conforms with the current code.

I believe this is the crux of the issue. The configuration is for dotnet-format but once you run Rider's formatter on the code, it starts making changes that dotnet-format wouldn't. If we can get the Rider's formatter to not break long lines, then I believe we will be in much better shape.

[trejjam]

I believe I addressed all comments and that the PR is ready.

[JoeRobich]

Thanks @trejjam! I added suggestions for the remaining places we had closing parens on the following line. I also want to add back the removed setting as commented out because we will certainly want to reenable it once the Rider formatter bug is fixed. I know there has been a lot of back and forth on this PR. Thanks for sticking with it.

[JoeRobich]

Thanks @trejjam! The test to validate our formatting with dotnet-format is a great addition. Wish I had thought of it. Also, the config changes to interact better with the Rider formatter are good for the community.

[trejjam]

Thank you for all the reviews, I like to push things forward :)

[abdulapopoola]

Thanks a lot @trejjam for all the help!

[CharliePoole]

I'm having this issue as well. Looking for the best workaround until the fix is released.

I could remove the grouping from my yml files but then I'd have to put them back later. What I'm thinking is to simply merge the change and then let dependabot re-discover the updates in a subsequent pass. Will that work?