Add command 'dotnet project convert' #47500

jjonescz · 2025-03-12T10:43:54Z

I have also removed the check for top-level statements because I've realized that

it's not correct in all cases, e.g., when there are some <DefineConstants> in an implicit build file or on the command line, they would not be considered when using Roslyn API to detect top-level statements but they would be recognized during the build itself, potentially leading to inconsistencies (I've added tests for that),
even if we allow multi-file support and want to error on dotnet run util.cs, we can do that check in Roslyn instead, avoiding the <DefineConstants> problem and reusing its logic for detecting entrypoints, hence also recognizing all forms of Main methods, not just top-level statements.

Copilot

Pull Request Overview

This pull request adds a new "dotnet project add" command that creates a project folder and generates a non-virtual project file based on an entry point file. It introduces:

A new command implementation (ProjectAddCommand) and parser (ProjectAddCommandParser) to handle the add operation.
Updates to the virtual project building logic and project command integration.
Minor type qualification updates for consistency in related modules.

Reviewed Changes

Copilot reviewed 29 out of 29 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
src/Cli/dotnet/commands/dotnet-project/add/ProjectAddCommand.cs	Implements the new add command; creates a project folder and moves/updates files accordingly.
src/Cli/dotnet/commands/dotnet-project/add/ProjectAddCommandParser.cs	Adds the parser for the new command.
src/Cli/dotnet/commands/dotnet-project/ProjectCommandParser.cs	Integrates the new subcommand into the project command.
src/Cli/dotnet/commands/VirtualProjectBuildingCommand.cs	Adds common project properties and updates project file generation.
src/Cli/dotnet/Parser.cs	Registers the new project command.
src/Cli/dotnet/Extensions/ProjectExtensions.cs	Updates parameter types for consistency.
src/Cli/dotnet/MsbuildProject.cs	Updates type qualification for evaluated projects.

Comments suppressed due to low confidence (1)

src/Cli/dotnet/commands/dotnet-project/add/ProjectAddCommand.cs:23

[nitpick] The variable name 'file' is ambiguous and may benefit from a more descriptive name such as 'fullFilePath' to clarify its purpose.

string file = Path.GetFullPath(_file);

chsienki

LGTM.

I did have a question about the verbiage of dotnet project add given that we have dotnet add <projectfile> as an existing command, but thats for the spec, and this PR matches what's currently in the spec.

jjonescz · 2025-03-13T18:02:38Z

given that we have dotnet add <projectfile> as an existing command

You mean dotnet add package and dotnet add reference? Yeah, Chet said they are moving away from verb-first to noun-first. And so there are actually now also dotnet package add and dotnet reference add.

baronfel · 2025-03-13T18:08:39Z

Correct - we prefer noun-first as much as possible starting in 10.0.

baronfel · 2025-03-13T18:17:26Z

We'll probably talk about this in design but I really don't like the dotnet project add verb/command chosen here. It's way to general IMO. We'll need to bikeshed about a proper name before .NET 10 RC1.

RikkiGibson · 2025-03-13T18:51:19Z

It feels like a verb like convert/migrate/move would be appropriate here. But not suggesting to rename the command in this PR.

src/Cli/dotnet/commands/dotnet-project/add/ProjectAddCommand.cs

src/Cli/dotnet/commands/VirtualProjectBuildingCommand.cs

test/dotnet-project-add.Tests/DotnetProjectAddTests.cs

Co-authored-by: Rikki Gibson <[email protected]>

jjonescz · 2025-03-14T09:03:10Z

@MiYanni for a review, thanks

Forgind · 2025-03-14T21:43:36Z

We'll probably talk about this in design but I really don't like the dotnet project add verb/command chosen here. It's way to general IMO. We'll need to bikeshed about a proper name before .NET 10 RC1.

I'd like to come up with a good answer for this before taking a real look at this. Project feels wrong to me. I don't have a good answer to replace it yet; my best is library. dotnet library add? I don't like that, but that's all I've come up with

DamianEdwards · 2025-03-15T00:34:13Z

Ideas for other command names, with assumption that each accepts file name as an argument:

dotnet project init
dotnet project eject
dotnet project create
dotnet project convert
dotnet project up
dotnet project growup
dotnet project upgrade
dotnet new project

What ChatGPT settled on:

Final Recommendation
If the goal is transitioning from a script to a full project, I’d recommend dotnet project convert or dotnet project upgrade for the clearest intent.

If you want to align with .NET CLI conventions more broadly, dotnet project init or dotnet project create could work, but they might be slightly misleading in terms of upgrading an existing entry-point file.

https://chatgpt.com/share/67d4cad7-c7a4-8012-85f2-a0eb5286553e

jjonescz · 2025-03-17T12:42:10Z

I have a PR for #: directive handling almost ready, but it's based on this one (most of the tests of the directive processing will take a C# text with the directives as input and verify the .csproj after grow up matches expectations). (EDIT: I guess we don't need the CLI command for that, an internal API for the tests is enough; but still will need some effort to rebase this PR out of that one.) Do we want to block that until we settle on the CLI command name here, or can we go with dotnet project add for now? I can also retarget to a feature branch instead of main if that helps.

baronfel · 2025-03-17T12:48:19Z

I like 'dotnet project convert' quite a lot (lots of space for like a --from-file, or --from-Xyz if we need it). I'm also looking at a far future with a 'dotnet project upgrade' sibling command, and that feels pretty nice.

jjonescz · 2025-03-17T13:01:33Z

I like 'dotnet project convert' quite a lot (lots of space for like a --from-file, or --from-Xyz if we need it). I'm also looking at a far future with a 'dotnet project upgrade' sibling command, and that feels pretty nice.

Okay, I like that as well, and I can change to that easily. Thanks.

jjonescz · 2025-03-17T16:26:16Z

@MiYanni or @Forgind for a review, thanks

MiYanni · 2025-03-17T20:55:14Z

...dotnet-completions.Tests/snapshots/bash/DotnetCliSnapshotTests.VerifyCompletions.verified.sh

@baronfel So, is it intended that every CLI surface change requires these 3 completion tests to have changes? It looks like it requires at least some Bash, PowerShell, and ZSH knowledge to do this, which is a pretty high bar.

yes, it's intended. the CLI interface is a public interface, and we need to be careful about it the same way as we would a REST response or any other API.

these tests are one kind of gate in that regard.

It looks like it requires at least some Bash, PowerShell, and ZSH knowledge to do this, which is a pretty high bar.

Note that these are automatically generated snapshots.

MiYanni · 2025-03-17T21:55:55Z

test/dotnet-run.Tests/RunFileTests.cs

@@ -300,7 +297,7 @@ public void ClassLibrary_EntryPointFileExists()
            .WithWorkingDirectory(testInstance.Path)
            .Execute()
            .Should().Fail()
-            .And.HaveStdErrContaining(s_noTopLevelStatements);
+            .And.HaveStdOutContaining("error CS5001:"); // Program does not contain a static 'Main' method suitable for an entry point


Is the word "error" localized? Meaning, would this word change if it was run in a different language environment?

Yes, it should be. Note that this is the output of the Roslyn compiler. Not sure why you are asking? It doesn't look like sdk tests run in different locales and there are many tests that verify localizable strings against their English variant. But for example, in Roslyn tests, we don't do that as we run the tests also on non-English locales intentionally. If you intend to do that as well in sdk in the future, let me know, I will try to rewrite my tests so they are locale-insensitive.

Some people run SDK tests locally. They would get localized outputs for this sort of thing, so this test wouldn't work for them as-is.

Makes sense, I can follow up with a PR that ensures RunFileTests and DotnetProjectConvertTests can run on localized machines.

But I want to reiterate that this is a pre-existing problem for many other tests, e.g., https://github.com/search?q=repo%3Adotnet%2Fsdk%20HaveStdErrContaining&type=code

Add command 'dotnet project add'

ea915d3

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

dotnet-issue-labeler bot added the untriaged Request triage from a team member label Mar 12, 2025

Update tests

a68c547

jjonescz marked this pull request as ready for review March 12, 2025 13:24

jjonescz requested review from Copilot, jaredpar, DamianEdwards, baronfel, RikkiGibson, Forgind, chsienki and MiYanni March 12, 2025 13:24

Copilot AI reviewed Mar 12, 2025

View reviewed changes

jjonescz added 2 commits March 12, 2025 16:56

Remove top-level statements check for file-based programs

5d2c65b

Merge branch 'main' into sprint-grow

578214b

jjonescz force-pushed the sprint-grow branch from 268e4f2 to 578214b Compare March 13, 2025 12:13

chsienki approved these changes Mar 13, 2025

View reviewed changes

RikkiGibson approved these changes Mar 13, 2025

View reviewed changes

Mention test in comment

6f40e57

Co-authored-by: Rikki Gibson <[email protected]>

jjonescz added 2 commits March 14, 2025 12:01

Add output option

3b30717

Update snapshots

328ee9a

Change to dotnet project convert

6f76622

baronfel changed the title ~~Add command 'dotnet project add'~~ Add command 'dotnet project convert' Mar 17, 2025

RikkiGibson approved these changes Mar 17, 2025

View reviewed changes

MiYanni approved these changes Mar 17, 2025

View reviewed changes

Merge branch 'main' into sprint-grow

edfffc9

build-analysis bot mentioned this pull request Mar 18, 2025

Template engine tests hitting known parallelism issue in GetVisualStudioInstances #44878

Open

jjonescz merged commit b2845af into dotnet:main Mar 18, 2025
39 checks passed

jjonescz deleted the sprint-grow branch March 18, 2025 17:22

jjonescz mentioned this pull request Apr 8, 2025

Make 'dotnet run file' tests runnable on localized machines #48264

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add command 'dotnet project convert' #47500

Add command 'dotnet project convert' #47500

jjonescz commented Mar 12, 2025 •

edited

Loading

Copilot AI left a comment

chsienki left a comment

jjonescz commented Mar 13, 2025

baronfel commented Mar 13, 2025

baronfel commented Mar 13, 2025

RikkiGibson commented Mar 13, 2025 •

edited

Loading

jjonescz commented Mar 14, 2025

Forgind commented Mar 14, 2025

DamianEdwards commented Mar 15, 2025

jjonescz commented Mar 17, 2025 •

edited

Loading

baronfel commented Mar 17, 2025

jjonescz commented Mar 17, 2025 •

edited

Loading

jjonescz commented Mar 17, 2025

MiYanni Mar 17, 2025

baronfel Mar 17, 2025

jjonescz Mar 18, 2025

MiYanni Mar 17, 2025

jjonescz Mar 18, 2025

Forgind Mar 18, 2025

jjonescz Mar 18, 2025

Add command 'dotnet project convert' #47500

Add command 'dotnet project convert' #47500

Conversation

jjonescz commented Mar 12, 2025 • edited Loading

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

chsienki left a comment

Choose a reason for hiding this comment

jjonescz commented Mar 13, 2025

baronfel commented Mar 13, 2025

baronfel commented Mar 13, 2025

RikkiGibson commented Mar 13, 2025 • edited Loading

jjonescz commented Mar 14, 2025

Forgind commented Mar 14, 2025

DamianEdwards commented Mar 15, 2025

jjonescz commented Mar 17, 2025 • edited Loading

baronfel commented Mar 17, 2025

jjonescz commented Mar 17, 2025 • edited Loading

jjonescz commented Mar 17, 2025

MiYanni Mar 17, 2025

Choose a reason for hiding this comment

baronfel Mar 17, 2025

Choose a reason for hiding this comment

jjonescz Mar 18, 2025

Choose a reason for hiding this comment

MiYanni Mar 17, 2025

Choose a reason for hiding this comment

jjonescz Mar 18, 2025

Choose a reason for hiding this comment

Forgind Mar 18, 2025

Choose a reason for hiding this comment

jjonescz Mar 18, 2025

Choose a reason for hiding this comment

jjonescz commented Mar 12, 2025 •

edited

Loading

RikkiGibson commented Mar 13, 2025 •

edited

Loading

jjonescz commented Mar 17, 2025 •

edited

Loading

jjonescz commented Mar 17, 2025 •

edited

Loading