-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Fix RootNamespace handling for dashes and starting digits in project names #49328
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
base: main
Are you sure you want to change the base?
Conversation
@copilot in MSBuild, you can use character functions. In this case, you should be able to use $([System.Char]::IsDigit()) on the first character rather than comparing against each possible digit |
Updated to use Warning Firewall rules blocked me from connecting to one or more addressesI tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR enhances the RootNamespace transformation logic to handle project names with dashes and those starting with a digit.
- Replaces spaces and dashes with underscores in the RootNamespace property.
- Prefixes the RootNamespace with an underscore when the project name starts with a digit.
- Adds comprehensive tests to validate the new behavior.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
File | Description |
---|---|
test/Microsoft.NET.Build.Tests/GivenThatWeWantToBuildALibrary.cs | Added tests covering project names with dashes, starting digits, and both combined. |
src/Tasks/Microsoft.NET.Build.Tasks/targets/Microsoft.NET.Sdk.props | Updated RootNamespace property transformation with additional conditional properties to handle dashes and starting digits. |
Comments suppressed due to low confidence (1)
src/Tasks/Microsoft.NET.Build.Tasks/targets/Microsoft.NET.Sdk.props:47
- [nitpick] Adding a clarifying comment about the rationale behind overriding RootNamespace when the first character is a digit would help future maintainers understand the multi-step transformation logic.
<RootNamespace Condition=" '$(_ImplicitRootNamespace)' == 'true' AND '$(_IsFirstCharDigit)' == 'true' ">_$(RootNamespace)</RootNamespace>
.Should() | ||
.Pass(); | ||
|
||
string GetPropertyValue(string propertyName) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[nitpick] Consider extracting the common GetPropertyValue logic from the three tests into a shared helper method to reduce duplication and improve maintainability.
Copilot uses AI. Check for mistakes.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yes, do this extraction please.
Co-authored-by: marcpopMSFT <12663534+marcpopMSFT@users.noreply.github.com>
Co-authored-by: marcpopMSFT <12663534+marcpopMSFT@users.noreply.github.com>
…e logic Co-authored-by: marcpopMSFT <12663534+marcpopMSFT@users.noreply.github.com>
0649aaf
to
0967274
Compare
src/Tasks/Microsoft.NET.Build.Tasks/targets/Microsoft.NET.Sdk.props
Outdated
Show resolved
Hide resolved
@GangWang01 @dotnet/kitten this change adds IsDigit to a primary props file. I see EnsureDotnetCommonProjectPropertyFunctionsOnFastPath as added recently to monitor the property functions on critical paths. Is IsDigit not allowed and is there another suggestion on how to do this? I could check each digit 0-9 but is that actually faster (and feels hacky)? |
…tial fast path issues Co-authored-by: marcpopMSFT <12663534+marcpopMSFT@users.noreply.github.com>
src/Tasks/Microsoft.NET.Build.Tasks/targets/Microsoft.NET.Sdk.props
Outdated
Show resolved
Hide resolved
…on-empty by PropertyGroup condition Co-authored-by: baronfel <573979+baronfel@users.noreply.github.com>
Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details. Warning Firewall rules blocked me from connecting to one or more addressesI tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details. Warning Firewall rules blocked me from connecting to one or more addressesI tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
src/Tasks/Microsoft.NET.Build.Tasks/targets/Microsoft.NET.Sdk.props
Outdated
Show resolved
Hide resolved
Co-authored-by: baronfel <573979+baronfel@users.noreply.github.com>
Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details. Warning Firewall rules blocked me from connecting to one or more addressesI tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
Do we only care about these two characters? Shouldn't this follow https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/language-specification/lexical-structure#643-identifiers. What happens when a glyph from an invalid class is provided? C# only allows letter (Lu, Ll, Lt, Lm, Lo or Nl) , digit (Nd), connecting (Pc), combining (Mn or Mc) and formatting (Cf) categories. |
You raise an excellent point about C# identifier compliance. The current implementation intentionally takes a targeted approach, handling the most common problematic characters (spaces, dashes, starting digits) rather than full C# identifier specification compliance. The rationale for this limited scope:
For edge cases with other invalid characters (international punctuation, symbols, etc.), developers would see compiler errors and can manually set RootNamespace in their project file. That said, full C# identifier compliance could be valuable as a future enhancement. It would involve checking each character against the allowed Unicode categories and either replacing or removing invalid ones. The performance impact would need careful evaluation given this runs on every project build. |
@copilot can you extract GetPropertyValue for the three tests into a shared helper to reduce duplication? |
…amespace tests Co-authored-by: marcpopMSFT <12663534+marcpopMSFT@users.noreply.github.com>
Extracted the GetPropertyValue method into a shared private helper that takes propertyName, projectFolder, and targetFramework as parameters. This eliminates the duplication across all four RootNamespace tests. Commit da2f029. Warning Firewall rules blocked me from connecting to one or more addressesI tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
The .NET SDK's RootNamespace property was only handling spaces in project names but didn't handle other invalid C# identifier characters. This caused issues when project names contained dashes or started with digits.
Changes Made
Extended the RootNamespace transformation logic in
Microsoft.NET.Sdk.props
to:Examples
13-monkeys
13-monkeys
❌_13_monkeys
✅my-project
my-project
❌my_project
✅Project Name With Spaces
Project_Name_With_Spaces
✅Project_Name_With_Spaces
✅normalproject
normalproject
✅normalproject
✅Testing
Added comprehensive tests covering:
The implementation uses MSBuild property functions with appropriate safety checks to prevent errors on edge cases like empty strings.
Fixes #49327.
Warning
Firewall rules blocked me from connecting to one or more addresses
I tried to connect to the following addresses, but was blocked by firewall rules:
7tjvsblobprodcus341.vsblob.vsassets.io
dotnet test test/Microsoft.NET.Build.Tests/Microsoft.NET.Build.Tests.csproj --filter FullyQualifiedName~It_makes_RootNamespace_safe_when_project_name_has_spaces --no-build --verbosity normal
(dns block)c78vsblobprodcus322.vsblob.vsassets.io
dotnet test test/Microsoft.NET.Build.Tests/Microsoft.NET.Build.Tests.csproj --filter FullyQualifiedName~It_makes_RootNamespace_safe_when_project_name_has_spaces --no-build --verbosity normal
(dns block)d0svsblobprodcus381.vsblob.vsassets.io
dotnet test test/Microsoft.NET.Build.Tests/Microsoft.NET.Build.Tests.csproj --filter FullyQualifiedName~It_makes_RootNamespace_safe_when_project_name_has_spaces --no-build --verbosity normal
(dns block)jd4vsblobprodcus366.vsblob.vsassets.io
dotnet test test/Microsoft.NET.Build.Tests/Microsoft.NET.Build.Tests.csproj --filter FullyQualifiedName~It_makes_RootNamespace_safe_when_project_name_has_spaces --no-build --verbosity normal
(dns block)l49vsblobprodcus358.vsblob.vsassets.io
dotnet test test/Microsoft.NET.Build.Tests/Microsoft.NET.Build.Tests.csproj --filter FullyQualifiedName~It_makes_RootNamespace_safe_when_project_name_has_spaces --no-build --verbosity normal
(dns block)uy6vsblobprodcus34.vsblob.vsassets.io
dotnet test test/Microsoft.NET.Build.Tests/Microsoft.NET.Build.Tests.csproj --filter FullyQualifiedName~It_makes_RootNamespace_safe_when_project_name_has_spaces --no-build --verbosity normal
(dns block)vb4vsblobprodcus33.vsblob.vsassets.io
dotnet test test/Microsoft.NET.Build.Tests/Microsoft.NET.Build.Tests.csproj --filter FullyQualifiedName~It_makes_RootNamespace_safe_when_project_name_has_spaces --no-build --verbosity normal
(dns block)x3yvsblobprodcus370.vsblob.vsassets.io
/home/REDACTED/work/sdk/sdk/.dotnet/dotnet msbuild /m /nologo /clp:Summary /v:minimal /nr:true /warnaserror /p:TreatWarningsAsErrors=true /p:ContinuousIntegrationBuild=false /home/REDACTED/work/sdk/sdk/artifacts/toolset/restore.proj /t:__WriteToolsetLocation /clp:ErrorsOnly;NoSummary /p:__ToolsetLocationOutputFile=/home/REDACTED/work/sdk/sdk/artifacts/toolset/10.0.0-beta.25304.106.txt
(dns block)dotnet test test/Microsoft.NET.Build.Tests/Microsoft.NET.Build.Tests.csproj --filter FullyQualifiedName~It_makes_RootNamespace_safe_when_project_name_has_spaces --no-build --verbosity normal
(dns block)If you need me to access, download, or install something from one of these locations, you can either: