Add TargetFramework(s) unexpected check #11285
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rainersigwald
requested changes
Jan 14, 2025
| @@ -10,7 +10,8 @@ Report codes are chosen to conform to suggested guidelines. Those guidelines are | |||
| | [BC0104](#bc0104---projectreference-is-preferred-to-reference) | Warning | N/A | 9.0.200 | ProjectReference is preferred to Reference. | | |||
| | [BC0105](#bc0105---embeddedresource-should-specify-culture-metadata) | Warning | N/A | 9.0.200 | Culture specific EmbeddedResource should specify Culture metadata. | | |||
| | [BC0106](#bc0106---copytooutputdirectoryalways-should-be-avoided) | Warning | N/A | 9.0.200 | CopyToOutputDirectory='Always' should be avoided. | | |||
| | [BC0107](#bc0107---targetframework-and-targetframeworks-specified-together) | Warning | N/A | 9.0.200 | TargetFramework and TargetFrameworks specified together. | | |||
| | [BC0107](#bc0107---targetframework-and-targetframeworks-specified-together) | Warning | N/A | 9.0.200 | TargetFramework or TargetFrameworks specified in non-SDK style project. | | |||
| | [BC0108](#bc0108---targetframework-or-targetframeworks-specified-in-non-sdk-style-project) | Warning | N/A | 9.0.300 | TargetFramework and TargetFrameworks specified together. | | |||
There was a problem hiding this comment.
Suggested change
| | [BC0108](#bc0108---targetframework-or-targetframeworks-specified-in-non-sdk-style-project) | Warning | N/A | 9.0.300 | TargetFramework and TargetFrameworks specified together. | | |
| | [BC0108](#bc0108---targetframework-or-targetframeworks-specified-in-non-sdk-style-project) | Warning | N/A | 9.0.300 | TargetFramework or TargetFrameworks specified in non-SDK style project. | |
| @@ -2198,6 +2198,14 @@ Utilization: {0} Average Utilization: {1:###.0}</value> | |||
| <value>Project {0} specifies 'TargetFrameworks' property '{1}' and 'TargetFramework' property '{2}' at the same time. This will lead to 'TargetFrameworks' being ignored and build will behave as single-targeted.</value> | |||
| <comment>Terms in quotes are not to be translated.</comment> | |||
| </data> | |||
| <data name="BuildCheck_BC0108_Title" xml:space="preserve"> | |||
| <value>'TargetFramework' nor 'TargetFrameworks' property should not be specified in non-SDK style projects.</value> | |||
There was a problem hiding this comment.
Suggested change
| <value>'TargetFramework' nor 'TargetFrameworks' property should not be specified in non-SDK style projects.</value> | |
| <value>'TargetFramework' and 'TargetFrameworks' properties are not respected and should not be specified in projects that do not use the .NET SDK.</value> |
| <comment>Terms in quotes are not to be translated.</comment> | ||
| </data> | ||
| <data name="BuildCheck_BC0108_MessageFmt" xml:space="preserve"> | ||
| <value>Project {0} specifies 'TargetFramework(s)' property '{1}', while it's not SDK-style project. Those properties are not understood by legacy-style projects and have no impact.</value> |
There was a problem hiding this comment.
How dare you use the forbidden word? 😅
Suggested change
| <value>Project {0} specifies 'TargetFramework(s)' property '{1}', while it's not SDK-style project. Those properties are not understood by legacy-style projects and have no impact.</value> | |
| <value>Project {0} specifies 'TargetFramework(s)' property '{1}', which does not use the .NET SDK. Those properties are not understood by projects that import C# targets directly.</value> |
| context.Data.EvaluatedProperties.TryGetValue(PropertyNames.TargetFramework, out framework)) && | ||
| !string.IsNullOrEmpty(framework ?? frameworks)) | ||
| { | ||
| // {0} specifies 'TargetFrameworks' property '{1}' and 'TargetFramework' property '{2}' |
| string? frameworks = null; | ||
| string? framework = null; | ||
| // This is not SDK style project | ||
| if ((!context.Data.EvaluatedProperties.TryGetValue(PropertyNames.UsingMicrosoftNETSdk, out string? usingSdkStr) || |
There was a problem hiding this comment.
If I'm reading your conditions correctly here, I think this would fire on a C++/CLI vcxproj targeting .NET 8--but shouldn't.
|
|
||
| 'TargetFramework' or 'TargetFrameworks' control the project output targets in modern .NET SDK-style projects. The older non-SDK style projects ('legacy style' projects) interprets different properties for similar mechanism (like 'TargetFrameworkVersion') and the 'TargetFramework' or 'TargetFrameworks' are silently ignored. | ||
|
|
||
| Make sure the Target Framework targetting is done by properly understood mechanism. |
There was a problem hiding this comment.
Suggested change
| Make sure the Target Framework targetting is done by properly understood mechanism. | |
| Make sure the Target Framework is specified appropriately for your project. |
|
|
||
| "'TargetFramework' nor 'TargetFrameworks' property should not be specified in non-SDK style projects." | ||
|
|
||
| 'TargetFramework' or 'TargetFrameworks' control the project output targets in modern .NET SDK-style projects. The older non-SDK style projects ('legacy style' projects) interprets different properties for similar mechanism (like 'TargetFrameworkVersion') and the 'TargetFramework' or 'TargetFrameworks' are silently ignored. |
There was a problem hiding this comment.
don't say "legacy". And the style of the project isn't relevant, the actual SDK used is what matters (this is a hill I'll die on, "SDK-style" is horribly overused).
| [Fact] | ||
| public void TFMinNonSdkCheckTest() | ||
| { | ||
| string content = """ |
There was a problem hiding this comment.
I'd say this is an example of a project that shouldn't fire this: it's not controlling an output DLL's TF, but it might be doing something on purpose . . .
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #10635
Context
TargetFramework(s) are honored only in SDK-style projects - emit diagnostic if the property is used in legacy style project
Testing
Targetted test