Add AlternateLookups and WinRT compatibility, bump versions

Author: mikernet

.editorconfig

@@ -281,6 +281,9 @@ dotnet_diagnostic.SA1200.severity = none
 # SA1618: Generic type parameters should be documented
 dotnet_diagnostic.SA1618.severity = suggestion
 
+# SA1619: Generic type parameters should be documented partial class
+dotnet_diagnostic.SA1619.severity = suggestion
+
 # CA1303: Do not pass literals as localized parameters
 dotnet_diagnostic.CA1303.severity = none
 
@@ -396,4 +399,4 @@ dotnet_diagnostic.IDE0057.severity = warning
 dotnet_diagnostic.IDE0059.severity = warning
 
 # RS0030: Do not use banned APIs
-dotnet_diagnostic.RS0030.severity = error
+dotnet_diagnostic.RS0030.severity = error

.github/workflows/build-and-test.yml

@@ -18,8 +18,8 @@ jobs:
       with:
         dotnet-version: |
           6.0.x
-          7.0.x
           8.0.x
+          9.0.x
     - name: Clean
       run: dotnet clean --configuration Debug && dotnet nuget locals all --clear
     - name: Install dependencies
@@ -40,8 +40,8 @@ jobs:
       with:
         dotnet-version: |
           6.0.x
-          7.0.x
           8.0.x
+          9.0.x
     - name: Clean
       run: dotnet clean --configuration Release && dotnet nuget locals all --clear
     - name: Install dependencies

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Singulink.Collections
 
+### V3.2
+- `AlternateLookup` support for keyed collections
+- WinRT compatibility
+
 ### V3.1
 - Full support for AOT and trimming
 
@@ -17,6 +21,10 @@
 
 ## Singulink.Collections.Weak
 
+### V2.2
+- `AlternateLookup` support for `WeakDictionary`
+- WinRT compatibility
+
 ### V2.1
 - Full support for AOT and trimming
 

Directory.Build.props

@@ -1,11 +1,12 @@
 <Project>
   <PropertyGroup>
-    <LangVersion>12.0</LangVersion>
+    <LangVersion>preview</LangVersion>
     <Nullable Condition="'$(TargetFramework)' != 'netstandard2.0'">enable</Nullable>
     <Nullable Condition="'$(TargetFramework)' == 'netstandard2.0'">annotations</Nullable>
     <NoWarn>CS8769</NoWarn>
     <ImplicitUsings>enable</ImplicitUsings>
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
+    <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
 
     <WeaverConfiguration>
       <Weavers>
@@ -20,11 +21,11 @@
 
   <ItemGroup>
     <!-- Fody -->
-    <PackageReference Include="RuntimeNullables.Fody" Version="1.0.6" PrivateAssets="all" />
+    <PackageReference Include="RuntimeNullables.Fody" Version="2.0.0" PrivateAssets="all" />
 
     <!-- Analyzers -->
     <PackageReference Include="DotNetAnalyzers.DocumentationAnalyzers" Version="1.0.0-beta.59" PrivateAssets="all" />
     <PackageReference Include="StyleCop.Analyzers" Version="1.2.0-beta.556" PrivateAssets="all" />
-    <PackageReference Include="Roslynator.Analyzers" Version="4.11.0" PrivateAssets="all" />
+    <PackageReference Include="Roslynator.Analyzers" Version="4.12.4" PrivateAssets="all" />
   </ItemGroup>
 </Project>

Docs/docfx.json

@@ -2,7 +2,7 @@
   "metadata": [
     {
       "properties": {
-          "TargetFramework": "net6.0"
+          "TargetFramework": "net9.0"
       },
       "src": [
         {

Docs/index.md

@@ -10,16 +10,17 @@ The following collections are included in the package:
 - `HashSetDictionary`: Collection of keys mapped to a hash set of unique values per key.
 - `ListDictionary`: Collection of keys mapped to a list of values per key.
 - `Map`: Collection of two types of values that map between each other in a bidirectional one-to-one relationship.
-- `ReadOnlyHashSet`: Fast read-only wrapper around a HashSet (instead of going through `ISet<>`).
-- `ReadOnlyList`: Fast read-only wrapper around a List (instead of going through `IList<>`).
+- `AlternateLookup` nested types for each of the above collections that allow looking up values by alternate keys.
+- `ReadOnlyHashSet`: Fast direct read-only wrapper for HashSets (instead of going through `ISet<>` like `ReadOnlySet` does).
+- `ReadOnlyList`: Fast direct read-only wrapper for Lists (instead of going through `IList<>` like `ReadOnlyCollection` does).
 - A full set of interfaces for the new collections as well as an `IReadOnlySet<>` polyfill for .NET Standard.
 
 **Singulink.Collections.Weak** provides a set of collection classes that store weak references to values so that the garbage collector is free to reclaim the memory they use when they aren't being referenced anymore. The values returned by the collections will never be `null` - if the value was garbage collected then the collection behaves as if the value was removed from the collection.
 
 The following collections are included in the package:
 - `WeakCollection`: Collection of weakly referenced values that keeps items in an undefined order.
 - `WeakList`: Collection of weakly referenced values that maintains relative insertion order.
-- `WeakValueDictionary`: Collection of keys and weakly referenced values.
+- `WeakValueDictionary`: Collection of keys and weakly referenced values with `AlternateLookup` support.
 
 ### About Singulink
 

README.md

@@ -14,16 +14,17 @@ The following collections are included in the package:
 - `HashSetDictionary`: Collection of keys mapped to a hash set of unique values per key.
 - `ListDictionary`: Collection of keys mapped to a list of values per key.
 - `Map`: Collection of two types of values that map between each other in a bidirectional one-to-one relationship.
-- `ReadOnlyHashSet`: Fast read-only wrapper around a HashSet (instead of going through `ISet<>`).
-- `ReadOnlyList`: Fast read-only wrapper around a List (instead of going through `IList<>`).
-- A full set of interfaces and read-only wrappers for the new collections as well as an `IReadOnlySet<>` polyfill for .NET Standard.
+- `AlternateLookup` nested wrapper types for each of the above collections that allow looking up values by alternate keys.
+- `ReadOnlyHashSet`: Fast direct read-only wrapper for HashSets (instead of going through `ISet<>` like `ReadOnlySet` does).
+- `ReadOnlyList`: Fast direct read-only wrapper for Lists (instead of going through `IList<>` like `ReadOnlyCollection` does).
+- A full set of interfaces for the new collections as well as an `IReadOnlySet<>` polyfill for .NET Standard.
 
 **Singulink.Collections.Weak** provides a set of collection classes that store weak references to values so that the garbage collector is free to reclaim the memory they use when they aren't being referenced anymore. The values returned by the collections will never be `null` - if the value was garbage collected then the collection behaves as if the value was removed from the collection.
 
 The following collections are included in the package:
 - `WeakCollection`: Collection of weakly referenced values that keeps items in an undefined order.
 - `WeakList`: Collection of weakly referenced values that maintains relative insertion order.
-- `WeakValueDictionary`: Collection of keys and weakly referenced values.
+- `WeakValueDictionary`: Collection of keys and weakly referenced values with `AlternateLookup` support.
 
 ### About Singulink
 
@@ -68,8 +69,6 @@ int one = nameToNumberMap["ONE"]; // 1
 
 ### ListDictionary
 
-Very similar API to `HashSetDictionary`, and both can be exposed as `ICollectionDictionary`:
-
 ```c#
 var numberNames = new ListDictionary<int, string>();
 numberNames[1].AddRange("One", "Uno");
@@ -85,7 +84,7 @@ numberNames.ContainsKey(3); // false
 threeNamesList.Add("Three");
 numberNames.ContainsKey(3); // true
 
-// Lists are automatically removed from the dictionary when they become empty
+// Lists are automatically removed from the dictionary when they are empty
 
 threeNamesList.Clear();
 numberNames.TryGetValues(3, out threeNamesList); // false

Source/Directory.Build.props

@@ -11,7 +11,12 @@
     <AssemblyOriginatorKeyFile>..\key.snk</AssemblyOriginatorKeyFile>
     <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
 
-    <IsAotCompatible Condition="$([MSBuild]::IsTargetFrameworkCompatible('$(TargetFramework)', 'net6.0'))">true</IsAotCompatible>
+    <AnalysisLevel>latest-Recommended</AnalysisLevel>
+  </PropertyGroup>
+
+  <PropertyGroup Label="AOT Compatibility" Condition="$([MSBuild]::IsTargetFrameworkCompatible('$(TargetFramework)', 'net7.0'))">
+    <IsAotCompatible>true</IsAotCompatible>
+    <CsWinRTAotWarningLevel>2</CsWinRTAotWarningLevel>
   </PropertyGroup>
 
   <PropertyGroup Label="Source Link" Condition="'$(Configuration)' == 'Release'">

Source/Singulink.Collections.Weak/GlobalSuppressions.cs

@@ -0,0 +1,8 @@
+// This file is used by Code Analysis to maintain SuppressMessage
+// attributes that are applied to this project.
+// Project-level suppressions either have no target or are given
+// a specific target and scoped to a namespace, type, member, etc.
+
+using System.Diagnostics.CodeAnalysis;
+
+[assembly: SuppressMessage("Naming", "CA1711:Identifiers should not have incorrect suffix", Justification = "Collection type naming recommendations not applicable")]

Source/Singulink.Collections.Weak/Singulink.Collections.Weak.csproj

@@ -1,9 +1,9 @@
 <Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
-    <TargetFrameworks>netstandard2.0;netstandard2.1;net6.0;net8.0</TargetFrameworks>
+    <TargetFrameworks>netstandard2.0;netstandard2.1;net6.0;net6.0-windows10.0.19041;net8.0;net8.0-windows10.0.19041;net9.0;net9.0-windows10.0.19041;</TargetFrameworks>
     <RootNamespace>Singulink.Collections</RootNamespace>
 
-    <Version>2.1.0</Version>
+    <Version>2.2.0</Version>
     <PackageTags>weak, dictionary, value, collection, list</PackageTags>
     <Description>Collection classes that store weak references to values so that they can be garbage collected when they are no longer needed.</Description>
     <PackageProjectUrl>https://github.com/Singulink/Singulink.Collections.Weak</PackageProjectUrl>