aminnairi / command-parser Goto Github PK

Describe the bug
There is no logo for the Travis CI badge.

Expected behavior
There should be a logo for the Travis CI badge.

Additional context
The reason why there is no logo is because the badge was fetched from the Travis CI website and not from the Shields.io website. Hence, preventing the new logo feature from being used on the Travis CI badge (which is not implemented).

Describe the bug
There is a typo in the documentation for the first and second section of the quick start.

Expected behavior
There should be no typo.

Describe the bug
The coverage badge links to the development branch.

Expected behavior
The coverage badge should link to the master branch.

Additional context
The coverage reports were initially done on the development branch for testing (and learning) purposes. All coverage reports are now done on the branch master (where the latest version resides for all tags and NPM versions).

Describe the bug
There is currently no way of providing parameters with the equal sign syntax for double-dash parameters.

To Reproduce
Steps to reproduce the behavior:

1. Create a directory of test

$ mkdir double-dash-equal-test

2. Move to the created directory

$ cd double-dash-equal-test

3. Quickly initialize the NPM project

$ npm init --yes

4. Install the package

$ npm install @aminnairi/command-parser

5. Create the test file

$ touch index.js

6. Add these line to the index.js file with the editor of your choice

'use strict';

const { CommandParser } = require('@aminnairi/command-parser');

const parser = new CommandParser();

parser.option('meme', 'Template of the meme to use');

console.log(parser.parse());

7. Run the script

$ node index.js --meme=conceited-reaction So you want to use double-dash-equal syntax huh
{ argument:
   '--meme=conceited-reaction So you want to use double-dash syntax huh' }

Expected behavior
The step 7 should output something like this:

$ node index.js --meme=conceited-reaction So you want to use double-dash-equal syntax huh
{ meme: 'conceited-reaction',
  argument: 'So you want to use double-dash syntax huh' }

Desktop:

• OS: GNU/Linux Arch
• Nodejs Version 11.6.0

Additional context
Documentation for the POSIX specification for parsing arguments.

Is your feature request related to a problem? Please describe.
There should be a name section indicating the name and the quick description of the program.

Describe the solution you'd like
The solution to adopt is inspired from the How should a formatted man page look? page.

Describe the bug
The documentation for the version 0.3.0 is currently outdated and does not represent the real configuration necessary for the API to work. Though it will be indicated to the user whenever something is missing/wrong in the configuration/usage.

Expected behavior
The documentation should provide informations about:

• How to properly instanciate the class.
• An example usage of displaying the version (set when instanciating the class).
• Add a usage for the instanciation of the API helper.

Desktop:

• Command Parser version 0.3.0

Is your feature request related to a problem? Please describe.
There should be a description section in the help output.

Describe the solution you'd like
The solution is inspired from the How should a formatted man page look? page.