search

espressif / idf-eclipse-plugin

Espressif-IDE (based on Eclipse CDT) for ESP-IDF CMake based projects 4.x and above
Eclipse Public License 2.0
302 stars 121 forks source link

IEP-1246 Set --compile-commands-dir=<path> for the current project which the user is trying to build #973

Closed sigmaaa closed 3 months ago

sigmaaa commented 4 months ago

Description

Set --compile-commands-dir= for the current project which the user is trying to build

Fixes # (IEP-1246)

Type of change

Please delete options that are not relevant.

How has this been tested?

Test A: build project -> check additional lsp options -> --compile-commands-dir points to the right path Test B: change the target -> check query drivers -> points to correct toolchain

Test Configuration:

Dependent components impacted by this PR:

Checklist

Summary by CodeRabbit

coderabbitai[bot] commented 4 months ago

Walkthrough

The changes primarily focus on integrating Language Server Protocol (LSP) support into the Espressif IDF core and UI bundles. Dependencies on LSP-related bundles were added to the core, while redundant dependencies were removed from the UI. Additionally, a new LspService class was introduced to manage LSP servers, and existing methods in LaunchBarListener were refactored to utilize this new service.

Changes

Files Change Summary
bundles/com.espressif.idf.core/META-INF/MANIFEST.MF Added dependencies: org.eclipse.cdt.lsp.clangd, org.eclipse.cdt.lsp, org.eclipse.lsp4e.
bundles/com.espressif.idf.core/src/com/espressif/idf/core/build/... Added LspService import, created LspService instance, updated options, restarted LSP servers.
bundles/com.espressif.idf.core/src/com/espressif/idf/core/util/... Introduced LspService class to manage LSP servers and configurations.
bundles/com.espressif.idf.ui/META-INF/MANIFEST.MF Removed dependencies: com.espressif.idf.lsp, org.eclipse.lsp4e; retained org.eclipse.cdt.lsp.clangd.
bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/LaunchBar... Removed LSP-related imports and methods, replaced with LspService methods.

Sequence Diagram(s) (Beta)

sequenceDiagram
    participant User
    participant LaunchBarListener
    participant LspService
    participant LSPServer

    User->>LaunchBarListener: Initiate Build
    LaunchBarListener->>LspService: restartLspServers()
    LspService->>LSPServer: Restart
    LSPServer->>LspService: Confirm Restart
    LspService->>LaunchBarListener: Servers Restarted
    LaunchBarListener->>User: Build Completed

Poem

In the realm of code so bright, LSP servers take flight. Dependencies align, new paths we find, With LspService, all in kind. Code anew, with ease and grace, Espressif's build, a smoother pace.

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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.` - `@coderabbitai help me debug CodeRabbit configuration file.` 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 an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
AndriiFilippov commented 3 months ago

@sigmaaa hi!

Tested under: OS - Windows 10 ESP-IDF: v5.2.1

build project -> check additional lsp options -> --compile-commands-dir points to the right path ✔️ change the target -> check query drivers -> points to correct toolchain ✔️ Also verified with custom build folder ✔️

image

Since we have it as a default, should we remove this hint ? image

kolipakakondal commented 3 months ago

Hi @AndriiFilippov We can remove troubleshooting from the build console and move it to clangd documentation area