abbyswag/qwen-code
1
0
Fork 0
mirror of https://github.com/QwenLM/qwen-code.git synced 2025-12-20 08:47:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

[Refactor] Centralizes autocompletion logic within useCompletion (#4740)

Browse Source
This commit is contained in:
Sandy Tao
2025-07-24 21:41:35 -07:00
committed by GitHub
parent 273e74c09d
commit 1d7eb0d250
5 changed files with 786 additions and 533 deletions
Download Patch File Download Diff File Expand all files Collapse all files

284
packages/cli/src/ui/hooks/useCompletion.integration.test.ts
View File

@@ -16,6 +16,7 @@ import {
SlashCommand,
} from '../commands/types.js';
import { Config, FileDiscoveryService } from '@google/gemini-cli-core';
import { useTextBuffer } from '../components/shared/text-buffer.js';
interface MockConfig {
getFileFilteringOptions: () => {
@@ -26,6 +27,19 @@ interface MockConfig {
getFileService: () => FileDiscoveryService | null;
}
// Helper to create real TextBuffer objects within renderHook
const useTextBufferForTest = (text: string) => {
const cursorOffset = text.length;
return useTextBuffer({
initialText: text,
initialCursorOffset: cursorOffset,
viewport: { width: 80, height: 20 },
isValidPath: () => false,
onChange: () => {},
});
};
// Mock dependencies
vi.mock('fs/promises');
vi.mock('@google/gemini-cli-core', async () => {
@@ -183,16 +197,16 @@ describe('useCompletion git-aware filtering integration', () => {
},
);
const { result } = renderHook(() =>
useCompletion(
'@d',
const { result } = renderHook(() => {
const textBuffer = useTextBufferForTest('@d');
return useCompletion(
textBuffer,
testCwd,
true,
slashCommands,
mockCommandContext,
mockConfig as Config,
),
);
);
});
// Wait for async operations to complete
await act(async () => {
@@ -241,16 +255,16 @@ describe('useCompletion git-aware filtering integration', () => {
},
);
const { result } = renderHook(() =>
useCompletion(
'@',
const { result } = renderHook(() => {
const textBuffer = useTextBufferForTest('@');
return useCompletion(
textBuffer,
testCwd,
true,
slashCommands,
mockCommandContext,
mockConfig as Config,
),
);
);
});
// Wait for async operations to complete
await act(async () => {
@@ -323,16 +337,16 @@ describe('useCompletion git-aware filtering integration', () => {
},
);
const { result } = renderHook(() =>
useCompletion(
'@t',
const { result } = renderHook(() => {
const textBuffer = useTextBufferForTest('@t');
return useCompletion(
textBuffer,
testCwd,
true,
slashCommands,
mockCommandContext,
mockConfig as Config,
),
);
);
});
// Wait for async operations to complete
await act(async () => {
@@ -362,16 +376,16 @@ describe('useCompletion git-aware filtering integration', () => {
{ name: 'dist', isDirectory: () => true },
] as unknown as Awaited<ReturnType<typeof fs.readdir>>);
renderHook(() =>
useCompletion(
'@d',
renderHook(() => {
const textBuffer = useTextBufferForTest('@d');
return useCompletion(
textBuffer,
testCwd,
true,
slashCommands,
mockCommandContext,
mockConfigNoRecursive,
),
);
);
});
await act(async () => {
await new Promise((resolve) => setTimeout(resolve, 150));
@@ -390,22 +404,21 @@ describe('useCompletion git-aware filtering integration', () => {
{ name: 'README.md', isDirectory: () => false },
] as unknown as Awaited<ReturnType<typeof fs.readdir>>);
const { result } = renderHook(() =>
useCompletion(
'@',
const { result } = renderHook(() => {
const textBuffer = useTextBufferForTest('@');
return useCompletion(
textBuffer,
testCwd,
true,
slashCommands,
mockCommandContext,
undefined,
),
);
);
});
await act(async () => {
await new Promise((resolve) => setTimeout(resolve, 150));
});
// Without config, should include all files
expect(result.current.suggestions).toHaveLength(3);
expect(result.current.suggestions).toEqual(
expect.arrayContaining([
@@ -424,16 +437,16 @@ describe('useCompletion git-aware filtering integration', () => {
const consoleSpy = vi.spyOn(console, 'warn').mockImplementation(() => {});
const { result } = renderHook(() =>
useCompletion(
'@',
const { result } = renderHook(() => {
const textBuffer = useTextBufferForTest('@');
return useCompletion(
textBuffer,
testCwd,
true,
slashCommands,
mockCommandContext,
mockConfig as Config,
),
);
);
});
await act(async () => {
await new Promise((resolve) => setTimeout(resolve, 150));
@@ -470,16 +483,16 @@ describe('useCompletion git-aware filtering integration', () => {
},
);
const { result } = renderHook(() =>
useCompletion(
'@src/comp',
const { result } = renderHook(() => {
const textBuffer = useTextBufferForTest('@src/comp');
return useCompletion(
textBuffer,
testCwd,
true,
slashCommands,
mockCommandContext,
mockConfig as Config,
),
);
);
});
await act(async () => {
await new Promise((resolve) => setTimeout(resolve, 150));
@@ -495,16 +508,16 @@ describe('useCompletion git-aware filtering integration', () => {
const globResults = [`${testCwd}/src/index.ts`, `${testCwd}/README.md`];
vi.mocked(glob).mockResolvedValue(globResults);
const { result } = renderHook(() =>
useCompletion(
'@s',
const { result } = renderHook(() => {
const textBuffer = useTextBufferForTest('@s');
return useCompletion(
textBuffer,
testCwd,
true,
slashCommands,
mockCommandContext,
mockConfig as Config,
),
);
);
});
await act(async () => {
await new Promise((resolve) => setTimeout(resolve, 150));
@@ -530,16 +543,16 @@ describe('useCompletion git-aware filtering integration', () => {
];
vi.mocked(glob).mockResolvedValue(globResults);
const { result } = renderHook(() =>
useCompletion(
'@.',
const { result } = renderHook(() => {
const textBuffer = useTextBufferForTest('@.');
return useCompletion(
textBuffer,
testCwd,
true,
slashCommands,
mockCommandContext,
mockConfig as Config,
),
);
);
});
await act(async () => {
await new Promise((resolve) => setTimeout(resolve, 150));
@@ -559,15 +572,15 @@ describe('useCompletion git-aware filtering integration', () => {
});
it('should suggest top-level command names based on partial input', async () => {
const { result } = renderHook(() =>
useCompletion(
'/mem',
const { result } = renderHook(() => {
const textBuffer = useTextBufferForTest('/mem');
return useCompletion(
textBuffer,
'/test/cwd',
true,
mockSlashCommands,
mockCommandContext,
),
);
);
});
expect(result.current.suggestions).toEqual([
{ label: 'memory', value: 'memory', description: 'Manage memory' },
@@ -578,30 +591,30 @@ describe('useCompletion git-aware filtering integration', () => {
it.each([['/?'], ['/usage']])(
'should not suggest commands when altNames is fully typed',
async (altName) => {
const { result } = renderHook(() =>
useCompletion(
altName,
const { result } = renderHook(() => {
const textBuffer = useTextBufferForTest(altName);
return useCompletion(
textBuffer,
'/test/cwd',
true,
mockSlashCommands,
mockCommandContext,
),
);
);
});
expect(result.current.suggestions).toHaveLength(0);
},
);
it('should suggest commands based on partial altNames matches', async () => {
const { result } = renderHook(() =>
useCompletion(
'/usag', // part of the word "usage"
const { result } = renderHook(() => {
const textBuffer = useTextBufferForTest('/usag'); // part of the word "usage"
return useCompletion(
textBuffer,
'/test/cwd',
true,
mockSlashCommands,
mockCommandContext,
),
);
);
});
expect(result.current.suggestions).toEqual([
{
@@ -613,15 +626,15 @@ describe('useCompletion git-aware filtering integration', () => {
});
it('should suggest sub-command names for a parent command', async () => {
const { result } = renderHook(() =>
useCompletion(
'/memory a',
const { result } = renderHook(() => {
const textBuffer = useTextBufferForTest('/memory a');
return useCompletion(
textBuffer,
'/test/cwd',
true,
mockSlashCommands,
mockCommandContext,
),
);
);
});
expect(result.current.suggestions).toEqual([
{ label: 'add', value: 'add', description: 'Add to memory' },
@@ -629,15 +642,15 @@ describe('useCompletion git-aware filtering integration', () => {
});
it('should suggest all sub-commands when the query ends with the parent command and a space', async () => {
const { result } = renderHook(() =>
useCompletion(
'/memory ',
const { result } = renderHook(() => {
const textBuffer = useTextBufferForTest('/memory ');
return useCompletion(
textBuffer,
'/test/cwd',
true,
mockSlashCommands,
mockCommandContext,
),
);
);
});
expect(result.current.suggestions).toHaveLength(2);
expect(result.current.suggestions).toEqual(
@@ -652,8 +665,9 @@ describe('useCompletion git-aware filtering integration', () => {
const availableTags = ['my-chat-tag-1', 'my-chat-tag-2', 'another-channel'];
const mockCompletionFn = vi
.fn()
.mockImplementation(async (context: CommandContext, partialArg: string) =>
availableTags.filter((tag) => tag.startsWith(partialArg)),
.mockImplementation(
async (_context: CommandContext, partialArg: string) =>
availableTags.filter((tag) => tag.startsWith(partialArg)),
);
const mockCommandsWithFiltering = JSON.parse(
@@ -678,15 +692,15 @@ describe('useCompletion git-aware filtering integration', () => {
resumeCmd.completion = mockCompletionFn;
const { result } = renderHook(() =>
useCompletion(
'/chat resume my-ch',
const { result } = renderHook(() => {
const textBuffer = useTextBufferForTest('/chat resume my-ch');
return useCompletion(
textBuffer,
'/test/cwd',
true,
mockCommandsWithFiltering,
mockCommandContext,
),
);
);
});
await act(async () => {
await new Promise((resolve) => setTimeout(resolve, 150));
@@ -701,45 +715,45 @@ describe('useCompletion git-aware filtering integration', () => {
});
it('should not provide suggestions for a fully typed command that has no sub-commands or argument completion', async () => {
const { result } = renderHook(() =>
useCompletion(
'/clear ',
const { result } = renderHook(() => {
const textBuffer = useTextBufferForTest('/clear ');
return useCompletion(
textBuffer,
'/test/cwd',
true,
mockSlashCommands,
mockCommandContext,
),
);
);
});
expect(result.current.suggestions).toHaveLength(0);
expect(result.current.showSuggestions).toBe(false);
});
it('should not provide suggestions for an unknown command', async () => {
const { result } = renderHook(() =>
useCompletion(
'/unknown-command',
const { result } = renderHook(() => {
const textBuffer = useTextBufferForTest('/unknown-command');
return useCompletion(
textBuffer,
'/test/cwd',
true,
mockSlashCommands,
mockCommandContext,
),
);
);
});
expect(result.current.suggestions).toHaveLength(0);
expect(result.current.showSuggestions).toBe(false);
});
it('should suggest sub-commands for a fully typed parent command without a trailing space', async () => {
const { result } = renderHook(() =>
useCompletion(
'/memory', // Note: no trailing space
const { result } = renderHook(() => {
const textBuffer = useTextBufferForTest('/memory'); // Note: no trailing space
return useCompletion(
textBuffer,
'/test/cwd',
true,
mockSlashCommands,
mockCommandContext,
),
);
);
});
// Assert that suggestions for sub-commands are shown immediately
expect(result.current.suggestions).toHaveLength(2);
@@ -753,15 +767,15 @@ describe('useCompletion git-aware filtering integration', () => {
});
it('should NOT provide suggestions for a perfectly typed command that is a leaf node', async () => {
const { result } = renderHook(() =>
useCompletion(
'/clear', // No trailing space
const { result } = renderHook(() => {
const textBuffer = useTextBufferForTest('/clear'); // No trailing space
return useCompletion(
textBuffer,
'/test/cwd',
true,
mockSlashCommands,
mockCommandContext,
),
);
);
});
expect(result.current.suggestions).toHaveLength(0);
expect(result.current.showSuggestions).toBe(false);
@@ -787,15 +801,15 @@ describe('useCompletion git-aware filtering integration', () => {
}
resumeCommand.completion = mockCompletionFn;
const { result } = renderHook(() =>
useCompletion(
'/chat resume ', // Trailing space, no partial argument
const { result } = renderHook(() => {
const textBuffer = useTextBufferForTest('/chat resume '); // Trailing space, no partial argument
return useCompletion(
textBuffer,
'/test/cwd',
true,
isolatedMockCommands,
mockCommandContext,
),
);
);
});
await act(async () => {
await new Promise((resolve) => setTimeout(resolve, 150));
@@ -807,15 +821,15 @@ describe('useCompletion git-aware filtering integration', () => {
});
it('should suggest all top-level commands for the root slash', async () => {
const { result } = renderHook(() =>
useCompletion(
'/',
const { result } = renderHook(() => {
const textBuffer = useTextBufferForTest('/');
return useCompletion(
textBuffer,
'/test/cwd',
true,
mockSlashCommands,
mockCommandContext,
),
);
);
});
expect(result.current.suggestions.length).toBe(mockSlashCommands.length);
expect(result.current.suggestions.map((s) => s.label)).toEqual(
@@ -824,15 +838,15 @@ describe('useCompletion git-aware filtering integration', () => {
});
it('should provide no suggestions for an invalid sub-command', async () => {
const { result } = renderHook(() =>
useCompletion(
'/memory dothisnow',
const { result } = renderHook(() => {
const textBuffer = useTextBufferForTest('/memory dothisnow');
return useCompletion(
textBuffer,
'/test/cwd',
true,
mockSlashCommands,
mockCommandContext,
),
);
);
});
expect(result.current.suggestions).toHaveLength(0);
expect(result.current.showSuggestions).toBe(false);

699
packages/cli/src/ui/hooks/useCompletion.test.ts
View File

File diff suppressed because it is too large Load Diff

121
packages/cli/src/ui/hooks/useCompletion.ts
View File

@@ -4,7 +4,7 @@
* SPDX-License-Identifier: Apache-2.0
*/
import { useState, useEffect, useCallback } from 'react';
import { useState, useEffect, useCallback, useMemo } from 'react';
import * as fs from 'fs/promises';
import * as path from 'path';
import { glob } from 'glob';
@@ -22,6 +22,9 @@ import {
Suggestion,
} from '../components/SuggestionsDisplay.js';
import { CommandContext, SlashCommand } from '../commands/types.js';
import { TextBuffer } from '../components/shared/text-buffer.js';
import { isSlashCommand } from '../utils/commandUtils.js';
import { toCodePoints } from '../utils/textUtils.js';
export interface UseCompletionReturn {
suggestions: Suggestion[];
@@ -35,12 +38,12 @@ export interface UseCompletionReturn {
resetCompletionState: () => void;
navigateUp: () => void;
navigateDown: () => void;
handleAutocomplete: (indexToUse: number) => void;
}
export function useCompletion(
query: string,
buffer: TextBuffer,
cwd: string,
isActive: boolean,
slashCommands: readonly SlashCommand[],
commandContext: CommandContext,
config?: Config,
@@ -122,13 +125,45 @@ export function useCompletion(
});
}, [suggestions.length]);
// Check if cursor is after @ or / without unescaped spaces
const isActive = useMemo(() => {
if (isSlashCommand(buffer.text.trim())) {
return true;
}
// For other completions like '@', we search backwards from the cursor.
const [row, col] = buffer.cursor;
const currentLine = buffer.lines[row] || '';
const codePoints = toCodePoints(currentLine);
for (let i = col - 1; i >= 0; i--) {
const char = codePoints[i];
if (char === ' ') {
// Check for unescaped spaces.
let backslashCount = 0;
for (let j = i - 1; j >= 0 && codePoints[j] === '\\'; j--) {
backslashCount++;
}
if (backslashCount % 2 === 0) {
return false; // Inactive on unescaped space.
}
} else if (char === '@') {
// Active if we find an '@' before any unescaped space.
return true;
}
}
return false;
}, [buffer.text, buffer.cursor, buffer.lines]);
useEffect(() => {
if (!isActive) {
resetCompletionState();
return;
}
const trimmedQuery = query.trimStart();
const trimmedQuery = buffer.text.trimStart();
if (trimmedQuery.startsWith('/')) {
// Always reset perfect match at the beginning of processing.
@@ -275,13 +310,13 @@ export function useCompletion(
}
// Handle At Command Completion
const atIndex = query.lastIndexOf('@');
const atIndex = buffer.text.lastIndexOf('@');
if (atIndex === -1) {
resetCompletionState();
return;
}
const partialPath = query.substring(atIndex + 1);
const partialPath = buffer.text.substring(atIndex + 1);
const lastSlashIndex = partialPath.lastIndexOf('/');
const baseDirRelative =
lastSlashIndex === -1
@@ -545,7 +580,7 @@ export function useCompletion(
clearTimeout(debounceTimeout);
};
}, [
query,
buffer.text,
cwd,
isActive,
resetCompletionState,
@@ -554,6 +589,77 @@ export function useCompletion(
config,
]);
const handleAutocomplete = useCallback(
(indexToUse: number) => {
if (indexToUse < 0 || indexToUse >= suggestions.length) {
return;
}
const query = buffer.text;
const suggestion = suggestions[indexToUse].value;
if (query.trimStart().startsWith('/')) {
const hasTrailingSpace = query.endsWith(' ');
const parts = query
.trimStart()
.substring(1)
.split(/\s+/)
.filter(Boolean);
let isParentPath = false;
// If there's no trailing space, we need to check if the current query
// is already a complete path to a parent command.
if (!hasTrailingSpace) {
let currentLevel: readonly SlashCommand[] | undefined = slashCommands;
for (let i = 0; i < parts.length; i++) {
const part = parts[i];
const found: SlashCommand | undefined = currentLevel?.find(
(cmd) => cmd.name === part || cmd.altNames?.includes(part),
);
if (found) {
if (i === parts.length - 1 && found.subCommands) {
isParentPath = true;
}
currentLevel = found.subCommands as
| readonly SlashCommand[]
| undefined;
} else {
// Path is invalid, so it can't be a parent path.
currentLevel = undefined;
break;
}
}
}
// Determine the base path of the command.
// - If there's a trailing space, the whole command is the base.
// - If it's a known parent path, the whole command is the base.
// - Otherwise, the base is everything EXCEPT the last partial part.
const basePath =
hasTrailingSpace || isParentPath ? parts : parts.slice(0, -1);
const newValue = `/${[...basePath, suggestion].join(' ')}`;
buffer.setText(newValue);
} else {
const atIndex = query.lastIndexOf('@');
if (atIndex === -1) return;
const pathPart = query.substring(atIndex + 1);
const lastSlashIndexInPath = pathPart.lastIndexOf('/');
let autoCompleteStartIndex = atIndex + 1;
if (lastSlashIndexInPath !== -1) {
autoCompleteStartIndex += lastSlashIndexInPath + 1;
}
buffer.replaceRangeByOffset(
autoCompleteStartIndex,
buffer.text.length,
suggestion,
);
}
resetCompletionState();
},
[resetCompletionState, buffer, suggestions, slashCommands],
);
return {
suggestions,
activeSuggestionIndex,
@@ -566,5 +672,6 @@ export function useCompletion(
resetCompletionState,
navigateUp,
navigateDown,
handleAutocomplete,
};
}