Add support for flat launch settings #49769

jjonescz · 2025-07-14T14:01:45Z

Resolves #48200.

Youssef1313 · 2025-07-14T14:52:02Z

test/dotnet.Tests/CommandTests/Test/GivenDotnetTestBuildsAndRunsTests.cs

-        [InlineData(TestingConstants.Release)]
-        [Theory]
-        public void RunTestProjectWithTestsAndLaunchSettings_ShouldReturnExitCodeSuccess(string configuration)
+        [Theory, CombinatorialData]


Happy to see we have an updated test for dotnet test :)

FYI @nohwnd @mariam-abdulla @Evangelink

Copilot

Pull Request Overview

This PR adds support for “flat” launch settings files (e.g. MyApp.run.json) alongside the existing launchSettings.json.
Key changes:

Updated CLI logic in RunCommand, CommonRunHelpers, and LaunchSettingsManager to locate and apply both legacy and flat launch settings.
Expanded tests in dotnet test, dotnet run, and dotnet-watch suites to cover flat launch settings; updated completion snapshots.
Updated resource strings and localization artifacts to reference both file patterns.

Reviewed Changes

Copilot reviewed 27 out of 27 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
src/Cli/dotnet/Commands/Run/CommonRunHelpers.cs	Added helpers to build paths for both launch settings.
src/Cli/dotnet/Commands/Run/RunCommand.cs	Updated launch settings lookup logic, error reporting.
src/Cli/dotnet/Commands/Run/LaunchSettings/LaunchSettingsManager.cs	Changed `TryApplyLaunchSettings` to accept a file path.
src/Cli/dotnet/Commands/Test/SolutionAndProjectUtility.cs	Kept test utility in sync with new lookup signature.
test/dotnet.Tests/CommandTests/Test/GivenDotnetTestBuildsAndRunsTests.cs	Extended test combinatorics for flat vs legacy profiles.
test/dotnet.Tests/CommandTests/Run/*.cs	Added `run.json`-based launch profile tests.
test/dotnet-watch.Tests/Process/LaunchSettingsProfileTest.cs	Adapted to use flat launch settings path.
test/dotnet.Tests/CompletionTests/snapshots/{zsh,pwsh}/DotnetCliSnapshotTests.VerifyCompletions.*	Updated completion descriptions for `--no-launch-profile`.
src/Cli/dotnet/Commands/xlf/CliCommandStrings.*.xlf and CliCommandStrings.resx	Updated message strings to mention flat launch settings.

Comments suppressed due to low confidence (2)

test/dotnet.Tests/CommandTests/Run/GivenDotnetRunBuildsVbProj.cs:32

There is no testInstance variable defined in this test. It appears you meant to use the testProjectDirectory variable for the working directory. Please update the references accordingly so the test compiles.

                    {Path.Join(testInstance.Path, "My Project", "launchSettings.json")}

test/dotnet.Tests/CommandTests/Run/GivenDotnetRunBuildsCsProj.cs:382

The variable testInstance is not defined here; the test uses testProjectDirectory earlier. Please replace testInstance.Path with the correct test directory variable so the test compiles and runs.

                    {Path.Join(testInstance.Path, "Properties", "launchSettings.json")}

Copilot · 2025-07-15T06:47:33Z

src/Cli/dotnet/Commands/Run/CommonRunHelpers.cs

@@ -36,4 +36,10 @@ public static Dictionary<string, string> GetGlobalPropertiesFromArgs(string[] ar
        }
        return globalProperties;
    }
+
+    public static string GetPropertiesLaunchSettingsPath(string directoryPath, string propertiesDirectoryName)


[nitpick] The file path helpers use both Path.Combine and Path.Join in this class. Consider unifying on one approach (e.g. Path.Combine) for consistency and clarity.

The existing helper used Path.Combine and I opted to preserve that to avoid a break.

Copilot · 2025-07-15T06:47:33Z

src/Cli/dotnet/Commands/Run/RunCommand.cs

+                Reporter.Error.WriteLine(string.Format(CliCommandStrings.RunCommandExceptionCouldNotLocateALaunchSettingsFile, launchProfile, $"""
+                    {launchSettingsPath}
+                    {runJsonPath}
+                    """).Red());


[nitpick] Error messages elsewhere use .Bold().Red() for emphasis before writing to the reporter. For consistency, consider adding .Bold() here as well.

Suggested change

""").Red());

""").Bold().Red());

This is not a hard error (in fact, the command continues to run in spite of the error), so I feel like bolding it is not necessary.

The location you moved this from did bold it though.

Copilot · 2025-07-15T06:47:33Z

src/Cli/dotnet/Commands/xlf/CliCommandStrings.zh-Hant.xlf

-        <source>Do not attempt to use launchSettings.json to configure the application.</source>
-        <target state="translated">請勿嘗試使用 launchSettings.json 設定該應用程式。</target>
-        <note />
+        <source>Do not attempt to use launchSettings.json or [app].run.json to configure the application.</source>


Manual edits to .xlf localization files should be avoided. Please update the source strings in the .resx and regenerate all .xlf files via the MSBuild /t:UpdateXlf target to ensure consistency.

I didn't modify those, the build did this.

Youssef1313 · 2025-07-15T08:11:19Z

@jjonescz Quick question, the new run.json is applicable to dotnet run file.cs only? Or applicable to both dotnet run file.cs and dotnet run --project MyProject.csproj?

jjonescz · 2025-07-15T08:19:59Z

Quick question, the new run.json is applicable to dotnet run file.cs only? Or applicable to both dotnet run file.cs and dotnet run --project MyProject.csproj?

Both. Also dotnet test and dotnet watch.

Youssef1313 · 2025-07-15T08:22:02Z

Quick question, the new run.json is applicable to dotnet run file.cs only? Or applicable to both dotnet run file.cs and dotnet run --project MyProject.csproj?

Both. Also dotnet test and dotnet watch.

Yeah I was asking for the behavior of dotnet run for projects because that's what we want to match dotnet test with. Thanks for clarifying!

tmat · 2025-07-15T17:23:03Z

dotnet-watch changes LGTM

jjonescz · 2025-07-16T08:47:51Z

@MiYanni @RikkiGibson @jaredpar for reviews, thanks

jjonescz · 2025-07-18T08:27:37Z

@RikkiGibson @jaredpar for reviews, thanks

jjonescz · 2025-07-21T10:59:38Z

@RikkiGibson @333fred for reviews, thanks

RikkiGibson · 2025-07-22T22:19:40Z

src/Cli/dotnet/Commands/Run/CommonRunHelpers.cs

+        => Path.Combine(directoryPath, propertiesDirectoryName, "launchSettings.json");
+
+    public static string GetFlatLaunchSettingsPath(string directoryPath, string projectNameWithoutExtension)
+        => Path.Join(directoryPath, $"{projectNameWithoutExtension}.run.json");


Is it expected to be able to put launch settings in MyProject/MyProject.run.json alongside MyProject/MyProject.csproj?

Yes, quoting from #48200:

It also allows project-based apps to simplify their file structure by not needing to have a Properties directory to put the launchSettings.json file in.

RikkiGibson · 2025-07-22T22:22:52Z

src/Cli/dotnet/Commands/Run/RunCommand.cs

-            if (!string.IsNullOrEmpty(LaunchProfile))
-            {
-                Reporter.Error.WriteLine(string.Format(CliCommandStrings.RunCommandExceptionCouldNotLocateALaunchSettingsFile, launchSettingsPath).Bold().Red());
-            }
            return true;


what does the return value of this method mean? "Either we don't need launch settings, or we do, and we found it?"

Yes, simply false means there was an error and we should not continue (and the return code from the CLI should be non-zero); true means success and we can continue (and the return code from the CLI should be zero).

RikkiGibson · 2025-07-22T22:26:20Z

src/Cli/dotnet/Commands/Run/RunCommand.cs

-            {
-                return null;
-            }
+            var buildPathContainer = File.Exists(projectOrEntryPointFilePath) ? Path.GetDirectoryName(projectOrEntryPointFilePath)! : projectOrEntryPointFilePath;


I am struggling a bit to follow this File.Exists check. I realize it is pre-existing code. But what is this doing? Is this really saying: if this is a file, then use its containing directory, otherwise assume it's a directory and use the path as-is? Is that something we should verify (e.g. buildPathContainer should always be a directory on disk)?

Hm, looks like the check is unnecessary, the projectOrEntryPointFilePath should always be a path, we should never get a directory there (we check that when parsing the command). I will remove it.

RikkiGibson · 2025-07-22T22:42:47Z

test/dotnet.Tests/CommandTests/Run/RunFileTests.cs

+            """);
+        Directory.CreateDirectory(Path.Join(testInstance.Path, "Properties"));
+        File.WriteAllText(Path.Join(testInstance.Path, "Properties", "launchSettings.json"), s_launchSettings.Replace("TestProfileMessage", "PropertiesLaunchSettingsJson"));
+        File.WriteAllText(Path.Join(testInstance.Path, "Program.run.json"), s_launchSettings.Replace("TestProfileMessage", "ProgramRunJson"));


I am curious if this is a situation that the CLI should warn about. However, it doesn't seem super important.

Sounds good to me, I will add a warning, thanks.

jjonescz added 2 commits July 14, 2025 14:38

Disallow using --launch-profile with dotnet run -

7c2b3dc

Add support for flat launch settings

95dd2dd

jjonescz changed the title ~~Sprint launch~~ Add support for flat launch settings Jul 14, 2025

Youssef1313 reviewed Jul 14, 2025

View reviewed changes

jjonescz added the Area-run-file Items related to the "dotnet run <file>" effort label Jul 14, 2025

This was referenced Jul 14, 2025

dotnet-watch tests failing #40006

Open

Containers integration tests are flaky when the network fails to load the registry #49502

Open

jjonescz marked this pull request as ready for review July 15, 2025 06:45

jjonescz requested review from tmat and a team as code owners July 15, 2025 06:45

jjonescz requested review from a team and Copilot July 15, 2025 06:46

Copilot AI reviewed Jul 15, 2025

View reviewed changes

jjonescz mentioned this pull request Jul 15, 2025

Update xlf copilot instructions #49780

Open

MiYanni approved these changes Jul 16, 2025

View reviewed changes

jjonescz requested review from jaredpar, RikkiGibson and chsienki July 17, 2025 07:40

RikkiGibson mentioned this pull request Jul 22, 2025

Implement #:package manipulation for file-based apps #49635

Merged

RikkiGibson approved these changes Jul 22, 2025

View reviewed changes

jjonescz added 3 commits July 23, 2025 10:24

Remove unnecessary check

04be093

Re-add bold

995f332

Warn if app.run.json is not used

b7229a9

Add support for flat launch settings #49769

Are you sure you want to change the base?

Add support for flat launch settings #49769

Conversation

jjonescz commented Jul 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Jul 15, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 15, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 15, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Youssef1313 commented Jul 15, 2025

Uh oh!

jjonescz commented Jul 15, 2025

Uh oh!

Youssef1313 commented Jul 15, 2025

Uh oh!

tmat commented Jul 15, 2025

Uh oh!

jjonescz commented Jul 16, 2025

Uh oh!

jjonescz commented Jul 18, 2025

Uh oh!

jjonescz commented Jul 21, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jjonescz Jul 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jjonescz Jul 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

jjonescz commented Jul 14, 2025 •

edited

Loading

jjonescz Jul 23, 2025 •

edited

Loading

jjonescz Jul 23, 2025 •

edited

Loading