Remove superfluous and broken manifest file #133
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
`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.
per1234
added
type: imperfection
aentinger
approved these changes
Apr 25, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
library.jsonis PlatformIO's native library manifest file but Arduino'slibrary.propertiesis also supported by PlatformIO:https://docs.platformio.org/en/latest/librarymanager/creating.html#creating-library
The
library.jsonfile was missing the requiredversionfield: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 belibrary.propertiesthat is kept andlibrary.jsonthat is removed.