Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add TargetFramework(s) unexpected check #11285

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

JanKrivanek
Copy link
Member

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

documentation/specs/BuildCheck/Codes.md Outdated Show resolved Hide resolved
src/Build/Resources/Strings.resx Outdated Show resolved Hide resolved
src/Build/Resources/Strings.resx Outdated Show resolved Hide resolved
string? frameworks = null;
string? framework = null;
// This is not SDK style project
if ((!context.Data.EvaluatedProperties.TryGetValue(PropertyNames.UsingMicrosoftNETSdk, out string? usingSdkStr) ||
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If I'm reading your conditions correctly here, I think this would fire on a C++/CLI vcxproj targeting .NET 8--but shouldn't.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can detect import of Microsoft.Cpp.props to handle this.
But together with this comment: #11285 (comment) - this leads to more importnat question: do you feel this is fundamentaly wrong and would you suggest different way of detecting non-SDK project?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if we should restrict it to .csproj? Or check for any import called CSharp.targets? though I guess it should apply to vbproj and fsproj too . . .

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As brainstormed offline - I updated the check to detect ProjectCapability and if the project is sdk-style or c++/cli

documentation/specs/BuildCheck/Codes.md Outdated Show resolved Hide resolved
documentation/specs/BuildCheck/Codes.md Outdated Show resolved Hide resolved
src/BuildCheck.UnitTests/EndToEndTests.cs Show resolved Hide resolved

// We want to avoid repeated checking of a same project (as it might be evaluated multiple times)
// for this reason we use a hashset with already seen projects.
if (!_projectsSeen.Add(context.Data.ProjectFilePath))
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is having another dictionary with all the project paths in it worth it memory-wise to avoid looping over ProjectCapability? Which has worse perf I wonder?

This is fine, it makes sense to do this kind of check, though I wonder if we should somehow make it cheaper for individual checks to do this sort of thing.

Comment on lines +133 to +137
"'TargetFramework' nor 'TargetFrameworks' property should not be specified in projects not using .NET SDK."

'TargetFramework' or 'TargetFrameworks' control the project output targets in modern .NET SDK projects. The older SDK-less projects interprets different properties for similar mechanism (like 'TargetFrameworkVersion') and the 'TargetFramework' or 'TargetFrameworks' are silently ignored.

Make sure the Target Framework is specified appropriately for your project.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Update this with the new error text please

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[BuildCheck Suggestion]: Non-SDK project defines TargetFramework
3 participants