search

mmurdoch / arduinounit

ArduinoUnit is a unit testing framework for Arduino libraries
MIT License
394 stars 51 forks source link

Use correct field separator in keywords.txt #84

Closed per1234 closed 6 years ago

per1234 commented 6 years ago

The Arduino IDE requires the use of a single true tab separator between the keyword name and identifier. When spaces are used rather than a true tab the keyword is not highlighted.

Reference: https://github.com/arduino/Arduino/wiki/Arduino-IDE-1.5:-Library-specification#keywords

wmacevoy commented 6 years ago

Thanks - I've done this before - a linter for library version updates would be pretty nice....

per1234 commented 6 years ago

@wmacevoy I wrote a script for continuous integration testing of Arduino IDE projects. In additional to the standard compilation testing, it includes checks for common problems with keywords.txt (such as the one fixed in this PR), library.properties, library/sketch structure, and compliance with the extra requirements of the Library Manager indexer: https://github.com/per1234/arduino-ci-script

wmacevoy commented 6 years ago

Thanks! I will try to incorporate it...

per1234 commented 6 years ago

Cool! Feel free to ping me if you have any questions, problems, or feedback. I've been using it extensively to automatically detect problems in all the Arduino libraries on GitHub and feel like it's working very well now but I'm hoping it can also be useful to others.