Skip to main content
Link
Menu
Expand
(external link)
Document
Search
Copy
Copied
Home
Configuration of .NET project file analyzers
Using .NET Project File Analyzers on Shared Files
Rules
MSBuild
Packaging
Proj0048: Language version should be set to an explicit version number
Proj0049: Prefer the latest released language version
Proj0200: Define the project packability explicitly
Proj0201: Define the project version explicitly
Proj0202: Define the project description explicitly
Proj0203: Define the project authors explicitly
Proj0204: Define the project tags explicitly
Proj0205: Define the project repository URL explicitly
Proj0206: Define the project URL explicitly
Proj0207: Define the project copyright explicitly
Proj0208: Define the project release notes explicitly
Proj0209: Define the project readme file explicitly
Proj0210: Define the project license explicitly
Proj0211: Avoid using deprecated license definition
Proj0212: Define the project icon file explicitly
Proj0213: Define the project icon URL explicitly
Proj0214: Define the NuGet project ID explicitly
Proj0215: Provide a compliant NuGet package icon
Proj0216: Define the product name explicitly
Proj0217: Define requiring license acceptance explicitly
Proj0218: Symbol package format snupkg requires debug type portable
Proj0219: Packable projects should be libraries
Proj0220: Symbol package format snupkg requires include symbols to be enabled
Proj0240: Enable package validation
Proj0241: Enable package baseline validation
Proj0242: Generate NuGet packages conditionally
Proj0243: Generate software bill of materials
Proj0244: Generate documentation file
Proj0245: Don’t mix Version and VersionPrefix/VersionSuffix
Proj0246: Define VersionPrefix if VersionSuffix is defined
Proj0247: Enable strict mode for package baseline validation
Proj0248: Enable strict mode for package runtime compatibility validation
Proj0249: Enable strict mode for package framework compatibility validation
Proj0250: Generate API compatibility suppression file
Proj0251: Enable API compatibility attribute checks
Proj0252: Enable API compatibility parameter name checks
Proj0253: Versions should be compliant with Semantic Versioning
Proj0254: Version prefixes should be compliant with Semantic Versioning
Proj0600: Avoid generating packages on build if not packable
Publishing
Proj0400: Define the project publishability explicitly
Proj0401: Only publish executables
Test Projects
Proj0450: Test projects should not be packable
Proj0451: Test projects should not be publishable
Proj0452: Test projects require Microsoft.NET.Test.Sdk
Proj0453: Using Microsoft.NET.Test.Sdk implies a test project
SDK
Proj0700: Avoid defining items in SDK project
Central Package Management
Proj0800: Configure Central Package Management explicitly
Proj0801: Include ‘Directory.Packages.props’
Proj0802: Enable Central Package Management centrally
Proj0803: Use VersionOverride only with Central Package Management enabled
Proj0804: Use Version only with Central Package Management not enabled
Proj0805: Define version for PackageReference
Proj0806: VersionOverride should change the version
Proj0807: Use Directory.Packages.props only for Central Package Management
Proj0808: Define CPM related configuration only in Directory.Packages.props
Proj0809: Global package references are meant for private assets only
Proj0810: Remove unused package versions
Proj0811: Directory.Build.props and Directory.Packages.props should be in the same directory
Proj0812: Remove redundant packages references that are globally referenced
Proj0813: Global package references only work when CPM is enabled
Analyzers
Proj1001: Use analyzers for packages
Proj1002: Use Microsoft’s analyzers
Proj1003: Use Sonar analyzers
Proj1004: .NET Project File Analyzers SDK no longer requires separate package
Proj1005: Suppress NuGet issues per package
Proj1006: Suppress NuGet advisories per vulnerability
Design
Proj1300: Avoid project references to executables
Proj1301: Project references of packable targets should be packable
Proj1302: Avoid project references to test projects
Proj1303: Avoid project references to benchmark projects
Other
Proj1007: Non-Roslyn languages require .NET Project File Analyzers SDK
Proj1100: Avoid using Moq
Proj1101: Package references should have stable versions
Proj1102: Use Coverlet Collector or MSBuild
Proj1103: TUnit test projects must be executable
Proj1104: TUnit conflicts with Microsoft.NET.Test.Sdk
Proj1200: Exclude private assets as project file dependency
General
Proj0001: MS Build project file could not be located
Proj0002: Upgrade legacy MS Build project files
Proj0003: Define usings explicitly
Proj0004: Run NuGet security audits automatically
Proj0005: Define package reference assets as attributes
Proj0006: Add additional files to improve static code analysis
Proj0007: Remove empty nodes
Proj0008: Remove folder nodes
Proj0009: Use the node for a single target framework
Proj0010: Define the project output type explicitly
Proj0011: Define properties once
Proj0012: Reassign properties with different value
Proj0013: Include package references only once
Proj0014: Include project references only once
Proj0015: Order package references alphabetically
Proj0016: Order project references alphabetically
Proj0017: Can’t create alias for static using directive
Proj0018: Order using directives by type
Proj0019: Order using directives alphabetically
Proj0020: Item group should only contain nodes of a single type
Proj0021: Build actions should have a single task
Proj0022: Build action includes should exist
Proj0023: Use forward slashes in paths
Proj0024: Order package versions alphabetically
Proj0025: Migrate from ruleset file to .globalconfig file
Proj0026: Remove IncludeAssets when redundant
Proj0027: Override <TargetFrameworks> with <TargetFramework>
Proj0028: Define conditions on level 1
Proj0029: Use C# specific properties only when applicable
Proj0030: Use VB.NET specific properties only when applicable
Proj0031: Adopt preferred casing of nodes
Proj0032: Migrate away from BinaryFormatter
Proj0033: Project reference includes should exist
Proj0034: Import statement could not be resolved by the analyzer
Proj0035: Remove deprecated RestoreProjectStyle property
Proj0036: Remove None when redundant
Proj0037: Exclude runtime when all assets are private
Proj0038: Fully specify NoWarn rule IDs
Proj0039: Treat all warnings as errors is considered a bad practice
Proj0040: Run NuGet security audits on transitive dependencies too
Proj0041: NuGet security audits should report on moderate issues at minimum
Proj0042: Enable <ContinuousIntegrationBuild> when running in CI pipeline
Proj0043: Use lock files
Proj0044: Enable <RestoreLockedMode> when <ContinuousIntegrationBuild> is enabled
Proj0045: Convention-based MSBuild file names should use correct casing
Proj0046: Update statements should change state
Proj0047: Label item groups that disable compilation items
Proj0050: Enforce code-style in builds
Proj0051: Project reference must be case-consistent with the file system
Proj0052: Prefer attributes over elements
Proj0053: Run analyzers during build
Proj0054: Avoid changing compiler tools
Proj0055: Enable nullability analysis for C#
Proj0056: Enable nullability analysis for F#
Proj0508: Order third-party licenses alphabetically
Proj0509: NuGet package cache could not be resolved
NuGet Configuration
Proj0300: Configure NuGet explicitly
Proj0301: Clear previously defined package sources
Proj0302: NuGet authentication should be secure
Proj0303: Define a mapping for each package source
Proj0304: Package source mappings should be unique
Proj0305: Last source map should map all packages
Proj0306: Avoid local package sources
Resources
Proj2000: Embed valid resources
Proj2001: Define data in a resource file
Proj2002: Sort resource file values alphabetically
Proj2003: Add invariant fallback resources
Proj2004: Add invariant fallback value
Proj2005: Escape XML nodes of resource values
Proj2100: Indent RESX
SLNX
Proj5000: Use SLNX solution files
Proj5001: Remove SLN solution files
Proj5005: Omit Project ID’s
Proj5006: Included files should exist
INI
Proj4000: Invalid INI file
Proj4001: Invalid INI Header
Proj4002: Invalid INI key-value pair
Proj4010: Sections should contain at least one key-value pair
Proj4011: Define INI keys once
Editorconfig
Proj4050: Header must be a GLOB
Proj4051: Use equals sign for key-value assignments
Proj4052: Use global configuration for Roslyn diagnostics
Globalconfig
Proj4025: Remove section header
Proj4026: Specify is_global
Proj4027: Use valid diagnostic severity value
Proj4028: Use explicit diagnostic severity level
Proj4029: Use known diagnostic IDs
Proj4030: Avoid global diagnostic suppression
Proj4031: Avoid global diagnostic severity configuration
JSON
Proj6000: Invalid JSON file
Proj6010: global.json should exist
Licensing
Proj0500: Only include packages with an explicitly defined license
Proj0501: Package only contains a deprecated license URL
Proj0502: Only include packages compliant with project license
Proj0503: Package license is unknown
Proj0504: Package license has changed
Proj0505: Third-party license registry requires include
Proj0506: Third-party license registry requires hash
Proj0507: Third-party license registry must be unconditional
Generic
Proj3000: Only use UTF-8 without BOM
Proj3001: Track uses of “TODO” tags
Proj3002: Remove commented-out code
Proj3003: Trim whitespace
Formatting
Proj1700: Indent XML
Proj1701: Use <![CDATA[ for large texts
Proj1702: Omit XML declarations
Proj1703: MSBuild child elements should be separated by an empty line
NuGet packages
SonarQube Integration
AGENTS.md
Light mode
Dark mode
.NET project file analyzers on GitHub
Rules
JSON
Proj6000: Invalid JSON file
Proj6000: Invalid JSON file
A
JSON file
is a plain text file with a lightweight data-interchange format.