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

Jump to bottom

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

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

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

sohkai opened this issue Dec 6, 2017 · 9 comments
Labels
help wanted Team would love to have contributors working on these in progress

Comments

@sohkai
Copy link
Contributor

sohkai 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 mentioned this issue Dec 6, 2017
Closed
@idrabenia
Copy link
Contributor

idrabenia commented Dec 7, 2017 •
edited

Hi @sohkai ,

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

@fvictorio
Copy link
Contributor

fvictorio commented Dec 7, 2017 •
edited

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
Copy link
Contributor

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

@mgarciap mgarciap added the help wanted Team would love to have contributors working on these label Apr 25, 2018
@mgarciap
Copy link
Contributor

@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
Copy link
Contributor

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
Copy link
Contributor

mgarciap commented Jul 26, 2018 via email

@fvictorio
Copy link
Contributor

Added to the docs: 7eb0dc0

@pablofullana
Copy link
Contributor

@fvictorio we should close this one, right?

@fvictorio
Copy link
Contributor

Sure.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
help wanted Team would love to have contributors working on these in progress
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
5 participants
@mgarciap @fvictorio @idrabenia @pablofullana @sohkai