modernize, add license headers

Author: saucecontrol

.editorconfig

@@ -1,9 +1,27 @@
 root = true
 
 [*]
+charset = utf-8
+end_of_line = crlf
 indent_style = tab
 indent_size = 4
 
+[*.yml]
+indent_style = space
+indent_size = 2
+
 [*.cs]
-# CA1031: Do not catch general exception types
-dotnet_diagnostic.CA1031.severity = silent
+file_header_template = Copyright © Clinton Ingram and Contributors.  Licensed under the MIT License.
+
+csharp_style_namespace_declarations = file_scoped:suggestion
+
+dotnet_diagnostic.CA1031.severity = silent ; do not catch general exception types
+
+dotnet_naming_rule.private_non_field_members_should_be_camel_case.severity = suggestion
+dotnet_naming_rule.private_non_field_members_should_be_camel_case.symbols = private_non_field_members
+dotnet_naming_rule.private_non_field_members_should_be_camel_case.style = camel_case
+
+dotnet_naming_symbols.private_non_field_members.applicable_kinds = property, event, method
+dotnet_naming_symbols.private_non_field_members.applicable_accessibilities = private
+
+dotnet_naming_style.camel_case.capitalization = camel_case

azure-pipelines.yml

@@ -1,47 +1,58 @@
+name: $(Year:yy)$(DayOfYear)$(Rev:r)
 trigger:
-- master
+  branches:
+    include:
+    - master
+  paths:
+    exclude:
+    - readme.md
 
 pool:
-  vmImage: windows-latest
+  vmImage: ubuntu-latest
 
 variables:
+  azureNuGet: https://pkgs.dev.azure.com/saucecontrol/InheritDoc/_packaging/inheritdoc_ci/nuget/v3/index.json
   disable.coverage.autogenerate: true
 
-name: $(Year:yy)$(DayOfYear)$(Rev:r)
 steps:
 - task: UseDotNet@2
-  displayName: Ensure 5.0 SDK
+  displayName: Ensure 8.0 SDK
+  inputs:
+    version: 8.0.x
+    includePreviewVersions: true
+
+- task: UseDotNet@2
+  displayName: Ensure 6.0 Runtime
   inputs:
-    version: 5.0.x
+    packageType: runtime
+    version: 6.0.x
     performMultiLevelLookup: true
 
-- script: dotnet build src\InheritDoc -c Dist --version-suffix ci$(Build.BuildNumber)
+- script: dotnet build src/InheritDoc -c Dist --version-suffix ci$(Build.BuildNumber)
   displayName: Build
 
-- script: dotnet test tests\InheritDoc.Test -c Coverage -s tests\runsettings --logger trx --collect "XPlat Code Coverage"
+- script: dotnet test tests/InheritDoc.Test -c Coverage
   displayName: Test
 
-- task: Palmmedia.reportgenerator.reportgenerator-build-release-task.reportgenerator@4
+- task: Palmmedia.reportgenerator.reportgenerator-build-release-task.reportgenerator@5
   displayName: Coverage Reports
   inputs:
-    reports: out\coverage\opencover*.xml
-    targetdir: out\coverage\reports
+    reports: out/coverage/opencover*.xml
+    targetdir: out/coverage/reports
     reporttypes: HtmlInline_AzurePipelines;Cobertura;Badges
 
 - task: NuGetAuthenticate@0
   condition: ne(variables['Build.Reason'], 'PullRequest')
 
-- script: dotnet nuget push --api-key AzureArtifacts --source https://pkgs.dev.azure.com/saucecontrol/InheritDoc/_packaging/inheritdoc_ci/nuget/v3/index.json out\bin\InheritDoc\Dist\SauceControl.InheritDoc.*.nupkg
+- script: dotnet nuget push --source $(azureNuGet) --api-key AzureArtifacts out/nuget/*.nupkg
   displayName: Push
   condition: ne(variables['Build.Reason'], 'PullRequest')
 
 - task: PublishTestResults@2
   inputs:
     testRunner: VSTest
-    testResultsFiles: out\testresults\*.trx
+    testResultsFiles: out/testresults/*.trx
 
-- task: PublishCodeCoverageResults@1
+- task: PublishCodeCoverageResults@2
   inputs:
-    codeCoverageTool: Cobertura
-    summaryFileLocation: out\coverage\reports\cobertura.xml
-    reportDirectory: out\coverage\reports
+    summaryFileLocation: out/coverage/reports/Cobertura.xml

build/Common.props

@@ -6,32 +6,37 @@
 		<RepositoryUrl>https://github.com/saucecontrol/InheritDoc</RepositoryUrl>
 		<Copyright>Copyright © 2019-$([System.DateTime]::Today.Year) $(Authors)</Copyright>
 		<Title>Automatic Documentation Inheritance Processing</Title>
+		<Description>Automatically replace &lt;inheritdoc /&gt; tags with inherited documentation at build time.  Integrates with MSBuild, so no command line tool or VS add-on is required.</Description>
 
 		<RootNamespace>$(MSBuildProjectName)</RootNamespace>
 		<AssemblyName>$(Owners).$(MSBuildProjectName)</AssemblyName>
 		<AssemblyTitle>$(MSBuildProjectName)</AssemblyTitle>
 		<Product>$(MSBuildProjectName)</Product>
 
-		<PackageIcon>package/$(Owners).png</PackageIcon>
+		<PackageIcon>$(Owners).png</PackageIcon>
+		<PackageReadmeFile>readme.md</PackageReadmeFile>
 		<PackageLicenseExpression>MIT</PackageLicenseExpression>
 		<PackageProjectUrl>$(RepositoryUrl)</PackageProjectUrl>
 		<PackageTags>Inherit, XML, Documentation, Comments, MSBuild</PackageTags>
 		<PackageReleaseNotes>See $(RepositoryUrl)/releases for release-specific notes.</PackageReleaseNotes>
-		<PackageDescription>Automatically replace &lt;inheritdoc /&gt; tags with inherited documentation at build time.  Integrates with MSBuild, so no command line tool or VS add-on is required.</PackageDescription>
 
-		<LangVersion>9</LangVersion>
+		<LangVersion>12</LangVersion>
+		<WarningLevel>7</WarningLevel>
 		<Features>strict</Features>
 		<Nullable>annotations</Nullable>
 		<AllowUnsafeBlocks>true</AllowUnsafeBlocks>
 
 		<Configurations>Debug;Release;Dist</Configurations>
 		<Configuration Condition="'$(Configuration)'==''">Release</Configuration>
 
+		<ProjectRoot>$(MSBuildProjectDirectory)\</ProjectRoot>
 		<RepositoryRoot>$(MSBuildThisFileDirectory)..\</RepositoryRoot>
 		<BaseIntermediateOutputPath>$(RepositoryRoot)out\obj\$(MSBuildProjectName)\</BaseIntermediateOutputPath>
-		<BaseOutputPath>$(RepositoryRoot)out\bin\$(MSBuildProjectName)\</BaseOutputPath>
+		<BaseOutputBinPath>$(RepositoryRoot)out\bin\</BaseOutputBinPath>
+		<BaseOutputPath>$(BaseOutputBinPath)$(MSBuildProjectName)\</BaseOutputPath>
 		<IntermediateOutputPath>$(BaseIntermediateOutputPath)$(Configuration)\</IntermediateOutputPath>
 		<OutputPath>$(BaseOutputPath)$(Configuration)\</OutputPath>
+		<PackageOutputPath>$(RepositoryRoot)out\nuget\</PackageOutputPath>
 		<IntDir>$(IntermediateOutputPath)$(TargetFramework)\</IntDir>
 		<OutDir>$(OutputPath)$(TargetFramework)\</OutDir>
 
@@ -52,8 +57,9 @@
 	</PropertyGroup>
 
 	<ItemGroup Condition="'$(Configuration)'=='Dist' Or '$(Configuration)'=='Coverage'">
-		<None Include="$(MSBuildThisFileDirectory)$(Owners).png" Pack="true" PackagePath="package" />
-		<None Include="$(RepositoryRoot)license" Pack="true" PackagePath="package" />
+		<None Include="$(MSBuildThisFileDirectory)$(Owners).png" Pack="true" PackagePath="/" />
+		<None Include="$(ProjectRoot)readme.md" Pack="true" PackagePath="/" />
+		<None Include="$(RepositoryRoot)license" Pack="true" PackagePath="/" />
 		<SourceRoot Include="$(RepositoryRoot)" />
 	</ItemGroup>
 

license

@@ -1,6 +1,6 @@
 The MIT License
 
-Copyright (c) 2019-2021 Clinton Ingram and Contributors
+Copyright (c) 2019-2023 Clinton Ingram and Contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

src/Directory.Build.props

@@ -16,7 +16,7 @@
 	</PropertyGroup>
 
 	<ItemGroup Condition="'$(Configuration)'=='Dist' or '$(Configuration)'=='Coverage'">
-		<PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.0.0" PrivateAssets="all" />
+		<PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.1.1" PrivateAssets="all" />
 	</ItemGroup>
 
 	<ItemGroup Condition="'$(Configuration)'!='Dist'">

src/Directory.Build.targets

@@ -1,4 +1,6 @@
-using System;
+// Copyright © Clinton Ingram and Contributors.  Licensed under the MIT License.
+
+using System;
 using System.Linq;
 using System.Collections.Generic;
 
@@ -9,13 +11,13 @@ internal static class CecilExtensions
 	private const string compilerGeneratedAttribute = "System.Runtime.CompilerServices.CompilerGeneratedAttribute";
 
 	// These are ignored as the base for types, defaulting the doc inheritance target to an implemented interface instead.
-	private static readonly string[] ignoredBaseTypes = new[] {
+	private static readonly string[] ignoredBaseTypes = [
 		"System.Object",
 		"System.ValueType",
 		"System.Enum",
 		"System.Delegate",
 		"System.MulticastDelegate"
-	};
+	];
 
 	private static readonly IEnumerable<string> emptyStringEnumerable = new[] { string.Empty };
 
@@ -297,7 +299,7 @@ public static RefAssemblyResolver Create(string mainAssembly, string[] refAssemb
 			var resolver = new RefAssemblyResolver();
 			var rparams = new ReaderParameters { AssemblyResolver = resolver };
 
-			foreach (var assemblyFile in refAssemblies.Concat(new[] { mainAssembly }))
+			foreach (string assemblyFile in refAssemblies.Concat(new[] { mainAssembly }))
 			{
 				var assembly = AssemblyDefinition.ReadAssembly(assemblyFile, rparams);
 				resolver.cache[assembly.FullName] = assembly;
@@ -319,7 +321,7 @@ public AssemblyDefinition Resolve(AssemblyNameReference name)
 			return match ?? throw new AssemblyResolutionException(name);
 		}
 
-		public AssemblyDefinition Resolve(AssemblyNameReference name, ReaderParameters parameters) => Resolve(name);
+		public AssemblyDefinition Resolve(AssemblyNameReference name, ReaderParameters _) => Resolve(name);
 
 		public void Dispose()
 		{

src/InheritDoc/CecilExtensions.cs

@@ -1,8 +1,8 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
 	<PropertyGroup>
-		<VersionPrefix>1.3.0</VersionPrefix>
-		<TargetFrameworks>netstandard2.0;net46</TargetFrameworks>
+		<VersionPrefix>1.4.0</VersionPrefix>
+		<TargetFrameworks>netstandard2.0;net462</TargetFrameworks>
 	</PropertyGroup>
 
 	<PropertyGroup>
@@ -14,15 +14,18 @@
 	</PropertyGroup>
 
 	<ItemGroup>
-		<None Include="package\build\*" Pack="true" PackagePath="build;buildCrossTargeting" />
+		<None Include="package\build\*" Pack="true" PackagePath="build;buildMultiTargeting" />
 		<None Include="$(OutputPath)\*\Mono.Cecil.dll" Pack="true" PackagePath="tools" />
 		<None Include="$(OutputPath)\*\System.ValueTuple.dll" Pack="true" PackagePath="tools" />
 	</ItemGroup>
 
 	<ItemGroup>
 		<PackageReference Include="Microsoft.Build.Utilities.Core" Version="15.9.20" PrivateAssets="all" />
-		<PackageReference Include="Mono.Cecil" Version="0.11.3" PrivateAssets="all" />
-		<PackageReference Condition="$(DefineConstants.Contains('NETFRAMEWORK'))" Include="System.ValueTuple" Version="4.5.0" PrivateAssets="all" />
+		<PackageReference Include="Mono.Cecil" Version="0.11.5" PrivateAssets="all" />
+		<PackageReference Condition="$(DefineConstants.Contains('NETFRAMEWORK'))" Include="System.ValueTuple" Version="4.5.0" />
+		<!-- these are for use in the test project, downloaded here to avoid version conflicts when building tests -->
+		<PackageDownload Include="Microsoft.NETCore.App.Ref" Version="[7.0.0]" />
+		<PackageDownload Include="Microsoft.NETFramework.ReferenceAssemblies.net48" Version="[1.0.0]" />
 	</ItemGroup>
 
 </Project>

src/InheritDoc/InheritDoc.csproj

@@ -1,4 +1,6 @@
-using System;
+// Copyright © Clinton Ingram and Contributors.  Licensed under the MIT License.
+
+using System;
 using System.IO;
 using System.Text;
 using System.Linq;
@@ -30,14 +32,14 @@ private static class DocElementNames
 
 	private static class DocAttributeNames
 	{
-		public static readonly XName _visited = XName.Get("_visited");
-		public static readonly XName _trimmed = XName.Get("_trimmed");
+		public static readonly XName _visited = XName.Get(nameof(_visited));
+		public static readonly XName _trimmed = XName.Get(nameof(_trimmed));
 		public static readonly XName Cref = XName.Get("cref");
 		public static readonly XName Name = XName.Get("name");
 		public static readonly XName Path = XName.Get("path");
 	}
 
-	private static readonly XName[] inheritSkipIfExists = new[] {
+	private static readonly XName[] inheritSkipIfExists = [
 		XName.Get("example"),
 		XName.Get("exclude"),
 		XName.Get("filterpriority"),
@@ -47,15 +49,15 @@ private static class DocAttributeNames
 		XName.Get("returns"),
 		XName.Get("threadsafety"),
 		XName.Get("value")
-	 };
+	 ];
 
-	private static readonly XName[] inheritSkipIfMatch = new[] {
+	private static readonly XName[] inheritSkipIfMatch = [
 		XName.Get("cref"),
 		XName.Get("href"),
 		XName.Get("name"),
 		XName.Get("vref"),
 		XName.Get("xref")
-	};
+	];
 
 	private static readonly string refFolderToken = Path.DirectorySeparatorChar + "ref" + Path.DirectorySeparatorChar;
 	private static readonly string libFolderToken = Path.DirectorySeparatorChar + "lib" + Path.DirectorySeparatorChar;
@@ -101,7 +103,7 @@ static XDocument loadDoc(string path)
 			beforeCount = docMembers.Descendants(DocElementNames.InheritDoc).Count(dm => !dm.Ancestors(DocElementNames.Member).Any(m => m.HasAttribute(DocAttributeNames._trimmed)));
 
 		var mem = default(XElement);
-		while ((mem = docMembers.Elements(DocElementNames.Member).FirstOrDefault(m => isInheritDocCandidate(m))) is not null)
+		while ((mem = docMembers.Elements(DocElementNames.Member).FirstOrDefault(isInheritDocCandidate)) is not null)
 			replaceInheritDoc(docPath, mem, docMap, docMembers, refDocs, logger);
 
 		foreach (var md in docMembers.Elements(DocElementNames.Member).Where(m => m.HasAttribute(DocAttributeNames._visited)))
@@ -251,7 +253,7 @@ private static void replaceInheritDoc(string file, XElement mem, IDictionary<str
 
 		foreach (var inh in mem.Descendants(DocElementNames.InheritDoc).ToArray())
 		{
-			string? cref = (string)inh.Attribute(DocAttributeNames.Cref) ?? dml?.First().Cref;
+			string? cref = (string)inh.Attribute(DocAttributeNames.Cref) ?? dml?.FirstOrDefault()?.Cref;
 			if (string.IsNullOrEmpty(cref))
 			{
 				if (!mem.HasAttribute(DocAttributeNames._trimmed))
@@ -374,7 +376,7 @@ static XDocument getRefDocs(IReadOnlyCollection<string> refAssemblies, IReadOnly
 			return doc;
 
 		var docPaths = refAssemblies
-			.Select(path => Path.Combine(Path.GetDirectoryName(path)!, Path.GetFileNameWithoutExtension(path) + ".xml"))
+			.Select(path => Path.ChangeExtension(path, ".xml"))
 			.Concat(refAssemblies.Select(p => Path.GetDirectoryName(p)).Distinct().Select(p => Path.Combine(p!, "namespaces.xml"))
 			.Concat(refDocs));
 
@@ -478,18 +480,16 @@ private static string getTypeIDFromDocID(string docID)
 
 	private static IEnumerable<XElement> findDocsByID(XElement container, string docID) => container.Elements(DocElementNames.Member).Where(m => (string)m.Attribute(DocAttributeNames.Name) == docID);
 
-	private class DocMatch
+	private class DocMatch(string cref)
 	{
 		private static readonly IReadOnlyDictionary<string, string> emptyMap = new Dictionary<string, string>();
 
-		public string Cref;
+		public string Cref = cref;
 		public IReadOnlyDictionary<string, string> TypeParamMap = emptyMap;
 		public IReadOnlyDictionary<string, string> ParamMap = emptyMap;
 		public bool HasReturn = false;
 		public bool HasValue = false;
 
-		public DocMatch(string cref) => Cref = cref;
-
 		public DocMatch(string cref, TypeReference t, TypeReference? bt = null) : this(cref)
 		{
 			if (t.HasGenericParameters && (bt?.IsGenericInstance ?? true))
@@ -501,7 +501,7 @@ public DocMatch(string cref, TypeReference t, TypeReference? bt = null) : this(c
 					var ga = ((GenericInstanceType)bt).GenericArguments;
 					var rbt = bt.Resolve();
 
-					foreach (var tp in t.GenericParameters.Where(p => ga.Contains(p)))
+					foreach (var tp in t.GenericParameters.Where(ga.Contains))
 						tpm.Add(rbt.GenericParameters[ga.IndexOf(tp)].Name, tp.Name);
 				}
 				else
@@ -548,7 +548,7 @@ public enum Severity { Diag, Info, Message, Warn, Error }
 	void Warn(string code, string file, int line, int column, string msg);
 }
 
-internal class ErrorCodes
+internal static class ErrorCodes
 {
 	public const string BadXml = "IDT001";
 	public const string NoDocs = "IDT002";