.NET project file analyzers
Get Started
$ dotnet add package DotNetProjectFile.AnalyzersReadme
.NET project file analyzers
The package contains analyzers that analyze .NET project files.
MS Build project file rules
- Proj0001 MS Build project file could not be located
- Proj0002 Upgrade legacy MS Build project files
- Proj0003 Define usings explicit
- 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 TargetFramework node for a single target framework
- Proj0010 Define OutputType 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 <TargetFrameworks>
- 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
- 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 compliation items
- Proj0048 Language version should be set to an explicit version number
- Proj0049 Prefer the latest released language version
Packaging
- Proj0200 Define IsPackable 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 ID 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
- Proj0600 Avoid generating packages on build if not packable
Publishing
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
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
- 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
- Proj0508 Order third-party licenses alphabetically
- Proj0509 NuGet package cache could not be resolved
.NET project file analyzers SDK
Central Package Management
- Proj0800 Configure Central Package Management
- Proj0801 Include 'Directory.Packages.props'
- Proj0802 Enable Central Package Management centrally
- Proj0803 Only use VersionOverride when CPM is enabled
- Proj0804 Only use Version when CPM is 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
Analyzers
- Proj1000 Use the .NET project file analyzers
- Proj1001 Use analyzers for packages
- Proj1002 Use Microsoft's analyzers
- Proj1003 Use Sonar analyzers
Formatting
Design
- Proj1300 Avoid project references to executables
- Proj1301 Project references of packable targets should be packable
- Proj1302 Avoid project references to test projects
Other
- 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
Resource file rules
- Proj2000 Embed valid resource files
- Proj2001 Define data in a resource file
- Proj2002 Sort resource file values alphabetically
- Proj2003 Add invariant fallback resources
- Proj2004 Add invariant fallback values
- Proj2005 Escape XML nodes of resource values
- Proj2100 Indent RESX
Generic
- Proj3000 Only use UTF-8 without BOM
- Proj3001 Track uses of "TODO" tags
- Proj3002 Remove commented-out code
- Proj3003 Trim whitespace
NuGet configuration
- Proj0300 Configure NuGet explicitly
- Proj0301 Clear previously defined package sources
- Proj0302 Credentials should be injected
- Proj0303 Define a mapping for each package source
- Proj0304 Package source mappings should be unique
- Proj0305 Last source map should map all packages
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