Svrooij.PowerShell.DependencyInjection 1.1.0

dotnet add package Svrooij.PowerShell.DependencyInjection --version 1.1.0
NuGet\Install-Package Svrooij.PowerShell.DependencyInjection -Version 1.1.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Svrooij.PowerShell.DependencyInjection" Version="1.1.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Svrooij.PowerShell.DependencyInjection --version 1.1.0
#r "nuget: Svrooij.PowerShell.DependencyInjection, 1.1.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Svrooij.PowerShell.DependencyInjection as a Cake Addin
#addin nuget:?package=Svrooij.PowerShell.DependencyInjection&version=1.1.0

// Install Svrooij.PowerShell.DependencyInjection as a Cake Tool
#tool nuget:?package=Svrooij.PowerShell.DependencyInjection&version=1.1.0

Svrooij.PowerShell.DependencyInjection

A library that allows you to use dependency injection in binary PowerShell modules.

  • Dependency injection (based on Microsoft.Extensions.DependencyInjection)
  • Using ILogger throughout your PowerShell Module.
  • Run any asynchronous code in your commandlets.

I choose to only support a Task, I guess that all code that you're executing using this package will by async anyway.

Create a new PowerShell module

# Install the correct template (only once)
dotnet new install Microsoft.PowerShell.Standard.Module.Template

# Create a new directory and enter it
mkdir MyNewModule
cd MyNewModule

# Create a new PowerShell module
dotnet new psmodule

Add Package

Add the pacakge dotnet add package Svrooij.PowerShell.DependencyInjection

Edit project file

Add the CopyLocalLockFileAssemblies to your project file, this will make sure that the dependencies are copied to the output folder.

  <PropertyGroup>
    <TargetFramework>netstandard2.0</TargetFramework>
    <AssemblyName>Svrooij.PowerShell.DependencyInjection.SamplePs5</AssemblyName>
    <CopyLocalLockFileAssemblies>true</CopyLocalLockFileAssemblies>
  </PropertyGroup>

And change the version of PowerShellStandard.Library to 5.1.1.

  <ItemGroup>
    <PackageReference Include="PowerShellStandard.Library" Version="5.1.1" />
    <PackageReference Include="Svrooij.PowerShell.DependencyInjection" Version="1.0.1" />
  </ItemGroup>

Create a Startup class

using Microsoft.Extensions.DependencyInjection;
using Svrooij.PowerShell.DependencyInjection;

public class Startup : PsStartup
    {
        // You need to override this method.
        public override void ConfigureServices(IServiceCollection services)
        {
            services.AddTransient<ITestService, TestService>();
        }
    }

Create a CmdLet

  1. Instead of inheriting from PsCmdLet, you need to inherit DependencyCmdlet<YourStartupClass>.
  2. And then you put the [ServiceDependency] attribute above every private (or internal), field or property you want loaded from dependency injection.
  3. Override the Task ProcessRecordAsync(CancellationToken cancellationToken) method and call all the async stuff you want.
    [Cmdlet(VerbsDiagnostic.Test, "SampleCmdlet")]
    [OutputType(typeof(FavoriteStuff))]
    public class TestSampleCmdletCommand : DependencyCmdlet<YourStartupClass>
    {
        [Parameter(
            Mandatory = true,
            Position = 0,
            ValueFromPipeline = true,
            ValueFromPipelineByPropertyName = true)]
        public int FavoriteNumber { get; set; }

        [Parameter(
            Position = 1,
            ValueFromPipelineByPropertyName = true)]
        [ValidateSet("Cat", "Dog", "Horse")]
        public string FavoritePet { get; set; } = "Dog";

        // Give your dependencies the ServiceDependency attribute
        [ServiceDependency]
        private ITestService TestService { get; set; }

        // Logging using Microsoft.Extensions.Logging is supported (and configured automatically)
        // You can alse use the regular WriteVerbose(), WriteDebug(), WriteInformation(), WriteWarning() and WriteError() methods
        [ServiceDependency]
        private ILogger<TestSampleCmdletCommand> _logger;

        // This method will be called automatically by DependencyCmdlet which is called by ProcessRecord()
        public override async Task ProcessRecordAsync(CancellationToken cancellationToken)
        {
            _logger.LogInformation("Starting ProcessRecordAsync()");

            await TestService.DoSomethingAsync(cancellationToken);

            WriteObject(new FavoriteStuff
            {
                FavoriteNumber = this.FavoriteNumber,
                FavoritePet = this.FavoritePet
            });
        }
    }
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.1.0 94 4/2/2024
1.0.2 97 1/17/2024
1.0.1 100 1/11/2024
1.0.0 93 1/10/2024