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

Friendly names for config parameters #57

Open
cgarwood opened this issue Jun 25, 2021 · 0 comments
Open

Friendly names for config parameters #57

cgarwood opened this issue Jun 25, 2021 · 0 comments
Labels
enhancement New feature or request

Comments

@cgarwood
Copy link
Collaborator

cgarwood commented Jun 25, 2021

Module's should have an object for each config parameter that includes a friendly name, type, and possibly validation rules.

For example:

module.config = {
  "name": {
    "name": "Instance Name",
    "type": "string"
  },
  "host": {
    "name": "Hostname or IP Address",
    "type": "string"
  },
  "port": {
    "name": "Port",
    "type": "number",
  }.
  "version": {
    "name": "Software Version",
    "type": "select",
    "options": {
      "6": "v6",
      "7": "v7.8.9 or higher"
    },
  },
  "use_ssl": {
    "name": "Use secure connection",
    "type": "boolean"
  }
}
@cgarwood cgarwood added the enhancement New feature or request label Jun 25, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant