Comments (1)
Hi @aliphys. Thanks for your suggestion.
According to the library registery FAQ:
- [ ] The library repository must be hosted on a major Git-hosting website like GitHub, BitBucket or GitLab (other hosting sites may be considered on request).
That requirement is about the URL that is added to the repositories.txt
file in the arduino/library-registry
repository. The reason for the restrictions on that URL is because the libraries-repository-engine tool must be able to check out the library's Git repository in order to generate the Library Manager index and associated assets.
Since this data is not part of the Arduino library project content, a separate tool is used to check the Library Manager submissions for compliance with this requirement:
https://github.com/arduino/library-registry-submission-parser/blob/1.1.1/main.go#L272-L279
The purpose of the url
field of the library.properties
metadata file is to provide the library user with a link they can follow to get more information about the library. The library repository might be the place where that information is found, but this is not required. In fact, many of the official Arduino libraries use the URL of the library's page in the Arduino Library Reference (example), and that is perfectly fine (and in fact superior for the purpose when compared to sending the end user directly to the repository). So there is no need to apply the same requirements on the url
field of the library.properties
file as we impose on the registration URL.
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
- Documentation and linter setup mismatch 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.