Style slash command descriptions consistently (#11395)

This commit is contained in:
Tommaso Sciortino
2025-10-17 13:20:15 -07:00
committed by GitHub
parent 426d36146a
commit b4a405c684
28 changed files with 39 additions and 39 deletions

View File

@@ -77,7 +77,7 @@ describe('aboutCommand', () => {
it('should have the correct name and description', () => {
expect(aboutCommand.name).toBe('about');
expect(aboutCommand.description).toBe('show version info');
expect(aboutCommand.description).toBe('Show version info');
});
it('should call addItem with all version info', async () => {

View File

@@ -13,7 +13,7 @@ import { IdeClient } from '@google/gemini-cli-core';
export const aboutCommand: SlashCommand = {
name: 'about',
description: 'show version info',
description: 'Show version info',
kind: CommandKind.BUILT_IN,
action: async (context) => {
const osVersion = process.platform;

View File

@@ -31,6 +31,6 @@ describe('authCommand', () => {
it('should have the correct name and description', () => {
expect(authCommand.name).toBe('auth');
expect(authCommand.description).toBe('change the auth method');
expect(authCommand.description).toBe('Change the auth method');
});
});

View File

@@ -9,7 +9,7 @@ import { CommandKind } from './types.js';
export const authCommand: SlashCommand = {
name: 'auth',
description: 'change the auth method',
description: 'Change the auth method',
kind: CommandKind.BUILT_IN,
action: (_context, _args): OpenDialogActionReturn => ({
type: 'dialog',

View File

@@ -19,7 +19,7 @@ import { IdeClient, sessionId } from '@google/gemini-cli-core';
export const bugCommand: SlashCommand = {
name: 'bug',
description: 'submit a bug report',
description: 'Submit a bug report',
kind: CommandKind.BUILT_IN,
action: async (context: CommandContext, args?: string): Promise<void> => {
const bugDescription = (args || '').trim();

View File

@@ -83,7 +83,7 @@ describe('chatCommand', () => {
it('should have the correct main command definition', () => {
expect(chatCommand.name).toBe('chat');
expect(chatCommand.description).toBe('Manage conversation history.');
expect(chatCommand.description).toBe('Manage conversation history');
expect(chatCommand.subCommands).toHaveLength(5);
});

View File

@@ -357,7 +357,7 @@ const shareCommand: SlashCommand = {
export const chatCommand: SlashCommand = {
name: 'chat',
description: 'Manage conversation history.',
description: 'Manage conversation history',
kind: CommandKind.BUILT_IN,
subCommands: [
listCommand,

View File

@@ -10,7 +10,7 @@ import { CommandKind } from './types.js';
export const clearCommand: SlashCommand = {
name: 'clear',
description: 'clear the screen and conversation history',
description: 'Clear the screen and conversation history',
kind: CommandKind.BUILT_IN,
action: async (context, _args) => {
const geminiClient = context.services.config?.getGeminiClient();

View File

@@ -12,7 +12,7 @@ import { CommandKind } from './types.js';
export const compressCommand: SlashCommand = {
name: 'compress',
altNames: ['summarize'],
description: 'Compresses the context by replacing it with a summary.',
description: 'Compresses the context by replacing it with a summary',
kind: CommandKind.BUILT_IN,
action: async (context) => {
const { ui } = context;

View File

@@ -29,6 +29,6 @@ describe('corgiCommand', () => {
it('should have the correct name and description', () => {
expect(corgiCommand.name).toBe('corgi');
expect(corgiCommand.description).toBe('Toggles corgi mode.');
expect(corgiCommand.description).toBe('Toggles corgi mode');
});
});

View File

@@ -8,7 +8,7 @@ import { CommandKind, type SlashCommand } from './types.js';
export const corgiCommand: SlashCommand = {
name: 'corgi',
description: 'Toggles corgi mode.',
description: 'Toggles corgi mode',
hidden: true,
kind: CommandKind.BUILT_IN,
action: (context, _args) => {

View File

@@ -15,7 +15,7 @@ import { MessageType } from '../types.js';
export const docsCommand: SlashCommand = {
name: 'docs',
description: 'open full Gemini CLI documentation in your browser',
description: 'Open full Gemini CLI documentation in your browser',
kind: CommandKind.BUILT_IN,
action: async (context: CommandContext): Promise<void> => {
const docsUrl = 'https://goo.gle/gemini-cli-docs';

View File

@@ -25,6 +25,6 @@ describe('editorCommand', () => {
it('should have the correct name and description', () => {
expect(editorCommand.name).toBe('editor');
expect(editorCommand.description).toBe('set external editor preference');
expect(editorCommand.description).toBe('Set external editor preference');
});
});

View File

@@ -12,7 +12,7 @@ import {
export const editorCommand: SlashCommand = {
name: 'editor',
description: 'set external editor preference',
description: 'Set external editor preference',
kind: CommandKind.BUILT_IN,
action: (): OpenDialogActionReturn => ({
type: 'dialog',

View File

@@ -47,6 +47,6 @@ describe('helpCommand', () => {
it('should have the correct command properties', () => {
expect(helpCommand.name).toBe('help');
expect(helpCommand.kind).toBe(CommandKind.BUILT_IN);
expect(helpCommand.description).toBe('for help on gemini-cli');
expect(helpCommand.description).toBe('For help on gemini-cli');
});
});

View File

@@ -12,7 +12,7 @@ export const helpCommand: SlashCommand = {
name: 'help',
altNames: ['?'],
kind: CommandKind.BUILT_IN,
description: 'for help on gemini-cli',
description: 'For help on gemini-cli',
action: async (context) => {
const helpItem: Omit<HistoryItemHelp, 'id'> = {
type: MessageType.HELP,

View File

@@ -138,7 +138,7 @@ export const ideCommand = async (): Promise<SlashCommand> => {
if (!currentIDE) {
return {
name: 'ide',
description: 'manage IDE integration',
description: 'Manage IDE integration',
kind: CommandKind.BUILT_IN,
action: (): SlashCommandActionReturn =>
({
@@ -151,14 +151,14 @@ export const ideCommand = async (): Promise<SlashCommand> => {
const ideSlashCommand: SlashCommand = {
name: 'ide',
description: 'manage IDE integration',
description: 'Manage IDE integration',
kind: CommandKind.BUILT_IN,
subCommands: [],
};
const statusCommand: SlashCommand = {
name: 'status',
description: 'check status of IDE integration',
description: 'Check status of IDE integration',
kind: CommandKind.BUILT_IN,
action: async (): Promise<SlashCommandActionReturn> => {
const { messageType, content } =
@@ -173,7 +173,7 @@ export const ideCommand = async (): Promise<SlashCommand> => {
const installCommand: SlashCommand = {
name: 'install',
description: `install required IDE companion for ${ideClient.getDetectedIdeDisplayName()}`,
description: `Install required IDE companion for ${ideClient.getDetectedIdeDisplayName()}`,
kind: CommandKind.BUILT_IN,
action: async (context) => {
const installer = getIdeInstaller(currentIDE);
@@ -246,7 +246,7 @@ export const ideCommand = async (): Promise<SlashCommand> => {
const enableCommand: SlashCommand = {
name: 'enable',
description: 'enable IDE integration',
description: 'Enable IDE integration',
kind: CommandKind.BUILT_IN,
action: async (context: CommandContext) => {
context.services.settings.setValue(
@@ -268,7 +268,7 @@ export const ideCommand = async (): Promise<SlashCommand> => {
const disableCommand: SlashCommand = {
name: 'disable',
description: 'disable IDE integration',
description: 'Disable IDE integration',
kind: CommandKind.BUILT_IN,
action: async (context: CommandContext) => {
context.services.settings.setValue(

View File

@@ -15,7 +15,7 @@ import { CommandKind } from './types.js';
export const initCommand: SlashCommand = {
name: 'init',
description: 'Analyzes the project and creates a tailored GEMINI.md file.',
description: 'Analyzes the project and creates a tailored GEMINI.md file',
kind: CommandKind.BUILT_IN,
action: async (
context: CommandContext,

View File

@@ -285,7 +285,7 @@ const schemaCommand: SlashCommand = {
const refreshCommand: SlashCommand = {
name: 'refresh',
description: 'Restarts MCP servers.',
description: 'Restarts MCP servers',
kind: CommandKind.BUILT_IN,
action: async (
context: CommandContext,

View File

@@ -12,12 +12,12 @@ import { CommandKind } from './types.js';
export const memoryCommand: SlashCommand = {
name: 'memory',
description: 'Commands for interacting with memory.',
description: 'Commands for interacting with memory',
kind: CommandKind.BUILT_IN,
subCommands: [
{
name: 'show',
description: 'Show the current memory contents.',
description: 'Show the current memory contents',
kind: CommandKind.BUILT_IN,
action: async (context) => {
const memoryContent = context.services.config?.getUserMemory() || '';
@@ -39,7 +39,7 @@ export const memoryCommand: SlashCommand = {
},
{
name: 'add',
description: 'Add content to the memory.',
description: 'Add content to the memory',
kind: CommandKind.BUILT_IN,
action: (context, args): SlashCommandActionReturn | void => {
if (!args || args.trim() === '') {
@@ -67,7 +67,7 @@ export const memoryCommand: SlashCommand = {
},
{
name: 'refresh',
description: 'Refresh the memory from the source.',
description: 'Refresh the memory from the source',
kind: CommandKind.BUILT_IN,
action: async (context) => {
context.ui.addItem(
@@ -128,7 +128,7 @@ export const memoryCommand: SlashCommand = {
},
{
name: 'list',
description: 'Lists the paths of the GEMINI.md files in use.',
description: 'Lists the paths of the GEMINI.md files in use',
kind: CommandKind.BUILT_IN,
action: async (context) => {
const filePaths = context.services.config?.getGeminiMdFilePaths() || [];

View File

@@ -33,6 +33,6 @@ describe('privacyCommand', () => {
it('should have the correct name and description', () => {
expect(privacyCommand.name).toBe('privacy');
expect(privacyCommand.description).toBe('display the privacy notice');
expect(privacyCommand.description).toBe('Display the privacy notice');
});
});

View File

@@ -9,7 +9,7 @@ import { CommandKind } from './types.js';
export const privacyCommand: SlashCommand = {
name: 'privacy',
description: 'display the privacy notice',
description: 'Display the privacy notice',
kind: CommandKind.BUILT_IN,
action: (): OpenDialogActionReturn => ({
type: 'dialog',

View File

@@ -10,7 +10,7 @@ import { CommandKind, type SlashCommand } from './types.js';
export const quitCommand: SlashCommand = {
name: 'quit',
altNames: ['exit'],
description: 'exit the cli',
description: 'Exit the cli',
kind: CommandKind.BUILT_IN,
action: (context) => {
const now = Date.now();

View File

@@ -16,7 +16,7 @@ import {
export const statsCommand: SlashCommand = {
name: 'stats',
altNames: ['usage'],
description: 'check session stats. Usage: /stats [model|tools]',
description: 'Check session stats. Usage: /stats [model|tools]',
kind: CommandKind.BUILT_IN,
action: (context: CommandContext) => {
const now = new Date();
@@ -43,7 +43,7 @@ export const statsCommand: SlashCommand = {
subCommands: [
{
name: 'model',
description: 'Show model-specific usage statistics.',
description: 'Show model-specific usage statistics',
kind: CommandKind.BUILT_IN,
action: (context: CommandContext) => {
context.ui.addItem(
@@ -56,7 +56,7 @@ export const statsCommand: SlashCommand = {
},
{
name: 'tools',
description: 'Show tool-specific usage statistics.',
description: 'Show tool-specific usage statistics',
kind: CommandKind.BUILT_IN,
action: (context: CommandContext) => {
context.ui.addItem(

View File

@@ -33,6 +33,6 @@ describe('themeCommand', () => {
it('should have the correct name and description', () => {
expect(themeCommand.name).toBe('theme');
expect(themeCommand.description).toBe('change the theme');
expect(themeCommand.description).toBe('Change the theme');
});
});

View File

@@ -9,7 +9,7 @@ import { CommandKind } from './types.js';
export const themeCommand: SlashCommand = {
name: 'theme',
description: 'change the theme',
description: 'Change the theme',
kind: CommandKind.BUILT_IN,
action: (_context, _args): OpenDialogActionReturn => ({
type: 'dialog',

View File

@@ -13,7 +13,7 @@ import { MessageType, type HistoryItemToolsList } from '../types.js';
export const toolsCommand: SlashCommand = {
name: 'tools',
description: 'list available Gemini CLI tools. Usage: /tools [desc]',
description: 'List available Gemini CLI tools. Usage: /tools [desc]',
kind: CommandKind.BUILT_IN,
action: async (context: CommandContext, args?: string): Promise<void> => {
const subCommand = args?.trim();

View File

@@ -9,7 +9,7 @@ import { CommandKind } from './types.js';
export const vimCommand: SlashCommand = {
name: 'vim',
description: 'toggle vim mode on/off',
description: 'Toggle vim mode on/off',
kind: CommandKind.BUILT_IN,
action: async (context, _args) => {
const newVimState = await context.ui.toggleVimEnabled();