eskimo--assignment1 (Command Line Parser) #51

avi-01 · 2019-08-24T07:29:23Z

No description provided.

kaustubh-karkare

Looks like you've gone a bit overboard on the comments, you want to use them only when actually needed. There is a balance. Ie - if I can read code, the comment explaining what it does is pointless. But if you have a large method (like 50 lines of code) then having a 2-3 line comment for me to read that describes what you're trying to do is useful.

kaustubh-karkare · 2019-08-24T19:25:23Z

solutions/eskimo/assignment1/test.js

@@ -0,0 +1,45 @@
+var command_line=require("./command_line");


Lets use a framework like Jest to test your code properlu.

kaustubh-karkare · 2019-08-24T19:28:40Z

solutions/eskimo/assignment1/command_line.js

+        this.argument_JSON={};
+
+        //To check two Exclusive commands doesn't get together 
+        this.isSetExclusive= new Array(100).fill("0");


I always thought that the linter wanted spaces around operations like '='.

I used the linter of visual studio code.

kaustubh-karkare · 2019-08-24T19:31:31Z

solutions/eskimo/assignment1/test.js

+    type:'number',
+    handler: function(){
+        console.log("Key");
+    }


Looks like the helper is called when the this command is provided?
That can be useful, but it isn't strictly necessary.
Ie - when I'm using a CLI argument parser, each command does not map to a specific method.
It might change something small, like a condition in an if-statement in some other part of the code.
But I guess it's fine now that you've added it.

kaustubh-karkare · 2019-08-24T19:33:07Z

solutions/eskimo/assignment1/command_line.js

+        {
+            command:"help",
+            describe:"HELP",
+            handler:()=>{


These instructions are useful if you're a developer using the library, but not if you're a user of the larger program.
And so showing them in CLI output is not really useful I think. It would have been fine to explain all this in a comment next to the method that you're supposed to call, or in a readme file.

I checked that yargs have such type of property of providing command details when --help is typed, that's why I included it.

I'm not opposed to have a help.

There are 3 roles here:

the developer of the library (you)

the developer of the application (using this library)

the user of the application

This output will be seen by "the user of the application", but is actually relevant only to "the developer of the application". If you want to show something for "the user of the application", you could create a help message based on the exact commands that were specified. This is where the description field comes in handy :)

kaustubh-karkare · 2019-08-24T19:34:43Z

solutions/eskimo/assignment1/command_line.js

+     * Add commands to commandList
+     * @param {JSON_object} add_command
+     */
+    command(add_command)


You could also provided default values like this:

add_option({command, type = 'string', required = false, ...})

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Destructuring_assignment

Btw, note that I renamed the method. Because a function named "command" does not tell me what it does without looking inside (ie - is it get_command? or does_command_exist?).

kaustubh-karkare · 2019-08-24T19:42:15Z

solutions/eskimo/assignment1/test.js

+command_line.command({
+    command:"local",
+    describe:"Set local",
+    ExclusiveIndex: 1,


This is not great API. Can you do something like:

group = command_line.add_mutually_exclusive_group() group.add('local', ...) group.add('remote', ...)

I think of creating a commad line parser like yargs... so I used its format of input.

kaustubh-karkare · 2019-08-24T19:44:13Z

solutions/eskimo/assignment1/command_line.js

+                            if(!val.includes("="))
+                            {
+                                //Error if argument doesn't have a value
+                                console.log("The '--"+command_available.command+"' argument is required, but missing from input.");


Instead of logging, you should throw errors here too, right?

kaustubh-karkare · 2019-08-24T19:46:07Z

solutions/eskimo/assignment1/command_line.js

+        }
+
+        //Adds help to commandList
+        this.commandList.push(help_obj);


This shouldn't be a class property.
Ie - it is relevant only for a single call to your execute method, so you can create it there, return it, and then forget it.

kaustubh-karkare · 2019-08-24T19:48:20Z

solutions/eskimo/assignment1/command_line.js

+                            //Checks the command type
+                            var command_type=command_available.type;
+
+                            if(command_type=='string')


How about a map?

const validators = { string: value => value.match("^[A-z]+$"), number: value => value.match("^[0-9]+$"), ... }

You'll save a lot of lines.

kaustubh-karkare · 2019-08-24T19:49:22Z

solutions/eskimo/assignment1/command_line.js

+    /**
+     * Prints the JSON
+     */
+    display()


this.argument_JSON shouldn't be a class property.
Ie - it is relevant only for a single call to your execute method, so you can create it there, return it, and then forget it. If the caller wants, they can remember it, but that's not the job of this module.

avi-01

added small argument option (-k), renamed command to add_command, reduced extra comments, mapped the commandName with command, removed arg_JSON & commandList from class property,
throw error instead of logging it.

kaustubh-karkare

Still waiting to address a few comments from previous review.

kaustubh-karkare · 2019-08-24T22:50:36Z

solutions/eskimo/assignment1/command_line.js

+        {
+            command:"help",
+            describe:"HELP",
+            handler:()=>{


I'm not opposed to have a help.

There are 3 roles here:

the developer of the library (you)

the developer of the application (using this library)

the user of the application

This output will be seen by "the user of the application", but is actually relevant only to "the developer of the application". If you want to show something for "the user of the application", you could create a help message based on the exact commands that were specified. This is where the description field comes in handy :)

kaustubh-karkare · 2019-08-24T22:52:28Z

solutions/eskimo/assignment1/command_line.js

+var commandsmallName={};
+
+//Stores the argument in JSON format
+var argument_JSON={};


There shouldn't be any global variables like this. This violates OOPs :)
If your parser class needs anything, it can create class properties.

assignment1

72e063a

kaustubh-karkare requested changes Aug 24, 2019

View reviewed changes

avi-01 added 2 commits August 25, 2019 03:46

Modified_Command_line

8a72d8d

Modified_Command_line1

2a21ec9

avi-01 commented Aug 24, 2019

View reviewed changes

kaustubh-karkare requested changes Aug 24, 2019

View reviewed changes

kaustubh-karkare force-pushed the master branch from f9e6d92 to 4bfac84 Compare August 28, 2019 00:03

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

eskimo--assignment1 (Command Line Parser) #51

eskimo--assignment1 (Command Line Parser) #51

avi-01 commented Aug 24, 2019

kaustubh-karkare left a comment

kaustubh-karkare Aug 24, 2019

kaustubh-karkare Aug 24, 2019

avi-01 Aug 24, 2019

kaustubh-karkare Aug 24, 2019

kaustubh-karkare Aug 24, 2019

avi-01 Aug 24, 2019

kaustubh-karkare Aug 24, 2019

kaustubh-karkare Aug 24, 2019

kaustubh-karkare Aug 24, 2019

avi-01 Aug 24, 2019

kaustubh-karkare Aug 24, 2019

kaustubh-karkare Aug 24, 2019

kaustubh-karkare Aug 24, 2019

kaustubh-karkare Aug 24, 2019

avi-01 left a comment

kaustubh-karkare left a comment

kaustubh-karkare Aug 24, 2019

kaustubh-karkare Aug 24, 2019

eskimo--assignment1 (Command Line Parser) #51

Are you sure you want to change the base?

eskimo--assignment1 (Command Line Parser) #51

Conversation

avi-01 commented Aug 24, 2019

kaustubh-karkare left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

avi-01 left a comment

Choose a reason for hiding this comment

kaustubh-karkare left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment