Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated README examples #218

Merged
merged 3 commits into from
Jan 12, 2018
Merged

Updated README examples #218

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
46bf0bc
Added VB.NET Verb example code.
Jan 12, 2018
9cb0e30
Updated VB.NET quick start example
Jan 12, 2018
dd07605
Updated C# quick start example to work with the newer API.
Jan 12, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
89 changes: 46 additions & 43 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,31 +54,28 @@ See more details in the [wiki for direct integrations](https://github.com/gsscod
C# Examples:

```csharp
internal class Options {
[Option('r',"read",
Required = true,
HelpText = "Input files to be processed.")]
class Options
{
[Option('r', "read", Required = true, HelpText = "Input files to be processed.")]
public IEnumerable<string> InputFiles { get; set; }

// Omitting long name, defaults to name of property, ie "--verbose"
[Option(
DefaultValue = false,
HelpText = "Prints all messages to standard output.")]
[Option(Default = false, HelpText = "Prints all messages to standard output.")]
public bool Verbose { get; set; }

[Option("stdin",
DefaultValue = false
HelpText = "Read from stdin")]
public bool stdin { get; set; }

[Value(0, MetaName = "offset",
HelpText = "File offset.")]

[Option("stdin", Default = false, HelpText = "Read from stdin")]
public bool stdin { get; set; }

[Value(0, MetaName = "offset", HelpText = "File offset.")]
public long? Offset { get; set; }
}

static int Main(string[] args) {
var options = new Options();
var isValid = CommandLine.Parser.Default.ParseArgumentsStrict(args, options);
static void Main(string[] args)
{
CommandLine.Parser.Default.ParseArguments<Options>(args)
.WithParsed<Options>(opts => RunOptionsAndReturnExitCode(opts))
.WithNotParsed<Options>((errs) => HandleParseError(errs));
}
```

F# Examples:
Expand All @@ -102,25 +99,25 @@ VB.Net:

```VB.NET
Class Options
<CommandLine.Option('r', "read", Required := true,
HelpText:="Input files to be processed.")>
Public Property InputFiles As IEnumerable(Of String)

' Omitting long name, defaults to name of property, ie "--verbose"
<CommandLine.Option(
HelpText:="Prints all messages to standard output.")>
Public Property Verbose As Boolean

<CommandLine.Option(DefaultValue:="中文",
HelpText:="Content language.")>
Public Property Language As String

<CommandLine.Value(0, MetaName:="offset",
HelpText:="File offset.")>
Public Property Offset As Long?
<CommandLine.Option("r", "read", Required:=True, HelpText:="Input files to be processed.")>
Public Property InputFiles As IEnumerable(Of String)

' Omitting long name, defaults to name of property, ie "--verbose"
<CommandLine.Option(HelpText:="Prints all messages to standard output.")>
Public Property Verbose As Boolean

<CommandLine.Option([Default]:="中文", HelpText:="Content language.")>
Public Property Language As String

<CommandLine.Value(0, MetaName:="offset", HelpText:="File offset.")>
Public Property Offset As Long?
End Class

'TODO
Sub Main(ByVal args As String())
CommandLine.Parser.Default.ParseArguments(Of Options)(args) _
.WithParsed(Function(opts As Options) RunOptionsAndReturnExitCode(opts)) _
.WithNotParsed(Function(errs As IEnumerable(Of [Error])) 1)
End Sub
```

### For verbs:
Expand Down Expand Up @@ -160,20 +157,26 @@ VB.Net example:
```VB.NET
<CommandLine.Verb("add", HelpText:="Add file contents to the index.")>
Public Class AddOptions
'Normal options here
'Normal options here
End Class
<CommandLine.Verb("commit", HelpText:="Record changes to the repository.")>
Public Class AddOptions
'Normal options here
Public Class CommitOptions
'Normal options here
End Class
<CommandLine.Verb("clone", HelpText:="Clone a repository into a new directory.")>
Public Class AddOptions
'Normal options here
Public Class CloneOptions
'Normal options here
End Class

Public Shared Sub Main()
'TODO
End Sub
Function Main(ByVal args As String()) As Integer
Return CommandLine.Parser.Default.ParseArguments(Of AddOptions, CommitOptions, CloneOptions)(args) _
.MapResult(
(Function(opts As AddOptions) RunAddAndReturnExitCode(opts)),
(Function(opts As CommitOptions) RunCommitAndReturnExitCode(opts)),
(Function(opts As CloneOptions) RunCloneAndReturnExitCode(opts)),
(Function(errs As IEnumerable(Of [Error])) 1)
)
End Function
```

F# Example:
Expand Down