bears/general: Add TextLintBear #1597

yash-nisar · 2017-04-09T11:34:07Z

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 · 2017-04-09T11:35:18Z

bears/general/TextLintBear.py

+
+        default_config = {'rules': rules,
+                          "plugins": [
+                              "rst", "html"


You do not use the preferred quotation marks.

QuotesBear, severity NORMAL, section python.

The issue can be fixed by applying the following patch:

--- a/bears/general/TextLintBear.py +++ b/bears/general/TextLintBear.py @@ -88,7 +88,7 @@ default_config = {'rules': rules, "plugins": [ - "rst", "html" + "rst", 'html' ] } return json.dumps(default_config)

gitmate-bot · 2017-04-09T11:35:18Z

bears/general/TextLintBear.py

+
+        default_config = {'rules': rules,
+                          "plugins": [
+                              "rst", "html"


You do not use the preferred quotation marks.

QuotesBear, severity NORMAL, section python.

The issue can be fixed by applying the following patch:

--- a/bears/general/TextLintBear.py +++ b/bears/general/TextLintBear.py @@ -88,7 +88,7 @@ default_config = {'rules': rules, "plugins": [ - "rst", "html" + 'rst', "html" ] } return json.dumps(default_config)

gitmate-bot · 2017-04-09T11:35:19Z

bears/general/TextLintBear.py

+        }
+
+        default_config = {'rules': rules,
+                          "plugins": [


You do not use the preferred quotation marks.

QuotesBear, severity NORMAL, section python.

The issue can be fixed by applying the following patch:

--- a/bears/general/TextLintBear.py +++ b/bears/general/TextLintBear.py @@ -87,7 +87,7 @@ } default_config = {'rules': rules, - "plugins": [ + 'plugins': [ "rst", "html" ] }

jayvdb · 2017-04-09T11:53:50Z

tests/general/textlint_test_files/bad_write_good_common_misspellings.html

+Abreviate is a commonly misspelled word.
+So should be avoided at the beginning of a sentence.
+</body>
+</html>


jayvdb · 2017-04-09T11:53:50Z

bears/general/TextLintBear.py

+        }
+
+        rules['max-number-of-lines'] = {
+            'max': 300


we have a bear which does this; this bear should accept the same configuration setting name.

trailing comma so future additions dont need to modify this line.

jayvdb · 2017-04-09T11:53:50Z

bears/general/TextLintBear.py

+    @staticmethod
+    def generate_config(filename, file):
+        rules = {
+            'no-todo': True,


we have a bear which does this? If so, this bear should accept the same configuration setting name.

jayvdb · 2017-04-09T11:53:50Z

bears/general/TextLintBear.py

+            'date-weekday-mismatch': True,
+            'no-nfd': True,
+            'no-surrogate-pair': True,
+            'ginger': True


trailing comma so future additions dont need to modify this line. (and everywhere else)

jayvdb · 2017-04-09T11:53:50Z

bears/general/TextLintBear.py

+        rules['unexpanded-acronym'] = {
+            'min_acronym_len': 3,
+            'max_acronym_len': 5,
+            'ignore_acronyms': ['OSS']


we have a bear which does this? If so, this bear should accept the same configuration setting name.

jayvdb · 2017-04-09T11:53:50Z

bears/general/TextLintBear.py

+            'ignore': []
+        }
+
+        rules['write-good'] = {


isnt this a separate bear? again, this bear would need to match that bear settings.

jayvdb · 2017-04-09T11:53:50Z

bears/general/TextLintBear.py

+        rules['no-dead-link'] = {
+            'checkRelative': False,
+            'baseURI': None,
+            'ignore': []


we have a bear which does this? If so, this bear should accept the same configuration setting name.

yash-nisar · 2017-04-09T20:13:40Z

Aaaaannnddd the testsss passsss 🎉

gitmate-bot · 2017-04-16T23:46:38Z

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

gitmate-bot · 2017-04-23T22:27:08Z

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

jayvdb · 2017-04-26T08:43:10Z

.travis.yml

@@ -77,6 +77,7 @@ env:

 before_install:
  # Remove Ruby directive from Gemfile as this image has 2.2.5
+  - nvm install 6.10.2


the comment above about Ruby, relates to the line below about Ruby. And in the middle you've added Node ...

A very irresponsible act by me.

jayvdb · 2017-04-26T08:43:10Z

bears/general/TextLintBear.py

+                    NpmRequirement('textlint-rule-unexpanded-acronym',
+                                   '1.2.1'),
+                    NpmRequirement('textlint-rule-write-good', '1.6.0'),
+                    PipRequirement('docutils-ast-writer', '0.1.2')}


why do we need docutils-ast-writer?

Dependency for the rst plugin, https://github.com/jimo1001/textlint-plugin-rst#installation

Maybe we should comment on that above the PipRequirement?

gitmate-bot · 2017-05-03T15:47:31Z

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

gitmate-bot · 2017-05-11T07:43:47Z

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

gitmate-bot · 2017-05-11T07:43:48Z

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

gitmate-bot · 2017-05-18T06:23:43Z

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

gitmate-bot · 2017-05-25T05:04:02Z

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

gitmate-bot · 2017-06-01T03:43:30Z

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

gitmate-bot · 2017-06-01T03:43:30Z

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

gitmate-bot · 2017-06-08T02:24:15Z

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

Makman2 · 2017-06-14T23:34:08Z

bears/general/TextLintBear.py

+            # Header B
+
+            Text.
+            ```


ah RST syntax please :3 (already forgotten that this is not Markdown :P)

... there is an empty section ``#Header A`` below:: <-- double colons # Header A # Header B Text.

maybe you want to shorten the example by one line too:

# Header A # Header B Text.

up to you :)

Makman2 · 2017-06-14T23:35:36Z

bears/general/TextLintBear.py

+                        check_common_misspellings: bool=True,
+                        write_good: bool=True,
+                        check_relative_links: bool=False,
+                        base_uri: str='null',


what about leaving the default empty? Though it seems that textlint doesn't like this :3

Makman2 · 2017-06-14T23:38:43Z

bears/general/TextLintBear.py

+
+@linter(executable='textlint',
+        output_format='regex',
+        output_regex=r'(?P<line>\d+):(?P<column>\d+)[\s*|✓]*(?P<severity>'


[\s*|checkmark-character] --> (?:\s|checkmark-character)*

[] denotes a character class and is not the same as a group (). Also you don't need the quantifier behind \s if you define it for the group 👍

Works like a charm. 🎉

I tested the unicode manually to make sure that everything works (which is anyway proved above 😛 )

Makman2 · 2017-06-14T23:39:22Z

bears/general/TextLintBear.py

+
+@linter(executable='textlint',
+        output_format='regex',
+        output_regex=r'(?P<line>\d+):(?P<column>\d+)[\s*|✓]*(?P<severity>'


I know python supports unicode, though I wouldn't stress that support on different platforms. Is it possible to write the checkmark character as some kind of unicode-code? Like \x0030 or so?

Pasted this in the wrong comment box, should be pasted here.

yash-nisar · 2017-06-15T17:06:10Z

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.

yash-nisar · 2017-06-15T17:12:10Z

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

Makman2 · 2017-06-15T23:24:38Z

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 · 2017-06-15T23:27:34Z

bears/general/TextLintBear.py

+                     r'(?:  .*|\n|$)')
+class TextLintBear:
+    """
+    The pluggable linting tool for text and markdown. It is similar to


Hm Wikipedia writes markdown uppercase. Let's follow that convention :)

Makman2 · 2017-06-15T23:29:01Z

bears/general/TextLintBear.py

+class TextLintBear:
+    """
+    The pluggable linting tool for text and markdown. It is similar to
+    ESLint, but textlint for natural language.


"but textlint for natural language"? I mean you are just describing TextLint and referring to itself again? :)
Maybe just: It is similar to ESLint, but covers natural language (instead). (The "instead" is optional)

Hehe, didn't notice that. Sorry

Makman2 · 2017-06-15T23:38:23Z

bears/general/TextLintBear.py

+            list of common misspellings.
+        :param allow_passive_voice:
+            Allows passive voice.
+        :param allow_so_beginning:


setting rename:

allow_sentence_beginning_with_so

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 ?

ah then keep it :)

Makman2 · 2017-06-15T23:39:12Z

bears/general/TextLintBear.py

+            Allows passive voice.
+        :param allow_so_beginning:
+            Allows ``So`` at the beginning of a sentence.
+        :param allow_adverbs:


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

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 ?

keep it then :)

Makman2 · 2017-06-15T23:40:07Z

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:


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

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 ?

same, let's keep :)

Makman2 · 2017-06-15T23:41:51Z

bears/general/TextLintBear.py

+            Allows ``There is`` or ``There are`` at the beginning of a
+            sentence.
+        :param allow_ambiguous_words:
+            Allows ``weasel words`` for example ``often``, ``probably``.


-->

Allows "weasel words" like "often" or "probably".

I think we should use regular double quotes as those are words referring to standard prose. For me code-highlighting means it's referring to some kind of specific technical/informatics term^^

Or

Allows "weasel words", for example "often" or "probably".

I've used the same documentation as here. So, is it okay or do we need to change it ?

Let's change, I think we should also change it for WriteGoodLintBear (there's also missing a period actually^^)

Opening an issue in a while ;)

yash-nisar · 2017-06-16T06:23:35Z

Updated @Makman2

Makman2 · 2017-06-17T15:06:48Z

bears/general/TextLintBear.py

+
+@linter(executable='textlint',
+        output_format='regex',
+        output_regex=r'(?P<line>\d+):(?P<column>\d+)(?:\s|\u2713)*'


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

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

Makman2 · 2017-06-17T15:08:52Z

bears/general/TextLintBear.py

+class TextLintBear:
+    """
+    The pluggable linting tool for text and Markdown. It is similar to ESLint,
+    but covers natural language (instead).


either
but covers natural language.
or
but covers natural language instead.
Sorry I think I should have been more clear with that :P

Makman2 · 2017-06-17T15:12:31Z

package.json

+    "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",


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

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

Closes coala#1576

Makman2 · 2017-06-17T16:35:43Z

ack d09c8f9

Makman2 · 2017-06-17T16:35:55Z

@rultor merge

rultor · 2017-06-17T16:36:22Z

@rultor merge

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

rultor · 2017-06-17T16:38:04Z

@rultor merge

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

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

gitmate-bot reviewed Apr 9, 2017

View changes

yash-nisar force-pushed the textlint-bear branch from dc60d9d to 5a737c1 Compare April 9, 2017 11:37

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

jayvdb requested changes Apr 9, 2017

View changes

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

yash-nisar force-pushed the textlint-bear branch from 5a737c1 to 83ad753 Compare April 9, 2017 13:16

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

yash-nisar force-pushed the textlint-bear branch 3 times, most recently from 8e35a77 to b9842f1 Compare April 9, 2017 19:25

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

yash-nisar force-pushed the textlint-bear branch from b9842f1 to fe1b0c5 Compare April 9, 2017 19:53

jayvdb requested changes Apr 26, 2017

View changes

Makman2 reviewed Jun 14, 2017

View changes

yash-nisar force-pushed the textlint-bear branch from 8270a9d to 651a2ec Compare June 15, 2017 17:06

Makman2 reviewed Jun 15, 2017

View changes

yash-nisar force-pushed the textlint-bear branch from 651a2ec to 3556ed3 Compare June 16, 2017 06:18

Makman2 reviewed Jun 17, 2017

View changes

bears/general: Add TextLintBear

d09c8f9

Closes coala#1576

yash-nisar force-pushed the textlint-bear branch from 3556ed3 to d09c8f9 Compare June 17, 2017 16:09

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

rultor merged commit d09c8f9 into coala:master Jun 17, 2017

yash-nisar deleted the textlint-bear branch June 17, 2017 16:38

durandom mentioned this pull request Jun 18, 2020

Linting for documentation aicoe-aiops/data-science-workflows#7

Open

bears/general: Add TextLintBear #1597

bears/general: Add TextLintBear #1597

Conversation

yash-nisar commented Apr 9, 2017 • edited

Checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yash-nisar commented Apr 9, 2017

gitmate-bot commented Apr 16, 2017

gitmate-bot commented Apr 23, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gitmate-bot commented May 3, 2017

gitmate-bot commented May 11, 2017

gitmate-bot commented May 11, 2017

gitmate-bot commented May 18, 2017

gitmate-bot commented May 25, 2017

gitmate-bot commented Jun 1, 2017

gitmate-bot commented Jun 1, 2017

gitmate-bot commented Jun 8, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yash-nisar commented Jun 15, 2017

yash-nisar commented Jun 15, 2017

Makman2 commented Jun 15, 2017 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Makman2 Jun 15, 2017 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yash-nisar commented Jun 16, 2017

Makman2 Jun 17, 2017 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Makman2 commented Jun 17, 2017

Makman2 commented Jun 17, 2017

rultor commented Jun 17, 2017

rultor commented Jun 17, 2017

yash-nisar commented Apr 9, 2017 •

edited

Makman2 commented Jun 15, 2017 •

edited

Makman2 Jun 15, 2017 •

edited

Makman2 Jun 17, 2017 •

edited