EnvironmentAbstractions.BannedApiAnalyzer 3.0.2

dotnet add package EnvironmentAbstractions.BannedApiAnalyzer --version 3.0.2
NuGet\Install-Package EnvironmentAbstractions.BannedApiAnalyzer -Version 3.0.2
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="EnvironmentAbstractions.BannedApiAnalyzer" Version="3.0.2">
  <PrivateAssets>all</PrivateAssets>
  <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
</PackageReference>
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add EnvironmentAbstractions.BannedApiAnalyzer --version 3.0.2
#r "nuget: EnvironmentAbstractions.BannedApiAnalyzer, 3.0.2"
#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 EnvironmentAbstractions.BannedApiAnalyzer as a Cake Addin
#addin nuget:?package=EnvironmentAbstractions.BannedApiAnalyzer&version=3.0.2

// Install EnvironmentAbstractions.BannedApiAnalyzer as a Cake Tool
#tool nuget:?package=EnvironmentAbstractions.BannedApiAnalyzer&version=3.0.2

EnvironmentAbstractions.BannedApiAnalyzer

Nuget (with prereleases)

The EnvironmentAbstractions.BannedApiAnalyzer package uses the Microsoft.CodeAnalysis.BannedApiAnalyzers package to prevent usages of System.Environment to access the environment.

Adding a <PackageReference /> to the package in your project is all you need:

<Project Sdk="Microsoft.NET.Sdk">
  <PropertyGroup>
    <TargetFramework>netstandard2.0</TargetFramework>
  </PropertyGroup>
  <ItemGroup>
    <PackageReference Include="EnvironmentAbstractions.BannedApiAnalyzer" Version="1.0.0" />
  </ItemGroup>
</Project>

Then when anyone attempts to call the built-in methods for accessing the environment, they'll receive a build warning indicating that they should use IEnvironmentProvider instead:

public static void Main(string[] args)
{
    Console.WriteLine("Hello, {0}!", System.Environment.UserName);
}
warning RS0030: The symbol 'Environment.UserName' is banned in this project: Use IEnvironmentProvider.UserName instead.

If you want to only ban access to environment variables, you'll need to first set the MSBuild property BanSystemEnvironmentVariableAPIs to true in your project:

<PropertyGroup>
  
  <BanSystemEnvironmentVariableAPIs>true</BanSystemEnvironmentVariableAPIs>
</PropertyGroup>

Then only accessing environment variables will emit a compile-time error telling developers to use IEnvironmentVariableProvider instead:

public static void Main(string[] args)
{
    Console.WriteLine("Hello, {0}!", System.Environment.GetEnvironmentVariable("USERNAME"));
}
warning RS0030: The symbol 'Environment.GetEnvironmentVariable(string)' is banned in this project: Use IEnvironmentVariableProvider.GetEnvironmentVariable(string) instead.
There are no supported framework assets in this package.

Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories (1)

Showing the top 1 popular GitHub repositories that depend on EnvironmentAbstractions.BannedApiAnalyzer:

Repository Stars
microsoft/slngen
Visual Studio solution generator
Version Downloads Last updated
3.0.2 784 11/15/2023
2.1.0 523 9/26/2023