Comments (4)
[Edit] - I've modified the solution below and published to NuGet.
I've been waiting a long time for someone to ask this question :).
I've added 2 properties to the [ArgRequired] attribute. They are 'If' and 'IfNot'. Here's how they work.
public class ConditionalArgs
{
[ArgRequired(If = "SecondArgument")]
public string FirstArgument { get; set; }
public string SecondArgument { get; set; }
}
In this example, 'FirstArgument' is required only if 'SecondArgument' is specified by the user. You'll still need to check for null at runtime to see which one the user actually provided, but you'll get the validation for free.
You can even put boolean expressions in the If and IfNot properties like this if you need to do some more complex logic.
public class ComplexUnlessArgs
{
[ArgRequired(IfNot = "LocalFile & LocalFileUserName & LocalFilePassword")]
[ArgCantBeCombinedWith("LocalFile | LocalFileUserName | LocalFilePassword")]
public string Uri { get; set; }
public string LocalFile { get; set; }
public string LocalFileUserName { get; set; }
public string LocalFilePassword { get; set; }
}
You can do ands '&', ors '|', group expressions in parentheses, and use not '!'.
That last example showed another new attribute called [ArgCantBeCombinedWith] that lets you declare that this argument is not valid if some other arguments are specified. Boolean expressions are allowed there as well.
And if you're worried about hardcoding the property names as strings within the If and IfNot values then I understand, but I do some basic validation for you. For example if you make a typo and type the name of an argument that does not exist then you'll get an InvalidArgDefinitionException which is almost as good as a compilation error.
After parsing, your code can tell if an argument was specified by checking for null. If you want to make a value type optional then use a Nullable. If you're not familiar with nullables they let you use value types like reference types. Here's an example:
// Define a nullable property
public int? OptionalInt{get;set;}
// Check a nullable property
if(OptionalInt.HasValue)
{
int intValue = OptionalInt.Value;
// Do something with your int
}
Hopefully that does what you need. Let me know if it does not solve your problem or if you have any other feedback.
Thanks,
Adam
from powerargs.
sounds like you covered it all, that is great!
thank you again for such a complete solution, really makes working with command line args fun lol
looking forward to the next nuget release so i can throw this in. I would just grab latest but think im going to wait so i can just let nuget manage the versions for me.
I owe you a beer | coffee | tea ..... what ever it is you prefer to drink ;)
from powerargs.
Thanks for the kind words. I'll probably add a few more tests before updating NuGet. I wrote a full boolean expression parser to make this solution flexible and I want to make sure it's solid before I publish it.
ETA - 1-2 weeks.
from powerargs.
Available in 2.0.6
from powerargs.
Related Issues (20)
- Add support for a warning on usage of obsolete enum value HOT 1
- Implementation of ContextAssistSearch doesn't get initialized HOT 1
- Slash (/) with positional arguments running on Linux & MacOS HOT 2
- How to specify command line parameters with double dashes (eg. --help) HOT 1
- Boolean args as 'flags'? HOT 1
- String args with 'null' as default throw unhandled exception HOT 1
- New Release Pending? HOT 1
- validation message missing for ArgCantBeCombinedWith HOT 1
- Prompting for input despite PromptIfMissing=false on Required arg HOT 3
- Allow zero-length list of argument values to be terminated by next option
- How to parse into an array? HOT 2
- Issue with scrolling in console HOT 2
- Issue running on Linux HOT 3
- Scrolling and background issues on 4.0.0. Works on 3.6.0 HOT 2
- Some links broken in README.md HOT 1
- Validator only checks first item in List arguments HOT 1
- Release 4.0.2 is not strongnamed (4.0.0 is, as well as 3.6.x) HOT 1
- Change executable name in 'help'?
- bool reviver not working
- Use param label as value
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from powerargs.