Skip to main content

Add framework reference

OpenRewrite.CSharp.Recipes.AddFrameworkReference

Adds a <FrameworkReference> to a .csproj if it isn't already present.

Recipe source

This recipe is only available to users of Moderne.

This recipe is available under the Moderne Proprietary License.

Options

TypeNameDescriptionExample
StringFrameworkNameThe shared framework name to reference.Microsoft.AspNetCore.App
StringTriggerPackageGlobOptional. Optional glob: only add the framework reference when a <PackageReference> matching this glob is present in the project. Leave blank to always add.Microsoft.AspNetCore.*
BooleanRegenerateMarkerOptional. Whether to re-run dotnet restore after the edit to refresh the project's MSBuildProject marker. Defaults to true. Composite recipes that chain multiple csproj-mutating steps may set this to false on intermediate steps and finalize once with EnsureCsprojAttestation.

Used by

This recipe is used as part of the following composite recipes:

Usage

In order to run C# recipes, you will need to use the Moderne CLI.

Once the CLI is installed, you can install this C# recipe package by running the following command:

Install the recipe package
mod config recipes nuget install OpenRewrite.Recipes.CSharp.Migration.Dotnet

Then, you can run the recipe via:

Run the recipe
mod run . --recipe OpenRewrite.CSharp.Recipes.AddFrameworkReference