Comments (1)
Hi @jonnybergdahl. Thanks for your suggestion. The reference link is provided to help you to understand how the name is defined. The name length recommendation is only that. It is a completely optional suggestion for those who would like to follow best practices (because displaying excessively long arbitrary library names in the UI of Arduino development software such as Arduino IDE and Arduino CLI can be problematic). Although we do hope that library maintainers will heed these recommendations, you are free to disregard it if you like. Warnings do not have any impact on a library's inclusion in Arduino Library Manager.
Either the linter setup is wrong
It is not wrong. Arduino Lint't rule was intentionally configured this way according to best practices recommendations from the developers of the official Arduino development tools.
the documentation is wrong
There is nothing wrong in the linked reference. The best practices optional recommendation for the library name length was intentionally not included in the Arduino Library Specification because this type of suggestion is not appropriate for a formal specification.
It is included in the Arduino Lint documentation:
https://arduino.github.io/arduino-lint/1.2/rules/library/#name-recommended-length-lp010
from arduino-lint.
Related Issues (20)
- Add "zero-length board ID" rule HOT 4
- Please add check for invalid examples e.g. containing no ino file HOT 3
- Question: Why are library names limited to 16 characters? (low prio) HOT 2
- Add maximum file system size rule for libraries
- Add the ability to mute some rules HOT 1
- Broken link in docs HOT 1
- Strict check on libraries should check for header guards or #pragma once HOT 2
- Consider raising LP048 to error instead of warning HOT 2
- Feature Request: Add ability to exclude certain sub-folders from checks
- Feature request: Support macOS arm64 HOT 5
- Update link LP018 HOT 1
- arduino-lint can't load url from library.properties (http status 503) HOT 3
- New error raised with 1.2.1 while it should not
- My `examples` directory is getting ignored HOT 1
- Change of LP010: Increase character limit for naming Arduino libraries
- Publish Arduino project JSON schemas to "JSON Schema Store"
- Allow test sketches to be outside examples folder HOT 1
- Specify link to Github, BitBucket or GitLab as requirement for `url` field HOT 1
- Broken symlinks in libraries results in linter panic HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from arduino-lint.