summaryrefslogtreecommitdiff
path: root/packages/cli/src
diff options
context:
space:
mode:
Diffstat (limited to 'packages/cli/src')
-rw-r--r--packages/cli/src/config/config.test.ts81
-rw-r--r--packages/cli/src/config/config.ts9
-rw-r--r--packages/cli/src/ui/App.tsx7
-rw-r--r--packages/cli/src/ui/commands/ideCommand.test.ts138
-rw-r--r--packages/cli/src/ui/commands/ideCommand.ts105
-rw-r--r--packages/cli/src/ui/components/IDEContextDetailDisplay.tsx9
-rw-r--r--packages/cli/src/ui/hooks/slashCommandProcessor.test.ts14
7 files changed, 95 insertions, 268 deletions
diff --git a/packages/cli/src/config/config.test.ts b/packages/cli/src/config/config.test.ts
index 7f47660d..1dd09f4b 100644
--- a/packages/cli/src/config/config.test.ts
+++ b/packages/cli/src/config/config.test.ts
@@ -35,11 +35,13 @@ vi.mock('@google/gemini-cli-core', async () => {
);
return {
...actualServer,
- IdeClient: vi.fn().mockImplementation(() => ({
- getConnectionStatus: vi.fn(),
- initialize: vi.fn(),
- shutdown: vi.fn(),
- })),
+ IdeClient: {
+ getInstance: vi.fn().mockReturnValue({
+ getConnectionStatus: vi.fn(),
+ initialize: vi.fn(),
+ shutdown: vi.fn(),
+ }),
+ },
loadEnvironment: vi.fn(),
loadServerHierarchicalMemory: vi.fn(
(cwd, debug, fileService, extensionPaths, _maxDirs) =>
@@ -922,8 +924,6 @@ describe('loadCliConfig ideMode', () => {
vi.resetAllMocks();
vi.mocked(os.homedir).mockReturnValue('/mock/home/user');
process.env.GEMINI_API_KEY = 'test-api-key';
- // Explicitly delete TERM_PROGRAM and SANDBOX before each test
- delete process.env.TERM_PROGRAM;
delete process.env.SANDBOX;
delete process.env.GEMINI_CLI_IDE_SERVER_PORT;
});
@@ -942,72 +942,7 @@ describe('loadCliConfig ideMode', () => {
expect(config.getIdeMode()).toBe(false);
});
- it('should be false if --ide-mode is true but TERM_PROGRAM is not vscode', async () => {
- process.argv = ['node', 'script.js', '--ide-mode'];
- const settings: Settings = {};
- const argv = await parseArguments();
- const config = await loadCliConfig(settings, [], 'test-session', argv);
- expect(config.getIdeMode()).toBe(false);
- });
-
- it('should be false if settings.ideMode is true but TERM_PROGRAM is not vscode', async () => {
- process.argv = ['node', 'script.js'];
- const argv = await parseArguments();
- const settings: Settings = { ideMode: true };
- const config = await loadCliConfig(settings, [], 'test-session', argv);
- expect(config.getIdeMode()).toBe(false);
- });
-
- it('should be true when --ide-mode is set and TERM_PROGRAM is vscode', async () => {
- process.argv = ['node', 'script.js', '--ide-mode'];
- const argv = await parseArguments();
- process.env.TERM_PROGRAM = 'vscode';
- process.env.GEMINI_CLI_IDE_SERVER_PORT = '3000';
- const settings: Settings = {};
- const config = await loadCliConfig(settings, [], 'test-session', argv);
- expect(config.getIdeMode()).toBe(true);
- });
-
- it('should be true when settings.ideMode is true and TERM_PROGRAM is vscode', async () => {
- process.argv = ['node', 'script.js'];
- const argv = await parseArguments();
- process.env.TERM_PROGRAM = 'vscode';
- process.env.GEMINI_CLI_IDE_SERVER_PORT = '3000';
- const settings: Settings = { ideMode: true };
- const config = await loadCliConfig(settings, [], 'test-session', argv);
- expect(config.getIdeMode()).toBe(true);
- });
-
- it('should prioritize --ide-mode (true) over settings (false) when TERM_PROGRAM is vscode', async () => {
- process.argv = ['node', 'script.js', '--ide-mode'];
- const argv = await parseArguments();
- process.env.TERM_PROGRAM = 'vscode';
- process.env.GEMINI_CLI_IDE_SERVER_PORT = '3000';
- const settings: Settings = { ideMode: false };
- const config = await loadCliConfig(settings, [], 'test-session', argv);
- expect(config.getIdeMode()).toBe(true);
- });
-
- it('should prioritize --no-ide-mode (false) over settings (true) even when TERM_PROGRAM is vscode', async () => {
- process.argv = ['node', 'script.js', '--no-ide-mode'];
- const argv = await parseArguments();
- process.env.TERM_PROGRAM = 'vscode';
- const settings: Settings = { ideMode: true };
- const config = await loadCliConfig(settings, [], 'test-session', argv);
- expect(config.getIdeMode()).toBe(false);
- });
-
- it('should be false when --ide-mode is true, TERM_PROGRAM is vscode, but SANDBOX is set', async () => {
- process.argv = ['node', 'script.js', '--ide-mode'];
- const argv = await parseArguments();
- process.env.TERM_PROGRAM = 'vscode';
- process.env.SANDBOX = 'true';
- const settings: Settings = {};
- const config = await loadCliConfig(settings, [], 'test-session', argv);
- expect(config.getIdeMode()).toBe(false);
- });
-
- it('should be false when settings.ideMode is true, TERM_PROGRAM is vscode, but SANDBOX is set', async () => {
+ it('should be false when settings.ideMode is true, but SANDBOX is set', async () => {
process.argv = ['node', 'script.js'];
const argv = await parseArguments();
process.env.TERM_PROGRAM = 'vscode';
diff --git a/packages/cli/src/config/config.ts b/packages/cli/src/config/config.ts
index 1dd8519c..1cc78888 100644
--- a/packages/cli/src/config/config.ts
+++ b/packages/cli/src/config/config.ts
@@ -269,14 +269,9 @@ export async function loadCliConfig(
);
const ideMode =
- (argv.ideMode ?? settings.ideMode ?? false) &&
- process.env.TERM_PROGRAM === 'vscode' &&
- !process.env.SANDBOX;
+ (argv.ideMode ?? settings.ideMode ?? false) && !process.env.SANDBOX;
- let ideClient: IdeClient | undefined;
- if (ideMode) {
- ideClient = new IdeClient();
- }
+ const ideClient = IdeClient.getInstance(ideMode);
const allExtensions = annotateActiveExtensions(
extensions,
diff --git a/packages/cli/src/ui/App.tsx b/packages/cli/src/ui/App.tsx
index 7ac6936c..2e899cc1 100644
--- a/packages/cli/src/ui/App.tsx
+++ b/packages/cli/src/ui/App.tsx
@@ -967,7 +967,12 @@ const App = ({ config, settings, startupWarnings = [], version }: AppProps) => {
</Box>
</Box>
{showIDEContextDetail && (
- <IDEContextDetailDisplay ideContext={ideContextState} />
+ <IDEContextDetailDisplay
+ ideContext={ideContextState}
+ detectedIdeDisplay={config
+ .getIdeClient()
+ .getDetectedIdeDisplayName()}
+ />
)}
{showErrorDetails && (
<OverflowProvider>
diff --git a/packages/cli/src/ui/commands/ideCommand.test.ts b/packages/cli/src/ui/commands/ideCommand.test.ts
index d1d72466..3c73f52c 100644
--- a/packages/cli/src/ui/commands/ideCommand.test.ts
+++ b/packages/cli/src/ui/commands/ideCommand.test.ts
@@ -15,24 +15,16 @@ import {
} from 'vitest';
import { ideCommand } from './ideCommand.js';
import { type CommandContext } from './types.js';
-import { type Config } from '@google/gemini-cli-core';
-import * as child_process from 'child_process';
-import { glob } from 'glob';
-
-import { IDEConnectionStatus } from '@google/gemini-cli-core/index.js';
+import { type Config, DetectedIde } from '@google/gemini-cli-core';
+import * as core from '@google/gemini-cli-core';
vi.mock('child_process');
vi.mock('glob');
-
-function regexEscape(value: string) {
- return value.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
-}
+vi.mock('@google/gemini-cli-core');
describe('ideCommand', () => {
let mockContext: CommandContext;
let mockConfig: Config;
- let execSyncSpy: MockInstance;
- let globSyncSpy: MockInstance;
let platformSpy: MockInstance;
beforeEach(() => {
@@ -47,8 +39,6 @@ describe('ideCommand', () => {
getIdeClient: vi.fn(),
} as unknown as Config;
- execSyncSpy = vi.spyOn(child_process, 'execSync');
- globSyncSpy = vi.spyOn(glob, 'sync');
platformSpy = vi.spyOn(process, 'platform', 'get');
});
@@ -64,6 +54,9 @@ describe('ideCommand', () => {
it('should return the ide command if ideMode is enabled', () => {
vi.mocked(mockConfig.getIdeMode).mockReturnValue(true);
+ vi.mocked(mockConfig.getIdeClient).mockReturnValue({
+ getCurrentIde: () => DetectedIde.VSCode,
+ } as ReturnType<Config['getIdeClient']>);
const command = ideCommand(mockConfig);
expect(command).not.toBeNull();
expect(command?.name).toBe('ide');
@@ -78,12 +71,13 @@ describe('ideCommand', () => {
vi.mocked(mockConfig.getIdeMode).mockReturnValue(true);
vi.mocked(mockConfig.getIdeClient).mockReturnValue({
getConnectionStatus: mockGetConnectionStatus,
+ getCurrentIde: () => DetectedIde.VSCode,
} as ReturnType<Config['getIdeClient']>);
});
it('should show connected status', () => {
mockGetConnectionStatus.mockReturnValue({
- status: IDEConnectionStatus.Connected,
+ status: core.IDEConnectionStatus.Connected,
});
const command = ideCommand(mockConfig);
const result = command!.subCommands![0].action!(mockContext, '');
@@ -97,7 +91,7 @@ describe('ideCommand', () => {
it('should show connecting status', () => {
mockGetConnectionStatus.mockReturnValue({
- status: IDEConnectionStatus.Connecting,
+ status: core.IDEConnectionStatus.Connecting,
});
const command = ideCommand(mockConfig);
const result = command!.subCommands![0].action!(mockContext, '');
@@ -110,7 +104,7 @@ describe('ideCommand', () => {
});
it('should show disconnected status', () => {
mockGetConnectionStatus.mockReturnValue({
- status: IDEConnectionStatus.Disconnected,
+ status: core.IDEConnectionStatus.Disconnected,
});
const command = ideCommand(mockConfig);
const result = command!.subCommands![0].action!(mockContext, '');
@@ -125,7 +119,7 @@ describe('ideCommand', () => {
it('should show disconnected status with details', () => {
const details = 'Something went wrong';
mockGetConnectionStatus.mockReturnValue({
- status: IDEConnectionStatus.Disconnected,
+ status: core.IDEConnectionStatus.Disconnected,
details,
});
const command = ideCommand(mockConfig);
@@ -140,128 +134,68 @@ describe('ideCommand', () => {
});
describe('install subcommand', () => {
+ const mockInstall = vi.fn();
beforeEach(() => {
vi.mocked(mockConfig.getIdeMode).mockReturnValue(true);
+ vi.mocked(mockConfig.getIdeClient).mockReturnValue({
+ getCurrentIde: () => DetectedIde.VSCode,
+ } as ReturnType<Config['getIdeClient']>);
+ vi.mocked(core.getIdeInstaller).mockReturnValue({
+ install: mockInstall,
+ isInstalled: vi.fn(),
+ });
platformSpy.mockReturnValue('linux');
});
- it('should show an error if VSCode is not installed', async () => {
- execSyncSpy.mockImplementation(() => {
- throw new Error('Command not found');
+ it('should install the extension', async () => {
+ mockInstall.mockResolvedValue({
+ success: true,
+ message: 'Successfully installed.',
});
const command = ideCommand(mockConfig);
-
- await command!.subCommands![1].action!(mockContext, '');
- expect(mockContext.ui.addItem).toHaveBeenCalledWith(
- expect.objectContaining({
- type: 'error',
- text: expect.stringMatching(/VS Code command-line tool .* not found/),
- }),
- expect.any(Number),
- );
- });
-
- it('should show an error if the VSIX file is not found', async () => {
- execSyncSpy.mockReturnValue(''); // VSCode is installed
- globSyncSpy.mockReturnValue([]); // No .vsix file found
-
- const command = ideCommand(mockConfig);
await command!.subCommands![1].action!(mockContext, '');
- expect(mockContext.ui.addItem).toHaveBeenCalledWith(
- expect.objectContaining({
- type: 'error',
- text: 'Could not find the required VS Code companion extension. Please file a bug via /bug.',
- }),
- expect.any(Number),
- );
- });
-
- it('should install the extension if found in the bundle directory', async () => {
- const vsixPath = '/path/to/bundle/gemini.vsix';
- execSyncSpy.mockReturnValue(''); // VSCode is installed
- globSyncSpy.mockReturnValue([vsixPath]); // Found .vsix file
-
- const command = ideCommand(mockConfig);
- await command!.subCommands![1].action!(mockContext, '');
-
- expect(globSyncSpy).toHaveBeenCalledWith(
- expect.stringContaining('.vsix'),
- );
- expect(execSyncSpy).toHaveBeenCalledWith(
- expect.stringMatching(
- new RegExp(
- `code(.cmd)? --install-extension ${regexEscape(vsixPath)} --force`,
- ),
- ),
- { stdio: 'pipe' },
- );
+ expect(core.getIdeInstaller).toHaveBeenCalledWith('vscode');
+ expect(mockInstall).toHaveBeenCalled();
expect(mockContext.ui.addItem).toHaveBeenCalledWith(
expect.objectContaining({
type: 'info',
- text: `Installing VS Code companion extension...`,
+ text: `Installing IDE companion extension...`,
}),
expect.any(Number),
);
expect(mockContext.ui.addItem).toHaveBeenCalledWith(
expect.objectContaining({
type: 'info',
- text: 'VS Code companion extension installed successfully. Restart gemini-cli in a fresh terminal window.',
+ text: 'Successfully installed.',
}),
expect.any(Number),
);
});
- it('should install the extension if found in the dev directory', async () => {
- const vsixPath = '/path/to/dev/gemini.vsix';
- execSyncSpy.mockReturnValue(''); // VSCode is installed
- // First glob call for bundle returns nothing, second for dev returns path.
- globSyncSpy.mockReturnValueOnce([]).mockReturnValueOnce([vsixPath]);
+ it('should show an error if installation fails', async () => {
+ mockInstall.mockResolvedValue({
+ success: false,
+ message: 'Installation failed.',
+ });
const command = ideCommand(mockConfig);
await command!.subCommands![1].action!(mockContext, '');
- expect(globSyncSpy).toHaveBeenCalledTimes(2);
- expect(execSyncSpy).toHaveBeenCalledWith(
- expect.stringMatching(
- new RegExp(
- `code(.cmd)? --install-extension ${regexEscape(vsixPath)} --force`,
- ),
- ),
- { stdio: 'pipe' },
- );
+ expect(core.getIdeInstaller).toHaveBeenCalledWith('vscode');
+ expect(mockInstall).toHaveBeenCalled();
expect(mockContext.ui.addItem).toHaveBeenCalledWith(
expect.objectContaining({
type: 'info',
- text: 'VS Code companion extension installed successfully. Restart gemini-cli in a fresh terminal window.',
+ text: `Installing IDE companion extension...`,
}),
expect.any(Number),
);
- });
-
- it('should show an error if installation fails', async () => {
- const vsixPath = '/path/to/bundle/gemini.vsix';
- const errorMessage = 'Installation failed';
- execSyncSpy
- .mockReturnValueOnce('') // VSCode is installed check
- .mockImplementation(() => {
- // Installation command
- const error: Error & { stderr?: Buffer } = new Error(
- 'Command failed',
- );
- error.stderr = Buffer.from(errorMessage);
- throw error;
- });
- globSyncSpy.mockReturnValue([vsixPath]);
-
- const command = ideCommand(mockConfig);
- await command!.subCommands![1].action!(mockContext, '');
-
expect(mockContext.ui.addItem).toHaveBeenCalledWith(
expect.objectContaining({
type: 'error',
- text: `Failed to install VS Code companion extension.`,
+ text: 'Installation failed.',
}),
expect.any(Number),
);
diff --git a/packages/cli/src/ui/commands/ideCommand.ts b/packages/cli/src/ui/commands/ideCommand.ts
index 31f2371f..26b0f57d 100644
--- a/packages/cli/src/ui/commands/ideCommand.ts
+++ b/packages/cli/src/ui/commands/ideCommand.ts
@@ -4,40 +4,29 @@
* SPDX-License-Identifier: Apache-2.0
*/
-import { fileURLToPath } from 'url';
-import { Config, IDEConnectionStatus } from '@google/gemini-cli-core';
+import {
+ Config,
+ getIdeDisplayName,
+ getIdeInstaller,
+ IDEConnectionStatus,
+} from '@google/gemini-cli-core';
import {
CommandContext,
SlashCommand,
SlashCommandActionReturn,
CommandKind,
} from './types.js';
-import * as child_process from 'child_process';
-import * as process from 'process';
-import { glob } from 'glob';
-import * as path from 'path';
-
-const VSCODE_COMMAND = process.platform === 'win32' ? 'code.cmd' : 'code';
-const VSCODE_COMPANION_EXTENSION_FOLDER = 'vscode-ide-companion';
-
-function isVSCodeInstalled(): boolean {
- try {
- child_process.execSync(
- process.platform === 'win32'
- ? `where.exe ${VSCODE_COMMAND}`
- : `command -v ${VSCODE_COMMAND}`,
- { stdio: 'ignore' },
- );
- return true;
- } catch {
- return false;
- }
-}
export const ideCommand = (config: Config | null): SlashCommand | null => {
if (!config?.getIdeMode()) {
return null;
}
+ const currentIDE = config.getIdeClient().getCurrentIde();
+ if (!currentIDE) {
+ throw new Error(
+ 'IDE slash command should not be available if not running in an IDE',
+ );
+ }
return {
name: 'ide',
@@ -49,7 +38,7 @@ export const ideCommand = (config: Config | null): SlashCommand | null => {
description: 'check status of IDE integration',
kind: CommandKind.BUILT_IN,
action: (_context: CommandContext): SlashCommandActionReturn => {
- const connection = config.getIdeClient()?.getConnectionStatus();
+ const connection = config.getIdeClient().getConnectionStatus();
switch (connection?.status) {
case IDEConnectionStatus.Connected:
return {
@@ -79,77 +68,37 @@ export const ideCommand = (config: Config | null): SlashCommand | null => {
},
{
name: 'install',
- description: 'install required VS Code companion extension',
+ description: `install required IDE companion ${getIdeDisplayName(currentIDE)} extension `,
kind: CommandKind.BUILT_IN,
action: async (context) => {
- if (!isVSCodeInstalled()) {
- context.ui.addItem(
- {
- type: 'error',
- text: `VS Code command-line tool "${VSCODE_COMMAND}" not found in your PATH.`,
- },
- Date.now(),
- );
- return;
- }
-
- const bundleDir = path.dirname(fileURLToPath(import.meta.url));
- // The VSIX file is copied to the bundle directory as part of the build.
- let vsixFiles = glob.sync(path.join(bundleDir, '*.vsix'));
- if (vsixFiles.length === 0) {
- // If the VSIX file is not in the bundle, it might be a dev
- // environment running with `npm start`. Look for it in the original
- // package location, relative to the bundle dir.
- const devPath = path.join(
- bundleDir,
- '..',
- '..',
- '..',
- '..',
- '..',
- VSCODE_COMPANION_EXTENSION_FOLDER,
- '*.vsix',
- );
- vsixFiles = glob.sync(devPath);
- }
- if (vsixFiles.length === 0) {
+ const installer = getIdeInstaller(currentIDE);
+ if (!installer) {
context.ui.addItem(
{
type: 'error',
- text: 'Could not find the required VS Code companion extension. Please file a bug via /bug.',
+ text: 'No installer available for your configured IDE.',
},
Date.now(),
);
return;
}
- const vsixPath = vsixFiles[0];
- const command = `${VSCODE_COMMAND} --install-extension ${vsixPath} --force`;
context.ui.addItem(
{
type: 'info',
- text: `Installing VS Code companion extension...`,
+ text: `Installing IDE companion extension...`,
+ },
+ Date.now(),
+ );
+
+ const result = await installer.install();
+ context.ui.addItem(
+ {
+ type: result.success ? 'info' : 'error',
+ text: result.message,
},
Date.now(),
);
- try {
- child_process.execSync(command, { stdio: 'pipe' });
- context.ui.addItem(
- {
- type: 'info',
- text: 'VS Code companion extension installed successfully. Restart gemini-cli in a fresh terminal window.',
- },
- Date.now(),
- );
- } catch (_error) {
- context.ui.addItem(
- {
- type: 'error',
- text: `Failed to install VS Code companion extension.`,
- },
- Date.now(),
- );
- }
},
},
],
diff --git a/packages/cli/src/ui/components/IDEContextDetailDisplay.tsx b/packages/cli/src/ui/components/IDEContextDetailDisplay.tsx
index f535c40a..a1739227 100644
--- a/packages/cli/src/ui/components/IDEContextDetailDisplay.tsx
+++ b/packages/cli/src/ui/components/IDEContextDetailDisplay.tsx
@@ -4,17 +4,19 @@
* SPDX-License-Identifier: Apache-2.0
*/
-import { Box, Text } from 'ink';
import { type File, type IdeContext } from '@google/gemini-cli-core';
-import { Colors } from '../colors.js';
+import { Box, Text } from 'ink';
import path from 'node:path';
+import { Colors } from '../colors.js';
interface IDEContextDetailDisplayProps {
ideContext: IdeContext | undefined;
+ detectedIdeDisplay: string | undefined;
}
export function IDEContextDetailDisplay({
ideContext,
+ detectedIdeDisplay,
}: IDEContextDetailDisplayProps) {
const openFiles = ideContext?.workspaceState?.openFiles;
if (!openFiles || openFiles.length === 0) {
@@ -30,7 +32,8 @@ export function IDEContextDetailDisplay({
paddingX={1}
>
<Text color={Colors.AccentCyan} bold>
- IDE Context (ctrl+e to toggle)
+ {detectedIdeDisplay ? detectedIdeDisplay : 'IDE'} Context (ctrl+e to
+ toggle)
</Text>
{openFiles.length > 0 && (
<Box flexDirection="column" marginTop={1}>
diff --git a/packages/cli/src/ui/hooks/slashCommandProcessor.test.ts b/packages/cli/src/ui/hooks/slashCommandProcessor.test.ts
index 30a14815..2dc206d7 100644
--- a/packages/cli/src/ui/hooks/slashCommandProcessor.test.ts
+++ b/packages/cli/src/ui/hooks/slashCommandProcessor.test.ts
@@ -16,6 +16,7 @@ vi.mock('@google/gemini-cli-core', async (importOriginal) => {
...original,
logSlashCommand,
SlashCommandEvent,
+ getIdeInstaller: vi.fn().mockReturnValue(null),
};
});
@@ -23,11 +24,16 @@ const { mockProcessExit } = vi.hoisted(() => ({
mockProcessExit: vi.fn((_code?: number): never => undefined as never),
}));
-vi.mock('node:process', () => ({
- default: {
+vi.mock('node:process', () => {
+ const mockProcess = {
exit: mockProcessExit,
- },
-}));
+ platform: 'test-platform',
+ };
+ return {
+ ...mockProcess,
+ default: mockProcess,
+ };
+});
const mockBuiltinLoadCommands = vi.fn();
vi.mock('../../services/BuiltinCommandLoader.js', () => ({
generated by cgit v1.2.3 (git 2.51.0) at 2025-11-19 11:24:17 +0000