IEP-1279 Verify clangd editor features and find the gaps

[sigmaaa]

Description

Updating the README to clarify differences with the old editor

Fixes # (IEP-1279)

Type of change

Please delete options that are not relevant.

• New feature (non-breaking change which adds functionality)

How has this been tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

• Test A
• Test B

Test Configuration:

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

Dependent components impacted by this PR:

• Component 1
• Component 2

Checklist

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

Summary by CodeRabbit

• Documentation
  • Added a new section on "LSP Editor" in the README, detailing features, functionalities, and customization options.
  • Included subsections for Formatting, Search, Inlay Hints, and Searching ESP-IDF Components within the LSP Editor.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The changes involve the addition of a new section titled "LSP Editor" in the README.md file. This section details the features and functionalities of the LSP Editor introduced in Espressif IDE 3.0.0, highlighting differences from the previous default editor. It includes information on formatting options, search capabilities, inlay hints, and instructions for customizing settings. The new content is integrated into the existing "Other IDE Features" section, maintaining the overall structure of the document.

Changes

File	Change Summary
README.md	Added a new section titled "LSP Editor" detailing features, functionalities, and customization options, including subsections on Formatting, Search, Inlay Hints, and Searching ESP-IDF Components.

Possibly related PRs

• Update README.md #1066: This PR updates the README.md file, which is directly related to the main PR that also modifies the README.md to add a section about the LSP Editor.

Suggested labels

needs translation:CN

Suggested reviewers

• sigmaaa
• AndriiFilippov

Poem

🐇 In the meadow, bright and fair,
A new editor waits with flair.
With formatting neat and search so grand,
Hop in, dear user, take my hand!
Explore the LSP, let ideas flow,
In Espressif IDE, watch your skills grow! 🌼

---

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>, please review it.
  • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @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 using 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.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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

🧹 Outside diff range and nitpick comments (3)

README.md (3)

311-321: Maintain consistent list formatting

For better readability and consistency with the rest of the document, consider using asterisks (*) instead of dashes (-) for unordered lists. This applies to the steps for creating a virtual folder and searching ESP-IDF components.

🧰 Tools

🪛 Markdownlint

311-311: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

---

312-312: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

---

313-313: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

---

314-314: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

---

315-315: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

---

318-318: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

---

319-319: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

---

320-320: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

---

321-321: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

---

265-266: Consider adding a brief explanation of LSP

It might be helpful to add a brief explanation of what LSP (Language Server Protocol) is and its benefits for users who may not be familiar with the term.

---

271-271: Specify language for fenced code blocks

To improve syntax highlighting and adherence to Markdown best practices, specify the language for the fenced code blocks. For example, use yaml for the .clang-format content and shell for the command-line examples.

Apply this change to the fenced code blocks:

-```
+```yaml
BasedOnStyle: LLVM
UseTab: Always
...

-```
+```
project
 - managed_components
...

-```
+```yaml
CompileFlags:
  CompilationDatabase: build
...

Also applies to: 282-282, 299-299

🧰 Tools

🪛 Markdownlint

271-271: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between b6d1458 and 680eb01.

📒 Files selected for processing (1)

• README.md (2 hunks)

🧰 Additional context used

🪛 Markdownlint

README.md

40-40: null
Spaces inside link text

(MD039, no-space-in-links)

---

311-311: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

---

312-312: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

---

313-313: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

---

314-314: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

---

315-315: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

---

318-318: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

---

319-319: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

---

320-320: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

---

321-321: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

---

271-271: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

282-282: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

299-299: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

🪛 LanguageTool

README.md

[style] ~289-~289: Consider using a different adverb to strengthen your wording.
Context: ... folder. This flag tells ClangFormat to completely ignore this specific .clang-format fi...

(COMPLETELY_ENTIRELY)

🔇 Additional comments (1)

README.md (1)

264-322: New LSP Editor section looks good!

The new section provides valuable information about the LSP Editor introduced in Espressif IDE 3.0.0. It covers important aspects such as formatting, search capabilities, inlay hints, and instructions for searching ESP-IDF components. The content is well-structured and informative.

🧰 Tools

🪛 LanguageTool

[style] ~289-~289: Consider using a different adverb to strengthen your wording.
Context: ... folder. This flag tells ClangFormat to completely ignore this specific .clang-format fi...

(COMPLETELY_ENTIRELY)

🪛 Markdownlint

311-311: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

---

312-312: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

---

313-313: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

---

314-314: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

---

315-315: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

---

318-318: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

---

319-319: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

---

320-320: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

---

321-321: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

---

271-271: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

282-282: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

299-299: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

[kolipakakondal]

Can we add the below recommendation as well -

It is recommended to always create a new project instead of modifying your current one to avoid unnecessary Git files and error markers created by the indexer for the components folder. As both the projects will be in the same workspace, you should be able to search anywhere within your workspace.

[kolipakakondal]

LGTM