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

bears/general: Add TextLintBear #1597

Merged

rultor merged 1 commit into coala:master from yash-nisar:textlint-bear

Jun 17, 2017

Member

yash-nisar commented Apr 9, 2017 •

edited

Closes #1576

For short term contributors: we understand that getting your commits well
defined like we require is a hard task and takes some learning. If you
look to help without wanting to contribute long term there's no need
for you to learn this. Just drop us a message and we'll take care of brushing
up your stuff for merge!

Checklist

I read the commit guidelines and I've followed
them.
I ran coala over my code locally. (All commits have to pass
individually. It is not sufficient to have "fixup commits" on your PR,
our bot will still report the issues for the previous commit.) You will
likely receive a lot of bot comments and build failures if coala does not
pass on every single commit!

After you submit your pull request, DO NOT click the 'Update Branch' button.
When asked for a rebase, consult coala.io/rebase
instead.

Please consider helping us by reviewing other peoples pull requests as well:

pick up any PR at https://coala.io/review
review it (check https://coala.io/reviewing for more info)
if you are sure that it needs work, use cobot mark wip <URL> to get it out
of the review queue.

The more you review, the more your score will grow at coala.io and we will
review your PRs faster!

gitmate-bot added process/pending review size/XL labels Apr 9, 2017

gitmate-bot reviewed Apr 9, 2017

View changes

Show outdated Hide outdated bears/general/TextLintBear.py

gitmate-bot reviewed Apr 9, 2017

View changes

Show outdated Hide outdated bears/general/TextLintBear.py

gitmate-bot reviewed Apr 9, 2017

View changes

Show outdated Hide outdated bears/general/TextLintBear.py

gitmate-bot added the review carefully! label Apr 9, 2017

jayvdb requested changes Apr 9, 2017

View changes

Show outdated Hide outdated tests/general/textlint_test_files/bad_write_good_common_misspellings.html

Show outdated Hide outdated bears/general/TextLintBear.py

Show outdated Hide outdated bears/general/TextLintBear.py

Show outdated Hide outdated bears/general/TextLintBear.py

Show outdated Hide outdated bears/general/TextLintBear.py

Show outdated Hide outdated bears/general/TextLintBear.py

Show outdated Hide outdated bears/general/TextLintBear.py

jayvdb added process/wip and removed process/pending review labels Apr 9, 2017

yash-nisar changed the title from bears/general: Add TextLintBear to WIP bears/general: Add TextLintBear Apr 9, 2017

gitmate-bot added size/XXL and removed size/XL labels Apr 9, 2017

Member

yash-nisar commented Apr 9, 2017

Aaaaannnddd the testsss passsss 🎉

Collaborator

gitmate-bot commented Apr 16, 2017

Hey! This pull request hasn't been updated for a while :/ It would be nice if we could get this going again!

Collaborator

gitmate-bot commented Apr 23, 2017

Hey! This pull request hasn't been updated for a while :/ It would be nice if we could get this going again!

jayvdb requested changes Apr 26, 2017

View changes

Show outdated Hide outdated .travis.yml

Show outdated Hide outdated bears/general/TextLintBear.py

Collaborator

gitmate-bot commented May 3, 2017

Hey! This pull request hasn't been updated for a while :/ It would be nice if we could get this going again!

Collaborator

gitmate-bot commented May 11, 2017

Hey! This pull request hasn't been updated for a while :/ It would be nice if we could get this going again!

Collaborator

gitmate-bot commented May 11, 2017

Hey! This pull request hasn't been updated for a while :/ It would be nice if we could get this going again!

Collaborator

gitmate-bot commented May 18, 2017

Hey! This pull request hasn't been updated for a while :/ It would be nice if we could get this going again!

Collaborator

gitmate-bot commented May 25, 2017

Hey! This pull request hasn't been updated for a while :/ It would be nice if we could get this going again!

Collaborator

gitmate-bot commented Jun 1, 2017

Hey! This pull request hasn't been updated for a while :/ It would be nice if we could get this going again!

Collaborator

gitmate-bot commented Jun 1, 2017

Hey! This pull request hasn't been updated for a while :/ It would be nice if we could get this going again!

Collaborator

gitmate-bot commented Jun 8, 2017

Hey! This pull request hasn't been updated for a while :/ It would be nice if we could get this going again!

yash-nisar changed the title from WIP bears/general: Add TextLintBear to bears/general: Add TextLintBear Jun 9, 2017

gitmate-bot reviewed Jun 9, 2017

View changes

Show outdated Hide outdated bears/general/TextLintBear.py

gitmate-bot added process/pending review and removed process/wip labels Jun 9, 2017

Makman2 reviewed Jun 9, 2017

View changes

Show outdated Hide outdated bears/general/TextLintBear.py

Makman2 reviewed Jun 9, 2017

View changes

Show outdated Hide outdated bears/general/TextLintBear.py

Makman2 reviewed Jun 14, 2017

View changes

Show outdated Hide outdated bears/general/TextLintBear.py

Makman2 reviewed Jun 14, 2017

View changes

Show outdated Hide outdated bears/general/TextLintBear.py

Makman2 reviewed Jun 14, 2017

View changes

Show outdated Hide outdated bears/general/TextLintBear.py

Makman2 reviewed Jun 14, 2017

View changes

Show outdated Hide outdated bears/general/TextLintBear.py

Makman2 reviewed Jun 14, 2017

View changes

Show outdated Hide outdated bears/general/TextLintBear.py

Makman2 reviewed Jun 14, 2017

View changes

Show outdated Hide outdated bears/general/TextLintBear.py

Makman2 reviewed Jun 14, 2017

View changes

Show outdated Hide outdated bears/general/TextLintBear.py

Makman2 reviewed Jun 14, 2017

View changes

Show outdated Hide outdated bears/general/TextLintBear.py

Member

yash-nisar commented Jun 15, 2017

Some changes that I think will be helpful :

Replacing check_offensive_expressions with check_with_alex as there are a couple of things that this rule can do apart form checking offensive expressions.
Note: We already have a bear and I did check if we can rename it with the corresponding setting.
Added a few extra rules for write_good just like https://github.com/coala/coala-bears/blob/master/bears/natural_language/WriteGoodLintBear.py#L36-L43 to give users more control.

Member

yash-nisar commented Jun 15, 2017

Some minor improvements done, @Makman2 your turn to review. 😉

Member

Makman2 commented Jun 15, 2017 •

edited

Replacing check_offensive_expressions with check_with_alex as there are a couple of things that this rule can do apart form checking offensive expressions.

Alright, though the name checking_offensive_expressions was so precise and I liked it :3 But yeah if it can check more than that, it doesn't help :)

Makman2 reviewed Jun 15, 2017

View changes

Show outdated Hide outdated bears/general/TextLintBear.py

Makman2 reviewed Jun 15, 2017

View changes

Show outdated Hide outdated bears/general/TextLintBear.py

Makman2 reviewed Jun 15, 2017

View changes

bears/general/TextLintBear.py

  
                    list of common misspellings.

                :param allow_passive_voice:

                    Allows passive voice.

                :param allow_so_beginning:

This comment has been minimized.

Show comment

Hide comment

Makman2 Jun 15, 2017

Member

setting rename:

allow_sentence_beginning_with_so

Makman2 Jun 15, 2017

Member

setting rename:

allow_sentence_beginning_with_so

yash-nisar Jun 16, 2017

Member

I've followed the standard used in https://github.com/coala/coala-bears/blob/master/bears/natural_language/WriteGoodLintBear.py#L37.

Maybe we should rename both the instances or keep this as it is ?

Makman2 Jun 17, 2017

Member

ah then keep it :)

Makman2 reviewed Jun 15, 2017

View changes

bears/general/TextLintBear.py

  
                    Allows passive voice.

                :param allow_so_beginning:

                    Allows ``So`` at the beginning of a sentence.

                :param allow_adverbs:

Makman2 Jun 15, 2017

Member

you should be more precise with that setting name, as completely removing adverbs in a text is going to make things hard :P

yash-nisar Jun 16, 2017

Member

I've followed the standard used in https://github.com/coala/coala-bears/blob/master/bears/natural_language/WriteGoodLintBear.py#L38

Maybe we should rename both the instances or keep this as it is ?

Makman2 Jun 17, 2017

Member

keep it then :)

Makman2 reviewed Jun 15, 2017

View changes

bears/general/TextLintBear.py

  
                    ``very``, ``extremely``, etc.

                :param allow_repeated_words:

                    Allows lexical illusions, i.e. cases where a word is repeated.

                :param allow_there_is:

Makman2 Jun 15, 2017

Member

maybe also call it allow_sentence_beginning_with_there_is? Not sure, as it's quite clear what's meant^^

yash-nisar Jun 16, 2017

Member

I've followed the standard used in https://github.com/coala/coala-bears/blob/master/bears/natural_language/WriteGoodLintBear.py#L40

Maybe we should rename both the instances or keep this as it is ?

Makman2 Jun 17, 2017

Member

same, let's keep :)

Makman2 reviewed Jun 15, 2017

View changes

Show outdated Hide outdated bears/general/TextLintBear.py

Member

yash-nisar commented Jun 16, 2017

Updated @Makman2

Makman2 reviewed Jun 17, 2017

View changes

bears/general/TextLintBear.py

  
        @linter(executable='textlint',

                output_format='regex',

                output_regex=r'(?P<line>\d+):(?P<column>\d+)(?:\s|\u2713)*'

Makman2 Jun 17, 2017 •

edited

Member

~~don't forget that we use raw-strings :D \u2713 will be rendered here as \u2713 actually and not ✓ :)~~

Makman2 Jun 17, 2017

Member

ah nvm, regex parses those \u escapes itself :D

Makman2 reviewed Jun 17, 2017

View changes

Show outdated Hide outdated bears/general/TextLintBear.py

Makman2 reviewed Jun 17, 2017

View changes

  
            "textlint-rule-period-in-list-item": "~0.2.0",

            "textlint-rule-rousseau": "~1.4.5",

            "textlint-rule-unexpanded-acronym": "~1.2.1",

            "textlint-rule-write-good": "~1.6.0",

Makman2 Jun 17, 2017

Member

just curious: Our package requirements don't support the ~ operator, right? (yet)
to indicate a rough version specification^^

yash-nisar Jun 17, 2017

Member

IIRC, nope. Maybe that is why we specify the exact version like NpmRequirement('textlint', '7.3.0')


      bears/general: Add TextLintBear

Closes #1576

d09c8f9

Member

Makman2 commented Jun 17, 2017

Makman2 added process/approved and removed process/pending review labels Jun 17, 2017

Member

Makman2 commented Jun 17, 2017

rultor commented Jun 17, 2017

@rultor merge

@Makman2 OK, I'll try to merge now. You can check the progress of the merge here

rultor merged commit `d09c8f9` into coala:master Jun 17, 2017
6 of 8 checks passed

6 of 8 checks passed

ci/circleci CircleCI is running your tests

Details

continuous-integration/travis-ci/push The Travis CI build is in progress

Details

codecov/project 100% (target 100%)

Details

continuous-integration/appveyor/pr AppVeyor build succeeded

Details

continuous-integration/travis-ci/pr The Travis CI build passed

Details

review/gitmate/commit No issues with this one - go ahead! :)

Details

review/gitmate/manual This commit was acknowledged.

Details

review/gitmate/pr All is well! :) (0 problems solved)

Details

rultor commented Jun 17, 2017

@rultor merge

@Makman2 Done! FYI, the full log is here (took me 2min)

yash-nisar deleted the yash-nisar:textlint-bear branch Jun 17, 2017

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.