Add completion items for unimported packages by ramya-rao-a · Pull Request #497 · microsoft/vscode-go

ramya-rao-a · 2016-09-22T01:50:55Z

This PR adds 2 features

Auto-complete for package names that are not imported. Example:
Assume you haven't imported fmt, type f, the auto-complete will give fmt as an option. Choose this option, the word will get completed and an import to fmt will be added to your go file
Auto-complete for methods from packages that are not yet imported. Example:
Assume you haven't imported math, type math., the auto-complete will give all methods from math package as options. Choose any, the word gets completed and an import to math will be added to your go file

Set go.autocomplteUnimportedPackages to true to enable these features.

These features depend on updates to the CompletionItem API in VS Code 1.5

ramya-rao-a · 2016-09-25T00:45:29Z

src/goSuggest.ts

+			return pkgInfo.name.startsWith(word);
+		}).map((pkgInfo: PackageInfo) => {
+			let item = new vscode.CompletionItem(pkgInfo.name, vscode.CompletionItemKind.Keyword);
+			item.detail = 'Add import';


I needed a place to suggest that choosing this completion item would add an import and so added the item.detail. But I guess we don't really need it

I think this is going to need to include the pull import path name as additional context. I think being clear that this will "Add an import" is also helpful.

lukehoban · 2016-09-28T20:47:36Z

Just trying this out - experience is overall really nice!

One thing I noticed, if you have "go.useCodeSnippetsOnFunctionSuggest": true, then the snippet generated when you complete a method call off of a package - like bytes.Contains don't cycle correctly with tab is the use of bytes trigged an import.

lukehoban · 2016-09-28T20:51:03Z

Looks like you can get into cases where the completion list contains several copies of the same entry - referring to each of the fully-qualified but unique packages whose last sub-package is the selected name, as well as to the already imported name.

The latter is actually a bigger problem - if I already have imported the name, I now see it twice, once based on the actual name in scope and once as a suggestion for an Add Import.

The former case may require that you include the full package name in the description text.

I think both of these will be important to fix - at least before making this the default experience.

lukehoban

A few notes from a quick pass.

lukehoban · 2016-09-28T20:56:02Z

src/goSuggest.ts

 	private ensureGoCodeConfigured(): Thenable<void> {
-		return new Promise<void>((resolve, reject) => {
+		let pkgPromise = listPackages().then((pkgs: string[]) => {
+this.pkgsList = pkgs.map(pkg => {


Is it okay for this to be fixed at startup time, not up to date as new packages are installed into the GOPATH?

I didnt want to run listPackages for every autocomplete operation and so added this basic placeholder for an actual caching mechanism. Plan was to see if users notice the missing packages and if they do, if a reload window is not too much of a hassle

lukehoban · 2016-09-28T20:56:55Z

src/goSuggest.ts

+			return pkgInfo.name.startsWith(word);
+		}).map((pkgInfo: PackageInfo) => {
+			let item = new vscode.CompletionItem(pkgInfo.name, vscode.CompletionItemKind.Keyword);
+			item.detail = 'Add import';


I think this is going to need to include the pull import path name as additional context. I think being clear that this will "Add an import" is also helpful.

lukehoban · 2016-09-28T21:00:50Z

src/goSuggest.ts

+		// There could be multiple words in the line
+		// we are interested in the last one
+		let wordmatches = null;
+		let pattern = /(\w+)/g;


Is this a correct regexp for Go identifies that could be packages?

Also - to avoid the while loop - can't you bind it to match at the end of the line? In fact, can't you avoid most of this logic by just using the regexp to match the .$ at the end of the line that you are sure is there?

Updated to use /(\w+)\.$/g and removed the while loop

ramya-rao-a · 2016-09-29T00:25:14Z

Reagrding #497 (comment)
This is why I had logged #494. If listPackages() does not return already imported packages, then autocomplete need not have to worry about them.

I'll send out another PR for this separately

ramya-rao-a · 2016-09-29T02:55:58Z

Regarding #497 (comment)

Using additionalTextEdits instead of command in the CompletionItem ensures that useCodeSnippetsOnFunctionSuggest feature is not broken

lukehoban

Experience is much improved with the fully-qualified package name in the completion list.

I do wonder if the lack of vendor packages in the listPackages list will be more noticeable with this feature.

I've tried this out in a few projects and I haven't seen any problems. So I think we could go ahead and merge once your happy with the changes.

It's quite a visible change, so it'll be interesting to get feedback - if there's any way to do that in advance of a new release would be great to get some users trying this out.

lukehoban · 2016-09-29T04:41:28Z

src/goImport.ts

-				editBuilder.insert(new vscode.Position(lastSingleImport + 1, 0), 'import "' + imp + '"\n');
+		let edit = getTextEditForAddImport(imp);
+		if (edit) {
+			vscode.window.activeTextEditor.edit(editBuilder => {


May not matter right now - but probably good to return the promise here so it get's chained into the .then.

lukehoban · 2016-09-29T04:44:26Z

src/goImport.ts

 	});
 }

+export function getTextEditForAddImport(arg: string): vscode.TextEdit {


arg should be importPackageName?

lukehoban · 2016-09-29T04:45:01Z

src/goImport.ts

 		}
 	});
-}
+}


No need to remove final newlines.

ramya-rao-a · 2016-10-02T02:05:25Z

@lukehoban

I do wonder if the lack of vendor packages in the listPackages list will be more noticeable with this feature.

Vendor packages do get returned by listPackages(). What are you referring to here?

It's quite a visible change, so it'll be interesting to get feedback - if there's any way to do that in advance of a new release would be great to get some users trying this out.

I can add a setting to enable this feature, have it off by default, get feedback from users who specifically asked for this feature and anyone else you have in mind. Then, in the next release we make it a default feature.

If I already have imported the name, I now see it twice, once based on the actual name in scope and once as a suggestion for an Add Import.

#508 and lukehoban/go-outline#4 should take care of this. Can you take a look?

…ature continues to work

ramya-rao-a · 2016-10-06T23:47:31Z

@lukehoban
A Setting go.autocomplteUnimportedPackages has been added. Its false by default. This will control the Autocomplete Unimported Packages feature

#508 has been merged, so no more double entries for the same package

msftclas added the cla-not-required label Sep 22, 2016

ramya-rao-a commented Sep 25, 2016

View reviewed changes

lukehoban reviewed Sep 28, 2016

View reviewed changes

lukehoban approved these changes Sep 29, 2016

View reviewed changes

ramya-rao-a added 6 commits October 6, 2016 11:43

Add completion items for unimported packages

0509883

Fix lint errors

5ae0d10

Use better regex, add pkg path to suggestion doc

1e10347

Use additionalTextEdits so that 'useCodeSnippetsOnFunctionSuggest' fe…

5d6e3d6

…ature continues to work

Apply edit only if edit exists

7b7ac12

Add setting autocomplteUnimportedPackages, dont show imported pkgs

e9d86d6

ramya-rao-a force-pushed the unimported-intellisense branch from 100d889 to e9d86d6 Compare October 6, 2016 22:22

ramya-rao-a merged commit b780d41 into microsoft:master Oct 6, 2016

ramya-rao-a deleted the unimported-intellisense branch January 22, 2017 07:58

               		}
               	});
-              }
+              }

                
                    No newline at end of file

Conversation

ramya-rao-a commented Sep 22, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ramya-rao-a Sep 25, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lukehoban commented Sep 28, 2016

Uh oh!

lukehoban commented Sep 28, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

lukehoban left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ramya-rao-a commented Sep 29, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ramya-rao-a commented Sep 29, 2016

Uh oh!

lukehoban left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ramya-rao-a commented Oct 2, 2016

Uh oh!

ramya-rao-a commented Oct 6, 2016

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

ramya-rao-a commented Sep 22, 2016 •

edited

Loading

ramya-rao-a Sep 25, 2016 •

edited

Loading

lukehoban commented Sep 28, 2016 •

edited

Loading

ramya-rao-a commented Sep 29, 2016 •

edited

Loading