Conversation
julianxcarter
left a comment
There was a problem hiding this comment.
This looks great and works really well for me! I have two small suggestions that I'd like to hear your thoughts on.
README.md
Outdated
| node src/cli/cli.js --help | ||
| ``` | ||
|
|
||
| The client can also be run by npm script: |
There was a problem hiding this comment.
I wonder if it'd be a good idea to entirely remove the instructions in the readme for running the client by way of the node src/cli/cli.js command. It seems like something that could only introduce confusion to some of our users, given that the node command only works from the top-level directory but the npm start command works from anywhere in the project. I'd love to hear your and @Dtphelan1's thoughts on this .
If we do keep the instructions for running the client with the node src/cli/cli.js command, we may want to move the npm start instructions to be the first command described in this readme and kind of suggest to users that this is our recommended way for running the client.
There was a problem hiding this comment.
Yeah, I wasn't sure if this was meant to be a replacement to node src/cli/cli.js or just an extra option. If we want to push this as the main way to run the client I can definitely make changes to the README to reflect that. I would like to hear other's opinions as well though.
Summary
You can now call
npm start -- [options]to start the client instead ofnode src/cli/cli.js [options]New behavior
There is now a script in
package.jsoncalled "start" that acts as a simpler way of calling the program from the command line. It is important to note that npm requires you to put "--" between your script name and command line arguments. If the double hyphen is left out, the arguments will be interpreted as npm flags, for example -d and -f will be interpreted as npm's debug and force flags, not our debug and from date flags.Code changes
package.jsonnow has a start script, which runs the clientTesting guidance
Make sure that you are able to use the client as usual when calling via the start script