Skip to content
New issue

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

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

Already on GitHub? # to your account

[Linter] Add keyword linting #46

Open
1 task
totally-not-frito-lays opened this issue Jul 15, 2024 · 0 comments
Open
1 task

[Linter] Add keyword linting #46

totally-not-frito-lays opened this issue Jul 15, 2024 · 0 comments

Comments

@totally-not-frito-lays
Copy link
Member

totally-not-frito-lays commented Jul 15, 2024

Is your feature request related to a problem? Please describe.
In keywords.txt we declare a few keywords which the Arduino IDE uses for syntactic sugar.

Describe the solution you'd like
We should add a rule in the linter that whenever new library functions are written, they should be required to add in keywords of any new public functions declared.

Alternatively, we could run a github actions workflow to automatically generate a keyword commit each time a new .h file is created with public functions.

Describe alternatives you've considered
Already listed, need to determine which is the better option.

Additional context

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant