Echo string format #76

KabbAmine · 2016-10-10T08:46:06Z

The implementation is done, so for example in a simple python file the following:

let g:ale_echo_msg_format = '[%linter%] [%severity%] %s'

will echo '[flake8] [Error] E302: expected 2 blank lines, found 1'

w0rp · 2016-10-10T08:53:29Z

ale_linters/javascript/eslint.vim

-        if len(marker_parts) == 2
-            let text = text . ' (' . marker_parts[1] . ')'
-        endif
+        let text = l:match[3] . ' (' . marker_parts[1] . ')'


I think the length here is sometimes 2, and sometimes 1, because you sometimes get something like Warning/comma-dangle and at other times just Error. I'd probably leave this part as it is.

w0rp · 2016-10-10T08:54:04Z

doc/ale.txt

 *ale*

-ALE - Asychronous Lint Engine
+ALE - Asynchronous Lint Engine


I totally missed that. Nice...

w0rp · 2016-10-10T08:54:47Z

doc/ale.txt

+  This variable defines the format of the echoed message. The `%s` is the
+  error message itself, and it can contain the following handlers:
+  - `%linter%` for linter's name
+  - `%severity%` for the type of severity


Could you add a paragraph here with an example string for setting it up how you like it? I suspect others will want the same thing.

Better to add it in the README.

Maybe. One thing I found really helpful when trying out vim-airline was that I could type :help some_variable, and the section would probably have some good suggestions on how to set the variables up. That was how I figured out how to get the triangular arrows to work.

Let it be a part of the future refactoring, add examples in the doc.

w0rp · 2016-10-10T08:56:15Z

plugin/ale/cursor.vim

+" Return a formatted message according to g:ale_echo_msg_format variable
+function! s:GetMessage(linter, type, text) abort
+    let msg = g:ale_echo_msg_format
+    let linter = a:linter


This assignment is redundant.

Are you talking about the comment?

You can use a:linter directly below.

Ah ok, the linter variable is there for debugging purpose and as usually I forgot to remove it.

w0rp · 2016-10-10T08:57:06Z

plugin/ale/cursor.vim

+function! s:GetMessage(linter, type, text) abort
+    let msg = g:ale_echo_msg_format
+    let linter = a:linter
+    let type = a:type ==# 'E' ? 'Error' : 'Warning'


I wonder if the severity strings should be configurable too. That might be handy for supporting other languages, or abbreviations, etc.

I don't really see the need. It may be helpful if you want some eye candy on the message, using some fancy unicode characters.

Japanese users may wish to display "でたらめ" instead of "Error" I suppose.

If that means Error, so maybe 😄 I'll add a commit for that then.

It's actually as near a translation of "bullshit" as I could find.

w0rp · 2016-10-10T08:57:33Z

plugin/ale/cursor.vim

@@ -81,7 +95,9 @@ function! ale#cursor#EchoCursorWarning(...)
    let index = s:BinarySearch(loclist, pos[1], pos[2])

    if index >= 0
-        call ale#cursor#TruncatedEcho(loclist[index]['text'])
+        let l = loclist[index]
+        let msg = s:GetMessage(l.linter_name, l.type, l.text)


I wonder if it might be easier to pass the whole loclist item to the function instead.

It is a good idea if we are planning to pass another variables in the future, but I cannot figure out what kind of variables.

Also even if its non noticeable, passing a big dictionnary may take some extra time for processing (a few milliseconds).

So as you wish, should I pass the whole loclist?

It takes more time? It will just be passing a reference to the dictionary.

You can leave it how it is. It's just an observation.

w0rp · 2016-10-10T08:58:01Z

Nice work on this. 👍 Check out my comments above.

Via `g:ale_echo_msg_format` where: - `%s` is the error message itself - `%linter%` is the linter name - `%severity` is the severity type e.g let g:ale_echo_msg_fomat = '[%linter%] [%severity%] %s'

KabbAmine · 2016-10-10T09:44:08Z

Check the last changes. The error and warning strings can now be defined.
The documentation files & linters will follow if you agree with my 2 last commits.

w0rp · 2016-10-10T10:14:01Z

plugin/ale/cursor.vim

+function! s:GetMessage(linter, type, text) abort
+    let msg = g:ale_echo_msg_format
+    let type = a:type ==# 'E' ? g:ale_echo_msg_error_str :
+    \   g:ale_echo_msg_warning_str


I only have a nitpick here. I'd write this instead.

let type = a:type ==# 'E' \ ? g:ale_echo_msg_error_str \ : g:ale_echo_msg_warning_str

I'm more a ...

let type = a:type ==# 'E' ? \ g:ale_echo_msg_error_str : \ g:ale_echo_msg_warning_str

... person 😃

w0rp · 2016-10-10T10:14:47Z

I added one nitpick above. Apart from that, it looks good to me. 👍

message `g:ale_echo_msg_error_str` and `g:ale_echo_msg_warning_str`

Now that the echoed message can be customized, no need to add the type to the text variable.

* Fix some typos * Sort the table of options alphabetically (except echo_msg_x_str options)

KabbAmine · 2016-10-10T10:54:45Z

Looks like I overwrite your changes by force pushing, but it should be good now.

KabbAmine · 2016-10-10T11:00:40Z

Oups, a small oversight just fixed now with da416bb

@w0rp Squash the last 2 commits when you'll merge the branch.

w0rp · 2016-10-10T11:53:33Z

doc/ale.txt

+  Default: `Warning`
+
+  The string used for warning severity in the echoed message.
+  Note |`g:ale_echo_cursor`| should be setted to 1


That should read "should be set". I'll merge this PR and change those phrases.

w0rp · 2016-10-10T11:54:17Z

I just squash merged this. Nice stuff. Cheers! 🍻

w0rp requested changes Oct 10, 2016

View reviewed changes

Implement an option to configure the echoed message, dense-analysis#48

50f14e9

Via `g:ale_echo_msg_format` where: - `%s` is the error message itself - `%linter%` is the linter name - `%severity` is the severity type e.g let g:ale_echo_msg_fomat = '[%linter%] [%severity%] %s'

KabbAmine force-pushed the echo-string-format branch from c82f52b to 0fc4132 Compare October 10, 2016 09:42

w0rp reviewed Oct 10, 2016

View reviewed changes

w0rp approved these changes Oct 10, 2016

View reviewed changes

KabbAmine added 3 commits October 10, 2016 13:49

Add new options for defining the string used for errors in echoed

9a5619e

message `g:ale_echo_msg_error_str` and `g:ale_echo_msg_warning_str`

Change text output of some linters

057f89b

Now that the echoed message can be customized, no need to add the type to the text variable.

Update README & documentation file

a56aae5

* Fix some typos * Sort the table of options alphabetically (except echo_msg_x_str options)

KabbAmine force-pushed the echo-string-format branch from 0fc4132 to a56aae5 Compare October 10, 2016 10:52

Added echo warning str option to the doc

da416bb

w0rp reviewed Oct 10, 2016

View reviewed changes

w0rp merged commit e4b3f57 into dense-analysis:echo-string-format Oct 10, 2016

KabbAmine deleted the echo-string-format branch October 10, 2016 12:16

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Echo string format #76

Echo string format #76

KabbAmine commented Oct 10, 2016

w0rp Oct 10, 2016

w0rp Oct 10, 2016

w0rp Oct 10, 2016

KabbAmine Oct 10, 2016 •

edited

Loading

w0rp Oct 10, 2016

KabbAmine Oct 10, 2016

w0rp Oct 10, 2016

KabbAmine Oct 10, 2016

w0rp Oct 10, 2016

KabbAmine Oct 10, 2016

w0rp Oct 10, 2016

KabbAmine Oct 10, 2016

w0rp Oct 10, 2016

KabbAmine Oct 10, 2016

w0rp Oct 10, 2016

w0rp Oct 10, 2016

KabbAmine Oct 10, 2016

w0rp Oct 10, 2016

w0rp commented Oct 10, 2016

KabbAmine commented Oct 10, 2016

w0rp Oct 10, 2016

KabbAmine Oct 10, 2016

w0rp commented Oct 10, 2016

KabbAmine commented Oct 10, 2016

KabbAmine commented Oct 10, 2016

w0rp Oct 10, 2016

w0rp commented Oct 10, 2016

Echo string format #76

Echo string format #76

Conversation

KabbAmine commented Oct 10, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

KabbAmine Oct 10, 2016 • edited Loading

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

w0rp commented Oct 10, 2016

KabbAmine commented Oct 10, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

w0rp commented Oct 10, 2016

KabbAmine commented Oct 10, 2016

KabbAmine commented Oct 10, 2016

Choose a reason for hiding this comment

w0rp commented Oct 10, 2016

KabbAmine Oct 10, 2016 •

edited

Loading