{"id":516541,"date":"2024-10-04T13:40:29","date_gmt":"2024-10-04T12:40:29","guid":{"rendered":"https:\/\/blog.jetbrains.com\/?post_type=dotnet&p=516541"},"modified":"2024-10-15T19:48:36","modified_gmt":"2024-10-15T18:48:36","slug":"support-for-slnx-solution-files","status":"publish","type":"dotnet","link":"https:\/\/blog.jetbrains.com\/zh-hans\/dotnet\/2024\/10\/04\/support-for-slnx-solution-files","title":{"rendered":"Support for SLNX Solution Files"},"content":{"rendered":"\n

For nearly twenty years<\/a>, the .NET community has enjoyed working with solution files (*.sln)<\/a>. Due to their tooling-centered format, manually changing these files has always been challenging. Merge conflicts in solution files\u2014much like merging CSPROJ files<\/a>\u2014were commonplace and often resulted in corrupted files or lost changes.<\/p>\n\n\n\n

The structure of SLN files is overly verbose\u2014an empty solution file starts at nine lines of code with 225 characters! Every added project contributes six lines and duplicated GUID references throughout the file. On top of that, it often seems impossible to remember which of the two GUIDs represents the project ID<\/a>. Also, the duplication of project names and solution items offers no real benefit despite expectations:<\/p>\n\n\n\n

Microsoft Visual Studio Solution File, Format Version 12.00\nProject(\"{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}\") = \"CSharpConsoleApp\", \"CSharpConsoleApp\\CSharpConsoleApp.csproj\", \"{56AC6E9D-28FA-60C6-322C-7A6C3A2CF147}\"\nEndProject\nProject(\"{2150E333-8FDC-42A3-9474-1A3956D46DE8}\") = \"SolutionFolder1\", \"SolutionFolder1\", \"{C6BC3CF2-0D31-8D54-D372-94C86BEC98BA}\"\n    ProjectSection(SolutionItems) = preProject\n        global.json = global.json\n    EndProjectSection\nEndProject\nGlobal\n    GlobalSection(SolutionConfigurationPlatforms) = preSolution\n        Debug|Any CPU = Debug|Any CPU\n        Release|Any CPU = Release|Any CPU\n    EndGlobalSection\n    GlobalSection(ProjectConfigurationPlatforms) = postSolution\n        {56AC6E9D-28FA-60C6-322C-7A6C3A2CF147}.Debug|Any CPU.ActiveCfg = Debug|Any CPU\n        {56AC6E9D-28FA-60C6-322C-7A6C3A2CF147}.Debug|Any CPU.Build.0 = Debug|Any CPU\n        {56AC6E9D-28FA-60C6-322C-7A6C3A2CF147}.Release|Any CPU.ActiveCfg = Release|Any CPU\n        {56AC6E9D-28FA-60C6-322C-7A6C3A2CF147}.Release|Any CPU.Build.0 = Release|Any CPU\n    EndGlobalSection\nEndGlobal<\/pre>\n\n\n\n
But enough ranting. Microsoft introduced a new SLNX format<\/b> based on XML as a solution (pun intended!) to fix these issues. We at JetBrains are excited to announce that Rider provides beta support already<\/b>!<\/p>\n\n\n
\n
Download Rider 2024.3 EAP<\/a><\/div>\n<\/div>\n\n\n
Getting Started<\/h2>\n\n\n\n
You can translate your existing solution to an SLNX file<\/b> by right-clicking on its node in the Explorer<\/em> window<\/a>. From there, you can choose Save as\u2026 | Save as XML Solution (.slnx)<\/em>:<\/p>\n\n\n\n
\n    \n   
Saving a Solution in SLNX Format<\/figcaption>\n<\/figure>\n\n\n\n
Next to your original SLN file, you will now see a clean and minimal SLNX file that everyone should feel confident to edit manually. Our example from the introduction looks as follows:<\/p>\n\n\n\n
<Solution>\n    <Folder Name=\"\/SolutionFolder\/\">\n        <File Path=\"global.json\" \/>\n    <\/Folder>\n    <Project Path=\"ConsoleApp1\\ConsoleApp1.csproj\" Type=\"Classic C#\" \/>\n<\/Solution><\/pre>\n\n\n\n
After you confirm the saving dialog, Rider will also offer you to open the freshly created SLNX file:<\/p>\n\n\n\n
\n    \n   
Prompt to open a newly created XML Solution<\/figcaption>\n<\/figure>\n\n\n\n
You can also translate SLNX files back to the SLN format<\/b>, which is particularly important if your development environment or team requires both files (more details below). Open an SLNX file, and find the Save as Solution (.sln)<\/em> action in the very same context menu location:<\/p>\n\n\n\n
\n    \n   
Saving an XML Solution in SLN Format<\/figcaption>\n<\/figure>\n\n\n\n
Limitations<\/h2>\n\n\n\n
Microsoft is still developing the SLNX format as a preview feature, and it has yet to be officially announced. Despite this, the community is excited and eager to migrate, as the format shows immense promise. As a result, there are a few limitations within the broader ecosystem that users should be aware of.<\/p>\n\n\n\n
Since there is no official dotnet new<\/code> template, Rider also currently doesn’t offer one from the New Project<\/em> dialog<\/a>.<\/p>\n\n\n\n
The .NET CLI and MSBuild don’t yet support SLNX files<\/a>. Therefore, it’s most certainly necessary to keep both files in your repository so that your CI\/CD infrastructure can do its work. Regarding that, please note that Rider does not automatically synchronize the two files.<\/p>\n\n\n\n
Conclusion<\/h2>\n\n\n\n
Although the SLNX format is still in preview, it already looks like a promising answer to the challenges .NET developers have faced for years with the old proprietary SLN format. Rider 2024.3 EAP introduces initial support for reading and writing the new SLNX format based on our research. We look forward to Microsoft publishing the details of the new SLNX schema and making it generally available to the community!<\/p>\n\n\n
\n
Download Rider 2024.3 EAP<\/a><\/div>\n<\/div>","protected":false},"author":553,"featured_media":516486,"comment_status":"closed","ping_status":"closed","template":"","categories":[4992,1401],"tags":[158,1978],"cross-post-tag":[],"acf":[],"_links":{"self":[{"href":"https:\/\/blog.jetbrains.com\/zh-hans\/wp-json\/wp\/v2\/dotnet\/516541"}],"collection":[{"href":"https:\/\/blog.jetbrains.com\/zh-hans\/wp-json\/wp\/v2\/dotnet"}],"about":[{"href":"https:\/\/blog.jetbrains.com\/zh-hans\/wp-json\/wp\/v2\/types\/dotnet"}],"author":[{"embeddable":true,"href":"https:\/\/blog.jetbrains.com\/zh-hans\/wp-json\/wp\/v2\/users\/553"}],"replies":[{"embeddable":true,"href":"https:\/\/blog.jetbrains.com\/zh-hans\/wp-json\/wp\/v2\/comments?post=516541"}],"version-history":[{"count":8,"href":"https:\/\/blog.jetbrains.com\/zh-hans\/wp-json\/wp\/v2\/dotnet\/516541\/revisions"}],"predecessor-version":[{"id":518426,"href":"https:\/\/blog.jetbrains.com\/zh-hans\/wp-json\/wp\/v2\/dotnet\/516541\/revisions\/518426"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/blog.jetbrains.com\/zh-hans\/wp-json\/wp\/v2\/media\/516486"}],"wp:attachment":[{"href":"https:\/\/blog.jetbrains.com\/zh-hans\/wp-json\/wp\/v2\/media?parent=516541"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/blog.jetbrains.com\/zh-hans\/wp-json\/wp\/v2\/categories?post=516541"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/blog.jetbrains.com\/zh-hans\/wp-json\/wp\/v2\/tags?post=516541"},{"taxonomy":"cross-post-tag","embeddable":true,"href":"https:\/\/blog.jetbrains.com\/zh-hans\/wp-json\/wp\/v2\/cross-post-tag?post=516541"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}