Skip to content

Commit

Permalink
clean up terminal suggest code, fix bugs (#237599)
Browse files Browse the repository at this point in the history
  • Loading branch information
@meganrogge
meganrogge authored Jan 9, 2025
1 parent e8184ed commit 4a8978f
Show file tree
Hide file tree
Showing 5 changed files with 119 additions and 68 deletions.
173 changes: 112 additions & 61 deletions extensions/terminal-suggest/src/terminalSuggestMain.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ function createCompletionItem(cursorPosition: number, prefix: string, label: str
label,
detail: description ?? '',
replacementIndex: cursorPosition - lastWord.length,
replacementLength: lastWord.length > 0 ? lastWord.length : cursorPosition,
replacementLength: lastWord.length,
kind: kind ?? vscode.TerminalCompletionItemKind.Method
};
}
Expand Down Expand Up @@ -246,21 +246,33 @@ export function asArray<T>(x: T | T[]): T[] {
return Array.isArray(x) ? x : [x];
}

export async function getCompletionItemsFromSpecs(specs: Fig.Spec[], terminalContext: { commandLine: string; cursorPosition: number }, availableCommands: string[], prefix: string, shellIntegrationCwd?: vscode.Uri, token?: vscode.CancellationToken): Promise<{ items: vscode.TerminalCompletionItem[]; filesRequested: boolean; foldersRequested: boolean; cwd?: vscode.Uri }> {
export async function getCompletionItemsFromSpecs(
specs: Fig.Spec[],
terminalContext: { commandLine: string; cursorPosition: number },
availableCommands: string[],
prefix: string,
shellIntegrationCwd?: vscode.Uri,
token?: vscode.CancellationToken
): Promise<{ items: vscode.TerminalCompletionItem[]; filesRequested: boolean; foldersRequested: boolean; cwd?: vscode.Uri }> {
const items: vscode.TerminalCompletionItem[] = [];
let filesRequested = false;
let foldersRequested = false;

const firstCommand = getFirstCommand(terminalContext.commandLine);
const precedingText = terminalContext.commandLine.slice(0, terminalContext.cursorPosition + 1);

for (const spec of specs) {
const specLabels = getLabel(spec);

if (!specLabels) {
continue;
}

for (const specLabel of specLabels) {
if (!availableCommands.includes(specLabel) || (token && token?.isCancellationRequested)) {
if (!availableCommands.includes(specLabel) || (token && token.isCancellationRequested)) {
continue;
}
//

if (
// If the prompt is empty
!terminalContext.commandLine
Expand All @@ -270,76 +282,38 @@ export async function getCompletionItemsFromSpecs(specs: Fig.Spec[], terminalCon
// push it to the completion items
items.push(createCompletionItem(terminalContext.cursorPosition, prefix, specLabel));
}

if (!terminalContext.commandLine.startsWith(specLabel)) {
// the spec label is not the first word in the command line, so do not provide options or args
continue;
}
const precedingText = terminalContext.commandLine.slice(0, terminalContext.cursorPosition + 1);
if ('options' in spec && spec.options) {
for (const option of spec.options) {
const optionLabels = getLabel(option);
if (!optionLabels) {
continue;
}
for (const optionLabel of optionLabels) {
if (!items.find(i => i.label === optionLabel) && optionLabel.startsWith(prefix) || (prefix.length > specLabel.length && prefix.trim() === specLabel)) {
items.push(createCompletionItem(terminalContext.cursorPosition, prefix, optionLabel, option.description, vscode.TerminalCompletionItemKind.Flag));
}
const expectedText = `${specLabel} ${optionLabel} `;
if (!precedingText.includes(expectedText)) {
continue;
}
const indexOfPrecedingText = terminalContext.commandLine.lastIndexOf(expectedText);
const currentPrefix = precedingText.slice(indexOfPrecedingText + expectedText.length);
const argsCompletions = getCompletionItemsFromArgs(option.args, currentPrefix, terminalContext);
if (!argsCompletions) {
continue;
}
const argCompletions = argsCompletions.items;
foldersRequested = foldersRequested || argsCompletions.foldersRequested;
filesRequested = filesRequested || argsCompletions.filesRequested;
let cwd: vscode.Uri | undefined;
if (shellIntegrationCwd && (filesRequested || foldersRequested)) {
cwd = await resolveCwdFromPrefix(prefix, shellIntegrationCwd) ?? shellIntegrationCwd;
}
return { items: argCompletions, filesRequested, foldersRequested, cwd };
}
}

const argsCompletionResult = handleArguments(specLabel, spec, terminalContext, precedingText);
if (argsCompletionResult) {
items.push(...argsCompletionResult.items);
filesRequested ||= argsCompletionResult.filesRequested;
foldersRequested ||= argsCompletionResult.foldersRequested;
}
if ('args' in spec && asArray(spec.args)) {
const expectedText = `${specLabel} `;
if (!precedingText.includes(expectedText)) {
continue;
}
const indexOfPrecedingText = terminalContext.commandLine.lastIndexOf(expectedText);
const currentPrefix = precedingText.slice(indexOfPrecedingText + expectedText.length);
const argsCompletions = getCompletionItemsFromArgs(spec.args, currentPrefix, terminalContext);
if (!argsCompletions) {
continue;
}
items.push(...argsCompletions.items);
filesRequested = filesRequested || argsCompletions.filesRequested;
foldersRequested = foldersRequested || argsCompletions.foldersRequested;

const optionsCompletionResult = handleOptions(specLabel, spec, terminalContext, precedingText, prefix);
if (optionsCompletionResult) {
items.push(...optionsCompletionResult.items);
filesRequested ||= optionsCompletionResult.filesRequested;
foldersRequested ||= optionsCompletionResult.foldersRequested;
}
}
}

const shouldShowResourceCompletions =
(
// If the command line is empty
terminalContext.commandLine.trim().length === 0
// or no completions are found and the prefix is empty
|| !items?.length
// or all of the items are '.' or '..' IE file paths
|| items.length && items.every(i => ['.', '..'].includes(i.label))
)
// and neither files nor folders are going to be requested (for a specific spec's argument)
&& (!filesRequested && !foldersRequested);
(!terminalContext.commandLine.trim() || !items.length) &&
!filesRequested &&
!foldersRequested;

const shouldShowCommands = !terminalContext.commandLine.substring(0, terminalContext.cursorPosition).trimStart().includes(' ');
if (shouldShowCommands && (filesRequested === foldersRequested)) {

if (shouldShowCommands && !filesRequested && !foldersRequested) {
// Include builitin/available commands in the results
const labels = new Set(items.map(i => i.label));
const labels = new Set(items.map((i) => i.label));
for (const command of availableCommands) {
if (!labels.has(command)) {
items.push(createCompletionItem(terminalContext.cursorPosition, prefix, command));
Expand All @@ -351,13 +325,90 @@ export async function getCompletionItemsFromSpecs(specs: Fig.Spec[], terminalCon
filesRequested = true;
foldersRequested = true;
}

let cwd: vscode.Uri | undefined;
if (shellIntegrationCwd && (filesRequested || foldersRequested)) {
cwd = await resolveCwdFromPrefix(prefix, shellIntegrationCwd) ?? shellIntegrationCwd;
}

return { items, filesRequested, foldersRequested, cwd };
}

function handleArguments(specLabel: string, spec: Fig.Spec, terminalContext: { commandLine: string; cursorPosition: number }, precedingText: string): { items: vscode.TerminalCompletionItem[]; filesRequested: boolean; foldersRequested: boolean } | undefined {
let args;
if ('args' in spec && spec.args && asArray(spec.args)) {
args = asArray(spec.args);
}
const expectedText = `${specLabel} `;

if (!precedingText.includes(expectedText)) {
return;
}

const currentPrefix = precedingText.slice(precedingText.lastIndexOf(expectedText) + expectedText.length);
const argsCompletions = getCompletionItemsFromArgs(args, currentPrefix, terminalContext);

if (!argsCompletions) {
return;
}

return argsCompletions;
}

function handleOptions(specLabel: string, spec: Fig.Spec, terminalContext: { commandLine: string; cursorPosition: number }, precedingText: string, prefix: string): { items: vscode.TerminalCompletionItem[]; filesRequested: boolean; foldersRequested: boolean } | undefined {
let options;
if ('options' in spec && spec.options) {
options = spec.options;
}
if (!options) {
return;
}

const optionItems: vscode.TerminalCompletionItem[] = [];

for (const option of options) {
const optionLabels = getLabel(option);

if (!optionLabels) {
continue;
}

for (const optionLabel of optionLabels) {
if (
// Already includes this option
optionItems.find((i) => i.label === optionLabel)
) {
continue;
}

optionItems.push(
createCompletionItem(
terminalContext.cursorPosition,
prefix,
optionLabel,
option.description,
vscode.TerminalCompletionItemKind.Flag
)
);

const expectedText = `${specLabel} ${optionLabel} `;
if (!precedingText.includes(expectedText)) {
continue;
}

const currentPrefix = precedingText.slice(precedingText.lastIndexOf(expectedText) + expectedText.length);
const argsCompletions = getCompletionItemsFromArgs(option.args, currentPrefix, terminalContext);

if (argsCompletions) {
return { items: argsCompletions.items, filesRequested: argsCompletions.filesRequested, foldersRequested: argsCompletions.foldersRequested };
}
}
}

return { items: optionItems, filesRequested: false, foldersRequested: false };
}


function getCompletionItemsFromArgs(args: Fig.SingleOrArray<Fig.Arg> | undefined, currentPrefix: string, terminalContext: { commandLine: string; cursorPosition: number }): { items: vscode.TerminalCompletionItem[]; filesRequested: boolean; foldersRequested: boolean } | undefined {
if (!args) {
return;
Expand Down
6 changes: 3 additions & 3 deletions extensions/terminal-suggest/src/test/terminalSuggestMain.test.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -62,9 +62,9 @@ function createCodeTestSpecs(executable: string): ITestSpec2[] {
{ input: `${executable} --merge ./file1 ./file2 ./base |`, expectedResourceRequests: { type: 'files', cwd: testCwd } },
{ input: `${executable} --goto |`, expectedResourceRequests: { type: 'files', cwd: testCwd } },
{ input: `${executable} --user-data-dir |`, expectedResourceRequests: { type: 'folders', cwd: testCwd } },
{ input: `${executable} --profile |` },
{ input: `${executable} --install-extension |` },
{ input: `${executable} --uninstall-extension |` },
{ input: `${executable} --profile |`, expectedResourceRequests: { type: 'both', cwd: testCwd } },
{ input: `${executable} --install-extension |`, expectedResourceRequests: { type: 'both', cwd: testCwd } },
{ input: `${executable} --uninstall-extension |`, expectedResourceRequests: { type: 'both', cwd: testCwd } },
{ input: `${executable} --log |`, expectedCompletions: logOptions },
{ input: `${executable} --sync |`, expectedCompletions: syncOptions },
{ input: `${executable} --extensions-dir |`, expectedResourceRequests: { type: 'folders', cwd: testCwd } },
Expand Down
2 changes: 1 addition & 1 deletion src/vs/workbench/contrib/terminalContrib/suggest/browser/terminalCompletionService.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -250,7 +250,7 @@ export class TerminalCompletionService extends Disposable implements ITerminalCo
isDirectory,
isFile: kind === TerminalCompletionItemKind.File,
replacementIndex: cursorPosition - lastWord.length,
replacementLength: lastWord.length > 0 ? lastWord.length : cursorPosition
replacementLength: lastWord.length
});
}

Expand Down
4 changes: 2 additions & 2 deletions .../workbench/contrib/terminalContrib/suggest/test/browser/terminalCompletionService.test.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ suite('TerminalCompletionService', () => {
isDirectory: true,
isFile: false,
replacementIndex: 1,
replacementLength: 1
replacementLength: 0
}]);
});
test('.|', async () => {
Expand Down Expand Up @@ -132,7 +132,7 @@ suite('TerminalCompletionService', () => {
isDirectory: true,
isFile: false,
replacementIndex: 3,
replacementLength: 3
replacementLength: 0
}]);
});
test('cd .|', async () => {
Expand Down
2 changes: 1 addition & 1 deletion src/vs/workbench/services/suggest/browser/simpleSuggestWidget.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -517,7 +517,7 @@ export class SimpleSuggestWidget extends Disposable {
const preferredWidth = this._completionModel ? this._completionModel.stats.pLabelLen * info.typicalHalfwidthCharacterWidth : width;

// height math
const fullHeight = info.statusBarHeight + this._list.contentHeight + info.borderHeight;
const fullHeight = info.statusBarHeight + this._list.contentHeight + this._messageElement.clientHeight + info.borderHeight;
const minHeight = info.itemHeight + info.statusBarHeight;
// const editorBox = dom.getDomNodePagePosition(this.editor.getDomNode());
// const cursorBox = this.editor.getScrolledVisiblePosition(this.editor.getPosition());
Expand Down

0 comments on commit 4a8978f

Please sign in to comment.