Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

HAST-327: New instructions about nested Directory.Build.props usage #94

Merged
merged 5 commits into from
Oct 19, 2023
Merged

HAST-327: New instructions about nested Directory.Build.props usage #94

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2fabc0f
New instructions about nested Directory.Build.props usage
sarahelsaig Oct 18, 2023
4d5451c
Merge remote-tracking branch 'origin/dev' into issue/HAST-327
sarahelsaig Oct 18, 2023
bab7603
Docs formatting
Piedone Oct 19, 2023
9973430
Update documentation.
sarahelsaig Oct 19, 2023
8778087
Elaborating on using <RunCodeAnalysis>false</RunCodeAnalysis>
Piedone Oct 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions Lombiq.Analyzers/Docs/AddingAnalyzers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ You only need to reference a single project; e.g., even though Orchard Core apps
If you don't want to stay on the cutting-edge version, nor do you intend to contribute to Lombiq .NET Analyzers, you can use one of the NuGet packages. Install the package suitable for your project, as described above. Check for the latest version number [on NuGet](https://www.nuget.org/packages/Lombiq.Analyzers/).

```csproj
<PackageReference Include="Lombiq.Analyzers" Version="<latest version>">
<PrivateAssets>all</PrivateAssets>
</PackageReference>
<PackageReference Include="Lombiq.Analyzers" Version="<latest version>">
<PrivateAssets>all</PrivateAssets>
</PackageReference>
```

The `<PrivateAssets>all</PrivateAssets>` is necessary to prevent the analyzers "leaking" into other projects that may consume yours.
Expand Down
19 changes: 15 additions & 4 deletions Lombiq.Analyzers/Docs/ConfiguringAnalyzers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,29 @@ Place a _Directory.Build.props_ file into the project's folder (or folder with s

```xml
<Project>
<ItemGroup>
<Analyzer Remove="@(Analyzer)" />
</ItemGroup>
</Project>
```

This will completely disable code analysis packages. To also disable .NET SDK analysis override them from a _.globalconfig_ file placed into the given project's folder. There you can disable any unwanted rules, like disabling .NET code style analysis completely:
MSBuild only loads in the closest _Directory.Build.props_ file to the project being built. So this empty props file will supersede any parent _Directory.Build.props_. To also disable .NET SDK analysis override them from a _.globalconfig_ file placed into the given project's folder. There you can disable any unwanted rules, like disabling .NET code style analysis completely:

```editorconfig
dotnet_analyzer_diagnostic.category-Style.severity = none
```

If you rely on `Lombiq.Analyzers` to set up compiler properties such as `<LangVersion>` you may still want to import the parent _Directory.Build.props_ file and just disable the code analyzers. Put this into the _Directory.Build.props_ file instead:

```xml
<Project>
<PropertyGroup>
<RunCodeAnalysis>false</RunCodeAnalysis>
</PropertyGroup>

<Import Project="$([MSBuild]::GetPathOfFileAbove('Directory.Build.props', '$(MSBuildThisFileDirectory)../'))" />
</Project>
```

Or if you added `Lombiq.Analyzers` to only a single project as a package reference, you can just add the `<RunCodeAnalysis>false</RunCodeAnalysis>` element.

## How to disable all analyzers during `dotnet build`

By default the `dotnet build` command runs analyzers and produces code analysis warnings if there are any but it makes the build slower. Pass the `/p:RunCodeAnalysis=false` parameter to disable analyzers during build, like:
Expand Down
Loading