airsdk / apm

AIR Package Manager
https://repository.airsdk.dev/
MIT License
59 stars 9 forks source link

Error message improvement: which extension need parameter to set #188

Open sjabberwocky opened 1 year ago

sjabberwocky commented 1 year ago

When apm generates the description, it is not easy to understand which extension missed the parameter value.

For example, apm gives me this message: generate/app-descriptor :: Parameter not valid: bundleSeedId=.

And it would be much faster to find context of this parameter if this message would contain info that this parameter is related to Push Notification One Signal extension.

marchbold commented 1 year ago

Sure, will look into it.

Currently if you just run:

apm project config set

you will be stepped through all the config and provided documentation from each of the extensions requiring the setting.

marchbold commented 1 year ago

Or if you just set that particular value you will get documentation as well:

apm project config set bundleSeedId

Outputs:

# [com.distriqt.PushNotifications]: Bundle Seed Id (or App ID Prefix) for your iOS application
#         See: https://docs.airnativeextensions.com/docs/pushnotifications/apple/apple-push-notification-service
bundleSeedId= (required)
Set []:
sjabberwocky commented 1 year ago

Maybe improve the error message this way:

generate/app-descriptor :: Parameter not valid: bundleSeedId=.
# [com.distriqt.PushNotifications]: Bundle Seed Id (or App ID Prefix) for your iOS application
#         See: https://docs.airnativeextensions.com/docs/pushnotifications/apple/apple-push-notification-service