eslint-formatter-github icon indicating copy to clipboard operation
eslint-formatter-github copied to clipboard

More clear instructions on setup

Open wolasss opened this issue 4 years ago • 3 comments

Hey, thanks for this app.

I am trying to integrate it into my repository so that it runs eslint in PR's but I am not sure what are the correct steps to install the app:

You will need to install the github app to your repo.

Then just use the formatter and it will report errors and warnings on PRs!

eslint --format github file.js

The usage section in the readme is very unclear about this. I installed the app on github, added the formatter to the repository and nothing is happening.

Then just use the formatter and it will report errors and warnings on PRs Where should I use this formatter? On CI? Locally when I run the eslint command :) ? Please point me in the right direction.

wolasss avatar Jun 01 '20 19:06 wolasss

It should only happen on the CI when building a PR. PRs welcome! Docs sometimes aren't my strong suit

hipstersmoothie avatar Jun 02 '20 16:06 hipstersmoothie

Hi, I too wanted to test this but have no luck. Does this only output into annotations for use in GH Checks API? Run on which CI?

kintarowins avatar Jul 30 '21 23:07 kintarowins

Hit this today.
No luck getting this to work based on docs. Any pointers? @hipstersmoothie

engrun avatar Jan 28 '22 13:01 engrun