feat: Enable Clangd in repo #6430
Merged
+138
−29
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tjzel
commented
Aug 21, 2024
piaskowyk
approved these changes
Aug 23, 2024
WoLewicki
reviewed
Aug 23, 2024
| generator_script_path = '../../../packages/react-native-reanimated/scripts/clangd-generate-xcode-metadata.sh' | ||
|
|
||
| script_phase :name => 'Generate metadata for clangd', :script => generator_script_path, :shell_path => '/bin/bash', :always_out_of_date => 'true', :execution_position => :after_compile | ||
| end |
There was a problem hiding this comment.
no newline at the end of file, not very nice
There was a problem hiding this comment.
Contributions are welcome 🤗
coado
added a commit
to software-mansion/react-native-gesture-handler
that referenced
this pull request
Oct 3, 2024
## Description This pull request introduces `clangd` support. You can read more about it in [this](software-mansion/react-native-reanimated#6430) awesome PR that bring it to reanimated. For now it supports iOS only as I am not sure if we need it for android here. To make it work, you have build `FabricExample` or `MacOSExample` first. <!-- Description and motivation for this PR. Include 'Fixes #<number>' if this is fixing some issue. --> <!-- Describe how did you test this change here. -->
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Bringing
clangdto our monorepo.What's clangd?
It's a language server that plugs into your text editor (yes, I'm looking at you VSCode) and provides you with syntax highlighting, autocompletion, inspections and much more. You can read about it on clangd's webpage.
Why do we need this?
Often times when we develop C++ code, we have to jump between Xcode and Android Studio just to get autosuggestions or be able to inspect some functions. This slows down development and these IDEs have their downsides.
With this change, you'll be able to edit the code in VSCode and have all the necessary information there, including static checks. In my experience it also works much faster than native IDEs.
Just to name a few useful features:
How do I use it?
I automated the whole pipeline for clangd, so all you need to do is install VSCode's clangd extension.
You also need to compile the project once to generate all the artifacts utilized by clangd. For example, if you are developing for Fabric, iOS, just build FabricExample.
As a bonus, built-in VSCode's C++ plugin also benefits from this, so you don't need to use clangd at all. However, I still recommend clangd as a replacement. Try it out yourself!
Before:
After:
Test plan
🚀