Skip to content

Fix code colorizer ansi escape bug.#21321

Merged
jacob314 merged 1 commit intomainfrom
fix_code_colorizer_escape
Mar 5, 2026
Merged

Fix code colorizer ansi escape bug.#21321
jacob314 merged 1 commit intomainfrom
fix_code_colorizer_escape

Conversation

@jacob314
Copy link
Contributor

@jacob314 jacob314 commented Mar 5, 2026

Summary

Fixes #21320

Done by Gemini with TDD. Before these fixes the background color would be red for the colorized code.

@jacob314 jacob314 requested a review from a team as a code owner March 5, 2026 21:30
@gemini-cli
Copy link
Contributor

gemini-cli bot commented Mar 5, 2026

Hi @jacob314, thank you so much for your contribution to Gemini CLI! We really appreciate the time and effort you've put into this.

We're making some updates to our contribution process to improve how we track and review changes. Please take a moment to review our recent discussion post: Improving Our Contribution Process & Introducing New Guidelines.

Key Update: Starting January 26, 2026, the Gemini CLI project will require all pull requests to be associated with an existing issue. Any pull requests not linked to an issue by that date will be automatically closed.

Thank you for your understanding and for being a part of our community!

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request addresses a bug in the code colorizer where ANSI escape codes present in the input code could "leak" and incorrectly color subsequent parts of the output. The changes introduce a mechanism to strip these escape codes before the code is highlighted and rendered, ensuring that only the intended syntax highlighting is applied. A new test case has been added to verify this fix.

Highlights

  • ANSI Escape Code Handling: Implemented stripping of ANSI escape codes from code lines before they are processed by the CodeColorizer, preventing color leakage and ensuring correct syntax highlighting.
  • Test Coverage: Added a new test case to CodeColorizer.test.tsx specifically to validate that ANSI escape codes do not interfere with the colorization process, along with corresponding SVG and Vitest snapshots.
Changelog
  • packages/cli/src/ui/utils/CodeColorizer.test.tsx
    • Added a new test case to verify that ANSI escape codes do not leak into colorized code.
  • packages/cli/src/ui/utils/CodeColorizer.tsx
    • Imported the strip-ansi utility.
    • Modified the highlightAndRenderLine function to strip ANSI escape codes from input lines before highlighting.
    • Updated the colorizeCode function to strip ANSI escape codes when rendering plain text lines.
  • packages/cli/src/ui/utils/snapshots/CodeColorizer-colorizeCode-does-not-let-colors-from-ansi-escape-codes-leak-into-colorized-code.snap.svg
    • Added a new SVG snapshot for the ANSI escape code leakage test.
  • packages/cli/src/ui/utils/snapshots/CodeColorizer.test.tsx.snap
    • Added a new Vitest snapshot for the ANSI escape code leakage test.
Activity
  • The pull request was opened by jacob314.
  • No additional comments or reviews have been posted yet.
  • The pre-merge checklist in the PR description remains unchecked.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request addresses a bug where ANSI escape codes were leaking colors into colorized code in the Gemini CLI. The changes include adding strip-ansi to remove these codes before highlighting and rendering the code, and a new test case to ensure that colors from ANSI escape codes do not leak into the colorized code, with a reminder for proper test cleanup using unmount.

Comment on lines +54 to +84
it('does not let colors from ansi escape codes leak into colorized code', async () => {
const code = 'line 1\n\x1b[41mline 2 with red background\x1b[0m\nline 3';
const settings = new LoadedSettings(
{ path: '', settings: {}, originalSettings: {} },
{ path: '', settings: {}, originalSettings: {} },
{
path: '',
settings: { ui: { useAlternateBuffer: true, showLineNumbers: false } },
originalSettings: {
ui: { useAlternateBuffer: true, showLineNumbers: false },
},
},
{ path: '', settings: {}, originalSettings: {} },
true,
[],
);

const result = colorizeCode({
code,
language: 'javascript',
maxWidth: 80,
settings,
hideLineNumbers: true,
});

const renderResult = renderWithProviders(<>{result}</>);
await renderResult.waitUntilReady();

await expect(renderResult).toMatchSvgSnapshot();
renderResult.unmount();
});
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

high

This test case verifies that ANSI escape codes do not leak colors into the colorized code. It uses a snapshot test to compare the rendered output with a pre-defined snapshot. Ensure that the snapshot is updated whenever the rendering logic changes. Additionally, when using renderWithProviders, the returned unmount function must be called at the end of the test for proper cleanup.

  it('does not let colors from ansi escape codes leak into colorized code', async () => {
    const code = 'line 1\n\x1b[41mline 2 with red background\x1b[0m\nline 3';
    const settings = new LoadedSettings(
      { path: '', settings: {}, originalSettings: {} },
      { path: '', settings: {}, originalSettings: {} },
      {
        path: '',
        settings: { ui: { useAlternateBuffer: true, showLineNumbers: false } },
        originalSettings: {
          ui: { useAlternateBuffer: true, showLineNumbers: false },
        },
      },
      { path: '', settings: {}, originalSettings: {} },
      true,
      [],
    );

    const result = colorizeCode({
      code,
      language: 'javascript',
      maxWidth: 80,
      settings,
      hideLineNumbers: true,
    });

    const renderResult = renderWithProviders(<>{
    result
  }</>);
    await renderResult.waitUntilReady();

    await expect(renderResult).toMatchSvgSnapshot();
    renderResult.unmount();
  });
References
  1. When using renderWithProviders in tests, the returned unmount function must be called at the end of the test to ensure proper cleanup and prevent resource leaks.

@jacob314 jacob314 enabled auto-merge March 5, 2026 21:33
@github-actions
Copy link

github-actions bot commented Mar 5, 2026

Size Change: +153 B (0%)

Total Size: 26 MB

ℹ️ View Unchanged
Filename Size Change
./bundle/gemini.js 25.5 MB +153 B (0%)
./bundle/node_modules/@google/gemini-cli-devtools/dist/client/main.js 221 kB 0 B
./bundle/node_modules/@google/gemini-cli-devtools/dist/src/_client-assets.js 227 kB 0 B
./bundle/node_modules/@google/gemini-cli-devtools/dist/src/index.js 11.5 kB 0 B
./bundle/node_modules/@google/gemini-cli-devtools/dist/src/types.js 132 B 0 B
./bundle/sandbox-macos-permissive-open.sb 890 B 0 B
./bundle/sandbox-macos-permissive-proxied.sb 1.31 kB 0 B
./bundle/sandbox-macos-restrictive-open.sb 3.36 kB 0 B
./bundle/sandbox-macos-restrictive-proxied.sb 3.56 kB 0 B
./bundle/sandbox-macos-strict-open.sb 4.82 kB 0 B
./bundle/sandbox-macos-strict-proxied.sb 5.02 kB 0 B

compressed-size-action

@jacob314 jacob314 added this pull request to the merge queue Mar 5, 2026
@gemini-cli gemini-cli bot added area/core Issues related to User Interface, OS Support, Core Functionality 🔒 maintainer only ⛔ Do not contribute. Internal roadmap item. labels Mar 5, 2026
Merged via the queue into main with commit e8bc7be Mar 5, 2026
31 checks passed
@jacob314 jacob314 deleted the fix_code_colorizer_escape branch March 5, 2026 21:58
struckoff pushed a commit to struckoff/gemini-cli that referenced this pull request Mar 6, 2026
kunal-10-cloud pushed a commit to kunal-10-cloud/gemini-cli that referenced this pull request Mar 12, 2026
liamhelmer pushed a commit to badal-io/gemini-cli that referenced this pull request Mar 12, 2026
yashodipmore pushed a commit to yashodipmore/geemi-cli that referenced this pull request Mar 21, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/core Issues related to User Interface, OS Support, Core Functionality 🔒 maintainer only ⛔ Do not contribute. Internal roadmap item.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

codeColorizer doesn't ascii escape

2 participants