swtor/argument-parser
0
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

📄 Fix headings

Browse source
This commit is contained in:
C-3PO 2018-11-02 01:11:41 +01:00
parent 050b990dc0
commit 72cd3d1b0f
Signed by: c3po
GPG key ID: 62993C4BB4D86F24
1 changed files with 5 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -1,8 +1,10 @@
# argument-parser
This module parses the command line arguments into a JavaScript object, and verifies that they match the given specification. It checks that all required options are set, that no unknown options are used, and optionally that the arguments match a given pattern. This module parses the command line arguments into a JavaScript object, and verifies that they match the given specification. It checks that all required options are set, that no unknown options are used, and optionally that the arguments match a given pattern.
The main goal is to keep all the complexity and error handling inside this module, so that all command line applications only need to provide a couple lines of specification and do not have to worry about verifying the input or checking for `undefined`. The main goal is to keep all the complexity and error handling inside this module, so that all command line applications only need to provide a couple lines of specification and do not have to worry about verifying the input or checking for `undefined`.
# Installation ## Installation
For this tool to work, the TypeScript compiler must be globally installed: For this tool to work, the TypeScript compiler must be globally installed:
@ -26,7 +28,7 @@ Then run:
npm install npm install
``` ```
# Usage ## Usage
This example shows how to use this module to check the arguments against a specification. This example shows how to use this module to check the arguments against a specification.
@ -84,7 +86,7 @@ OPTIONS
Size of the file, must be a non-negative integer Size of the file, must be a non-negative integer
``` ```
# License ## License
Copyright (C) 2018 Jedipedia.net Copyright (C) 2018 Jedipedia.net