gemini-cli/packages/cli/src/ui/utils/highlight.test.ts

/**
 * @license
 * Copyright 2025 Google LLC
 * SPDX-License-Identifier: Apache-2.0
 */

import { describe, it, expect } from 'vitest';
import { parseInputForHighlighting } from './highlight.js';
import type { Transformation } from '../components/shared/text-buffer.js';

describe('parseInputForHighlighting', () => {
  it('should handle an empty string', () => {
    expect(parseInputForHighlighting('', 0)).toEqual([
      { text: '', type: 'default' },
    ]);
  });

  it('should handle text with no commands or files', () => {
    const text = 'this is a normal sentence';
    expect(parseInputForHighlighting(text, 0)).toEqual([
      { text, type: 'default' },
    ]);
  });

  it('should highlight a single command at the beginning when index is 0', () => {
    const text = '/help me';
    expect(parseInputForHighlighting(text, 0)).toEqual([
      { text: '/help', type: 'command' },
      { text: ' me', type: 'default' },
    ]);
  });

  it('should NOT highlight a command at the beginning when index is not 0', () => {
    const text = '/help me';
    expect(parseInputForHighlighting(text, 1)).toEqual([
      { text: '/help', type: 'default' },
      { text: ' me', type: 'default' },
    ]);
  });

  it('should highlight a single file path at the beginning', () => {
    const text = '@path/to/file.txt please';
    expect(parseInputForHighlighting(text, 0)).toEqual([
      { text: '@path/to/file.txt', type: 'file' },
      { text: ' please', type: 'default' },
    ]);
  });

  it('should not highlight a command in the middle', () => {
    const text = 'I need /help with this';
    expect(parseInputForHighlighting(text, 0)).toEqual([
      { text: 'I need /help with this', type: 'default' },
    ]);
  });

  it('should highlight a file path in the middle', () => {
    const text = 'Please check @path/to/file.txt for details';
    expect(parseInputForHighlighting(text, 0)).toEqual([
      { text: 'Please check ', type: 'default' },
      { text: '@path/to/file.txt', type: 'file' },
      { text: ' for details', type: 'default' },
    ]);
  });

  it('should highlight files but not commands not at the start', () => {
    const text = 'Use /run with @file.js and also /format @another/file.ts';
    expect(parseInputForHighlighting(text, 0)).toEqual([
      { text: 'Use /run with ', type: 'default' },
      { text: '@file.js', type: 'file' },
      { text: ' and also /format ', type: 'default' },
      { text: '@another/file.ts', type: 'file' },
    ]);
  });

  it('should handle adjacent highlights at start', () => {
    const text = '/run@file.js';
    expect(parseInputForHighlighting(text, 0)).toEqual([
      { text: '/run', type: 'command' },
      { text: '@file.js', type: 'file' },
    ]);
  });

  it('should not highlight command at the end of the string', () => {
    const text = 'Get help with /help';
    expect(parseInputForHighlighting(text, 0)).toEqual([
      { text: 'Get help with /help', type: 'default' },
    ]);
  });

  it('should handle file paths with dots and dashes', () => {
    const text = 'Check @./path-to/file-name.v2.txt';
    expect(parseInputForHighlighting(text, 0)).toEqual([
      { text: 'Check ', type: 'default' },
      { text: '@./path-to/file-name.v2.txt', type: 'file' },
    ]);
  });

  it('should not highlight command with dashes and numbers not at start', () => {
    const text = 'Run /command-123 now';
    expect(parseInputForHighlighting(text, 0)).toEqual([
      { text: 'Run /command-123 now', type: 'default' },
    ]);
  });

  it('should highlight command with dashes and numbers at start', () => {
    const text = '/command-123 now';
    expect(parseInputForHighlighting(text, 0)).toEqual([
      { text: '/command-123', type: 'command' },
      { text: ' now', type: 'default' },
    ]);
  });

  it('should still highlight a file path on a non-zero line', () => {
    const text = 'some text @path/to/file.txt';
    expect(parseInputForHighlighting(text, 1)).toEqual([
      { text: 'some text ', type: 'default' },
      { text: '@path/to/file.txt', type: 'file' },
    ]);
  });

  it('should not highlight command but highlight file on a non-zero line', () => {
    const text = '/cmd @file.txt';
    expect(parseInputForHighlighting(text, 2)).toEqual([
      { text: '/cmd', type: 'default' },
      { text: ' ', type: 'default' },
      { text: '@file.txt', type: 'file' },
    ]);
  });

  it('should highlight a file path with escaped spaces', () => {
    const text = 'cat @/my\\ path/file.txt';
    expect(parseInputForHighlighting(text, 0)).toEqual([
      { text: 'cat ', type: 'default' },
      { text: '@/my\\ path/file.txt', type: 'file' },
    ]);
  });
});

describe('parseInputForHighlighting with Transformations', () => {
  const transformations: Transformation[] = [
    {
      logStart: 10,
      logEnd: 19,
      logicalText: '@test.png',
      collapsedText: '[Image test.png]',
      type: 'image',
    },
  ];

  it('should show collapsed transformation when cursor is not on it', () => {
    const line = 'Check out @test.png';
    const result = parseInputForHighlighting(
      line,
      0, // line index
      transformations,
      0, // cursor not on transformation
    );

    expect(result).toEqual([
      { text: 'Check out ', type: 'default' },
      { text: '[Image test.png]', type: 'file' },
    ]);
  });

  it('should show expanded transformation when cursor is on it', () => {
    const line = 'Check out @test.png';
    const result = parseInputForHighlighting(
      line,
      0, // line index
      transformations,
      11, // cursor on transformation
    );

    expect(result).toEqual([
      { text: 'Check out ', type: 'default' },
      { text: '@test.png', type: 'file' },
    ]);
  });

  it('should handle multiple transformations in a line', () => {
    const line = 'Images: @test1.png and @test2.png';
    const multiTransformations: Transformation[] = [
      {
        logStart: 8,
        logEnd: 18,
        logicalText: '@test1.png',
        collapsedText: '[Image test1.png]',
        type: 'image',
      },
      {
        logStart: 23,
        logEnd: 33,
        logicalText: '@test2.png',
        collapsedText: '[Image test2.png]',
        type: 'image',
      },
    ];

    // Cursor not on any transformation
    let result = parseInputForHighlighting(line, 0, multiTransformations, 0);
    expect(result).toEqual([
      { text: 'Images: ', type: 'default' },
      { text: '[Image test1.png]', type: 'file' },
      { text: ' and ', type: 'default' },
      { text: '[Image test2.png]', type: 'file' },
    ]);

    // Cursor on first transformation
    result = parseInputForHighlighting(line, 0, multiTransformations, 10);
    expect(result).toEqual([
      { text: 'Images: ', type: 'default' },
      { text: '@test1.png', type: 'file' },
      { text: ' and ', type: 'default' },
      { text: '[Image test2.png]', type: 'file' },
    ]);
  });

  it('should handle empty transformations array', () => {
    const line = 'Check out @test_no_transform.png';
    const result = parseInputForHighlighting(line, 0, [], 0);

    // Should fall back to default highlighting
    expect(result).toEqual([
      { text: 'Check out ', type: 'default' },
      { text: '@test_no_transform.png', type: 'file' },
    ]);
  });

  it('should handle cursor at transformation boundaries', () => {
    const line = 'Check out @test.png';
    const result = parseInputForHighlighting(
      line,
      0,
      transformations,
      10, // cursor at start of transformation
    );

    expect(result[1]).toEqual({ text: '@test.png', type: 'file' });
  });
});