linter/markdown: adds support for languatool #2155

wahrwolf · 2018-12-21T05:38:37Z

As requested in #1516 and #2154, this will add support for the super awesome grammar/style checker languagetool

I provide this without any tests

Let me know if you have any feedback!

ale_linters/markdown/languagetool.vim

oblitum · 2018-12-21T05:54:23Z

The propaganda is so strong on those issues that I'm trying it now.

oblitum · 2018-12-21T06:27:51Z

Location list position for me seems off, using example from #1516. How did it go for you?

oblitum · 2018-12-21T06:29:51Z

Columns are right, lines are not.

oblitum · 2018-12-21T06:32:11Z

In fact, I used LanguageTool from https://github.com/rhysd/vim-grammarous and forgot it was LanguageTool based :D

wahrwolf · 2018-12-21T06:33:27Z

Can you give me an example file, so I can try to reproduce the issue?

oblitum · 2018-12-21T06:34:25Z

I've opened a markdown file with the contents of example in issue #1516: #1516 (comment)

oblitum · 2018-12-21T06:36:37Z

I get 8 errors, but ALE just highlighted the error on last line, all errors are in that line, which is wrong. Clicking on location list errors, it goes to the right column an error is, but doesn't jump to the affected line.

wahrwolf · 2018-12-21T06:39:11Z

Are you sure, that you inserted newline?
With my copy from the text I got no line breaks at all!

oblitum · 2018-12-21T06:40:06Z

Yes, I formatted with gqG.

wahrwolf · 2018-12-21T06:41:48Z

That is weird. I can reproduce the issue, but when I add newlines with s/\./.\r/g everything seems normal...

wahrwolf · 2018-12-21T06:52:15Z

This looks like an issues with languagetool. It reports issues in lines that are not even on the screen...

ale_linters/markdown/languagetool.vim

oblitum · 2018-12-21T07:02:12Z

> cat foo.md

Paste your own text here and click the 'Check Text' button. Click the colored
phrases for details on potential errors. or use this text too see an few of of
the problems that LanguageTool can detecd. What do you thinks of grammar
checkers?lease not that they are not perfect.Style issues get a blue marker:
It's 5.M. in the afternoon. LanguageTool 3.8 was released on Thursday, 27 June
2017.

> languagetool foo.md

1.) Line 2, column 42, Rule ID: UPPERCASE_SENTENCE_START
Message: This sentence does not start with an uppercase letter
Suggestion: Or
...red phrases for details on potential errors. or use this text too see an few of of the probl...
                                                ^^                                             

2.) Line 2, column 59, Rule ID: TOO_TO[1]
Message: Did you mean 'to see'?
Suggestion: to see
...etails on potential errors. or use this text too see an few of of the problems that LanguageTool ...
                                                ^^^^^^^                                             

3.) Line 2, column 67, Rule ID: EN_A_VS_AN
Message: Use 'a' instead of 'an' if the following word doesn't start with a vowel sound, e.g. 'a sentence', 'a university'
Suggestion: a
...n potential errors. or use this text too see an few of of the problems that LanguageTool can...
                                                ^^                                             

4.) Line 2, column 74, Rule ID: ENGLISH_WORD_REPEAT_RULE
Message: Possible typo: you repeated a word
Suggestion: of
...tial errors. or use this text too see an few of of the problems that LanguageTool can detecd. W...
                                                ^^^^^                                             

5.) Line 3, column 56, Rule ID: DO_VBZ[1]
Message: Consider using the base form 'think'.
Suggestion: think
...ms that LanguageTool can detecd. What do you thinks of grammar checkers?lease not that they are ...
                                                ^^^^^^                                             

6.) Line 3, column 56, Rule ID: NON3PRS_VERB[4]
Message: The pronoun 'you' must be used with a non-third-person form of a verb: 'think'
Suggestion: think
...ms that LanguageTool can detecd. What do you thinks of grammar checkers?lease not that they are ...
                                                ^^^^^^                                             

7.) Line 4, column 46, Rule ID: SENTENCE_WHITESPACE
Message: Add a space between sentences
Suggestion:  Style
...checkers?lease not that they are not perfect.Style issues get a blue marker: It's 5.M. in the a...
                                                ^^^^^                                             

8.) Line 5, column 8, Rule ID: SENTENCE_WHITESPACE
Message: Add a space between sentences
Suggestion:  M
...rfect.Style issues get a blue marker: It's 5.M. in the afternoon. LanguageTool 3.8 was rele...
                                                ^                                             

9.) Line 5, column 62, Rule ID: DATE_WEEKDAY[1]
Message: The date 27 June 2017 is not a Thursday, but a Tuesday.
... afternoon. LanguageTool 3.8 was released on Thursday, 27 June 2017. 
                                                ^^^^^^^^^^^^^^^^^^^^^^  
Time: 1713ms for 7 sentences (4.1 sentences/sec)

oblitum · 2018-12-21T07:04:26Z

Exactly, the --line-by-line parameter cause it to output strange lines, without it (see above) seems fine.

oblitum · 2018-12-21T07:08:16Z

Everything gets correctly highlighted without the parameter now removed from pull.

oblitum · 2018-12-21T07:09:50Z

I wished ALE linters were better at highlighting words... It just highlights first char in most.

skywind3000 · 2018-12-21T07:15:48Z

Because most compilers or linters only output a position instead of a text range ?

I am using https://github.com/rhysd/vim-grammarous for LanguageTool right now. It can highlight a range of chars.

wahrwolf · 2018-12-21T11:14:52Z

Okay I'll remove the param!

oblitum · 2018-12-21T13:05:32Z

It's a bit of extra work, but, the tool does highlight entire pieces of text while this addition just highlights a single char, so, could that be added? If not, I think it's to be born with an issue open on that.

Related: #2125

oblitum · 2018-12-21T13:08:16Z

Possibly just counting the amount of ^^^^^^ in the empty line and using it as the number of chars to highlight will do a good job. See result above.

oblitum · 2018-12-21T13:10:21Z

Because most compilers or linters only output a position instead of a text range ?

I think vim-grammarous simply cares to process what I requested above. See #2125.

wahrwolf · 2018-12-21T17:47:36Z

alright, should work just fine!

oblitum · 2018-12-21T17:51:40Z

I've never seen a commit stream with that many typos, are you fine @wahrwolf?

…ngle char

wahrwolf · 2018-12-21T18:03:21Z

I am currently working on stuff for my university and am little low on sleep ;)

w0rp

Looks pretty good to me. Add some tests for the linter command and executable, and for the new error handler. See :help ale-development.

Merry Christmas!

ale_linters/markdown/languagetool.vim

oblitum · 2019-01-25T02:53:22Z

bump.

skywind3000 · 2019-01-25T03:05:52Z

I have made linters for ALE too, everything worked fine. But it required tests and I encountered some vader (?? If I remember correctly) integration problems on my laptop, so I give up.

the corpse of my PR is still there:
#1571

The hardest part is not writing the linter, but using vader.

w0rp · 2019-01-27T15:59:39Z

See :help ale-development-linter-tests for information on adding the tests required for linter commands and executables.

wahrwolf · 2019-01-27T21:55:40Z

Oh i forgotten completly this Ticket... Going to fix it this week though. Ty for the reminder Am So., 27. Jan. 2019, 16:59 hat w0rp <[email protected]> geschrieben:

…

See :help ale-development-linter-tests for information on adding the tests required for linter commands and executables. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#2155 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/ALOQw_apwvkoKZXkMTHu141l0ESNQoCPks5vHczsgaJpZM4ZdZSm> .

nbiederbeck · 2019-02-01T12:47:20Z

let me write the handler for txt and mail too!

Is it possible (probably with more work) to use this with Latex files?

oblitum · 2019-02-02T23:55:22Z

I have made linters for ALE too, everything worked fine. But it required tests and I encountered some vader (?? If I remember correctly) integration problems on my laptop, so I give up.

the corpse of my PR is still there:
#1571

The hardest part is not writing the linter, but using vader.

Heh, I just wrote a very simple linter for Neo4j's Cypher, which is working by the way. I wished to contribute but the tests part of the process look quite annoying for someone not familiar with neither Vader nor the ALE specific test setup.

w0rp

Looks pretty good. List the tool as being supported in README.md and in doc/ale.txt.

autoload/ale/handlers/languagetool.vim

oblitum · 2019-03-08T02:08:43Z

bump 😴

skywind3000 · 2019-03-08T02:40:49Z

@wahrwolf , will you make this final move ??

wahrwolf · 2019-03-08T20:15:16Z

now on to it! (i have the night and some coffee ready to go ;D )

wahrwolf · 2019-03-08T23:34:58Z

@w0rp lets try this :D

w0rp · 2019-03-09T13:56:03Z

Cheers! 🍻

oblitum · 2019-03-09T19:47:18Z

🚨 🚨 🚨

Sadly this broke mail/markdown/text/etc when languagetool is present. On file write I get some java GUIs popping up due to --autoDetect not being recognized as a file, this happens when you run languangetool --autoDetect without a file parameter, this means the pull is not passing it, there's no %s in the command_callback.

oblitum · 2019-03-09T19:58:36Z

I think is the only issue, the missing %s.

ghost · 2019-03-09T22:15:22Z

Maybe the languagetool_executable should be set to something like this: java -jar /path/to/languagetool-commandline.jar?

oblitum · 2019-03-09T22:41:09Z

@fszymanski why? I see no reason for that.

oblitum · 2019-03-09T22:42:03Z

It's configurable. I think languagetool as default is expected.

skywind3000 · 2019-03-10T03:12:45Z

Cannot be used on Windows:

let ale_linters.markdown = ['languagetool']
let g:ale_languagetool_executable = 'd:/software/LanguageTool/LanguageTool-4.4/languagetool.cmd'

while languagetool.cmd is a batch file for launching languagetool-commandline.jar:

@ECHO off
set "INSTALLDIR=%~dp0"
java -jar "%INSTALLDIR%languagetool-commandline.jar" %*

I can see the java process hangs in the background, and ALEInfo returns:

The java process will never finish until I kill it manually, any clue for this ??

oblitum · 2019-03-10T03:17:34Z

As I mentioned previously, there's a bug even on Linux, the file is not being passed, there's a %s missing in the pull. This bug has nothing to do with the executable path.

diff --git a/autoload/ale/handlers/languagetool.vim b/autoload/ale/handlers/languagetool.vim
index aaad4c9..10e049d 100644
--- a/autoload/ale/handlers/languagetool.vim
+++ b/autoload/ale/handlers/languagetool.vim
@@ -10,7 +10,7 @@ endfunction
 function! ale#handlers#languagetool#GetCommand(buffer) abort
     let l:executable = ale#handlers#languagetool#GetExecutable(a:buffer)

-    return ale#Escape(l:executable) . ' --autoDetect '
+    return ale#Escape(l:executable) . ' --autoDetect %s'
 endfunction

 function! ale#handlers#languagetool#HandleOutput(buffer, lines) abort

wahrwolf · 2019-03-10T03:34:05Z

will this PR ever pass xD

@oblitum you are right though and I have no idea why I removed the %s...

oblitum · 2019-03-11T07:13:43Z

Added #2349 to fix this.

skywind3000 · 2019-03-11T07:28:19Z

@w0rp , please

linter/markdown: adds support for languatool

bed3d6b

oblitum reviewed Dec 21, 2018

View reviewed changes

ale_linters/markdown/languagetool.vim Outdated Show resolved Hide resolved

linter/markdown: fixes languagetools according to project linting rules

c501b9d

skywind3000 reviewed Dec 21, 2018

View reviewed changes

ale_linters/markdown/languagetool.vim Outdated Show resolved Hide resolved

linter/markdown: romeves param for langaugetool, due to weird behaviors

a5f0639

linters/languagetool: changes highlighting to mark area instead of si…

82e856c

…ngle char

w0rp requested changes Dec 25, 2018

View reviewed changes

ale_linters/markdown/languagetool.vim Outdated Show resolved Hide resolved

ale_linters/markdown/languagetool.vim Outdated Show resolved Hide resolved

w0rp requested changes Feb 10, 2019

View reviewed changes

autoload/ale/handlers/languagetool.vim Outdated Show resolved Hide resolved

Vincent Dahmen added 2 commits March 8, 2019 23:43

handlers/languagetool: adapts new lint check style

b7161cd

test/command_callback: adds checks for languagetool

b4e968c

handlers/languagetool: adds wrapper functio get dyn path

4f88cfe

w0rp approved these changes Mar 9, 2019

View reviewed changes

w0rp merged commit 7eae06d into dense-analysis:master Mar 9, 2019

wahrwolf deleted the markdown/languagetool branch March 9, 2019 14:56

WojciechRydel mentioned this pull request Jul 8, 2020

AsciiDoc LanguageTool #3220

Closed

hsanson mentioned this pull request Oct 4, 2020

Disable LanguageTool for Markdown #3379

Open

linter/markdown: adds support for languatool #2155

linter/markdown: adds support for languatool #2155

Conversation

wahrwolf commented Dec 21, 2018

oblitum commented Dec 21, 2018

oblitum commented Dec 21, 2018 • edited Loading

oblitum commented Dec 21, 2018

oblitum commented Dec 21, 2018

wahrwolf commented Dec 21, 2018

oblitum commented Dec 21, 2018

oblitum commented Dec 21, 2018 • edited Loading

wahrwolf commented Dec 21, 2018

oblitum commented Dec 21, 2018 • edited Loading

wahrwolf commented Dec 21, 2018

wahrwolf commented Dec 21, 2018

oblitum commented Dec 21, 2018

oblitum commented Dec 21, 2018 • edited Loading

oblitum commented Dec 21, 2018

oblitum commented Dec 21, 2018 • edited Loading

skywind3000 commented Dec 21, 2018 • edited Loading

wahrwolf commented Dec 21, 2018

oblitum commented Dec 21, 2018

oblitum commented Dec 21, 2018 • edited Loading

oblitum commented Dec 21, 2018

wahrwolf commented Dec 21, 2018

oblitum commented Dec 21, 2018

wahrwolf commented Dec 21, 2018

w0rp left a comment

Choose a reason for hiding this comment

oblitum commented Jan 25, 2019

skywind3000 commented Jan 25, 2019 • edited Loading

w0rp commented Jan 27, 2019

wahrwolf commented Jan 27, 2019 via email

nbiederbeck commented Feb 1, 2019

oblitum commented Feb 2, 2019

w0rp left a comment

Choose a reason for hiding this comment

oblitum commented Mar 8, 2019

skywind3000 commented Mar 8, 2019

wahrwolf commented Mar 8, 2019 via email

wahrwolf commented Mar 8, 2019

w0rp commented Mar 9, 2019

oblitum commented Mar 9, 2019 • edited Loading

oblitum commented Mar 9, 2019

ghost commented Mar 9, 2019

oblitum commented Mar 9, 2019

oblitum commented Mar 9, 2019

skywind3000 commented Mar 10, 2019 • edited Loading

oblitum commented Mar 10, 2019

wahrwolf commented Mar 10, 2019

oblitum commented Mar 11, 2019

skywind3000 commented Mar 11, 2019

oblitum commented Dec 21, 2018 •

edited

Loading

oblitum commented Dec 21, 2018 •

edited

Loading

oblitum commented Dec 21, 2018 •

edited

Loading

oblitum commented Dec 21, 2018 •

edited

Loading

oblitum commented Dec 21, 2018 •

edited

Loading

skywind3000 commented Dec 21, 2018 •

edited

Loading

oblitum commented Dec 21, 2018 •

edited

Loading

skywind3000 commented Jan 25, 2019 •

edited

Loading

oblitum commented Mar 9, 2019 •

edited

Loading

skywind3000 commented Mar 10, 2019 •

edited

Loading