Get PR review comments from command line.
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin style: format by prettier Jan 17, 2018
src Fix formatter (#5) Jan 17, 2018
test initial commit Mar 5, 2017
.babelrc initial commit Mar 5, 2017
.gitignore initial commit Mar 5, 2017
.travis.yml initial commit Mar 5, 2017
LICENSE initial commit Mar 5, 2017
README.md fix typo Mar 5, 2017
package.json 1.2.1 Jan 17, 2018
yarn.lock initial commit Mar 5, 2017

README.md

get-github-pr-review-comments

Get PR review comments.

image

You can use it in an editor like VSCode. The editor can jump to the file path and line.

Install

Install with npm:

npm install get-github-pr-review-comments

Usage

Usage
  $ get-github-pr-review-comments --repo owner/repo --projectRoot /path/to/project --token <GitHubToken> <sha>

Options
  --repo  owner/repo
    e.g.) azu/get-github-pr-review-comments
  --projectRoot -p /path/to/root-project
    e.g.) /Users/azu/get-github-pr-review-comments
  --token GitHub Token
    Get from https://github.com/settings/tokens/new
    or
    export GH_TOKEN=XXX
    
 Example:
    get-github-pr-review-comments --repo azu/get-github-pr-review-comments --projectRoot /path/to/get-github-pr-review-comments --token xxx `git rev-parse HEAD`

Snippet

Shell script:

  declare repo=$(git config --local remote.origin.url | perl -pe's/(git@|https:\/\/)?github.com(:|\/)(\w+)\/(\w+)(.git)?/$3\/$4/' | sed 's/\.git//g')
  GH_TOKEN="xxx" get-github-pr-review-comments \
    --repo "${repo}" \
    --projectRoot `git rev-parse --show-toplevel` \
    `git rev-parse HEAD`

Changelog

See Releases page.

Running tests

Install devDependencies and Run npm test:

npm i -d && npm test

Contributing

Pull requests and stars are always welcome.

For bugs and feature requests, please create an issue.

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

Author

License

MIT © azu