-
Notifications
You must be signed in to change notification settings - Fork 446
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Support to manually select Maven pom files to import
- A new setting `java.import.configurationFileCollectionMode` is added to configure whether manually build file selection is required before import. - A new contribution point `javaBuildTypes` is introduced, and will be used when the build files need to be manually selected. Signed-off-by: Sheng Chen <[email protected]>
- Loading branch information
Showing
10 changed files
with
370 additions
and
22 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,214 @@ | ||
| import { ExtensionContext, MessageItem, QuickPickItem, QuickPickItemKind, Uri, WorkspaceFolder, extensions, window, workspace } from "vscode"; | ||
| import { getExclusionGlob as getExclusionGlobPattern } from "./utils"; | ||
| import * as path from "path"; | ||
|
|
||
| export const PICKED_BUILD_FILES = "java.pickedBuildFiles"; | ||
| export class BuildFileSelector { | ||
| private buildTypes: IBuildType[] = []; | ||
| private context: ExtensionContext; | ||
| private exclusionGlobPattern: string; | ||
|
|
||
| constructor(context: ExtensionContext) { | ||
| this.context = context; | ||
| // TODO: should we introduce the exclusion globs into the contribution point? | ||
| this.exclusionGlobPattern = getExclusionGlobPattern(["**/target/**", "**/bin/**", "**/build/**"]); | ||
| for (const extension of extensions.all) { | ||
| const javaBuildTypes: IBuildType[] = extension.packageJSON.contributes?.javaBuildTypes; | ||
| if (!Array.isArray(javaBuildTypes)) { | ||
| continue; | ||
| } | ||
|
|
||
| for (const buildType of javaBuildTypes) { | ||
| if (!this.isValidBuildTypeConfiguration(buildType)) { | ||
| continue; | ||
| } | ||
|
|
||
| if (buildType.controlledBy && !workspace.getConfiguration().get(buildType.controlledBy)) { | ||
| continue; | ||
| } | ||
|
|
||
| this.buildTypes.push(buildType); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * @returns `true` if there are build files in the workspace, `false` otherwise. | ||
| */ | ||
| public async hasBuildFiles(): Promise<boolean> { | ||
| for (const buildType of this.buildTypes) { | ||
| const uris: Uri[] = await workspace.findFiles(buildType.fileSearchPattern, this.exclusionGlobPattern, 1); | ||
| if (uris.length > 0) { | ||
| return true; | ||
| } | ||
| } | ||
| return false; | ||
| } | ||
|
|
||
| /** | ||
| * Get the uri strings for the build files that the user selected. | ||
| * @returns An array of uri string for the build files that the user selected. | ||
| * An empty array means user canceled the selection. | ||
| */ | ||
| public async getBuildFiles(): Promise<string[] | undefined> { | ||
| const cache = this.context.workspaceState.get<string[]>(PICKED_BUILD_FILES); | ||
| if (cache !== undefined) { | ||
| return cache; | ||
| } | ||
|
|
||
| const choice = await this.chooseBuildFilePickers(); | ||
| const pickedUris = await this.eliminateBuildToolConflict(choice); | ||
| if (pickedUris.length > 0) { | ||
| this.context.workspaceState.update(PICKED_BUILD_FILES, pickedUris); | ||
| } | ||
| return pickedUris; | ||
| } | ||
|
|
||
| private isValidBuildTypeConfiguration(buildType: IBuildType): boolean { | ||
| return !!buildType.displayName && !!buildType.fileSearchPattern; | ||
| } | ||
|
|
||
| private async chooseBuildFilePickers(): Promise<IBuildFilePicker[]> { | ||
| return window.showQuickPick(this.getBuildFilePickers(), { | ||
| placeHolder: "Select build file to import", | ||
| ignoreFocusOut: true, | ||
| canPickMany: true, | ||
| matchOnDescription: true, | ||
| matchOnDetail: true, | ||
| }); | ||
| } | ||
|
|
||
| /** | ||
| * Get pickers for all build files in the workspace. | ||
| */ | ||
| private async getBuildFilePickers(): Promise<IBuildFilePicker[]> { | ||
| const addedFolders: Map<string, IBuildFilePicker> = new Map<string, IBuildFilePicker>(); | ||
| for (const buildType of this.buildTypes) { | ||
| const uris: Uri[] = await workspace.findFiles(buildType.fileSearchPattern, this.exclusionGlobPattern); | ||
| for (const uri of uris) { | ||
| const containingFolder = path.dirname(uri.fsPath); | ||
| if (addedFolders.has(containingFolder)) { | ||
| const picker = addedFolders.get(containingFolder); | ||
| if (!picker.buildTypeAndUri.has(buildType)) { | ||
| picker.detail += `, ./${workspace.asRelativePath(uri)}`; | ||
| picker.description += `, ${buildType.displayName}`; | ||
| picker.buildTypeAndUri.set(buildType, uri); | ||
| } | ||
| } else { | ||
| addedFolders.set(containingFolder, { | ||
| label: path.basename(containingFolder), | ||
| detail: `./${workspace.asRelativePath(uri)}`, | ||
| description: buildType.displayName, | ||
| buildTypeAndUri: new Map<IBuildType, Uri>([[buildType, uri]]), | ||
| picked: true, | ||
| }); | ||
| } | ||
| } | ||
| } | ||
| const pickers: IBuildFilePicker[] = Array.from(addedFolders.values()); | ||
| return this.addSeparator(pickers); | ||
| } | ||
|
|
||
| /** | ||
| * Add a separator pickers between pickers that belong to different workspace folders. | ||
| */ | ||
| private addSeparator(pickers: IBuildFilePicker[]): IBuildFilePicker[] { | ||
| // group pickers by their containing workspace folder | ||
| const workspaceFolders = new Map<WorkspaceFolder, IBuildFilePicker[]>(); | ||
| for (const picker of pickers) { | ||
| const folder = workspace.getWorkspaceFolder(picker.buildTypeAndUri.values().next().value); | ||
| if (!folder) { | ||
| continue; | ||
| } | ||
| if (!workspaceFolders.has(folder)) { | ||
| workspaceFolders.set(folder, []); | ||
| } | ||
| workspaceFolders.get(folder)?.push(picker); | ||
| } | ||
|
|
||
| const newPickers: IBuildFilePicker[] = []; | ||
| const folderArray = Array.from(workspaceFolders.keys()); | ||
| folderArray.sort((a, b) => a.name.localeCompare(b.name)); | ||
| for (const folder of folderArray) { | ||
| const pickersInFolder = workspaceFolders.get(folder); | ||
| newPickers.push({ | ||
| label: folder.name, | ||
| kind: QuickPickItemKind.Separator, | ||
| buildTypeAndUri: null | ||
| }); | ||
| newPickers.push(...this.sortPickers(pickersInFolder)); | ||
| } | ||
| return newPickers; | ||
| } | ||
|
|
||
| private sortPickers(pickers: IBuildFilePicker[]): IBuildFilePicker[] { | ||
| return pickers.sort((a, b) => { | ||
| const pathA = path.dirname(a.buildTypeAndUri.values().next().value.fsPath); | ||
| const pathB = path.dirname(b.buildTypeAndUri.values().next().value.fsPath); | ||
| return pathA.localeCompare(pathB); | ||
| }); | ||
| } | ||
|
|
||
| /** | ||
| * Ask user to choose a build tool when there are multiple build tools in the same folder. | ||
| */ | ||
| private async eliminateBuildToolConflict(choice?: IBuildFilePicker[]): Promise<string[]> { | ||
| if (!choice) { | ||
| return []; | ||
| } | ||
| const conflictPickers = new Set<IBuildFilePicker>(); | ||
| const result: string[] = []; | ||
| for (const picker of choice) { | ||
| if (picker.buildTypeAndUri.size > 1) { | ||
| conflictPickers.add(picker); | ||
| } else { | ||
| result.push(picker.buildTypeAndUri.values().next().value.toString()); | ||
| } | ||
| } | ||
|
|
||
| if (conflictPickers.size > 0) { | ||
| for (const picker of conflictPickers) { | ||
| const conflictItems: IConflictItem[] = [{ | ||
| title: "Skip", | ||
| isCloseAffordance: true, | ||
| }]; | ||
| for (const buildType of picker.buildTypeAndUri.keys()) { | ||
| conflictItems.push({ | ||
| title: buildType.displayName, | ||
| uri: picker.buildTypeAndUri.get(buildType), | ||
| }); | ||
| } | ||
| const choice = await window.showInformationMessage<IConflictItem>( | ||
| `Which build tool would you like to use for folder: ${picker.label}?`, | ||
| { | ||
| modal: true, | ||
| }, | ||
| ...conflictItems | ||
| ); | ||
|
|
||
| if (choice?.title !== "Skip" && choice?.uri) { | ||
| result.push(choice.uri.toString()); | ||
| } | ||
| } | ||
| } | ||
| return result; | ||
| } | ||
| } | ||
|
|
||
| interface IBuildType { | ||
| displayName: string; | ||
| fileSearchPattern: string; | ||
| controlledBy: string | undefined; | ||
| } | ||
|
|
||
| interface IConflictItem extends MessageItem { | ||
| uri?: Uri; | ||
| } | ||
|
|
||
| interface IBuildFilePicker extends QuickPickItem { | ||
| buildTypeAndUri: Map<IBuildType, Uri>; | ||
| } | ||
|
|
||
| export function cleanupProjectPickerCache(context: ExtensionContext) { | ||
| context.workspaceState.update(PICKED_BUILD_FILES, undefined); | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.