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

[jeremija]

Related to #1519

ALERename [new_name]

Tested for tsserver, and should work for any LSP that has rename capability, but I currently do not have a LSP project to test it on. Currently only supports renaming of symbols (no file rename).

ALEOrganizeImports

Works with tsserver and will organize all import statements when called.

Auto Imports

Currently works with tsserver. The ts@completions message now includes the parameter: includeExternalModuleExports. If an external completion is returned, the necessary code actions will be stored in the user_data variable of the completion item.

To support both ale-manual and ale-automatic completion triggers, a new augroup ALECompletionActions has been added.

This functionality can be disabled by setting g:ale_completion_tsserver_autoimport to 0.

---

A new function was added for handling code actions: ale#code_action#HandleCodeAction. I've tested this extensively on a TypeScript project. I would appreciate feedback, especially on the implementation of this function. There might be a better way to edit the buffer without resorting to visual mode.

[w0rp]

Nice work! 👍 I've got a long list of emails to get through, and I'll take a look when I can.

[w0rp]

Great work! This kind of thing is difficult to manage. See my suggestions here. I have some of my own code for this kind of stuff already which you can use, plus some stuff to come later, when I finally have the time.

[w0rp]

Try removing json_encode here and json_decode below. I think you can store Dictionary values too.

[jeremija]

I thought so too, but I get E731: using Dictionary as a String when I remove the json_encode/json_decode functions :(

[w0rp]

Instead of supporting an optional argument for a new name in the command, always require the new name to be input with input() and the current name. Then you always know exactly what name ALE is going to try and rename, and it's easy to adjust the current name to something slightly different. See here: ca2026b#diff-c8e42b11378165eaf5fb1be0e53860e6R90

[jeremija]

I implemented this change but since feedkeys() doesn't work for input prompt, I added a new util method ale#util#Input(message, value) and mocked that method in the test. Let me know if this works!

[w0rp]

Thank you very much for working on this, and sorry for the delay. This is great work. When I finally get the time, I'll build on this later by finishing my work on showing code actions in menus, including the popup menu.

[w0rp]

Let's get people to try this out for a while, and we can fix any bugs people find later. Cheers! 🍻

[jeremija]

Thanks for your guidance and thank you for merging! 🍺

[cirias]

Nice work! But I found autoimport doesn't work when I use deoplete. Is it possible to support that?

[jeremija]

Hi @cirias, I do not use deoplete so I can't test this. Could you try to add a check for deoplete completion source on this line:

ale/autoload/ale/completion.vim

Line 721 in 61cfb3f

if l:source isnot# 'ale-automatic' && l:source isnot# 'ale-manual'

it should look like:

    if l:source isnot# 'ale-automatic' && l:source isnot# 'ale-manual' && l:source isnot# 'deoplete'

Let me know if this works!

[cirias]

I tried. But it still doesn't work. Also I found the problem is, when g:ale_completion_enabled is 0, it doesn't list any external symbols as candidates. As long as let g:ale_completion_enabled = 1, it works correct. Hope that helps you debug

[jeremija]

Perhaps we should move this conversation to a new issue. I just installed and configured deoplete to use ale and I believe I was able to reproduce the issue.

Can you confirm that the same happens to you:

a) deoplete is configured to use ale
b) external symbols show up the first time I enter insert mode and start typing. auto import works for external symbols listed if I add the change from my comment above
c) external symbols stop showing up the next time I enter insert mode

edit I believe the reason I'm experiencing this is because Deoplete caches completion results, and ale reduces the number of completion results to 50. When a user types S in a Typescript file, there will many completion results. Values such as SyntaxError (global) and SyntaxKind (from typescript) will be filtered out, given to Deoplete, and Deoplete will cache them, so when Syn is typed, neither will be shown.

I was able to resolve this by setting self.is_volatile = True in the Base.__init__ in rplugin/python/deoplete/sources/ale.py file.

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

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

[w0rp]

Importing external symbols isn't currently designed to work with Deoplete. That will require some additional work. Open an issue for that.

[thisjeremiah]

Excited that this feature could replace our usage of nvim-typescript!

I have noticed that the autoimport feature does not work when autocomplete is manually executed via <c-o><c-x>. Is that the intended behavior?

[jeremija]

@thisjeremiah What configuration are you using to trigger completion via <c-o><c-x>?

This is my configuration for <C-Space> and it works for me:

imap <C-Space> <Plug>(ale_complete)

[thisjeremiah]

I've actually just been using completion via <enter> or <esc>, which successfully fills out the term selected in the popup menu, but the autoimport does not execute.

I set up your mapping and it worked, probably because it is calling ale_complete directly. I'll probably use that for now. Thanks!

In general, I'm trying to reduce the steps needed to autoimport an already written term. The :TSImport command from nvim-typescript had a few less steps since that command could be run from normal mode with the term selected, whereas this command has to run in insert mode and manually execute ale_complete.

[heyrict]

Glad that ale is on the road to support CodeAction! I used to depend heavily on YCM's FixIt command when developing typescript projects and this will finally remove YCM from my YCM + ALE stack!

One thing (though not bug) I found inconvenient is that, You don't know which file the symbol you are importing from. e.g. When I want to import compose from react-redux, it shows compose from several other packages which are hard to differenciate.

[w0rp]

If anyone knows enough about Deoplete to make it work, please create a pull request.

I plan on adding code action support with Vim menus later, when I finally have the time. I have some experimental code for that in a branch.

I did notice one error with renaming in other files I saw once, but I haven't been able to repeat it since.

[jeremija]

I believe I found a fix for Deoplete, see #2779. @cirias can you test this?

[jeremija]

@heyrict The autoimport description should now be visible on master since 7b38e97 commit. See #2780 for more details.