Skip to content

improve clang-tidy output for multi-line progress mode#7038

Merged
waruqi merged 2 commits intodevfrom
progress
Nov 19, 2025
Merged

improve clang-tidy output for multi-line progress mode#7038
waruqi merged 2 commits intodevfrom
progress

Conversation

@waruqi
Copy link
Member

@waruqi waruqi commented Nov 19, 2025

  • Before adding new features and new modules, please go to issues to submit the relevant feature description first.
  • Write good commit messages and use the same coding conventions as the rest of the project.
  • Please commit code to dev branch and we will merge into master branch in feature
  • Ensure your edited codes with four spaces instead of TAB.

  • 增加新特性和新模块之前,请先到issues提交相关特性说明,经过讨论评估确认后,再进行相应的代码提交,避免做无用工作。
  • 编写友好可读的提交信息,并使用与工程代码相同的代码规范,代码请用4个空格字符代替tab缩进。
  • 请提交代码到dev分支,如果通过,我们会在特定时间合并到master分支上。
  • 为了规范化提交日志的格式,commit消息,不要用中文,请用英文描述。

@waruqi waruqi added this to the v3.0.5 milestone Nov 19, 2025
@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @waruqi, 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 significantly enhances the user experience of the clang-tidy checker within Xmake by improving how its output and errors are presented. The changes centralize the execution and reporting logic for clang-tidy, leading to clearer, more actionable feedback during code analysis and a more robust handling of analysis failures.

Highlights

  • Refactored Clang-Tidy Execution: The logic for running clang-tidy on individual source files has been extracted into a new private function, _check_sourcefile, improving modularity and maintainability.
  • Enhanced Error Handling: The _check_sourcefile function now uses a try-catch-finally block to robustly handle clang-tidy execution, capturing both standard output and error streams, and managing non-zero exit codes.
  • Improved Output Presentation: Error and warning messages from clang-tidy are now displayed with distinct color formatting using progress.show_output, making it easier to identify issues in the build log.
  • Switched Execution Method: The clang-tidy command is now executed using os.iorunv instead of os.execv, which allows for better capture and processing of the tool's output and error streams.
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.

@waruqi waruqi changed the title improve clang-tidy output improve clang-tidy output for multi-line progress mode Nov 19, 2025
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 refactors the clang-tidy checker to improve its output handling by introducing a new _check_sourcefile function. This function is intended to run clang-tidy on a single file and provide more structured output. While this is a good improvement, I've found a critical bug in the new function's implementation that will cause a runtime error. My review includes a suggested fix for this issue. Once addressed, this change will enhance the checker's usability.

Comment on lines +92 to +93
local outdata, errdata = os.iorunv(clang_tidy.program, opt.tidy_argv, {curdir = opt.projectdir})
return (outdata or "") .. (errdata or "")
Copy link
Contributor

Choose a reason for hiding this comment

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

critical

The os.iorunv function returns four values: ok, outdata, errdata, errors. In the current implementation, local outdata, errdata = os.iorunv(...) incorrectly assigns the boolean ok status to outdata and the stdout content to errdata. This will cause a runtime error on the next line when attempting to concatenate a boolean value with a string.

Additionally, the command's exit status is not checked, so failed clang-tidy runs would not be handled correctly.

To fix this, you should capture all return values from os.iorunv, check the ok status, and handle failures by raising an error. On success, you can then correctly process outdata and errdata.

            local ok, outdata, errdata, errors = os.iorunv(clang_tidy.program, opt.tidy_argv, {curdir = opt.projectdir})
            if not ok then
                raise({stdout = outdata, stderr = errdata, errors = errors})
            end
            return outdata, errdata

@waruqi waruqi merged commit f28284f into dev Nov 19, 2025
44 checks passed
@waruqi waruqi deleted the progress branch November 19, 2025 06:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant