Add --no-emoji option to disable emoji characters in console output #1635

paulr34 · 2025-08-05T18:41:49Z

Added emoji-util.js utility for conditional emoji formatting
Updated args.js to include --no-emoji command line option
Modified script-util.js to use formatMessage() for all emoji output
Updated startup.js to use emoji utility
Added documentation and demo scripts
Resolves issues with stdout when piping to automation tools
Python no longer chokes on emoji characters in output
Maintains backward compatibility (emojis enabled by default)

- Added emoji-util.js utility for conditional emoji formatting - Updated args.js to include --no-emoji command line option - Modified script-util.js to use formatMessage() for all emoji output - Updated startup.js to use emoji utility - Added documentation and demo scripts - Resolves issues with stdout when piping to automation tools - Python no longer chokes on emoji characters in output - Maintains backward compatibility (emojis enabled by default)

gemini-code-assist

Summary of Changes

Hello @paulr34, I'm Gemini Code Assist¹! 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!

I've implemented a new --no-emoji command-line option to disable emoji characters in console output. This change addresses issues where emojis could cause problems when piping output to automation tools or systems with limited character set support, such as Python scripts. By default, emojis remain enabled, ensuring backward compatibility while providing a clean text-only output option.

Highlights

New Command-Line Option: Added --no-emoji to allow users to disable emoji characters in console output.
Centralized Emoji Formatting: Introduced a new utility file, emoji-util.js, which provides a formatMessage function to conditionally include emojis based on the --no-emoji flag or NO_EMOJI environment variable.
Argument Parsing Integration: Updated args.js to recognize and process the --no-emoji command-line option, setting an internal environment variable.
Console Output Adaptation: Modified startup.js and script-util.js to utilize the new formatMessage utility for all console output that previously contained emojis, ensuring consistent behavior.
Documentation and Demos: Included comprehensive documentation in docs/no-emoji-implementation.md and demonstration scripts (demo-no-emoji.js, test-emoji.js) to illustrate the feature's usage and functionality.

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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

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 issue 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 or fill out our survey to provide feedback.

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.

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. ↩

gemini-code-assist

Code Review

This pull request introduces a valuable --no-emoji option to improve compatibility with automation tools. The core idea is well-implemented in emoji-util.js. However, there are several critical issues that need to be addressed. The changes in startup.js will cause a runtime error due to calling a non-existent function. The script-util.js file appears to be corrupted, likely from a merge conflict. Additionally, the new test file is broken and relies on functions that haven't been implemented, and the documentation is out of sync with the code. These issues must be fixed before this PR can be merged.

src-electron/main-process/startup.js

src-script/script-util.js

test-emoji.js

docs/no-emoji-implementation.md

…er to env.js

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

- Fixed corrupted license header in script-util.js - Standardized to use emojiUtil.formatMessage() in script files - Keep env.formatMessage() wrapper for startup.js compatibility - Both approaches work correctly for their respective module systems

- Fix broken emoji syntax in startup.js and gsdk-public-regen.js - Add emoji support to gsdk-public-regen.js and zap-package-metadata.js - Create fix-emojis.js utility script for systematic emoji conversion - All emojis now respect --no-emoji flag and NO_EMOJI environment variable

- Add emoji utility to zap-start.js and zap-uitest.js - Fix remaining hardcoded emojis in zap-start.js, zap-uitest.js, and gsdk-public-regen.js - All console output now respects --no-emoji flag and NO_EMOJI environment variable - Comprehensive solution ensures automation-friendly output for CI/CD pipelines

- Replace static constant with dynamic isEmojiDisabled() function - Add setEmojiDisabled() and resetEmojiState() for testing - Export testing functions through env.js wrapper - Fix test to use CommonJS emoji-util directly - Maintains environment variable and command line flag detection - Enables proper unit testing of emoji functionality

- Restore docs/api.md from commit 48de006 (before emoji changes) - File was accidentally truncated in commit 5f8ef3e due to JSDoc generation failure - JSDoc fails with Node.js v24 due to util.isRegExp compatibility issue - Restores all 28,406 lines of API documentation

- Remove redundant summary file - Documentation is already covered in docs/no-emoji-implementation.md

- Remove demo-no-emoji.js (was just a demonstration script) - Remove fix-emojis.js (was a utility script for development) - Keep only the production implementation files

- Remove duplicate formatMessage function from emoji-util.js - Keep single formatMessage implementation in env.js for general message formatting - Update all imports and function calls across codebase from emojiUtil.formatMessage to env.formatMessage - Maintain emoji-util.js focus on emoji state management only - Improve code organization by placing message formatting in general utilities module Fixes code duplication and follows best practices for single responsibility principle.

- Convert 42 'export function' declarations to regular functions - Convert 'export const environmentVariable' to regular const - Add all exports to module.exports object for CommonJS compatibility - Resolves CI failure caused by mixed ES/CommonJS module syntax - Maintains all existing functionality while fixing Node.js module loading

- Implement formatMessage logic directly instead of calling non-existent emojiUtil.formatMessage - Use emojiUtil.isEmojiDisabled() to check state and format accordingly - Resolves TypeError: emojiUtil.formatMessage is not a function

ethanzhouyc

Approved with comments

test-emoji.js

docs/no-emoji-implementation.md

src-electron/main-process/startup.js

src-electron/util/env.js

…ormatEmojiMessage - Fix corrupted emojis (� symbols) that appeared due to encoding issues during sed operations - Rename formatMessage() to formatEmojiMessage() for better semantic clarity - Restore proper Unicode emojis: 👈 for read operations, 👉 for write operations, 🔧 for processing - Update all 94+ function call sites across startup.js, script utilities, and tests - Verify emoji functionality works correctly with comprehensive test coverage - Remove obsolete test files and documentation per cleanup requirements Addresses feedback from PR review regarding function naming and emoji display issues.

Remove empty files that were created during development: - EMOJI_IMPLEMENTATION_SUMMARY.md - demo-no-emoji.js - fix-emojis.js These were temporary files that never got populated with content.

package-lock.json

src-electron/util/env.js

src-electron/util/args.js

test/emoji-util.test.js

package-lock.json

brdandu

Approving this but please clean up the PR before merging. Not sure if this is working with Studio. Leaving the testing part with you.

src-electron/main-process/startup.js

brdandu · 2025-08-26T19:23:10Z

src-electron/main-process/startup.js

      }
-      options.logger(`    👉 write out: ${upgrade_results}`)
+      options.logger(
+        env.formatEmojiMessage('🔧', `👉 write out: ${upgrade_results}`)


src-electron/main-process/startup.js

brdandu · 2025-08-26T19:31:43Z

src-electron/util/args.js

      type: 'boolean',
      deafult: false
    })
+    .option('noEmoji', {


why do we have 2 different formats?
noEmoji and no-emoji. very confused.

not seeing no-emoji here?

brdandu · 2025-08-26T19:32:54Z

src-electron/util/args.js


+  // Set emoji preference via environment variable
+  if (ret.noEmoji) {
+    process.env.NO_EMOJI = '1'


Best to use the noEmoji option coming from command args i.e. the uc_generate target from pack.json instead of doing a 2 step process of setting this as a environment.

src-electron/util/emoji-util.js

src-electron/util/env.js

codecov-commenter · 2025-08-27T19:51:08Z

Codecov Report

❌ Patch coverage is 82.66667% with 26 lines in your changes missing coverage. Please review.
✅ Project coverage is 66.90%. Comparing base (dc0747a) to head (43e6b24).
⚠️ Report is 48 commits behind head on master.

Files with missing lines	Patch %	Lines
src-electron/main-process/startup.js	60.78%	20 Missing ⚠️
src-electron/util/env.js	94.04%	5 Missing ⚠️
src-electron/util/args.js	50.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #1635      +/-   ##
==========================================
- Coverage   66.93%   66.90%   -0.03%     
==========================================
  Files         197      201       +4     
  Lines       21827    22794     +967     
  Branches     4817     5073     +256     
==========================================
+ Hits        14609    15250     +641     
- Misses       7218     7544     +326

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

paulr34 requested review from dhchandw and ethanzhouyc August 5, 2025 18:41

paulr34 requested review from brdandu and tecimovic as code owners August 5, 2025 18:41

gemini-code-assist bot reviewed Aug 5, 2025

View reviewed changes

src-electron/main-process/startup.js Show resolved Hide resolved

src-script/script-util.js Outdated Show resolved Hide resolved

test-emoji.js Outdated Show resolved Hide resolved

docs/no-emoji-implementation.md Outdated Show resolved Hide resolved

paulr34 and others added 12 commits August 5, 2025 16:00

Fix env.formatMessage() for startup.test.js - add emoji utility wrapp…

b0e14de

…er to env.js

Update src-script/script-util.js

759cdb3

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

Remove EMOJI_IMPLEMENTATION_SUMMARY.md

5570f2f

- Remove redundant summary file - Documentation is already covered in docs/no-emoji-implementation.md

Remove temporary development files

b78fe86

- Remove demo-no-emoji.js (was just a demonstration script) - Remove fix-emojis.js (was a utility script for development) - Keep only the production implementation files

Fix formatMessage implementation in env.js

aa54b12

- Implement formatMessage logic directly instead of calling non-existent emojiUtil.formatMessage - Use emojiUtil.isEmojiDisabled() to check state and format accordingly - Resolves TypeError: emojiUtil.formatMessage is not a function

ethanzhouyc approved these changes Aug 6, 2025

View reviewed changes

test-emoji.js Outdated Show resolved Hide resolved

docs/no-emoji-implementation.md Outdated Show resolved Hide resolved

src-electron/main-process/startup.js Show resolved Hide resolved

src-electron/util/env.js Outdated Show resolved Hide resolved

paulr34 added 2 commits August 6, 2025 16:12

Clean up empty development files

e68724d

Remove empty files that were created during development: - EMOJI_IMPLEMENTATION_SUMMARY.md - demo-no-emoji.js - fix-emojis.js These were temporary files that never got populated with content.

brdandu requested changes Aug 8, 2025

View reviewed changes

package-lock.json Show resolved Hide resolved

src-electron/util/env.js Show resolved Hide resolved

src-electron/util/args.js Show resolved Hide resolved

paulr34 force-pushed the no-emoji-option branch from 1e761d9 to e68724d Compare August 12, 2025 14:21

update apack.json

948611d

brdandu requested changes Aug 26, 2025

View reviewed changes

test/emoji-util.test.js Show resolved Hide resolved

package-lock.json Show resolved Hide resolved

remove package-lock.json

bc8e313

brdandu approved these changes Aug 26, 2025

View reviewed changes

paulr34 added 2 commits August 26, 2025 16:15

cleanup

538bca2

cleanup

fb5abd8

adding helper functions because they are needed for the tests

43e6b24

Add --no-emoji option to disable emoji characters in console output #1635

Are you sure you want to change the base?

Add --no-emoji option to disable emoji characters in console output #1635

Uh oh!

Conversation

paulr34 commented Aug 5, 2025

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Summary of Changes

Highlights

Footnotes

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ethanzhouyc left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

brdandu left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

brdandu Aug 26, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

brdandu Aug 26, 2025

Choose a reason for hiding this comment

Uh oh!

brdandu Aug 26, 2025

Choose a reason for hiding this comment

Uh oh!

brdandu Aug 26, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

codecov-commenter commented Aug 27, 2025

Codecov Report

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants