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
295 stars 115 forks source link

IEP-1230, IEP-1231: ESP-IDF Version Switching and build impact #964

Closed alirana01 closed 1 month ago

alirana01 commented 1 month ago

Description

ESP-IDF Version Switching and build impact. The build was not working and not showing any proper message to user if the active version was switched and project was built using someother version of idf. Now added a proper message to the console to let user know they need to clean before trying to build the project with currently active version Also fixed redundant output of the targets when activating a different idf version from esp-idf manager

Fixes # (IEP-1230, IEP-1231)

Type of change

Please delete options that are not relevant.

How has this been tested?

Please follow steps in original ticket to verify

Test Configuration:

Checklist

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago

Walkthrough

The changes introduce pre-build checks in the IDFBuildConfiguration class to ensure the project and environment IDF paths match. This involves adding the ProjectDescriptionReader and IDFEnvironmentVariables for handling project descriptions and environment variables. Additionally, new messages related to these checks are included in the Messages class and messages.properties file.

Changes

File Path Change Summary
.../idf/core/build/IDFBuildConfiguration.java Added imports for ProjectDescriptionReader and IDFEnvironmentVariables, and introduced buildPrechecks method.
.../idf/core/build/Messages.java Added a new string constant IDFBuildConfiguration_PreCheck_DifferentIdfPath.
.../idf/core/build/messages.properties Updated to include messages related to project refreshing and ESP-IDF path configuration.
.../idf/core/util/ProjectDescriptionReader.java Added getIdfPath method and modified getAppElfFileName method.
.../idf/ui/tools/ToolsJob.java Removed a line that prints line to the console within a while loop.

Poem

In the realm of code we tread,
Paths must match, the message said.
Pre-build checks, a safeguard true,
Ensuring paths align for you.
With tools refined, our task is clear,
A smoother build, no need to fear.
In lines of code, our journey's bright,
A coder's dream, in bytes of light.

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 full the 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 1 month ago

@alirana01 hi !

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

let's add "\n" after every string to make it easier to read: from: image

to: image

AndriiFilippov commented 1 month ago

@alirana01

Tested under: OS - Windows 10

Multiple projects scenario:

  1. install v5.2 -> create and build project A
  2. install and activate v5.11 -> create and build project B
  3. select project A in Project Explorer and then select project B again. Try to build. Getting this message:

image

alirana01 commented 1 month ago

@AndriiFilippov please verify after the recent builds the suggested changes

AndriiFilippov commented 1 month ago

@alirana01

Tested under: OS - Windows 10

Multiple projects scenario:

  1. install v5.2 -> create and build project A
  2. install and activate v5.11 -> create and build project B
  3. select project A in Project Explorer and then select project B again. Try to build. Getting this message:

image

@alirana01 hi !

Issue is still persist. image

alirana01 commented 1 month ago

@alirana01 Tested under: OS - Windows 10 Multiple projects scenario:

  1. install v5.2 -> create and build project A
  2. install and activate v5.11 -> create and build project B
  3. select project A in Project Explorer and then select project B again. Try to build. Getting this message:

image

@alirana01 hi !

Issue is still persist. image

Please see again sorry for missing the original point in the comment should be fixed now

AndriiFilippov commented 1 month ago

@alirana01 hi !

LGTM now 👍 Also tested with Custom Build folder. Works ✔️

No installed tools targets duplicate ✔️ image