Skip to content

[tool] tools/targets/vsc.py : improve compile_commands handling and w…#11138

Merged
supperthomas merged 1 commit intoRT-Thread:masterfrom
illustriousness:fix/vsc
Jan 19, 2026
Merged

[tool] tools/targets/vsc.py : improve compile_commands handling and w…#11138
supperthomas merged 1 commit intoRT-Thread:masterfrom
illustriousness:fix/vsc

Conversation

@illustriousness
Copy link
Contributor

@illustriousness illustriousness commented Jan 16, 2026

拉取/合并请求描述：(PR description)

为什么提交这份PR (why to submit this PR)

  • 优化 vsc workspace 生成逻辑，避免 clangd 路径不准确，并提升源文件/排除目录识别的覆盖范
    围。

你的解决方案是什么 (what is your solution)

  • 扩展源码后缀识别，支持 C++/ASM
  • 统一解析 compile_commands.json 绝对路径，并传递其目录给 clangd
  • 限定排除扫描范围到 rt-thread/packages，同时强制包含 board/linker_scripts

并确认并列出已经在什么情况或板卡上进行了测试。

  • qemu a9 使用dist 导出后的工程

当前拉取/合并请求的状态 Intent for your PR

必须选择一项 Choose one (Mandatory):

  • 本拉取/合并请求是一个草稿版本 This PR is for a code-review and is intended to get feedback
  • 本拉取/合并请求是一个成熟版本 This PR is mature, and ready to be integrated into the repo

代码质量 Code Quality：

我在这个拉取/合并请求中已经考虑了 As part of this pull request, I've considered the following:

  • 已经仔细查看过代码改动的对比 Already check the difference between PR and old code
  • 代码风格正确，包括缩进空格，命名及其他风格 Style guide is adhered to, including spacing, naming and other styles
  • 没有垃圾代码，代码尽量精简，不包含#if 0代码，不包含已经被注释了的代码 All redundant code is removed and cleaned up
  • 所有变更均有原因及合理的，并且不会影响到其他软件组件代码或BSP All modifications are justified and not affect other components or BSP
  • 对难懂代码均提供对应的注释 I've commented appropriately where code is tricky
  • 代码是高质量的 Code in this PR is of high quality
  • 已经使用formatting 等源码格式化工具确保格式符合RT-Thread代码规范 This PR complies with RT-Thread code specification
  • 如果是新增bsp, 已经添加ci检查到.github/ALL_BSP_COMPILE.json 详细请参考链接BSP自查

@illustriousness
[tool] tools/targets/vsc.py : improve compile_commands handling and w…
6af669d 
…orkspace excludes

  - broaden source file extension detection to include C++ and asm
  - resolve compile_commands path to absolute and pass its directory to clangd
  - limit excludes scan to rt-thread/packages and always include board/linker_scripts
@github-actions
Copy link

github-actions bot commented Jan 16, 2026

👋 感谢您对 RT-Thread 的贡献！Thank you for your contribution to RT-Thread!

为确保代码符合 RT-Thread 的编码规范，请在你的仓库中执行以下步骤运行代码格式化工作流（如果格式化CI运行失败）。
To ensure your code complies with RT-Thread's coding style, please run the code formatting workflow by following the steps below (If the formatting of CI fails to run).

🛠 操作步骤 | Steps

  1. 前往 Actions 页面 | Go to the Actions page
    点击进入工作流 → | Click to open workflow →

  2. 点击 Run workflow | Click Run workflow

  • 设置需排除的文件/目录（目录请以"/"结尾）
    Set files/directories to exclude (directories should end with "/")
  • 将目标分支设置为 \ Set the target branch to：fix/vsc
  • 设置PR number为 \ Set the PR number to：11138
  1. 等待工作流完成 | Wait for the workflow to complete
    格式化后的代码将自动推送至你的分支。
    The formatted code will be automatically pushed to your branch.

完成后，提交将自动更新至 fix/vsc 分支，关联的 Pull Request 也会同步更新。
Once completed, commits will be pushed to the fix/vsc branch automatically, and the related Pull Request will be updated.

如有问题欢迎联系我们，再次感谢您的贡献！💐
If you have any questions, feel free to reach out. Thanks again for your contribution!

@github-actions github-actions bot added the tools label Jan 16, 2026
supperthomas
supperthomas requested changes Jan 19, 2026
View reviewed changes
tools/targets/vsc.py
# os.chdir(root_path)
# 轮询root文件夹下面的每一个文件夹和子文件夹
for root, dirs, files in os.walk(root_path):
if not is_under_roots(root, root_path, ('rt-thread', 'packages')):
Copy link
Member

@supperthomas supperthomas Jan 19, 2026

Choose a reason for hiding this comment

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

这里package不解析吗？

Copy link
Contributor Author

@illustriousness illustriousness Jan 19, 2026

Choose a reason for hiding this comment

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

只从编译后的 compile_commands.json 解析rt-thread, packages 这两个目录的没有参与编译的部分 然后作为工作区的文件排除

@supperthomas supperthomas merged commit a68cc2e into RT-Thread:master Jan 19, 2026
59 checks passed
@supperthomas
Copy link
Member

supperthomas commented Jan 19, 2026

这个用起来咋样？顺手不？

@illustriousness
Copy link
Contributor Author

illustriousness commented Jan 19, 2026

这个用起来咋样？顺手不？

非常好用 及时没有这个导出为vsc 也可以开发 无非是搜索某些函数的时候有些没参与编译的文件 排除起来很麻烦

@supperthomas
Copy link
Member

supperthomas commented Jan 19, 2026

这个用起来咋样？顺手不？

非常好用 及时没有这个导出为vsc 也可以开发 无非是搜索某些函数的时候有些没参与编译的文件 排除起来很麻烦

那个实在太多了，特别是bsp下面的其他soc

@illustriousness illustriousness deleted the fix/vsc branch January 20, 2026 10:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@supperthomas supperthomas supperthomas approved these changes

Assignees

No one assigned

Labels

tools

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@illustriousness @supperthomas