Specify vendordep json file format #192
Draft
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
Contributor
spacey-sooty
commented
Feb 29, 2024
spacey-sooty
commented
- Create accurate specification for current format
- Add tests to ensure that we don't silently break current format
- Update errors to point to the specification when it is useful
spacey-sooty
commented
Feb 29, 2024
| | version | String | The version of the vendordep. | No. | | ||
| | uuid | String | The unique identifier for the vendordep. Used to avoid replicating vendordeps in projects. | No. | | ||
| | mavenUrls | String[] | An array of urls pointing to the root of the maven repository storing the vendordep. | No. | | ||
| | extraGroupIds | String[] | | Yes. | |
There was a problem hiding this comment.
I don't know what this is or if it's a valid key I got my specifications from https://github.com/wpilibsuite/native-utils/blob/main/src/main/java/edu/wpi/first/nativeutils/vendordeps/WPIVendorDepsExtension.java#L310 and the example json file
There was a problem hiding this comment.
Im also not sure if
public VendorDependency[] requires;
public VendorDependency[] conflictsWith;should be added in here along with the corresponding types
Comment on lines
+10
to
+12
| | JavaArtifact | `{ groupId: String, ArtifactId: String, version: String }` | | ||
| | JniArtifact | `{ groupId: String, ArtifactId: String, version: String, skipInvalidPlatforms: Boolean, isJar: Boolean, validPlatforms: String[] }` | | ||
| | CppArtifact | `{ groupId: String, ArtifactId: String, version: String, libName: String, headerClassifier: String, sharedLibrary: Boolean, skipInvalidPlatforms: Boolean, binaryPlatforms: String[] }` | |
There was a problem hiding this comment.
Not sure how this should be formatted
|
I'm guessing I'm missing a lot of things here |
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.