Feel free to try this out for your Github projects! If you like it, drop me a
line.
If you find any bugs, please see the wiki
page for a guide on submitting
bug reports (I'd love to get them so I know what I can fix). If you have any
improvements, please open a pull request (which I'll try reviewing via this
tool!) or give me a feature suggestion via Github issue. I'm more than happy to
branch this off into a more general and powerful project.
Installation
$ npm install -g github-review
Usage
Visit your favorite Github NodeJS project and pick an open pull request
Copy out the pull request's URL (anything that has
user/repo/pull/<num>/...)
Paste it on the commandline:
# Save yourself some typing, paste in whatever URL is in your browser$ review.js https://github.com/shelljs/shx/pull/14$ review.js https://github.com/shelljs/shx/pull/14/files # this works too$ review.js https://github.com/shelljs/shx/pull/14#discussion_r55946766 # even this
Press enter, watch the magic happen, and cd into the new PR_14/
directory
Testing the master branch
Also, you can also paste in the URL of the repo itself to clone & test the
master branch:
# Clone & test the master branch$ review.js https://github.com/shelljs/shx
System Compatibility
This is written mainly in ShellJS, so this is supposed to be compatible with
Linux, Mac OS X, and Windows. Note: you must have curl installed for this
script to run. Don't like that? I'll gladly accept a PR fixing that.
If you find that this script doesn't run on your system, let me know and I'll
try to fix that as well.