Skip to content

Allow test sketches to be outside examples folder #588

Closed as not planned
Closed as not planned
@aliphys

Description

@aliphys

Describe the request

The linter should allow for sketches outside of the examples folder to be within spec. Main reason, is to keep two types of .ino files seperate based on their functionality

  • Example sketches -> These showcase the functionality of the library and have practical and/or pedagogical value
  • Test sketches -> These are meant to strain the compile-sketches.yml workflow to the limit, as part of continuous testing (CT) procedures.

Including test sketches, which have no/little pedagogical value, will increase the complexity of the user experience. Advanced users can always see the test sketches in the repository or local installation of the library.

Describe the current behavior

According to Rule LD003, the linter does not allow for sketches outside the examples folder in the root directory of the library.

ID: "LD003",
Brief: "stray sketch",
Description: "A sketch was found outside the library's `examples` and/or `extras` subfolders. Example sketches must be placed in the standardized location.",
MessageTemplate: "Sketch(es) found outside examples and extras folders:\n{{.}}",

Arduino Lint version

arduino/arduino-lint-action@v1

Operating system

N/A

Operating system version

runs-on: ubuntu-latest

Additional context

Running Linter via check-arduino.yml workflow kindly provided by @per1234

Issue checklist

  • I searched for previous requests in the issue tracker
  • I verified the feature was still missing when using the latest version
  • My request contains all necessary details

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions