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

Add maximum file system size rule for libraries #181

Open
per1234 opened this issue Jun 2, 2021 · 0 comments
Open

Add maximum file system size rule for libraries #181

per1234 opened this issue Jun 2, 2021 · 0 comments
Assignees
Labels
topic: code Related to content of the project itself type: enhancement Proposed improvement

Comments

@per1234
Copy link
Contributor

per1234 commented Jun 2, 2021

Although the file sizes of an Arduino library's source code is always small enough to not be worth consideration, some library authors have added supplemental files which make the total file system size of the library unexpectedly large.

An example I have seen repeatedly causing problems by exceeding the maximum storage size for a standard Arduino Cloud account upon import is this popular library, currently ~40 MB:
https://github.com/itead/ITEADLIB_Arduino_Nextion

Excessive library sizes are inconvenient for users, who might have no interest in, nor even awareness of, the supplemental files that make installation and updates of the library take forever. This also causes an burden on the Library Manager infrastructure, which must index, store, and serve every release of every library.

For this reason, it would be helpful to add a rule that checks for library size exceeding some maximum value (e.g., 10 MB). This could be promoted from a warning to an error when in --library-manager=submit or --library-manager=update modes if we decide to prohibit such libraries from inclusion in the Library Manager index.

Such a rule would encourage library maintainers to package and distribute supplemental files separate from the library itself, which will likely be in the best interest of users, who often don't even know (or want to know) where the library is on their system. They also might find that the files are unnecessarily large (e.g., raw high resolution images where offering such level of detail is of no benefit).

@per1234 per1234 added type: enhancement Proposed improvement topic: code Related to content of the project itself labels Jun 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
topic: code Related to content of the project itself type: enhancement Proposed improvement
Projects
None yet
Development

No branches or pull requests

1 participant