Sort import packages by std lib first

src/goImport.ts

@@ -20,10 +20,19 @@ export async function listPackages(excludeImportedPkgs: boolean = false): Promis
 		? await getImports(vscode.window.activeTextEditor.document)
 		: [];
 	const pkgMap = await getImportablePackages(vscode.window.activeTextEditor.document.fileName, true);
-
-	return Array.from(pkgMap.keys())
-		.filter(pkg => !importedPkgs.some(imported => imported === pkg))
-		.sort();
+	const stdLibs: string[] = [];
+	const nonStdLibs: string[] = [];
+	pkgMap.forEach((value, key) => {
+		if (importedPkgs.some(imported => imported === key)) {
+			return;
+		}
+		if (value.isStd) {
+			stdLibs.push(key);
+		} else {
+			nonStdLibs.push(key);
+		}
+	});
+	return [...stdLibs.sort(), ...nonStdLibs.sort()];
 }
 
 /**
@@ -100,15 +109,15 @@ export function getTextEditForAddImport(arg: string): vscode.TextEdit[] {
 	}
 }
 
-export function addImport(arg: {importPath: string, from: string}) {
+export function addImport(arg: { importPath: string, from: string }) {
 	const p = (arg && arg.importPath) ? Promise.resolve(arg.importPath) : askUserForImport();
 	p.then(imp => {
 		/* __GDPR__
 		"addImportCmd" : {
 			"from" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" }
 		}
 		*/
-		sendTelemetryEvent('addImportCmd', { from: (arg && arg.from) || 'cmd'});
+		sendTelemetryEvent('addImportCmd', { from: (arg && arg.from) || 'cmd' });
 		const edits = getTextEditForAddImport(imp);
 		if (edits && edits.length > 0) {
 			const edit = new vscode.WorkspaceEdit();

src/goPackages.ts

@@ -10,12 +10,17 @@ import { promptForMissingTool, promptForUpdatingTool } from './goInstallTools';
 import { envPath, fixDriveCasingInWindows, getCurrentGoWorkspaceFromGOPATH } from './goPath';
 import { getBinPath, getCurrentGoPath, getGoVersion, getToolsEnvVars, isVendorSupported, sendTelemetryEvent } from './util';
 
-type GopkgsDone = (res: Map<string, string>) => void;
+type GopkgsDone = (res: Map<string, PackageInfo>) => void;
 interface Cache {
-	entry: Map<string, string>;
+	entry: Map<string, PackageInfo>;
 	lastHit: number;
 }
 
+export interface PackageInfo {
+	name: string;
+	isStd: boolean;
+}
+
 let gopkgsNotified: boolean = false;
 let cacheTimeout: number = 5000;
 
@@ -26,16 +31,16 @@ const allPkgsCache: Map<string, Cache> = new Map<string, Cache>();
 
 const pkgRootDirs = new Map<string, string>();
 
-function gopkgs(workDir?: string): Promise<Map<string, string>> {
+function gopkgs(workDir?: string): Promise<Map<string, PackageInfo>> {
 	const gopkgsBinPath = getBinPath('gopkgs');
 	if (!path.isAbsolute(gopkgsBinPath)) {
 		promptForMissingTool('gopkgs');
-		return Promise.resolve(new Map<string, string>());
+		return Promise.resolve(new Map<string, PackageInfo>());
 	}
 
 	const t0 = Date.now();
-	return new Promise<Map<string, string>>((resolve, reject) => {
-		const args = ['-format', '{{.Name}};{{.ImportPath}}'];
+	return new Promise<Map<string, PackageInfo>>((resolve, reject) => {
+		const args = ['-format', '{{.Name}};{{.ImportPath}};{{.Dir}}'];
 		if (workDir) {
 			args.push('-workDir', workDir);
 		}
@@ -48,7 +53,7 @@ function gopkgs(workDir?: string): Promise<Map<string, string>> {
 		cmd.stderr.on('data', d => errchunks.push(d));
 		cmd.on('error', e => err = e);
 		cmd.on('close', () => {
-			const pkgs = new Map<string, string>();
+			const pkgs = new Map<string, PackageInfo>();
 			if (err && err.code === 'ENOENT') {
 				return promptForMissingTool('gopkgs');
 			}
@@ -64,7 +69,7 @@ function gopkgs(workDir?: string): Promise<Map<string, string>> {
 				console.log(`Running gopkgs failed with "${errorMsg}"\nCheck if you can run \`gopkgs -format {{.Name}};{{.ImportPath}}\` in a terminal successfully.`);
 				return resolve(pkgs);
 			}
-
+			const goroot = process.env['GOROOT'];
 			const output = chunks.join('');
 			if (output.indexOf(';') === -1) {
 				// User might be using the old gopkgs tool, prompt to update
@@ -75,19 +80,23 @@ function gopkgs(workDir?: string): Promise<Map<string, string>> {
 					}
 					const index = pkgPath.lastIndexOf('/');
 					const pkgName = index === -1 ? pkgPath : pkgPath.substr(index + 1);
-					pkgs.set(pkgPath, pkgName);
+					pkgs.set(pkgPath, {
+						name: pkgName,
+						isStd: !pkgPath.includes('.')
+					});
 				});
 				return resolve(pkgs);
 			}
-
 			output.split('\n').forEach((pkgDetail) => {
 				if (!pkgDetail || !pkgDetail.trim() || pkgDetail.indexOf(';') === -1) {
 					return;
 				}
-				const [pkgName, pkgPath] = pkgDetail.trim().split(';');
-				pkgs.set(pkgPath, pkgName);
+				const [pkgName, pkgPath, pkgDir] = pkgDetail.trim().split(';');
+				pkgs.set(pkgPath, {
+					name: pkgName,
+					isStd: goroot === null ? false : pkgDir.startsWith(goroot)
+				});
 			});
-
 			const timeTaken = Date.now() - t0;
 			/* __GDPR__
 				"gopkgs" : {
@@ -102,10 +111,10 @@ function gopkgs(workDir?: string): Promise<Map<string, string>> {
 	});
 }
 
-function getAllPackagesNoCache(workDir: string): Promise<Map<string, string>> {
-	return new Promise<Map<string, string>>((resolve, reject) => {
+function getAllPackagesNoCache(workDir: string): Promise<Map<string, PackageInfo>> {
+	return new Promise<Map<string, PackageInfo>>((resolve, reject) => {
 		// Use subscription style to guard costly/long running invocation
-		const callback = function(pkgMap: Map<string, string>) {
+		const callback = function(pkgMap: Map<string, PackageInfo>) {
 			resolve(pkgMap);
 		};
 
@@ -134,7 +143,7 @@ function getAllPackagesNoCache(workDir: string): Promise<Map<string, string>> {
  * @argument workDir. The workspace directory of the project.
  * @returns Map<string, string> mapping between package import path and package name
  */
-export async function getAllPackages(workDir: string): Promise<Map<string, string>> {
+export async function getAllPackages(workDir: string): Promise<Map<string, PackageInfo>> {
 	const cache = allPkgsCache.get(workDir);
 	const useCache = cache && (new Date().getTime() - cache.lastHit) < cacheTimeout;
 	if (useCache) {
@@ -163,32 +172,32 @@ export async function getAllPackages(workDir: string): Promise<Map<string, strin
  * @param useCache. Force to use cache
  * @returns Map<string, string> mapping between package import path and package name
  */
-export function getImportablePackages(filePath: string, useCache: boolean = false): Promise<Map<string, string>> {
+export function getImportablePackages(filePath: string, useCache: boolean = false): Promise<Map<string, PackageInfo>> {
 	filePath = fixDriveCasingInWindows(filePath);
 	const fileDirPath = path.dirname(filePath);
 
 	let foundPkgRootDir = pkgRootDirs.get(fileDirPath);
 	const workDir = foundPkgRootDir || fileDirPath;
 	const cache = allPkgsCache.get(workDir);
 
-	const getAllPackagesPromise: Promise<Map<string, string>> = useCache && cache
+	const getAllPackagesPromise: Promise<Map<string, PackageInfo>> = useCache && cache
 		? Promise.race([getAllPackages(workDir), cache.entry])
 		: getAllPackages(workDir);
 
 	return Promise.all([isVendorSupported(), getAllPackagesPromise]).then(([vendorSupported, pkgs]) => {
-		const pkgMap = new Map<string, string>();
+		const pkgMap = new Map<string, PackageInfo>();
 		if (!pkgs) {
 			return pkgMap;
 		}
 
 		const currentWorkspace = getCurrentGoWorkspaceFromGOPATH(getCurrentGoPath(), fileDirPath);
-		pkgs.forEach((pkgName, pkgPath) => {
-			if (pkgName === 'main') {
+		pkgs.forEach((info, pkgPath) => {
+			if (info.name === 'main') {
 				return;
 			}
 
 			if (!vendorSupported || !currentWorkspace) {
-				pkgMap.set(pkgPath, pkgName);
+				pkgMap.set(pkgPath, info);
 				return;
 			}
 
@@ -208,7 +217,7 @@ export function getImportablePackages(filePath: string, useCache: boolean = fals
 
 			const allowToImport = isAllowToImportPackage(fileDirPath, currentWorkspace, relativePkgPath);
 			if (allowToImport) {
-				pkgMap.set(relativePkgPath, pkgName);
+				pkgMap.set(relativePkgPath, info);
 			}
 		});
 		return pkgMap;

src/goSuggest.ts

@@ -11,7 +11,7 @@ import cp = require('child_process');
 import { getTextEditForAddImport } from './goImport';
 import { promptForMissingTool, promptForUpdatingTool } from './goInstallTools';
 import { isModSupported } from './goModules';
-import { getImportablePackages } from './goPackages';
+import { getImportablePackages, PackageInfo } from './goPackages';
 import { getCurrentGoWorkspaceFromGOPATH } from './goPath';
 import { byteOffsetAt, getBinPath, getCurrentGoPath, getGoConfig, getParametersAndReturnType, getToolsEnvVars, goBuiltinTypes, goKeywords, guessPackageNameFromFile, isPositionInComment, isPositionInString, parseFilePrelude, runGodoc } from './util';
 
@@ -58,7 +58,7 @@ const exportedMemberRegex = /(const|func|type|var)(\s+\(.*\))?\s+([A-Z]\w*)/;
 const gocodeNoSupportForgbMsgKey = 'dontshowNoSupportForgb';
 
 export class GoCompletionItemProvider implements vscode.CompletionItemProvider, vscode.Disposable {
-	private pkgsList = new Map<string, string>();
+	private pkgsList = new Map<string, PackageInfo>();
 	private killMsgShown: boolean = false;
 	private setGocodeOptions: boolean = true;
 	private isGoMod: boolean = false;
@@ -467,8 +467,8 @@ export class GoCompletionItemProvider implements vscode.CompletionItemProvider,
 	 */
 	private getPackageImportPath(input: string): string[] {
 		const matchingPackages: any[] = [];
-		this.pkgsList.forEach((pkgName: string, pkgPath: string) => {
-			if (input === pkgName) {
+		this.pkgsList.forEach((info: PackageInfo, pkgPath: string) => {
+			if (input === info.name) {
 				matchingPackages.push(pkgPath);
 			}
 		});
@@ -528,15 +528,16 @@ function getKeywordCompletions(currentWord: string): vscode.CompletionItem[] {
  * @param allPkgMap Map of all available packages and their import paths
  * @param importedPackages List of imported packages. Used to prune imported packages out of available packages
  */
-function getPackageCompletions(document: vscode.TextDocument, currentWord: string, allPkgMap: Map<string, string>, importedPackages: string[] = []): vscode.CompletionItem[] {
+function getPackageCompletions(document: vscode.TextDocument, currentWord: string, allPkgMap: Map<string, PackageInfo>, importedPackages: string[] = []): vscode.CompletionItem[] {
 	const cwd = path.dirname(document.fileName);
 	const goWorkSpace = getCurrentGoWorkspaceFromGOPATH(getCurrentGoPath(), cwd);
 	const workSpaceFolder = vscode.workspace.getWorkspaceFolder(document.uri);
 	const currentPkgRootPath = (workSpaceFolder ? workSpaceFolder.uri.path : cwd).slice(goWorkSpace.length + 1);
 
 	const completionItems: any[] = [];
 
-	allPkgMap.forEach((pkgName: string, pkgPath: string) => {
+	allPkgMap.forEach((info: PackageInfo, pkgPath: string) => {
+		const pkgName = info.name;
 		if (pkgName.startsWith(currentWord) && importedPackages.indexOf(pkgName) === -1) {
 
 			const item = new vscode.CompletionItem(pkgName, vscode.CompletionItemKind.Keyword);

test/integration/extension.test.ts

@@ -552,7 +552,7 @@ It returns the number of bytes written and any write error encountered.
 
 		vendorSupportPromise.then(async (vendorSupport: boolean) => {
 			const gopkgsPromise = getAllPackages(workDir).then(pkgMap => {
-				const pkgs = Array.from(pkgMap.keys()).filter(p => pkgMap.get(p) !== 'main');
+				const pkgs = Array.from(pkgMap.keys()).filter(p => pkgMap.get(p).name !== 'main');
 				if (vendorSupport) {
 					vendorPkgsFullPath.forEach(pkg => {
 						assert.equal(pkgs.indexOf(pkg) > -1, true, `Package not found by goPkgs: ${pkg}`);