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

Author: jjonescz

documentation/general/dotnet-run-file.md

@@ -102,6 +102,9 @@ To opt out, use `#:property PublishAot=false` directive in your `.cs` file.
 
 Command `dotnet clean file.cs` can be used to clean build artifacts of the file-based program.
 
+Commands `dotnet package add PackageName --file app.cs` and `dotnet package remove PackageName --file app.cs`
+can be used to manipulate `#:package` directives in the C# files, similarly to what the commands do for project-based apps.
+
 ## Entry points
 
 If a file is given to `dotnet run`, it has to be an *entry-point file*, otherwise an error is reported.
@@ -378,8 +381,7 @@ We could also add `dotnet compile` command that would be the equivalent of `dotn
 `dotnet clean` could be extended to support cleaning all file-based app outputs,
 e.g., `dotnet clean --all-file-based-apps`.
 
-Adding references via `dotnet package add`/`dotnet reference add` could be supported for file-based programs as well,
-i.e., the command would add a `#:package`/`#:project` directive to the top of a `.cs` file.
+More NuGet commands (like `dotnet nuget why` or `dotnet package list`) could be supported for file-based programs as well.
 
 ### Explicit importing
 

src/Cli/dotnet/CliStrings.resx

@@ -273,9 +273,18 @@
   <data name="ProjectArgumentName" xml:space="preserve">
     <value>PROJECT</value>
   </data>
+  <data name="ProjectOrFileArgumentName" xml:space="preserve">
+    <value>PROJECT | FILE</value>
+  </data>
   <data name="ProjectArgumentDescription" xml:space="preserve">
     <value>The project file to operate on. If a file is not specified, the command will search the current directory for one.</value>
   </data>
+  <data name="ProjectOrFileArgumentDescription" xml:space="preserve">
+    <value>The project file or C# file-based app to operate on. If a file is not specified, the command will search the current directory for a project file.</value>
+  </data>
+  <data name="FileArgumentDescription" xml:space="preserve">
+    <value>The file-based app to operate on.</value>
+  </data>
   <data name="CommonCmdFramework" xml:space="preserve">
     <value>FRAMEWORK</value>
   </data>
@@ -814,4 +823,4 @@ The default is 'false.' However, when targeting .NET 7 or lower, the default is
   <data name="SDKSchemaCommandDefinition" xml:space="preserve">
     <value>Display the command schema as JSON.</value>
   </data>
-</root>
+</root>

src/Cli/dotnet/Commands/CliCommandStrings.resx

@@ -1280,6 +1280,11 @@ Tool '{1}' (version '{2}') was successfully installed. Entry is added to the man
   <data name="PackageRemoveSpecifyExactlyOnePackageReference" xml:space="preserve">
     <value>Specify only one package reference to remove.</value>
   </data>
+  <data name="DirectivesRemoved" xml:space="preserve">
+    <value>Removed '{0}' directives ({1}) for '{2}' from: {3}</value>
+    <comment>{0} is a directive kind (like '#:package'). {1} is number of removed directives.
+    {2} is directive key (e.g., package name). {3} is file path from which directives were removed.</comment>
+  </data>
   <data name="PackagesCommandNameCollisionConclusion" xml:space="preserve">
     <value>Command names conflict. Command names are case insensitive.
 {0}</value>
@@ -1590,14 +1595,14 @@ Tool '{1}' (version '{2}') was successfully installed. Entry is added to the man
     <value>Duplicate directives are not supported: {0} at {1}</value>
     <comment>{0} is the directive type and name. {1} is the file path and line number.</comment>
   </data>
-  <data name="InvalidOptionCombination" xml:space="preserve">
-    <value>Cannot combine option '{0}' and '{1}'.</value>
-    <comment>{0} and {1} are option names like '--no-build'.</comment>
-  </data>
   <data name="InvalidOptionForStdin" xml:space="preserve">
     <value>Cannot specify option '{0}' when also using '-' to read the file from standard input.</value>
     <comment>{0} is an option name like '--no-build'.</comment>
   </data>
+  <data name="InvalidOptionForFileBasedApp" xml:space="preserve">
+    <value>Cannot specify option '{0}' when operating on a file-based app.</value>
+    <comment>{0} is an option name like '--source'.</comment>
+  </data>
   <data name="NoBinaryLogBecauseUpToDate" xml:space="preserve">
     <value>Warning: Binary log option was specified but build will be skipped because output is up to date, specify '--no-cache' to force build.</value>
     <comment>{Locked="--no-cache"}</comment>

src/Cli/dotnet/Commands/Hidden/Add/AddCommandParser.cs

@@ -1,11 +1,10 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
-#nullable disable
-
 using System.CommandLine;
 using Microsoft.DotNet.Cli.Commands.Hidden.Add.Package;
 using Microsoft.DotNet.Cli.Commands.Hidden.Add.Reference;
+using Microsoft.DotNet.Cli.Commands.Package;
 using Microsoft.DotNet.Cli.Extensions;
 
 namespace Microsoft.DotNet.Cli.Commands.Hidden.Add;
@@ -14,11 +13,6 @@ internal static class AddCommandParser
 {
     public static readonly string DocsLink = "https://aka.ms/dotnet-add";
 
-    public static readonly Argument<string> ProjectArgument = new Argument<string>(CliStrings.ProjectArgumentName)
-    {
-        Description = CliStrings.ProjectArgumentDescription
-    }.DefaultToCurrentDirectory();
-
     private static readonly Command Command = ConstructCommand();
 
     public static Command GetCommand()
@@ -33,7 +27,7 @@ private static Command ConstructCommand()
             Hidden = true
         };
 
-        command.Arguments.Add(ProjectArgument);
+        command.Arguments.Add(PackageCommandParser.ProjectOrFileArgument);
         command.Subcommands.Add(AddPackageCommandParser.GetCommand());
         command.Subcommands.Add(AddReferenceCommandParser.GetCommand());
 

src/Cli/dotnet/Commands/Hidden/Add/Package/AddPackageCommandParser.cs

@@ -1,12 +1,9 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
-#nullable disable
-
 using System.CommandLine;
 using Microsoft.DotNet.Cli.Commands.Package;
 using Microsoft.DotNet.Cli.Commands.Package.Add;
-using Microsoft.DotNet.Cli.Extensions;
 
 namespace Microsoft.DotNet.Cli.Commands.Hidden.Add.Package;
 
@@ -32,20 +29,9 @@ private static Command ConstructCommand()
         command.Options.Add(PackageAddCommandParser.InteractiveOption);
         command.Options.Add(PackageAddCommandParser.PrereleaseOption);
         command.Options.Add(PackageCommandParser.ProjectOption);
+        command.Options.Add(PackageCommandParser.FileOption);
 
-        command.SetAction((parseResult) =>
-        {
-            // this command can be called with an argument or an option for the project path - we prefer the option.
-            // if the option is not present, we use the argument value instead.
-            if (parseResult.HasOption(PackageCommandParser.ProjectOption))
-            {
-                return new PackageAddCommand(parseResult, parseResult.GetValue(PackageCommandParser.ProjectOption)).Execute();
-            }
-            else
-            {
-                return new PackageAddCommand(parseResult, parseResult.GetValue(AddCommandParser.ProjectArgument) ?? Directory.GetCurrentDirectory()).Execute();
-            }
-        });
+        command.SetAction((parseResult) => new PackageAddCommand(parseResult).Execute());
 
         return command;
     }

src/Cli/dotnet/Commands/Hidden/Remove/Package/RemovePackageCommandParser.cs

@@ -1,8 +1,6 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
-#nullable disable
-
 using System.CommandLine;
 using Microsoft.DotNet.Cli.Commands.Package.Remove;
 

src/Cli/dotnet/Commands/Hidden/Remove/RemoveCommandParser.cs

@@ -1,11 +1,10 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
-#nullable disable
-
 using System.CommandLine;
 using Microsoft.DotNet.Cli.Commands.Hidden.Remove.Package;
 using Microsoft.DotNet.Cli.Commands.Hidden.Remove.Reference;
+using Microsoft.DotNet.Cli.Commands.Package;
 using Microsoft.DotNet.Cli.Extensions;
 
 namespace Microsoft.DotNet.Cli.Commands.Hidden.Remove;
@@ -14,11 +13,6 @@ internal static class RemoveCommandParser
 {
     public static readonly string DocsLink = "https://aka.ms/dotnet-remove";
 
-    public static readonly Argument<string> ProjectArgument = new Argument<string>(CliStrings.ProjectArgumentName)
-    {
-        Description = CliStrings.ProjectArgumentDescription
-    }.DefaultToCurrentDirectory();
-
     private static readonly Command Command = ConstructCommand();
 
     public static Command GetCommand()
@@ -33,7 +27,7 @@ private static Command ConstructCommand()
             Hidden = true
         };
 
-        command.Arguments.Add(ProjectArgument);
+        command.Arguments.Add(PackageCommandParser.ProjectOrFileArgument);
         command.Subcommands.Add(RemovePackageCommandParser.GetCommand());
         command.Subcommands.Add(RemoveReferenceCommandParser.GetCommand());
 

src/Cli/dotnet/Commands/New/DotnetCommandCallbacks.cs

@@ -21,7 +21,7 @@ internal static bool AddPackageReference(string projectPath, string packageName,
         {
             commandArgs = commandArgs.Append(PackageAddCommandParser.VersionOption.Name).Append(version);
         }
-        var addPackageReferenceCommand = new PackageAddCommand(AddCommandParser.GetCommand().Parse([.. commandArgs]), projectPath);
+        var addPackageReferenceCommand = new PackageAddCommand(AddCommandParser.GetCommand().Parse([.. commandArgs]));
         return addPackageReferenceCommand.Execute() == 0;
     }