Skip to content

Beautiful, AI-native markdown IDE and LLM wiki

Rank palette commands by where the query matched (#6759)

Andrew Mikofalvybf36d1788929
diff --git a/.changeset/prd-9598-palette-command-ranking.md b/.changeset/prd-9598-palette-command-ranking.md
new file mode 100644
index 000000000..5e0150cc8
--- /dev/null
+++ b/.changeset/prd-9598-palette-command-ranking.md
@@ -0,0 +1,5 @@
+---
+"@inkeep/open-knowledge": patch
+---
+
+Command palette searches now list commands whose names match before commands that match only a related term, so typing "check" leads with **Check for updates** rather than **Switch worktree**.
diff --git a/packages/app/src/components/CommandPalette.dom.test.tsx b/packages/app/src/components/CommandPalette.dom.test.tsx
index d87929c33..28f8907cf 100644
--- a/packages/app/src/components/CommandPalette.dom.test.tsx
+++ b/packages/app/src/components/CommandPalette.dom.test.tsx
@@ -970,6 +970,27 @@ describe('CommandPalette DOM behavior', () => {
expect(screen.queryByTestId('command-palette-report-bug')).toBeNull();
});
+ test('a command whose label matches leads a command that matched only a keyword', async () => {
+ pageListLoading = true;
+ await renderPalette({ bridge: createBridge() });
+
+ await setQuery('check');
+
+ await waitFor(() =>
+ expect(screen.getByTestId('command-palette-search-preparing')).not.toBeNull(),
+ );
+ const commandIds = screen
+ .getAllByRole('option')
+ .map((option) => option.getAttribute('data-testid'))
+ .filter((id) => id?.startsWith('command-palette-'));
+ expect(commandIds[0]).toBe('command-palette-check-for-updates');
+ expect(commandIds).toContain('command-palette-switch-worktree');
+ expect(commandIds.indexOf('command-palette-toggle-spell-check')).toBeLessThan(
+ commandIds.indexOf('command-palette-switch-worktree'),
+ );
+ expect(screen.queryByTestId('command-palette-search-hint-empty')).toBeNull();
+ });
+
test('a rejected worktree scope shows its cause, refreshes, and never opens', async () => {
worktreeModelMock = {
mainRoot: '/projects/current',
diff --git a/packages/app/src/components/CommandPalette.tsx b/packages/app/src/components/CommandPalette.tsx
index f5e5b0c6d..83f61de39 100644
--- a/packages/app/src/components/CommandPalette.tsx
+++ b/packages/app/src/components/CommandPalette.tsx
@@ -43,6 +43,7 @@ import {
classifyOmnibarSearchHint,
fetchWorkspaceSearchEntries,
matchesCommandQuery,
+ rankCommandQuery,
SEMANTIC_RESULT_LIMIT,
searchWorkspaceEntries,
splitTextByQueryMatches,
@@ -730,8 +731,14 @@ export function CommandPalette({ bridge = null, open, onOpenChange }: CommandPal
if (!cmd.available(paletteCtx)) return [];
if (cmd.visibility === 'search-only' && trimmedDeferredQuery === '') return [];
const label = cmd.label(paletteCtx);
- return matchesCommandQuery(label, deferredQuery, cmd.keywords) ? [{ cmd, label }] : [];
- });
+ const rank = rankCommandQuery(label, deferredQuery, cmd.keywords);
+ return rank === null ? [] : [{ cmd, label, rank }];
+ }).sort((a, b) => a.rank - b.rank);
+ const bestCommandRank = (group: PaletteCommandGroup) =>
+ visibleFixedCommands.find((row) => row.cmd.group === group)?.rank ?? Number.POSITIVE_INFINITY;
+ const trailingCommandGroups = (['file', 'view', 'terminal', 'app'] as const)
+ .slice()
+ .sort((a, b) => bestCommandRank(a) - bestCommandRank(b));
const hasVisibleFixedCommand = visibleFixedCommands.length > 0;
const commandGroupHeading = (group: PaletteCommandGroup): string => {
switch (group) {
@@ -1423,9 +1430,7 @@ export function CommandPalette({ bridge = null, open, onOpenChange }: CommandPal
</CommandGroup>
) : null}
- {(['file', 'view', 'terminal', 'app'] as const).map((groupKey) =>
- renderCommandGroup(groupKey),
- )}
+ {trailingCommandGroups.map((groupKey) => renderCommandGroup(groupKey))}
{showNavigation ? (
<CommandGroup heading={t`Search`}>
@@ -1445,6 +1450,7 @@ export function CommandPalette({ bridge = null, open, onOpenChange }: CommandPal
<SearchHint
mode={classifyOmnibarSearchHint(trimmedDeferredQuery, visibleSearchResults, {
truncated: searchTruncated,
+ pending: showSearchPreparing || showSearchLoading,
})}
inExclusiveMode={inExclusiveMode}
paletteModeKind={paletteMode.kind}
diff --git a/packages/app/src/components/command-palette-search.test.ts b/packages/app/src/components/command-palette-search.test.ts
index 4060fe9a8..cc0cc59b6 100644
--- a/packages/app/src/components/command-palette-search.test.ts
+++ b/packages/app/src/components/command-palette-search.test.ts
@@ -6,6 +6,7 @@ import {
EMPTY_QUERY_NAV_LIMIT,
fetchWorkspaceSearchEntries,
matchesCommandQuery,
+ rankCommandQuery,
searchWorkspaceEntries,
splitTextByQueryMatches,
type WorkspaceEntry,
@@ -174,6 +175,12 @@ describe('classifyOmnibarSearchHint', () => {
expect(classifyOmnibarSearchHint('mystery', [])).toBe('empty');
});
+ test('no empty verdict while the search has not answered yet', () => {
+ expect(classifyOmnibarSearchHint('check', [], { pending: true })).toBe('idle');
+ const results: WorkspaceEntry[] = [{ kind: 'file', path: 'notes/check', name: 'check' }];
+ expect(classifyOmnibarSearchHint('check', results, { pending: true })).toBe('name-only');
+ });
+
test('name-only when results exist but no entry carries a snippet', () => {
const results: WorkspaceEntry[] = [
{ kind: 'file', path: 'notes/foo', name: 'foo' },
@@ -294,6 +301,43 @@ describe('matchesCommandQuery', () => {
});
});
+describe('rankCommandQuery', () => {
+ const SWITCH_WORKTREE_KEYWORDS = ['worktree', 'switch', 'branch', 'change', 'checkout'];
+
+ test('returns null when the command does not match', () => {
+ expect(rankCommandQuery('Open graph', 'cursor')).toBeNull();
+ });
+
+ test('ranks every command equally on an empty query', () => {
+ expect(rankCommandQuery('New file', '')).toBe(rankCommandQuery('Switch worktree', ' '));
+ });
+
+ test('a label word match outranks a match found only in keywords', () => {
+ const labelRank = rankCommandQuery('Check for updates', 'check', ['update', 'check']);
+ const keywordRank = rankCommandQuery('Switch worktree', 'check', SWITCH_WORKTREE_KEYWORDS);
+ expect(labelRank).not.toBeNull();
+ expect(keywordRank).not.toBeNull();
+ expect(labelRank as number).toBeLessThan(keywordRank as number);
+ });
+
+ test('a term starting a label word outranks one found mid-word', () => {
+ const wordStart = rankCommandQuery('New worktree', 'work');
+ const midWord = rankCommandQuery('Show Terminal', 'min');
+ const keywordOnly = rankCommandQuery('Report a bug', 'issue', ['bug report issue']);
+ expect(wordStart as number).toBeLessThan(midWord as number);
+ expect(midWord as number).toBeLessThan(keywordOnly as number);
+ });
+
+ test('a multi-word query ranks by its weakest term', () => {
+ expect(rankCommandQuery('Report a bug', 'report bug', ['bug report issue'])).toBe(
+ rankCommandQuery('Report a bug', 'bug'),
+ );
+ expect(rankCommandQuery('Report a bug', 'report issue', ['bug report issue'])).toBe(
+ rankCommandQuery('Report a bug', 'issue', ['bug report issue']),
+ );
+ });
+});
+
describe('splitTextByQueryMatches', () => {
test('marks query words case-insensitively', () => {
expect(splitTextByQueryMatches('Homepage content on the home page', 'homepage home')).toEqual([
diff --git a/packages/app/src/components/command-palette-search.ts b/packages/app/src/components/command-palette-search.ts
index 172a59a2f..8aae2047a 100644
--- a/packages/app/src/components/command-palette-search.ts
+++ b/packages/app/src/components/command-palette-search.ts
@@ -290,15 +290,43 @@ export async function fetchWorkspaceSearchEntries(
};
}
+const COMMAND_RANK_LABEL_WORD_START = 0;
+const COMMAND_RANK_LABEL_INSIDE_WORD = 1;
+const COMMAND_RANK_KEYWORD_ONLY = 2;
+
+function commandTermRank(label: string, keywordText: string, term: string): number | null {
+ if (new RegExp(`(?:^|[^\\p{L}\\p{N}])${escapeRegExp(term)}`, 'u').test(label)) {
+ return COMMAND_RANK_LABEL_WORD_START;
+ }
+ if (label.includes(term)) return COMMAND_RANK_LABEL_INSIDE_WORD;
+ if (`${label} ${keywordText}`.includes(term)) return COMMAND_RANK_KEYWORD_ONLY;
+ return null;
+}
+
+export function rankCommandQuery(
+ label: string,
+ query: string,
+ keywords: readonly string[] = [],
+): number | null {
+ const normalizedQuery = normalize(query);
+ if (!normalizedQuery) return COMMAND_RANK_LABEL_WORD_START;
+ const normalizedLabel = normalize(label);
+ const keywordText = normalize(keywords.join(' '));
+ let rank = COMMAND_RANK_LABEL_WORD_START;
+ for (const term of queryTerms(normalizedQuery)) {
+ const termRank = commandTermRank(normalizedLabel, keywordText, term);
+ if (termRank === null) return null;
+ rank = Math.max(rank, termRank);
+ }
+ return rank;
+}
+
export function matchesCommandQuery(
label: string,
query: string,
keywords: readonly string[] = [],
): boolean {
- const normalizedQuery = normalize(query);
- if (!normalizedQuery) return true;
- const haystack = normalize([label, ...keywords].join(' '));
- return queryTerms(normalizedQuery).every((term) => haystack.includes(term));
+ return rankCommandQuery(label, query, keywords) !== null;
}
export type OmnibarSearchHintMode = 'idle' | 'content' | 'name-only' | 'empty' | 'truncated';
@@ -306,10 +334,10 @@ export type OmnibarSearchHintMode = 'idle' | 'content' | 'name-only' | 'empty' |
export function classifyOmnibarSearchHint(
query: string,
visibleResults: readonly (WorkspaceEntry | WorkspaceSearchEntry)[],
- options: { truncated?: boolean } = {},
+ options: { truncated?: boolean; pending?: boolean } = {},
): OmnibarSearchHintMode {
if (query.trim() === '') return 'idle';
- if (visibleResults.length === 0) return 'empty';
+ if (visibleResults.length === 0) return options.pending ? 'idle' : 'empty';
if (options.truncated) return 'truncated';
for (const entry of visibleResults) {
if ('snippet' in entry && typeof entry.snippet === 'string' && entry.snippet.length > 0) {