csf-dev / csf.cli.parameters Goto Github PK

Command-line parameter reader & parser

License: MIT License

C# 100.00%

csf.cli.parameters's Introduction

Command-line parameter reader (retired)

This library is now retired and will not receive further updates. Please consider System.CommandLine instead.

This library introduces a reader/parser for command-line application parameters, with a capability to deserialize the read parameters into a plain old CSharp object (POCO).

To use this library you would:

Register the available parameters using a mapping-based mechanism.
Pass the string[] parameters received from your static void Main(string[] args) method into the parser
Receive, from the parser, an instance of your POCO with its applicable properties populated.

Documentation and examples

The documentation and examples for this library may be found on the project wiki.

Open source license

All source files within this project are released as open source software, under the terms of the MIT license.

This software is distributed in the hope that it will be useful, but please remember that:

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

csf.cli.parameters's People

Contributors

Watchers

csf.cli.parameters's Issues

Handle Windows-style parameters

Windows-style parameters begin with a forward-slash instead of a dash.

Consider retiring this library

Microsoft have a good command line library of their own now. It supports almost all of the same features this does, except bundling the values into a model. That's quite easy to do though.

https://docs.microsoft.com/en-us/dotnet/standard/commandline/

In that case, I can retire this and stop maintaining it.

netstandard1.0
netstandard2.0
net45

Fix project URL in nuspec file

The nuspec file lists a github pages URL not the actual project page.

Tidy up and release v1.0.0 as nuget package

This new repository now needs tidying, ready for release as a nuget package:

Use git filter-branch to remove Common/Dependencies
Remove unneeded files in Common and util directories
Rewrite readme file
Rename solution file and tests project
Update AssemblyInfo accordingly
Create nuspec file
Configure project for documentation and compile flags

This repository is blocked on two others:

CSF.Core
CSF.Reflection

A number of code smell issues should be fixed

SonarCloud has reported a number of code smells, these must be fixed.

Handle -- to end parameter parsing

As with conventions on Linux, two dashes alone ends the parsing of parameters, and indicates that everything else is 'remaining arguments'. This should be supported.