Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

My examples directory is getting ignored #435

Open
3 tasks done
docwilco opened this issue Sep 30, 2022 · 1 comment
Open
3 tasks done

My examples directory is getting ignored #435

docwilco opened this issue Sep 30, 2022 · 1 comment
Labels
type: imperfection Perceived defect in any part of project

Comments

@docwilco
Copy link

Describe the problem

I run the linter in GitHub actions, output is here: https://github.com/docwilco/MFIButton/actions/runs/3159910327/jobs/5143724723

But running it locally gives the same result:

$ arduino-lint --compliance strict
Linting library in /redacted/MFIButton
WARNING: No example sketches found. Please provide examples.
         See: https://arduino.github.io/arduino-cli/latest/library-specification/#library-examples
         (Rule LD004)

Linter results for project: 0 ERRORS, 1 WARNINGS

-------------------

But there's definitely an example: https://github.com/docwilco/MFIButton/blob/main/examples/Example_1-Basics_and_ESP32_timers.ino

To reproduce

Expected behavior

Find the example that is present

Arduino Lint version

nightly-20220930 2022-09-30T01:37:12Z

Operating system

Linux

Operating system version

Ubuntu 20.04.3 LTS

Additional context

No response

Issue checklist

  • I searched for previous reports in the issue tracker
  • I verified the problem still occurs when using the latest version
  • My report contains all necessary details
@docwilco docwilco added the type: imperfection Perceived defect in any part of project label Sep 30, 2022
@docwilco
Copy link
Author

Ah, I see now. It needs to be a whole directory/folder per sketch example.

Maybe list a friendlier error that says each sketch needs to be in its own folder, especially if .ino files are found in examples folders?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: imperfection Perceived defect in any part of project
Projects
None yet
Development

No branches or pull requests

1 participant