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

Where can I find the list of rules? #158

Closed
ianfixes opened this issue Jan 12, 2021 · 3 comments · Fixed by #261
Closed

Where can I find the list of rules? #158

ianfixes opened this issue Jan 12, 2021 · 3 comments · Fixed by #261
Assignees
Labels
conclusion: resolved Issue was resolved criticality: medium Of moderate impact topic: documentation Related to documentation for the project type: enhancement Proposed improvement

Comments

@ianfixes
Copy link

Is there a published list of all the linter rules? I couldn't find a reference to it in the documentation.

Alternately, is there a sample project that (on purpose) triggers every possible linter error?

@per1234
Copy link
Contributor

per1234 commented Jan 12, 2021

Is there a published list of all the linter rules?

Here are all the rules:
https://github.com/arduino/arduino-lint/blob/main/internal/rule/ruleconfiguration/ruleconfiguration.go#L60-L2859

You can get details on all the rules that are run for a given project type and tool configuration by running arduino-lint --format json --verbose or print it to a file using the --report-file flag.

is there a sample project that (on purpose) triggers every possible linter error?

That would be one seriously messed up platform! It actually wouldn't be possible to trigger all of them from a single project because some are mutually exclusive.

There is an individual test project for each rule violation here:
https://github.com/arduino/arduino-lint/tree/main/internal/rule/rulefunction/testdata
It's pretty fun to run arduino-lint --recursive on that folder!

@ianfixes
Copy link
Author

OK, great. I'll leave this issue open in case you want to convert it to a "publish the rules on a webpage" request, but my needs here are met.

@per1234
Copy link
Contributor

per1234 commented Aug 27, 2021

Hi @ianfixes. Thanks for your excellent suggestion! It took a long time to get around to it, but we have finally added documentation for every rule to Arduino Lint's website:
https://arduino.github.io/arduino-lint/dev/rules/

@per1234 per1234 added the conclusion: resolved Issue was resolved label Sep 29, 2021
@rsora rsora added criticality: medium Of moderate impact and removed priority: medium Resolution is a medium priority labels Nov 2, 2021
@per1234 per1234 self-assigned this Nov 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
conclusion: resolved Issue was resolved criticality: medium Of moderate impact topic: documentation Related to documentation for the project type: enhancement Proposed improvement
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants