Remove superfluous and broken manifest file #133

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

Jump to bottom

Merged

aentinger merged 1 commit into arduino-libraries:master from per1234:remove-library.json

Apr 25, 2022

Merged

Remove superfluous and broken manifest file #133

aentinger merged 1 commit into arduino-libraries:master from per1234:remove-library.json

Apr 25, 2022

Conversation

@per1234

Copy link

@per1234 per1234 commented Apr 9, 2022

library.json is PlatformIO's native library manifest file but Arduino's library.properties is also supported by PlatformIO:

https://docs.platformio.org/en/latest/librarymanager/creating.html#creating-library

The library.json file was missing the required version field:

https://docs.platformio.org/en/latest/librarymanager/config.html#version

Although it could be added, experience with other libraries (arduino-libraries/NTPClient#152) indicates that it is not really realistic to expect two manifest files to be properly maintained.

Since the Arduino development software and the Arduino Library Manager require library.properties, if there is to be only one then it must be library.properties that is kept and library.json that is removed.

@per1234


 Remove superfluous and broken manifest file

c6e4ab9

`library.json` is PlatformIO's native library manifest file but Arduino's `library.properties` is also supported by
PlatformIO:
https://docs.platformio.org/en/latest/librarymanager/creating.html#creating-library
The `library.json` file was missing the required `version` field:
https://docs.platformio.org/en/latest/librarymanager/config.html#version
Although it could be added, experience with other libraries indicates that it is not really realistic to expect two
manifest files to be properly maintained.
Since the Arduino development software and the Arduino Library Manager requires `library.properties`, if we are to have
only one the choice of keeping `library.properties` and removing `library.json` is clear.