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

Change variables in the manifest file from dictionaries to objects #109

Open
lorenzo-cavazzi opened this issue Apr 20, 2021 · 0 comments
Open

Comments

@lorenzo-cavazzi
Copy link
Member

Currently, variables are dictionaries where the key is the variable name and the values represent its description.
We should use an object instead so that we can specify other properties like type, default, and support enumerations.

Instead of summary: short summary added at the beginning of the readme file, we should have something like this:

  - name: summary
    description: short summary added at the beginning of the readme file
    type: string

For enumerations, we should have something like the following:

  - name: plugins
    description: list of plugins to install in the template
    type: enum
    enum: ["none", "VScode", "GIS", "VScode and GIS"]
    default: none

Initial support for strings and enumerations may be enough.
We could also support numbers and booleans for completeness and to have a better validation system, as well as a better UX in the UI.

@lorenzo-cavazzi lorenzo-cavazzi changed the title Change variables to object Change variables in the manifest file from dictionaries to objects Apr 20, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Backlog
Development

No branches or pull requests

1 participant