fix: write console stream with lsp troubleshooting notes

[kolipakakondal]

Description

write console stream with lsp troubleshooting notes

Fixes # (IEP-1193)

Type of change

• This change requires a documentation update

How has this been tested?

• Create a project
• Build
• Observe the build console with the clangd troubleshooting notes

Test Configuration:

• ESP-IDF Version:
• OS (Windows,Linux and macOS):

Dependent components impacted by this PR:

• Build

Checklist

• PR Self Reviewed
• Applied Code formatting
• Added Documentation
• Added Unit Test
• Verified on all platforms - Windows,Linux and macOS

Summary by CodeRabbit

• New Features
  • Added troubleshooting notes for clangd to assist with unresolved header issues and enable source code navigation.

[coderabbitai]

Walkthrough

This update introduces a new method writeConsoleNotes in the IDFBuildConfiguration class to assist developers in troubleshooting clangd issues within the ESP-IDF Eclipse plugin. By providing guidance on handling unresolved headers and enabling source code navigation, this enhancement aims to streamline the development process.

Changes

File Path	Change Summary
.../idf.core/src/.../IDFBuildConfiguration.java	Added writeConsoleNotes method for clangd troubleshooting.

Possibly related issues

• getting 13 semantic error while building "Hello World" in idf-eclipse plugin in ubuntu. (IEP-970) #777: The addition of writeConsoleNotes could potentially help address unresolved symbols/types and semantic errors as discussed in this issue, offering guidance to developers facing similar challenges within the Eclipse environment.

Poem

Amongst code's winding maze, a new light does blaze,
🌱 writeConsoleNotes blooms, guiding through the haze.
In the realm of clangd, where errors once thrived,
🐾 Clarity emerges, in solutions derived.
Let's dance in the logic, where bugs take their leave,
🎉 With each fix we make, success we achieve.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

---

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

Review Status

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between cd49fcf and 0ae526b.

Files selected for processing (1)

• bundles/com.espressif.idf.core/src/com/espressif/idf/core/build/IDFBuildConfiguration.java (1 hunks)

Files not reviewed due to errors (1)

• IDFBuildConfiguration.java (no review received)

[coderabbitai]

Actionable comments posted: 0

Review Status

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 53baa6d and 8756fac.

Files selected for processing (1)

• bundles/com.espressif.idf.core/src/com/espressif/idf/core/build/IDFBuildConfiguration.java (1 hunks)

Files skipped from review as they are similar to previous changes (1)

• bundles/com.espressif.idf.core/src/com/espressif/idf/core/build/IDFBuildConfiguration.java