Always discover subprojects #167
Merged
+108
−83
Conversation
This file contains hidden or 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
The documentation of the `--project-type` flag promises that subprojects will also be discovered:
```
--project-type string Only lint projects of the specified type and their subprojects. Can be {sketch|library|platform|all}. (default "all")
```
Under a specific combination of configurations a bug caused subprojects to not be discovered:
- `--project-type` flag set to specific project type.
- `--recursive` flag not used.
- `PROJECT_PATH` is a folder (rather than file).
So, for example, given this project structure:
FooLibrary
|-- examples
| `-- FooExample
| `-- FooExample.ino
|-- src
| `-- FooLibrary.h
`-- library.properties
The following command only linted the library, and not the FooExample sketch:
```
arduino-lint --project-type library FooLibrary
```
Under any other configuration, subprojects were discovered and the FooExample sketch would be linted in the above example.
Subproject discovery must be done under any circumstances. Previously, there was duplicate code to do this for both file project paths and folder project paths, resulting in the code being more difficult to maintain. In order to accomodate this change, the error message in the event of no projects being discovered was reworded to be applicable to either project path type.
per1234
added
type: bug
priority: high
Codecov Report
@@ Coverage Diff @@
## main #167 +/- ##
==========================================
+ Coverage 84.27% 84.30% +0.02%
==========================================
Files 43 43
Lines 2957 2956 -1
==========================================
Hits 2492 2492
+ Misses 373 372 -1
Partials 92 92
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report at Codecov.
|
silvanocerza
approved these changes
Mar 10, 2021
rsora
added
criticality: high
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.
The documentation of the
--project-typeflag promises that subprojects will also be discovered:Under a specific combination of configurations a bug caused subprojects to not be discovered:
--project-typeflag set to specific project type.--recursiveflag not used.PROJECT_PATHis a folder (rather than file).So, for example, given this project structure:
The following command only linted the library, and not the FooExample sketch:
Under any other configuration, subprojects were discovered and the FooExample sketch would be linted in the above example.