cake-build / cake-build/cake

Improve error message for reserved argument names

Open
#2,794 1 comment 0 reactions 1 assignee Claimed by @FrankRay78 View on GitHub
blocked-upstream Improvement
Dominant language
C#
Stars
4.2k
Forks
778
Avg merge
3h 37m
Merged PRs (30d)
21

Description

It seems that some argument names cannot be used as build arguments. For example, trying to use an argument called `version` throws the error `Error: Argument value is not a valid boolean value.`

build.cake
```csharp
var version = Argument("version", "1.0.0");
// ...
```

![image](https://user-images.githubusercontent.com/177608/83976501-ac8ff180-a8d0-11ea-9542-89570857848b.png)

I'm guessing this is caused because version is already being used to show the tool version e.g. `dotnet cake --version`, which is reasonable.

However, it's not clear from the error message above why the error occurs. I'd suggest adding a validation and display a better error message and suggest a workaround such as "_Use a different name such as `appVersion`, `packageVersion`, etc._"

---

Using dotnet cake global tool v0.38.1

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.