import all and import current without organize

[academo]

Hello everyone,

I work in a big project and usually edit files that already contain many imports.

Import all missing and import current are great tools that I use all the time but they force a sort of the imports that doesn't benefit me as it will create changes in the file that were not intended. Suddenly a couple line change turn into a dozen changes because the imports get shuffle.

Is there a way to import all and import current without sorting the existing import? I checked the readme and options but I didn't see an option.

Thanks in advance.

[jose-elias-alvarez]

There's no way to do this currently. We could add support, either via a config option or using the Lua API, but the reason it's not currently supported is that the import all function is pretty dumb. If you add multiple missing imports from the same file, they'll each get a separate import statement:

// starting point
const user: User = { name: "Jose" };
const role: Role = "manager";

// current behavior after importing all
import { Role, User } from "types/user.types";

const user: User = { name: "Jose" };
const role: Role = "manager";

// behavior without sorting imports after importing all
import { User } from "types/user.types";

import { Role } from "types/user.types";

const user: User = { name: "Jose" };
const role: Role = "manager";

This is pretty annoying, since (to my knowledge) there's no way to automatically merge these statements without running an organizeImports action, which (again, as far as I know) can only be applied to the whole file. If that's okay with you, I guess we could add this as an option.

[academo]

@jose-elias-alvarez maybe for import current only? not for import all? would that be viable?
if you show me where the code is I can take a look, see if I can make something.

[jose-elias-alvarez]

It's definitely viable. You can see here that import_current is just a simple wrapper around import_all.

Currently, import_current adds all missing imports on the current line, so it'll run into the same issue with unmerged imports. If we're going to make this change, I think it would also make sense for import_current to limit itself to one diagnostic under the cursor (which probably aligns with user expectations, too). Let me know if you're up for it.

[academo]

@jose-elias-alvarez exactly. import_current would need to have a separate implementation from import_all in that case. I'll take a look, though expect slow progress as my lua, neovim and lsp API knowledge is limited.

[academo]

I am finally having some time to take a look at this. I am not much optimistic but I'll give it a try.

[academo]

@jose-elias-alvarez I made a proof of concept PR #102 Please let me know your comments and what I am missing.

Notice that I went for an alternative to your suggested solution of only apply 1 code action at the time. I could also do it that way but I want to explore this solution first.

[yioneko]

Well, recently typescript-language-server added support for it: typescript-language-server/typescript-language-server#318, but not supported yet in this plugin: #100. I think source.addMissingImports.ts is what you needed.

[jose-elias-alvarez]

Yes, I need to learn more about source actions to see how / if we can run them in Neovim, though as I mentioned in #99, our implementation has a few advantages over the raw actions.