Merge pull request #92 from jpinz/chore/package-metadata

Improve NuGet package metadata and AOT compatibility

Author: JamieMagee

Directory.Build.props

@@ -19,6 +19,7 @@
       https://github.com/dotnet/sourcelink
     -->
     <PublishRepositoryUrl>true</PublishRepositoryUrl>
+    <EmbedUntrackedSources>true</EmbedUntrackedSources>
     <IncludeSymbols>true</IncludeSymbols>
     <SymbolPackageFormat>snupkg</SymbolPackageFormat>
   </PropertyGroup>

README.md

@@ -17,7 +17,7 @@ dotnet add package packageurl-dotnet
 Or in your project file:
 
 ```xml
-<PackageReference Include="packageurl-dotnet" Version="1.0.0" />
+<PackageReference Include="packageurl-dotnet" Version="2.0.0" />
 ```
 
 ## Usage

src/PackageUrl.cs

@@ -40,10 +40,9 @@ namespace PackageUrl;
 /// See <see href="https://ecma-tc54.github.io/ECMA-427/">ECMA-427</see> for the full specification.
 /// </para>
 /// </summary>
-[Serializable]
 public sealed class PackageUrl : IEquatable<PackageUrl>
 {
-    private int _hashCode;
+    private readonly int _hashCode;
 
     /// <summary>
     /// The URL scheme. Always <c>"pkg"</c>.

src/PackageUrl.csproj

@@ -1,16 +1,18 @@
 <Project Sdk="Microsoft.NET.Sdk">
-
   <PropertyGroup>
     <TargetFrameworks>netstandard2.0;net8.0</TargetFrameworks>
-    <!--
-      Package
-      https://docs.microsoft.com/en-us/nuget/reference/msbuild-targets#pack-target
-    -->
     <PackageId>packageurl-dotnet</PackageId>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
-    <PackageTags>Package URL;purl</PackageTags>
-    <PackageDescription>.NET implementation of the package url spec</PackageDescription>
+    <PackageTags>purl;package-url;ECMA-427;SBOM;SCA</PackageTags>
+    <PackageDescription>Parse, build, and normalize Package URLs (purl) per ECMA-427. Handles strings like pkg:nuget/Newtonsoft.Json@13.0.1.</PackageDescription>
+    <PackageProjectUrl>https://github.com/package-url/packageurl-dotnet</PackageProjectUrl>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
+    <Copyright>Copyright (c) the packageurl-dotnet authors</Copyright>
     <PackageOutputPath>../nuget</PackageOutputPath>
+    <IsAotCompatible Condition="$([MSBuild]::IsTargetFrameworkCompatible('$(TargetFramework)', 'net8.0'))">true</IsAotCompatible>
   </PropertyGroup>
 
+  <ItemGroup>
+    <None Include="../README.md" Pack="true" PackagePath="/" />
+  </ItemGroup>
 </Project>

src/packages.lock.json

@@ -24,6 +24,12 @@
       }
     },
     "net8.0": {
+      "Microsoft.NET.ILLink.Tasks": {
+        "type": "Direct",
+        "requested": "[8.0.24, )",
+        "resolved": "8.0.24",
+        "contentHash": "1gnadp//+DoGJvV4AFdzPqYPxkypaWYjYMCr7KAacV0iadsHz1nU+rrkoxBCna4FCmeKH49CisEwa7g94/MbEg=="
+      },
       "MinVer": {
         "type": "Direct",
         "requested": "[7.0.0, )",