Allow use of a dependency helper source file during library detection #2758
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.
Please check if the PR fulfills these requirements
See how to contribute
before creating one)
our contributing guidelines
UPGRADING.md
has been updated with a migration guide (for breaking changes)configuration.schema.json
updated if new parameters are added.What kind of change does this PR introduce?
This is a tentative implementation for a strategy to increase the speed of the library discovery phase.
The idea behind this PR is to add a helper file in a library, called
arduino_deps.cpp
(orarduino_deps.c
), whose only purpose is to#include
the required dependencies. If the Arduino CLI finds the helper the library detection process is performed only on that file, skipping all the other source files (that may be a lot...).Advantages:
dependencies
field in thelibrary.properties
that may become outdated if the author is not precise).Disadvantages:
arduino_deps.cpp
.arduino_deps.cpp
may be tricky.arduino_deps.cpp
may result in difficult-to-diagnose "missing include X.h" errors (that could be a workaround by including X.h in the user sketch)What is the current behavior?
What is the new behavior?
Does this PR introduce a breaking change, and is titled accordingly?
Other information
This may be combined with #2625 for even better performance gain