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

Update dictionary JSON spec field names and examples #2574

Merged
merged 2 commits into from
Mar 19, 2024

Conversation

jwest115
Copy link
Collaborator

@jwest115 jwest115 commented Mar 7, 2024

Related Issue(s)
Has Unit Tests (y/n)
Documentation Included (y/n)

Change Description

  • move arrays, structs, and enums into typeDefinitions
  • rename formatSpecifier to format
  • rename identifier to name
  • shorten identifier to id
  • add bool size

@jwest115 jwest115 changed the title Update field names and examples Update dictionary JSON spec field names and examples Mar 7, 2024
@LeStarch
Copy link
Collaborator

@bocchino you'll need to review this one!

```json
{
"deploymentName": "MyDeployment",
"frameworkVersion": "3.3.2",
"projectVersion": "1.0.0",
"libraryVersions": []
"libraryVersions": [],
Copy link
Collaborator

@thomas-bc thomas-bc Mar 14, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As I'm wiring fpp-to-dict in to the CMake system, figuring out how to specify libraryVersions is giving me some troubles. I think providing an example would be helpful. Here are my questions:

  1. What is the format we want to use? libraryName=1.0.0, [email protected] , libraryName==1.0.0 etc... ? We probably need to add this to the spec.
  2. Say the library name is very generic e.g. arduino-i2c, are we ok with it being impossible to figure out where the library came from unless we can look at the source project? What I'm hinting at here is we could have an optional field e.g. remoteUrl or something. I don't actually think it would be useful/beneficial, but I just wanted to double check with everyone.
  3. How do we deal with unspecified versions? e.g. a user has created a library locally but it is not a git submodule and/or there is no version to be retrieved.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a good point @thomas-bc. The format of entries in libraryVersions is not specified in the spec. Also, there is no check done in the fpp-to-dict tool to verify that the libraryVersions input conforms to a certain format.

Copy link
Collaborator

@thomas-bc thomas-bc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just marking things as I notice them

docs/Design/fpp-json-dict.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@bocchino bocchino left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This PR looks good to me! It makes the changes we discussed.

@LeStarch LeStarch merged commit c4f8fdd into nasa:devel Mar 19, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants