Make interactive shell easily available when installing via npm #330
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Hi @kirsle do you think this PR could be merged anytime soon ? 😃 |
|
Hi @ErwanDL I've merged this now and published it as v2.1.0 on npm. 😄 Thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Following our discussion on #329, I made the interactive shell available as a command-line tool when installing rivescript-js via npm (there was actually very little change to make, only a few additions to package.json). I chose to call the associated command "riveshell", tell me if you'd prefer another name.
It can be called via
$ npx riveshell /path/to/brainwhen the package is installed locally, or simply$ riveshell /path/to/brainwhen installed globally. I ensured that the command works properly both on macOS (bash) and Windows (cmd, powershell and git-bash).I also updated the README.md file and the doc at the top of
shell.jsto reflect this new feature. I moved the "Installation" section of the README above the "Usage" section because I assume that people should already have installed the package before reading the details on how to use the interactive shell.