Fix the Arduino Lint check - #9
Merged
Merged
Conversation
ainyan03
force-pushed
the
arduino_lint_fixes
branch
from
August 28, 2026 04:57
99664d7 to
3f7e3e4
Compare
The includes field must list header files, not directories; arduino-lint rejected "src,src/utils" (LP052). List the primary header instead. Add StackChan-BSP.h as the primary header named after the library (LS008, best practice); it only includes M5StackChan.h so existing sketches are unaffected.
With library-manager: update, arduino-lint fails on LP018 because StackChan-BSP is not in the Library Manager index, so the check has been red on every run. Use the "submit" mode, which applies the rules for a library that is about to be submitted (so the pre-registration checks stay active) without requiring the name to be in the index yet. Switch to "update" once the library has been accepted into the index.
ainyan03
force-pushed
the
arduino_lint_fixes
branch
from
August 28, 2026 05:02
3f7e3e4 to
c9c30a2
Compare
Contributor
|
Thanks! |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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
Arduino Lint Checkworkflow has failed on every run ofmainsince April (it is not caused by any particular PR). Runningarduino-lint --compliance strict --library-manager updatelocally reproduces the CI result: 3 errors, 1 warning.What fails and why
library.properties includes field item(s) src, src/utils not found in libraryincludes=must list header files, not directoriesNo header file found matching library name (StackChan-BSP.h)Library name StackChan-BSP not found in the Library Manager indexlibrary-manager: updatein the workflow asks arduino-lint to enforce the registration rulesUnable to load the library.properties url field: ... unexpected EOFChanges
library.properties:includes=M5StackChan.h, and addsrc/StackChan-BSP.has the primary header (it only includesM5StackChan.h, so existing sketches are unaffected). This clears LP052 and LS008.library-manager: submit. LP018 cannot be fixed from the repository content; it only goes away once the library has been accepted into the Library Manager index.submitis arduino-lint's mode for a library that is not in the index yet: it keeps the pre-registration checks active without requiring the name to be present. Switch toupdateonce the library has been accepted — feel free to drop this commit if you prefer to keep the red check as a reminder.With both commits
arduino-lint --compliance strict --library-manager submitreports no errors or warnings for the library and all examples.