search

coala / coala

coala provides a unified command-line interface for linting and fixing all your code, regardless of the programming languages you use.
https://coala.io/
GNU Affero General Public License v3.0
3.55k stars 1.31k forks source link

Set up proselint #2284

Open underyx opened 8 years ago

gitmate-bot commented 8 years ago

Thanks for reporting this issue!

Your aid is required, fellow coalaian. Help us triage and solving this issue!

CC @sils1297, @AbdealiJK

tushar-rishav commented 8 years ago

I like this tool. But IMO this issue should rather go with coala-bears. @sils1297 We want this?

AbdealiLoKo commented 8 years ago

We already have ProseLintBear - https://github.com/coala-analyzer/coala-bears/blob/master/bears/natural_language/ProseLintBear.py

We could look into improving the configs if you like, but it is there. @underyx Is that what you meant by set-up ?

underyx commented 8 years ago

Yes, that's what I meant, sorry about the ambiguity. We had lots of documentation commits lately and thought it would be nice to have writing style checks for them.

On Sun, Jun 5, 2016, 3:37 AM AbdealiJK notifications@github.com wrote:

We already have ProseLintBear - https://github.com/coala-analyzer/coala-bears/blob/master/bears/natural_language/ProseLintBear.py

We could look into improving the configs if you like, but it is there. @underyx https://github.com/underyx Is that what you meant by set-up ?

— You are receiving this because you were mentioned.

Reply to this email directly, view it on GitHub https://github.com/coala-analyzer/coala/issues/2284#issuecomment-223805286, or mute the thread https://github.com/notifications/unsubscribe/ABAuVKIlcpLaV80FJP0qnLCKx0pJEyYkks5qIqbmgaJpZM4IuNKs .

cylussec commented 8 years ago

I would be willing to take this on, but its not clear what you are looking for. Should there be some automated process to look at documentation changes and use Proselint on them automatically? Or are you looking for someone to go through the existing documentation?

sils1297 commented 8 years ago

@underyx ?

sils commented 8 years ago

I think it's basically adding ProseLintBear to the coafile of the coala/documentation repository so our docs are checked, @underyx can you confirm?

underyx commented 8 years ago

Yep, that's it.

d1ndra commented 8 years ago

Would like to work on this if nobody isn't.

sils commented 8 years ago

Hi! Welcome to our community and thank you, both @cylussec and @d1ndra for your interest!

I have sent you an invitation to join our community. This is needed so we can coordinate tasks with you and make sure no two persons are working on the same thing. If you can't find the mail, you should be able to join us at http://github.com/coala-analyzer/!

Hint: if you're proud to be part of the team, you can make your membership public at https://github.com/orgs/coala/people

Rules as follows, since both of you want to do it: the first one to accept the invitation and confirming this on this issue will get it. I'm happy to help the other one to find another low difficulty issue.

We'd love to be able to help you when problems occur. Just join us on our gitter channel and tell us about them :)

jayvdb commented 7 years ago

As noted on https://github.com/coala/documentation/pull/244, there are false positives due to https://github.com/amperser/proselint not understanding code blocks in RST. It seems that upstream is interested, but someone needs to write the bug description, and probably do some leg work to make it happen.

An alternative is to use LanguageTool. I've raised that as an issue at https://github.com/coala/documentation/issues/283 .