Skip to content

Commit 6935885

Browse files
BenjaminAbtBenjaminAbt
committed
Standardize formatting in build configuration files
This commit improves the readability of `Directory.Build.props` and `Directory.Packages.props` by standardizing indentation and formatting. The `PublicKey` section has been reformatted for clarity, and all `PackageVersion` entries for `Microsoft.CodeAnalysis` packages now consistently include `PrivateAssets` and `IncludeAssets` attributes.
1 parent 03fc546 commit 6935885

File tree

2 files changed

+129
-111
lines changed

2 files changed

+129
-111
lines changed

‎Directory.Build.props

+117-108
Original file line numberDiff line numberDiff line change
@@ -1,125 +1,134 @@
11
<Project>
2-
<PropertyGroup Label="Project">
3-
<Product>MyCSharp.HttpClientHints</Product>
4-
<Authors>MyCSharp.de, Benjamin Abt, Günther Foidl and Contributors</Authors>
5-
<Company>MyCSharp.de</Company>
6-
</PropertyGroup>
2+
<PropertyGroup Label="Project">
3+
<Product>MyCSharp.HttpClientHints</Product>
4+
<Authors>MyCSharp.de, Benjamin Abt, Günther Foidl and Contributors</Authors>
5+
<Company>MyCSharp.de</Company>
6+
</PropertyGroup>
77

8-
<PropertyGroup Label="Vars">
9-
<IsWindows Condition="$([MSBuild]::IsOSPlatform('Windows'))">true</IsWindows>
10-
<IsOSX Condition="$([MSBuild]::IsOSPlatform('OSX'))">true</IsOSX>
11-
<IsLinux Condition="$([MSBuild]::IsOSPlatform('Linux'))">true</IsLinux>
8+
<PropertyGroup Label="Vars">
9+
<IsWindows Condition="$([MSBuild]::IsOSPlatform('Windows'))">true</IsWindows>
10+
<IsOSX Condition="$([MSBuild]::IsOSPlatform('OSX'))">true</IsOSX>
11+
<IsLinux Condition="$([MSBuild]::IsOSPlatform('Linux'))">true</IsLinux>
1212

13-
<IsTestProject>$(MSBuildProjectName.EndsWith('Tests'))</IsTestProject>
14-
<IsUnitTestProject>$(MSBuildProjectName.EndsWith('UnitTests'))</IsUnitTestProject>
15-
<IsIntegrationTestProject>$(MSBuildProjectName.EndsWith('IntegrationTests'))</IsIntegrationTestProject>
16-
<IsBenchmarkProject>$(MsBuildProjectName.EndsWith('Benchmarks'))</IsBenchmarkProject>
17-
</PropertyGroup>
13+
<IsTestProject>$(MSBuildProjectName.EndsWith('Tests'))</IsTestProject>
14+
<IsUnitTestProject>$(MSBuildProjectName.EndsWith('UnitTests'))</IsUnitTestProject>
15+
<IsIntegrationTestProject>$(MSBuildProjectName.EndsWith('IntegrationTests'))</IsIntegrationTestProject>
16+
<IsBenchmarkProject>$(MsBuildProjectName.EndsWith('Benchmarks'))</IsBenchmarkProject>
17+
</PropertyGroup>
1818

19-
<PropertyGroup Label="Assembly">
20-
<TargetFrameworks>net8.0;net9.0;net10.0</TargetFrameworks>
21-
<RootNamespace>MyCSharp.$(MSBuildProjectName)</RootNamespace>
22-
<AssemblyName>MyCSharp.$(MSBuildProjectName)</AssemblyName>
23-
</PropertyGroup>
19+
<PropertyGroup Label="Assembly">
20+
<TargetFrameworks>net8.0;net9.0;net10.0</TargetFrameworks>
21+
<RootNamespace>MyCSharp.$(MSBuildProjectName)</RootNamespace>
22+
<AssemblyName>MyCSharp.$(MSBuildProjectName)</AssemblyName>
23+
</PropertyGroup>
2424

25-
<PropertyGroup>
26-
<SignAssembly>true</SignAssembly>
27-
<AssemblyOriginatorKeyFile>$(MSBuildThisFileDirectory)MyCSharp.HttpClientHints.snk</AssemblyOriginatorKeyFile>
25+
<PropertyGroup>
26+
<SignAssembly>true</SignAssembly>
27+
<AssemblyOriginatorKeyFile>$(MSBuildThisFileDirectory)MyCSharp.HttpClientHints.snk</AssemblyOriginatorKeyFile>
2828

29-
<PublicKey>
30-
002400000480000094000000060200000024000052534131000400000100010049809bc922cd71
31-
a1539dd60826caafead07781420334254bdc0c276165f7313f241833f972437ee215684b4e10de
32-
49501812fa7fcdb18baead466e32978ca3e45ff7c82616283718d6ab2b729ab40e656fb856a845
33-
cede9fdd2b449fc34a99edf258524ce5e1f958a9598efba2953e34e179b13c086500f9b72ca08a
34-
065effe0
35-
</PublicKey>
36-
</PropertyGroup>
29+
<PublicKey>
30+
002400000480000094000000060200000024000052534131000400000100010049809bc922cd71
31+
a1539dd60826caafead07781420334254bdc0c276165f7313f241833f972437ee215684b4e10de
32+
49501812fa7fcdb18baead466e32978ca3e45ff7c82616283718d6ab2b729ab40e656fb856a845
33+
cede9fdd2b449fc34a99edf258524ce5e1f958a9598efba2953e34e179b13c086500f9b72ca08a
34+
065effe0
35+
</PublicKey>
36+
</PropertyGroup>
3737

38-
<PropertyGroup Label="Compiler">
39-
<LangVersion>preview</LangVersion>
40-
<DebugType>embedded</DebugType>
41-
<Nullable>enable</Nullable>
42-
<DefaultLanguage>en-US</DefaultLanguage>
43-
<ImplicitUsings>enable</ImplicitUsings>
44-
<TreatWarningsAsErrors>true</TreatWarningsAsErrors>
45-
</PropertyGroup>
38+
<PropertyGroup Label="Compiler">
39+
<LangVersion>preview</LangVersion>
40+
<DebugType>embedded</DebugType>
41+
<Nullable>enable</Nullable>
42+
<DefaultLanguage>en-US</DefaultLanguage>
43+
<ImplicitUsings>enable</ImplicitUsings>
44+
<TreatWarningsAsErrors>true</TreatWarningsAsErrors>
45+
</PropertyGroup>
4646

47-
<PropertyGroup Label="Package">
48-
<IsPackable>false</IsPackable>
49-
<NoPackageAnalysis>true</NoPackageAnalysis>
50-
<MinClientVersion>2.12</MinClientVersion>
51-
<EmbedUntrackedSources>true</EmbedUntrackedSources>
47+
<PropertyGroup Label="Package">
48+
<IsPackable>false</IsPackable>
49+
<NoPackageAnalysis>true</NoPackageAnalysis>
50+
<MinClientVersion>2.12</MinClientVersion>
51+
<EmbedUntrackedSources>true</EmbedUntrackedSources>
5252

53-
<Description>HTTP Client Hints for .NET</Description>
54-
<PackageProjectUrl>https://github.com/mycsharp/HttpClientHints</PackageProjectUrl>
55-
<RepositoryUrl>https://github.com/mycsharp/HttpClientHints</RepositoryUrl>
56-
<PackageTags>UserAgent, User Agent, Client Hints, Browser, Client, Detector, Detection, Console, ASP, Desktop, Mobile</PackageTags>
57-
</PropertyGroup>
53+
<Description>HTTP Client Hints for .NET</Description>
54+
<PackageProjectUrl>https://github.com/mycsharp/HttpClientHints</PackageProjectUrl>
55+
<RepositoryUrl>https://github.com/mycsharp/HttpClientHints</RepositoryUrl>
56+
<PackageTags>UserAgent, User Agent, Client Hints, Browser, Client, Detector, Detection, Console, ASP, Desktop, Mobile</PackageTags>
57+
</PropertyGroup>
5858

59-
<PropertyGroup Condition="'$(IsTestProject)' != 'true' AND '$(IsBenchmarkProject)' != 'true'">
60-
<GenerateDocumentationFile>true</GenerateDocumentationFile>
61-
</PropertyGroup>
59+
<PropertyGroup Condition="'$(IsTestProject)' != 'true' AND '$(IsBenchmarkProject)' != 'true'">
60+
<GenerateDocumentationFile>true</GenerateDocumentationFile>
61+
</PropertyGroup>
6262

63-
<PropertyGroup Label="Visual Studio">
64-
<!-- https://devblogs.microsoft.com/visualstudio/visual-studio-2022-17-5-performance-enhancements/ -->
65-
<AccelerateBuildsInVisualStudio>true</AccelerateBuildsInVisualStudio>
66-
</PropertyGroup>
63+
<PropertyGroup Label="Visual Studio">
64+
<!-- https://devblogs.microsoft.com/visualstudio/visual-studio-2022-17-5-performance-enhancements/ -->
65+
<AccelerateBuildsInVisualStudio>true</AccelerateBuildsInVisualStudio>
66+
</PropertyGroup>
6767

68-
<PropertyGroup Label="NuGet Audit">
69-
<NuGetAudit>true</NuGetAudit>
70-
<NuGetAuditMode>all</NuGetAuditMode>
71-
<NuGetAuditLevel>low</NuGetAuditLevel>
72-
</PropertyGroup>
68+
<PropertyGroup Label="NuGet Audit">
69+
<NuGetAudit>true</NuGetAudit>
70+
<NuGetAuditMode>all</NuGetAuditMode>
71+
<NuGetAuditLevel>low</NuGetAuditLevel>
72+
</PropertyGroup>
7373

74-
<ItemGroup Label="Default Test Dependencies" Condition="'$(IsTestProject)' == 'true'">
75-
<PackageReference Include="Microsoft.NET.Test.Sdk" />
76-
<PackageReference Include="Microsoft.Extensions.Diagnostics.Testing" />
77-
<PackageReference Include="NSubstitute" />
78-
<PackageReference Include="NSubstitute.Analyzers.CSharp">
79-
<PrivateAssets>all</PrivateAssets>
80-
<IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
81-
</PackageReference>
82-
<PackageReference Include="xunit.v3" />
83-
<PackageReference Include="xunit.v3.extensibility.core"/>
84-
<PackageReference Include="xunit.v3.assert" />
85-
<PackageReference Include="xunit.runner.console">
86-
<PrivateAssets>all</PrivateAssets>
87-
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
88-
</PackageReference>
89-
<PackageReference Include="xunit.runner.visualstudio">
90-
<PrivateAssets>all</PrivateAssets>
91-
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
92-
</PackageReference>
93-
</ItemGroup>
74+
<ItemGroup Label="Default Test Dependencies" Condition="'$(IsTestProject)' == 'true'">
75+
<PackageReference Include="Microsoft.NET.Test.Sdk" />
76+
<PackageReference Include="Microsoft.Extensions.Diagnostics.Testing" />
77+
<PackageReference Include="NSubstitute" />
78+
<PackageReference Include="NSubstitute.Analyzers.CSharp">
79+
<PrivateAssets>all</PrivateAssets>
80+
<IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
81+
</PackageReference>
82+
<PackageReference Include="xunit.v3" />
83+
<PackageReference Include="xunit.v3.extensibility.core"/>
84+
<PackageReference Include="xunit.v3.assert" />
85+
<PackageReference Include="xunit.runner.console">
86+
<PrivateAssets>all</PrivateAssets>
87+
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
88+
</PackageReference>
89+
<PackageReference Include="xunit.runner.visualstudio">
90+
<PrivateAssets>all</PrivateAssets>
91+
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
92+
</PackageReference>
93+
</ItemGroup>
9494

95-
<ItemGroup Label="Default Analyzers">
96-
<PackageReference Include="Roslynator.Analyzers">
97-
<PrivateAssets>all</PrivateAssets>
98-
<IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
99-
</PackageReference>
100-
<PackageReference Include="Roslynator.Formatting.Analyzers">
101-
<PrivateAssets>all</PrivateAssets>
102-
<IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
103-
</PackageReference>
104-
<PackageReference Include="Roslynator.CodeAnalysis.Analyzers">
105-
<PrivateAssets>all</PrivateAssets>
106-
<IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
107-
</PackageReference>
108-
<PackageReference Include="Microsoft.CodeAnalysis.CSharp.Workspaces" />
109-
<PackageReference Include="Microsoft.CodeAnalysis.Common" />
110-
<PackageReference Include="Microsoft.CodeAnalysis.CSharp" />
111-
<PackageReference Include="Meziantou.Analyzer">
112-
<PrivateAssets>all</PrivateAssets>
113-
<IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
114-
</PackageReference>
115-
</ItemGroup>
95+
<ItemGroup Label="Default Analyzers">
96+
<PackageReference Include="Roslynator.Analyzers">
97+
<PrivateAssets>all</PrivateAssets>
98+
<IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
99+
</PackageReference>
100+
<PackageReference Include="Roslynator.Formatting.Analyzers">
101+
<PrivateAssets>all</PrivateAssets>
102+
<IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
103+
</PackageReference>
104+
<PackageReference Include="Roslynator.CodeAnalysis.Analyzers">
105+
<PrivateAssets>all</PrivateAssets>
106+
<IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
107+
</PackageReference>
108+
<PackageReference Include="Microsoft.CodeAnalysis.CSharp.Workspaces">
109+
<PrivateAssets>all</PrivateAssets>
110+
<IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
111+
</PackageReference>
112+
<PackageReference Include="Microsoft.CodeAnalysis.Common">
113+
<PrivateAssets>all</PrivateAssets>
114+
<IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
115+
</PackageReference>
116+
<PackageReference Include="Microsoft.CodeAnalysis.CSharp">
117+
<PrivateAssets>all</PrivateAssets>
118+
<IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
119+
</PackageReference>
120+
<PackageReference Include="Meziantou.Analyzer">
121+
<PrivateAssets>all</PrivateAssets>
122+
<IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
123+
</PackageReference>
124+
</ItemGroup>
116125

117-
<!-- Block Projects with Privacy/Security/License Concerns -->
118-
<Target Name="CheckBlockedPackages" AfterTargets="ResolvePackageDependenciesForBuild">
119-
<Error Code="420" Text="Blocked package dependency detected: %(PackageDependencies.Identity)"
120-
Condition="'%(PackageDependencies.Identity)' == 'Devlooped.SponsorLink'" />
121-
<Error Code="420" Text="Blocked package dependency detected: %(PackageDependencies.Identity)"
122-
Condition="'%(PackageDependencies.Identity)' == 'FluentAssertions'" />
123-
</Target>
126+
<!-- Block Projects with Privacy/Security/License Concerns -->
127+
<Target Name="CheckBlockedPackages" AfterTargets="ResolvePackageDependenciesForBuild">
128+
<Error Code="420" Text="Blocked package dependency detected: %(PackageDependencies.Identity)"
129+
Condition="'%(PackageDependencies.Identity)' == 'Devlooped.SponsorLink'" />
130+
<Error Code="420" Text="Blocked package dependency detected: %(PackageDependencies.Identity)"
131+
Condition="'%(PackageDependencies.Identity)' == 'FluentAssertions'" />
132+
</Target>
124133

125134
</Project>

‎Directory.Packages.props

+12-3
Original file line numberDiff line numberDiff line change
@@ -46,9 +46,18 @@
4646
<PrivateAssets>all</PrivateAssets>
4747
<IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
4848
</PackageVersion>
49-
<PackageVersion Include="Microsoft.CodeAnalysis.CSharp.Workspaces" Version="4.13.0" />
50-
<PackageVersion Include="Microsoft.CodeAnalysis.Common" Version="4.13.0" />
51-
<PackageVersion Include="Microsoft.CodeAnalysis.CSharp" Version="4.13.0" />
49+
<PackageVersion Include="Microsoft.CodeAnalysis.CSharp.Workspaces" Version="4.13.0">
50+
<PrivateAssets>all</PrivateAssets>
51+
<IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
52+
</PackageVersion>
53+
<PackageVersion Include="Microsoft.CodeAnalysis.Common" Version="4.13.0">
54+
<PrivateAssets>all</PrivateAssets>
55+
<IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
56+
</PackageVersion>
57+
<PackageVersion Include="Microsoft.CodeAnalysis.CSharp" Version="4.13.0">
58+
<PrivateAssets>all</PrivateAssets>
59+
<IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
60+
</PackageVersion>
5261
<PackageVersion Include="Meziantou.Analyzer" Version="2.0.195">
5362
<PrivateAssets>all</PrivateAssets>
5463
<IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>

0 commit comments

Comments
 (0)