Merge pull request #21 from Atypical-Consulting/serviceCollectionExtensions

Add virtual file system extension method

Author: phmatray

docs/api/ServiceCollectionExtensions.AddVirtualFileSystem(thisIServiceCollection).md

@@ -0,0 +1,21 @@
+#### [Atypical.VirtualFileSystem.Core](VirtualFileSystem.md 'VirtualFileSystem')
+### [Atypical.VirtualFileSystem.Core.Services](VirtualFileSystem.md#Atypical.VirtualFileSystem.Core.Services 'Atypical.VirtualFileSystem.Core.Services').[ServiceCollectionExtensions](ServiceCollectionExtensions.md 'Atypical.VirtualFileSystem.Core.Services.ServiceCollectionExtensions')
+
+## ServiceCollectionExtensions.AddVirtualFileSystem(this IServiceCollection) Method
+
+Registers the virtual file system in the dependency injection container.
+
+```csharp
+public static Microsoft.Extensions.DependencyInjection.IServiceCollection AddVirtualFileSystem(this Microsoft.Extensions.DependencyInjection.IServiceCollection services);
+```
+#### Parameters
+
+<a name='Atypical.VirtualFileSystem.Core.Services.ServiceCollectionExtensions.AddVirtualFileSystem(thisMicrosoft.Extensions.DependencyInjection.IServiceCollection).services'></a>
+
+`services` [Microsoft.Extensions.DependencyInjection.IServiceCollection](https://docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.DependencyInjection.IServiceCollection 'Microsoft.Extensions.DependencyInjection.IServiceCollection')
+
+The service collection.
+
+#### Returns
+[Microsoft.Extensions.DependencyInjection.IServiceCollection](https://docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.DependencyInjection.IServiceCollection 'Microsoft.Extensions.DependencyInjection.IServiceCollection')  
+The service collection.

docs/api/ServiceCollectionExtensions.md

@@ -0,0 +1,17 @@
+#### [Atypical.VirtualFileSystem.Core](VirtualFileSystem.md 'VirtualFileSystem')
+### [Atypical.VirtualFileSystem.Core.Services](VirtualFileSystem.md#Atypical.VirtualFileSystem.Core.Services 'Atypical.VirtualFileSystem.Core.Services')
+
+## ServiceCollectionExtensions Class
+
+Extension methods for [Microsoft.Extensions.DependencyInjection.IServiceCollection](https://docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.DependencyInjection.IServiceCollection 'Microsoft.Extensions.DependencyInjection.IServiceCollection').  
+This class is used to register the virtual file system in the dependency injection container.
+
+```csharp
+public static class ServiceCollectionExtensions
+```
+
+Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 ServiceCollectionExtensions
+
+| Methods | |
+| :--- | :--- |
+| [AddVirtualFileSystem(this IServiceCollection)](ServiceCollectionExtensions.AddVirtualFileSystem(thisIServiceCollection).md 'Atypical.VirtualFileSystem.Core.Services.ServiceCollectionExtensions.AddVirtualFileSystem(this Microsoft.Extensions.DependencyInjection.IServiceCollection)') | Registers the virtual file system in the dependency injection container. |

docs/api/VirtualFileSystem.md

@@ -232,6 +232,13 @@
   - **[ToString()](RootNode.ToString().md 'Atypical.VirtualFileSystem.Core.Models.RootNode.ToString()')** `Method` Returns a string that represents the current object.  
     For [RootNode](RootNode.md 'Atypical.VirtualFileSystem.Core.Models.RootNode') this is always the constant string <cref see="ROOT_PATH"/>.
 
+<a name='Atypical.VirtualFileSystem.Core.Services'></a>
+
+## Atypical.VirtualFileSystem.Core.Services Namespace
+- **[ServiceCollectionExtensions](ServiceCollectionExtensions.md 'Atypical.VirtualFileSystem.Core.Services.ServiceCollectionExtensions')** `Class` Extension methods for [Microsoft.Extensions.DependencyInjection.IServiceCollection](https://docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.DependencyInjection.IServiceCollection 'Microsoft.Extensions.DependencyInjection.IServiceCollection').  
+  This class is used to register the virtual file system in the dependency injection container.
+  - **[AddVirtualFileSystem(this IServiceCollection)](ServiceCollectionExtensions.AddVirtualFileSystem(thisIServiceCollection).md 'Atypical.VirtualFileSystem.Core.Services.ServiceCollectionExtensions.AddVirtualFileSystem(this Microsoft.Extensions.DependencyInjection.IServiceCollection)')** `Method` Registers the virtual file system in the dependency injection container.
+
 <a name='Atypical.VirtualFileSystem.Core.ValueObjects'></a>
 
 ## Atypical.VirtualFileSystem.Core.ValueObjects Namespace

docs/links

@@ -51,6 +51,9 @@ M:Atypical.VirtualFileSystem.Core.ValueObjects.VFSRootPath.#ctor|VFSRootPath.VFS
 M:Atypical.VirtualFileSystem.Core.ValueObjects.VFSRootPath.ToString|VFSRootPath.ToString().md|ToString()
 M:Atypical.VirtualFileSystem.Core.ValueObjects.VFSRootPath.op_Implicit(Atypical.VirtualFileSystem.Core.ValueObjects.VFSRootPath)~System.String|VFSRootPath.implicitoperatorstring(VFSRootPath).md|implicit operator string(VFSRootPath)
 T:Atypical.VirtualFileSystem.Core.ValueObjects.VFSRootPath|VFSRootPath.md|VFSRootPath
+M:Atypical.VirtualFileSystem.Core.Services.ServiceCollectionExtensions.AddVirtualFileSystem(Microsoft.Extensions.DependencyInjection.IServiceCollection)|ServiceCollectionExtensions.AddVirtualFileSystem(thisIServiceCollection).md|AddVirtualFileSystem(this IServiceCollection)
+N:Atypical.VirtualFileSystem.Core.Services|VirtualFileSystem.md#Atypical.VirtualFileSystem.Core.Services|Atypical.VirtualFileSystem.Core.Services
+T:Atypical.VirtualFileSystem.Core.Services.ServiceCollectionExtensions|ServiceCollectionExtensions.md|ServiceCollectionExtensions
 P:Atypical.VirtualFileSystem.Core.Models.DirectoryNode.Path|DirectoryNode.Path.md|Path
 P:Atypical.VirtualFileSystem.Core.Models.DirectoryNode.IsDirectory|DirectoryNode.IsDirectory.md|IsDirectory
 P:Atypical.VirtualFileSystem.Core.Models.DirectoryNode.IsFile|DirectoryNode.IsFile.md|IsFile

src/Atypical.VirtualFileSystem.Core/Atypical.VirtualFileSystem.Core.csproj

@@ -26,6 +26,7 @@
         <PrivateAssets>all</PrivateAssets>
         <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
       </PackageReference>
+      <PackageReference Include="Microsoft.Extensions.DependencyInjection.Abstractions" Version="7.0.0" />
     </ItemGroup>
 
     <!-- NuGet metadata -->

src/Atypical.VirtualFileSystem.Core/Services/ServiceCollectionExtensions.cs

@@ -0,0 +1,28 @@
+// Copyright (c) 2022, Atypical Consulting SRL
+// All rights reserved.
+// 
+// This source code is licensed under the BSD-style license found in the
+// LICENSE file in the root directory of this source tree. 
+
+using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.DependencyInjection.Extensions;
+
+namespace Atypical.VirtualFileSystem.Core.Services;
+
+/// <summary>
+///     Extension methods for <see cref="IServiceCollection" />.
+///     This class is used to register the virtual file system in the dependency injection container.
+/// </summary>
+public static class ServiceCollectionExtensions
+{
+    /// <summary>
+    ///     Registers the virtual file system in the dependency injection container.
+    /// </summary>
+    /// <param name="services">The service collection.</param>
+    /// <returns>The service collection.</returns>
+    public static IServiceCollection AddVirtualFileSystem(this IServiceCollection services)
+    {
+        services.TryAddScoped<IVirtualFileSystem, VFS>();
+        return services;
+    }
+}