You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
check_library_structure: Note implications of stray sketches for Web Editor in error messages
Unlike the Arduino IDE, the Arduino Web Editor requires that all sketches bundled with a library be under the examples folder. If a library contains a sketch anywhere else, it can not be imported in the Arduino Web Editor. The sketches outside the examples folder will not be accessible as examples for the pre-installed libraries of the Library Manager index. I already have checks for stray sketches and misspelled examples folder name in check_library_structure, but their error messages didn't previously note the more serious implications of this for Arduino Web Editor.
Copy file name to clipboardExpand all lines: arduino-ci-script.sh
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -1440,7 +1440,7 @@ function check_library_structure() {
1440
1440
1441
1441
# Check for incorrect spelling of examples folder
1442
1442
if [[ $(find "$normalizedLibraryPath" -maxdepth 1 -type d -and -iregex '^.*/examples?$')&&!$(find "$normalizedLibraryPath" -maxdepth 1 -type d -and -name 'examples') ]];then
1443
-
echo"ERROR: ${normalizedLibraryPath}: Incorrect examples folder name. It should be spelled exactly \"examples\". See: https://github.com/arduino/Arduino/wiki/Arduino-IDE-1.5:-Library-specification#library-examples"
1443
+
echo"ERROR: ${normalizedLibraryPath}: Incorrect examples folder name. It should be spelled exactly \"examples\". Incorrect examples folder name will cause importing the library to Arduino Web Editor to fail and examples to not be available in Arduino Web Editor for Library Manager libraries. See: https://github.com/arduino/Arduino/wiki/Arduino-IDE-1.5:-Library-specification#library-examples"
echo"ERROR: ${normalizedLibraryPath}: Sketch files found outside the examples and extras folders."
1491
+
echo"ERROR: ${normalizedLibraryPath}: Sketch files found outside the examples and extras folders. Sketches outside the examples folder will cause importing the library to Arduino Web Editor to fail."
0 commit comments