Project config parameters description

[j3k0]

Packages parameters are defined with an ID and a default value. A nice addition would be some text description.

Currently:

$ apm project config
apsEnvironment=development
facebookAutoInitEnabled=true

My idealized output:

$ apm project config

# Apple push notifications environment (development | production)
apsEnvironment=development

# Tell the Facebook SDK not to initialize automatically
# See https://docs.airnativeextensions.com/docs/facebookapi/core/initialise-the-extension
facebookAutoInitEnabled=true

--

In package.json this could be done like so:

{
  "parameters": [
    {
      "name": "facebookAutoInitEnabled",
      "defaultValue": "true",
      "description": "Tell the Facebook SDK not to initialize automatically\nSee https://docs.airnativeextensions.com/docs/facebookapi/core/initialise-the-extension"
    }
  ]
}

_Originally posted by @j3k0 in https://github.com/airsdk/apm/discussions/59_

[marchbold]

Should output descriptions now, but we will need to go through and add these to our packages etc.