[One .NET] add $(AndroidGenerateResourceDesigner) property #6224
Conversation
This file contains hidden or 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
jonathanpeppers
force-pushed
the
androidgenerateresourcedesigner
branch
from
3d1a809 to
668e52d
Compare
Fixes: dotnet#6198 When migrating Xamarin.Android binding projects to .NET 6, one difference is that `Resource.designer.cs` will be generated by .NET 6 class libraries. There is not currently a way to turn this off, if you pass: dotnet build -p:AndroidUseIntermediateDesignerFile=false Then `Resources\Resource.designer.cs` will be generated instead. There is no way to prevent this behavior, because `$(AndroidResgenFile)` defaults to this value. To solve cases where you *don't* want `Resource.designer.cs` at all: 1. Remove the `$(AndroidResgenFile)` default value. 2. Add a new `$(AndroidGenerateResourceDesigner)` MSBuild property, that seems like it will be a better name for .NET 6. 3. `$(AndroidUseIntermediateDesignerFile)` is based on `$(AndroidGenerateResourceDesigner)`. I added a test for the new property.
jonathanpeppers
force-pushed
the
androidgenerateresourcedesigner
branch
from
668e52d to
71b87b8
Compare
jonathanpeppers
requested review from
dellis1972,
grendello and
jonpryor
as code owners
grendello
approved these changes
Aug 24, 2021
jpobst
approved these changes
Aug 24, 2021
jonpryor
reviewed
Aug 25, 2021
|
|
||
| In Xamarin.Android, Java binding projects did not support generating a `Resource.designer.cs` file. | ||
| Since binding projects are just class libraries in .NET 6, this file will be generated. This could | ||
| be a breaking change when migrating existing projects. |
There was a problem hiding this comment.
One request for improvement: please provide an example error message. What should customers be looking for in their migrated projects to know that $(AndroidGenerateResourceDesigner)=false should be set?
There was a problem hiding this comment.
I added two examples where Resource.designer.cs can break.
jonathanpeppers
added a commit
that referenced
this pull request
Aug 25, 2021
Fixes: #6198 When migrating Xamarin.Android binding projects to .NET 6, one difference is that `Resource.designer.cs` will be generated by .NET 6 class libraries. This can result in build failures, e.g.: error CS0101: The namespace 'MyBinding' already contains a definition for 'Resource' There is not currently a way to turn this off; if you try: dotnet build -p:AndroidUseIntermediateDesignerFile=false Then `Resources\Resource.designer.cs` will be generated instead. There is no way to prevent this behavior, because `$(AndroidResgenFile)` defaults to this value. To solve cases where you *don't* want `Resource.designer.cs` at all: 1. Remove the `$(AndroidResgenFile)` default value. 2. Add a new `$(AndroidGenerateResourceDesigner)` MSBuild property, that seems like it will be a better name for .NET 6. `$(AndroidGenerateResourceDesigner)` defaults to True. 3. `$(AndroidUseIntermediateDesignerFile)` is based on `$(AndroidGenerateResourceDesigner)`. This way, if a Xamarin.Android binding project is migrated to .NET 6, the binding project can set `$(AndroidGenerateResourceDesigner)`=False to prevent `Resource.designer.cs` from being generated, which may prevent build failures. I added a test and docs for the new property.
# for free
to subscribe to this conversation on GitHub.
Already have an account?
#.
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: #6198
When migrating Xamarin.Android binding projects to .NET 6, one
difference is that
Resource.designer.cswill be generated by .NET 6class libraries.
There is not currently a way to turn this off, if you pass:
Then
Resources\Resource.designer.cswill be generated instead. Thereis no way to prevent this behavior, because
$(AndroidResgenFile)defaults to this value.
To solve cases where you don't want
Resource.designer.csat all:$(AndroidResgenFile)default value.$(AndroidGenerateResourceDesigner)MSBuild property,that seems like it will be a better name for .NET 6.
$(AndroidUseIntermediateDesignerFile)is based on$(AndroidGenerateResourceDesigner).I added a test for the new property.