Add TypeScript autoimport support for deoplete #2779

jeremija · 2019-09-20T04:33:35Z

This should add support for TypeScript autoimport in deoplete.

This also fixes a bug with the current ALE source for Deoplete since ALE limits the number of completions to g:ale_completion_max_suggestions (default 50). When window. is typed, there will be a lot more results than 50, so most will be filtered out. Because of this, when window.Syn is typed SyntaxError will not be shown. I've tried increasing the limit to a higher number, but then TypeScript completions become really slow (possibly because of completion entry details requests), so I've set the is_volatile = True variable to ALE source.

From deoplete docs:

is_volatile
		(Bool)				(Optional)
		If it is True, the source depends on the user input. It means
		that if this flag is set to False, deoplete will cache
		gather_candidates results and will not call gather_candidates
		on each input change. Only on_post_filter method will be
		called on each input change (if implemented).

		Default: False

It would be great if somebody actively using deoplete (and TypeScript) would be able to test this before merging!

w0rp · 2019-09-20T08:19:51Z

Thanks for this! I'll ask around on IRC to see if anyone wants to try this out.

cirias · 2019-09-20T09:24:14Z

You are awesome! Just tested and it worked for me!

thisjeremiah · 2019-09-20T17:32:16Z

I tested it and it worked when I removed self.is_volatile = True from the deoplete plugin code. If I kept the line, the autocomplete options wouldn't populate.

These are my deoplete settings:

Plug 'Shougo/deoplete.nvim'
let g:deoplete#enable_at_startup = 1
set completeopt-=preview
let g:deoplete#max_abbr_width = -1
let g:deoplete#max_menu_width = -1
let g:deoplete#ignore_sources = {}
let g:deoplete#ignore_sources._ = [
  \ 'tags', 'buffer', 'around', 'local',
  \ 'file', 'member', 'omni', 'link',
  \ 'LanguageClient'
\]
autocmd FileType * call deoplete#custom#option({
  \ 'auto_complete': v:true,
  \ 'auto_complete_delay': 0,
  \ 'smart_case': v:true,
  \ 'min_pattern_length': 1
\ })
autocmd FileType * call deoplete#custom#option('sources', {
\ '_': ['ale']
\})

Maybe it one of these settings that is causing the different behavior?

jeremija · 2019-09-21T04:11:39Z

Just tested your config and I am unable to reproduce this. Which version of deoplete are you running?

jeremija · 2019-09-21T07:47:50Z

@thisjeremiah I took another look at this, this time I ran it in a clean neovim environment in Docker:

call plug#begin('~/.config/nvim/plugged')
  Plug 'jeremija/ale', { 'branch': 'feature/autoimport-deoplete' }
  Plug 'Shougo/deoplete.nvim', { 'do': ':UpdateRemotePlugins' }
call plug#end()

augroup FiletypeGroup
    autocmd!
    au BufNewFile,BufRead *.ts set filetype=typescript
augroup END

let g:ale_completion_tsserver_autoimport = 1

let g:deoplete#enable_at_startup = 1
autocmd FileType * call deoplete#custom#option('sources', {
\ '_': ['ale']
\})

I added some echom statements for logging and it looks like deoplete keeps calling ale#completion#GetCompletions in an infinite loop wehn self.is_volatile is set to True (l:source is always set to deoplete). See this video for more information:

I've already noticed this before and commented about it here:

On a side note, I noticed that the ale#completion#GetCompletionResult function frequently gets called many, many (too many?) times from ale.py.

Shuogo, the author of Deoplete, does not recommend using the `is_async` option: > I think is_async is not recommended. It is not so useful and broken. > You should use callback system instead. Link: Shougo/deoplete.nvim#1006 (comment) Incidentally, the same thread mentiones an issue started by w0rp: Shougo/deoplete.nvim#976 The deoplete docs also say is_async is deprecated: > is_async (Bool) > If the gather is asynchronous, the source must set > it to "True". A typical strategy for an asynchronous > gather_candidates method to use this flag is to > set is_async flag to True while results are being > produced in the background (optionally, returning them > as they become ready). Once background processing > has completed, is_async flag should be set to False > indicating that this is the last portion of the > candidates. > > Note: The feature is deprecated and not recommended. > You should use callback system by > |deoplete#auto_complete()| instead. Link: https://github.com/Shougo/deoplete.nvim/blob/master/doc/deoplete.txt

jeremija · 2019-09-22T08:15:06Z

@thisjeremiah can you test now?

w0rp · 2019-09-22T10:36:19Z

How recently was the newer callback system added?

jeremija · 2019-09-22T10:59:54Z

It seems that a pretty recent change introduced problems for some people. See:

The is_async has been marked as deprecated 23 days ago according to git blame.

My latest commit message has some more details.

jeremija · 2019-09-22T11:08:14Z

Also relevant https://gitter.im/Shougo/deoplete.nvim?at=5d69f10438499c13a67411e0

w0rp · 2019-09-22T11:40:32Z

If it's a very recent change, then we should still support is_async for some time, as many people won't bother to update Deoplete for a while.

Maybe we can detect if the newer feature exists or not, and use one thing or the other.

jeremija · 2019-09-22T15:58:16Z

Yeah, it looks like the latest changes in this PR will work only since a very recent commit in Deoplete:

commit 782fdaf0671d3acc0d70920ed7ca521cfdd5578e
Date:   Thu Sep 19 21:12:30 2019 +0900

thisjeremiah · 2019-09-22T17:25:20Z

Yes, I updated deoplete and tested with your updated branch. It works for me now!

w0rp · 2019-09-30T09:13:15Z

Okay, I think some detection of the Deoplete version is needed, and maybe we can only enable support for autoimports in Deoplete if the Deoplete version is new enough.

jeremija · 2019-09-30T10:58:39Z

I agree, I'm just not sure what would be the best way to check for this, since the old autocomplete functionality is buggy in the current version of deoplete (is_async callbacks sometimes work, and sometimes do not because it calls gather_candidates in an endless loop of is_async and is_refresh events). It does not seem to matter if autoimport is enabled or not, but it has something to do with the is_volatile flag.

AFAIK, there is no way to retrieve Deoplete version from vim/python - the only place I found it was in doc/deoplete.txt.

If anybody has an idea on how to reliably check for the new feature (or the bug), I'd love to hear it!

w0rp · 2019-10-07T19:10:36Z

I think we can check exists('deoplete#auto_complete') in Vim, via the same mechanism for calling a command.

jeremija · 2019-10-07T19:16:28Z

I think we can check exists('deoplete#auto_complete') in Vim, via the same mechanism for calling a command.

Unfortunately, this function was in deoplete before Shougo/deoplete.nvim@782fdaf, which is the most recent commit that my fixes work with :/

w0rp · 2019-10-09T08:56:24Z

Maybe there's something else we can use to detect if Deoplete is new enough.

laino · 2019-11-22T03:25:24Z

Unfortunately, this function was in deoplete before Shougo/deoplete.nvim@782fdaf, which is the most recent commit that my fixes work with :/

Using deoplete at that version together with your branch gives me working auto-import functionality. It's really cool.

w0rp · 2020-01-01T18:55:46Z

At this point, I'll merge this, and if anyone has problems they can update Deoplete. The version which works with this is old enough now.

w0rp · 2020-01-01T19:00:49Z

Cheers! 🍻

* Add autoimport support for deoplete * Fix test_deoplete_source.py * Use callback instead of is_async for deoplete Shuogo, the author of Deoplete, does not recommend using the `is_async` option: > I think is_async is not recommended. It is not so useful and broken. > You should use callback system instead. Link: Shougo/deoplete.nvim#1006 (comment) Incidentally, the same thread mentiones an issue started by w0rp: Shougo/deoplete.nvim#976 The deoplete docs also say is_async is deprecated: > is_async (Bool) > If the gather is asynchronous, the source must set > it to "True". A typical strategy for an asynchronous > gather_candidates method to use this flag is to > set is_async flag to True while results are being > produced in the background (optionally, returning them > as they become ready). Once background processing > has completed, is_async flag should be set to False > indicating that this is the last portion of the > candidates. > > Note: The feature is deprecated and not recommended. > You should use callback system by > |deoplete#auto_complete()| instead. Link: https://github.com/Shougo/deoplete.nvim/blob/master/doc/deoplete.txt Co-authored-by: w0rp <w0rp@users.noreply.github.com>

jeremija added 2 commits September 20, 2019 10:48

Add autoimport support for deoplete

efae0b7

Fix test_deoplete_source.py

17df1c0

jeremija mentioned this pull request Sep 20, 2019

Add ALERename (tsserver & LSP), ALEOrganizeImports (tsserver) and auto import support (tsserver) #2709

Merged

jeremija force-pushed the feature/autoimport-deoplete branch from 4468b09 to 3dce8bf Compare September 22, 2019 07:12

jeremija force-pushed the feature/autoimport-deoplete branch from 3dce8bf to bdb7c74 Compare September 22, 2019 07:27

Merge branch 'master' into feature/autoimport-deoplete

ac90a51

w0rp approved these changes Jan 1, 2020

View reviewed changes

w0rp merged commit 0cb432c into dense-analysis:master Jan 1, 2020

w0rp mentioned this pull request Jan 1, 2020

Clean up excess whitespace in deoplete completion menu #2870

Closed

jeremija mentioned this pull request Jan 20, 2020

Add autoimport support for LSP linters #2976

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add TypeScript autoimport support for deoplete #2779

Add TypeScript autoimport support for deoplete #2779

jeremija commented Sep 20, 2019

w0rp commented Sep 20, 2019

cirias commented Sep 20, 2019

thisjeremiah commented Sep 20, 2019

jeremija commented Sep 21, 2019

jeremija commented Sep 21, 2019 •

edited

Loading

jeremija commented Sep 22, 2019

w0rp commented Sep 22, 2019

jeremija commented Sep 22, 2019 •

edited

Loading

jeremija commented Sep 22, 2019

w0rp commented Sep 22, 2019

jeremija commented Sep 22, 2019

thisjeremiah commented Sep 22, 2019

w0rp commented Sep 30, 2019

jeremija commented Sep 30, 2019

w0rp commented Oct 7, 2019

jeremija commented Oct 7, 2019

w0rp commented Oct 9, 2019

laino commented Nov 22, 2019 •

edited

Loading

w0rp commented Jan 1, 2020

w0rp commented Jan 1, 2020

Add TypeScript autoimport support for deoplete #2779

Add TypeScript autoimport support for deoplete #2779

Conversation

jeremija commented Sep 20, 2019

w0rp commented Sep 20, 2019

cirias commented Sep 20, 2019

thisjeremiah commented Sep 20, 2019

jeremija commented Sep 21, 2019

jeremija commented Sep 21, 2019 • edited Loading

jeremija commented Sep 22, 2019

w0rp commented Sep 22, 2019

jeremija commented Sep 22, 2019 • edited Loading

jeremija commented Sep 22, 2019

w0rp commented Sep 22, 2019

jeremija commented Sep 22, 2019

thisjeremiah commented Sep 22, 2019

w0rp commented Sep 30, 2019

jeremija commented Sep 30, 2019

w0rp commented Oct 7, 2019

jeremija commented Oct 7, 2019

w0rp commented Oct 9, 2019

laino commented Nov 22, 2019 • edited Loading

w0rp commented Jan 1, 2020

w0rp commented Jan 1, 2020

jeremija commented Sep 21, 2019 •

edited

Loading

jeremija commented Sep 22, 2019 •

edited

Loading

laino commented Nov 22, 2019 •

edited

Loading