Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add full list of formatters to docs and help text #19

Closed
sohkai opened this issue Dec 6, 2017 · 9 comments

Comments

Projects
None yet
5 participants
@sohkai
Copy link
Contributor

commented Dec 6, 2017

It'd be nice if it was made explicit somewhere that solhint just delegates to ESLint for formatters (and to add all the formatters to the README and CLI's help text).

@fvictorio and I have missed this before while adding vim plugins :) (e.g. #16 (comment)).

@sohkai sohkai referenced this issue Dec 6, 2017

Closed

Add gcc format #16

@idrabenia

This comment has been minimized.

Copy link
Member

commented Dec 7, 2017

Hi @sohkai ,

There is a documentation. https://protofire.github.io/solhint/
And list of formatters available there.

@fvictorio

This comment has been minimized.

Copy link
Member

commented Dec 7, 2017

I think what @sohkai is saying is that, since solhint just delegates the formatting to the formatters module of eslint, then that should be made explicit in the documentation. Right now it says:

report formatter name (stylish, table, tap, unix)

But there are many more formatters supported by eslint.

@idrabenia

This comment has been minimized.

Copy link
Member

commented Dec 15, 2017

@fvictorio Detailed documentation on this site. It contains details to full list of formatter https://protofire.github.io/solhint/

@mgarciap

This comment has been minimized.

Copy link
Member

commented Jul 26, 2018

@sohkai @fvictorio does @idrabenia answer satisfy the issue's requirement? If not, what do you propose?
We might have a circular reference with #16.

@fvictorio

This comment has been minimized.

Copy link
Member

commented Jul 26, 2018

I think it should be made more clear that solhint uses the same formatters that eslint and that you can specify the one you want. Right now there's just a link to the eslint docs and you have to assume that's how it works.

@mgarciap

This comment has been minimized.

Copy link
Member

commented Jul 26, 2018

@fvictorio

This comment has been minimized.

Copy link
Member

commented Jul 30, 2018

Added to the docs: 7eb0dc0

@pablofullana pablofullana added to do in progress and removed to do labels Jan 10, 2019

@pablofullana

This comment has been minimized.

Copy link
Member

commented Jan 10, 2019

@fvictorio we should close this one, right?

@fvictorio

This comment has been minimized.

Copy link
Member

commented Jan 22, 2019

Sure.

@fvictorio fvictorio closed this Jan 22, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.