ArgumentStringHandler blocks usage of variables

[makp0]

Usage Information

7.0.0, NET 7.0

Description

ArgumentStringHandler does not allow variables to be passed as arguments.

Reproduction Steps

var cloneCommand = "clone https://github.com/nuke-build/nuke.git";
Git(cloneCommand);

Expected Behavior

There have to be an overload allowing to pass strings.

Actual Behavior

Argument is 'value' while parameter is declared as 'ref'

Regression?

Yes. It's a completely avoidable breaking change.

Known Workarounds

No response

Could you help with a pull-request?

No

[matkoch]

FYI, this has been discussed here: #1007

From the upcoming blog post:

As a consequence of introducing this feature, all arguments must be passed as interpolated strings; even if you’re invoking a tool without any arguments, you have to pass $“”. This has two reasons. On the one hand, interpolated string handlers cannot deal with constant strings. On the other hand, there can’t be another overload with just string, because interpolated strings composed of just constant strings would be handled by the DefaultInterpolatedStringHandler, which would render this feature unreliable.

[Droppers]

Any estimate on when this blog post will be published?

[matt-richardson]

I ran into trouble here too - I couldn't get it to work as expected...

Before:

var heatArguments = $"dir {serverOutputPath} " +
    "-nologo " +
    // <snip/>
    $"-out {heatGeneratedWxsFile}";
var wiXHeatTool = ToolResolver.GetPackageTool("wix", "heat.exe");
wiXHeatTool(heatArguments);

After:

var wiXHeatTool = ToolResolver.GetNuGetTool("wix", "heat.exe");
var heatArguments = new ArgumentStringHandler();
heatArguments.AppendLiteral($"dir {serverOutputPath} ");
heatArguments.AppendLiteral("-nologo ");
// <snip/>
heatArguments.AppendLiteral($"-out {heatGeneratedWxsFile}");
wiXHeatTool(ref heatArguments);

The only thing that I could get to work (though I didn't spend too long on it) was to directly call the ArgumentStringHandler methods to build up the args.

[matt-richardson]

Hmmm. I wonder if the string concatenation was forcing a conversion from interpolated strings to a fixed string 🤔

[matt-richardson]

Update:

I got it working via:

var wiXHeatTool = ToolResolver.GetPackageTool("wix", "heat.exe");
wiXHeatTool($"dir {serverOutputPath} " +
    $"-nologo " +
    // <snip/>
    $"-out {heatGeneratedWxsFile}");

Note that if you're using string concatenation (the +), then every part of the string needs to be an interpolated string (prefixed with $).

[maxcherednik]

Will duplicate my message here. Might be useful.

Was struggling with the upgrade from 6.3.0 to 7.0.0

After the upgrade the parameter of the node was double quoted by default.

NodeExe($"{yarnCommand}", workingDirectory: path, logger: LogErrorAsWarning);
I had to add the nq format.

NodeExe($"{yarnCommand:nq}", workingDirectory: path, logger: LogErrorAsWarning);
I guess it should have been the default option.

Am I doing something wrong?

[capjan]

@maxcherednik - thanks a lot!

I wrote the same code to convert my prepared arguments and also forgot to include the now required :nq formatter.

Maybe a note to the nq formatter should the added to the documentation (Executing CLI Tools).
That would help developers to execute their prepared arguments with quotes in the intended and expected way.