Try dotnet-project-file-analyzers

[sungam3r]

No description provided.

[Corniel]

Nice that you want to use the .NET project file analyzers!

Two tips:

1. Those rules should be applied on on MS build project files, not only those who are publisable.
2. Consider using our SDK as a replacement for Solution Items in your solution file.

[Corniel]

If you want to disable these, you better use a .globalconfig file.

[sungam3r]

I prefer to use editorconfig for all projects I participate of. For now it's just a first attempt to use analyzer. I evaluate pros and cons. My goal is to find reasonable set of diagnostics and those ones that have a little value.

[Corniel]

I prefer to use editorconfig for all projects I participate of. For now it's just a first attempt to use analyzer. I evaluate pros and cons. My goal is to find reasonable set of diagnostics and those ones that have a little value.

That is true. However, MS itself states that the configuration of files should be specified in the .globalconfig instead of the .editorconfig. Some rules (including the of .NET project file analyzers) can not be configured in .editorconfig, but can be configured in .globalconfig.

[sungam3r]

MS itself states that the configuration of files should be specified in the .globalconfig instead of the .editorconfig

Could you please point to the relevant documentation?

[Corniel]

The link can be found here:

https://dotnet-project-file-analyzers.github.io/general/configuration.html

[sungam3r]

@Corniel regarding

Those rules should be applied on on MS build project files, not only those who are publisable.

What do you mean? I added analyzer into Directory.Build.props applying it to all projects.

Consider using our SDK as a replacement for Solution Items in your solution file.

I've read about it. For now it looks like rather invasive solution. I would not want to lose the usual structure of many projects without good reason.

[Corniel]

What do you mean? I added analyzer into Directory.Build.props applying it to all projects.

<ItemGroup Condition="'$(IsPackable)' == 'true'">
    <PackageReference Include="DotNetProjectFile.Analyzers" Version="1.5.2" PrivateAssets="all" />
    <PackageReference Include="Microsoft.SourceLink.GitHub" Version="8.0.0" PrivateAssets="All" />
    <PackageReference Include="MinVer" Version="6.0.0" PrivateAssets="All" />
  </ItemGroup>

So, the DotNetProjectFile.Analyzers are now only applied on projects that are packable.

I've read about it. For now it looks like rather invasive solution. I would not want to lose the usual structure of many projects without good reason.

I have to admit that is the response I got quite often when suggesting it. And when I came up with the idea, it really felt like it. But in practice, you get a way less cumbersome solution file, and an easy to maintain container project just for files shared by the solution. That being said, if you want to give it a try, you probably should do it in a separate PR.

[sungam3r]

So, the DotNetProjectFile.Analyzers are now only applied on projects that are packable.

ooops, my oversight

[sungam3r]

But in practice, you get a way less cumbersome solution file, and an easy to maintain container project just for files shared by the solution.

I doubt it very much, especially in the words less cumbersome solution file. I do not see difficulty in the current project format. What cumbersome solution file are you talking about?

That being said, if you want to give it a try, you probably should do it in a separate PR.

Could you please provide PR to demonstrate so I can evaluate?

[sungam3r]

I have to admit that is the response I got quite often when suggesting it.

Yep, I expected such an answer.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (b5864b2) to head (1fb63db).
Report is 1 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff            @@
##            master      #143   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           11        11           
  Lines          242       242           
  Branches        37        37           
=========================================
  Hits           242       242           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[sungam3r]

That being said, if you want to give it a try, you probably should do it in a separate PR.

Honestly I do not understand what I will get.