IEP-1212 Headers unresolved after build Custom Build Folder

sigmaaa commented 4 months ago

Description

Fixed unresolved headers after build with custom build folder by editing clang file after the build. Also improved clangd Troubleshooting messages after the build

Fixes # (IEP-1212)

Type of change

Please delete options that are not relevant.

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)

How has this been tested?

Test build project, check .clangd file -> CompilationDatabase should point to the build folder add custom build folder -> rebuild the project -> CompilationDatabase points to the custom build folder
Test check after clangd Troubleshooting messages. Path to GCC exe and build folder should be actual

Test Configuration:

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

Dependent components impacted by this PR:

Build
After build messages

Checklist

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

Summary by CodeRabbit

Refactor
- Updated package names from com.espressif.idf.lsp to com.espressif.idf.core for better organization and consistency.
- Enhanced the build method to include a new handler for updating project configurations.
- Improved console output during build processes with additional details.
New Features
- The build process now includes updates to the CompileFlags section with the project's build folder name, ensuring more accurate configurations.
Chores
- Reorganized import statements across multiple files to reflect the new package structure.

coderabbitai[bot] commented 4 months ago

Walkthrough

The changes across the project involve updating package names from com.espressif.idf.lsp to com.espressif.idf.core and reorganizing imports accordingly. Additionally, functionality enhancements include updating the ClangdConfigFileHandler to incorporate the project's build folder name and modifying methods in IDFBuildConfiguration for better console output and build handling.

Changes

File Path	Change Summary
`.../src/com/espressif/idf/core/ILSPConstants.java`	Updated package name and modified `CLANGD_CONFIG_FILE` declaration.
`.../src/com/espressif/idf/core/build/IDFBuildConfiguration.java`	Added imports for `GCCToolChain` and `ClangdConfigFileHandler`, updated `build` method and `writeConsoleNotes` method.
`.../src/com/espressif/idf/core/util/ClangdConfigFileHandler.java`	Updated package name, added imports, and modified `updateCompileFlagsSection` method.
`.../src/com/espressif/idf/lsp/preferences/IDFClangdOptionsDefaults.java`	Updated import statement for `ILSPConstants`.
`.../src/com/espressif/idf/ui/handlers/ClangdConfigCreateHandler.java`	Updated import statement for `ClangdConfigFileHandler`.
`.../src/com/espressif/idf/ui/wizard/NewIDFProjectWizard.java`	Added and removed import statements for `ClangdConfigFileHandler`.

In the land of code where constants shift, Packages change and imports lift. Build configurations now refined, Clangd flags with folders aligned. A rabbit hops with joy, you see, For code's as clean as it can be! 🐇✨

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.` 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](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 4 months ago

@sigmaaa hi !

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

Create project -> build with Custom Build folder -> all headers are resolved -> ✔️ Create project -> build with Custom Build folder -> all headers are resolved -> "Project Full Clean" -> re-build -> all headers are resolved ✔️

LGTM 👍

espressif / idf-eclipse-plugin