Add a simple ZP name check #417
Conversation
Added a check, that ZP name starts with "ZenPacks." to avoid typos and errors like #415
| sys.exit( | ||
| "`{}` is a wrong name for ZenPack - zenpack name must starts " | ||
| "with `ZenPacks`. Please, check ZP name.".format(zenpack_name) | ||
| ) |
There was a problem hiding this comment.
I would suggest changing message to something like this:
"ZenPack name is incorrect, it does not match ZenPack naming requirenments. Please see documentation: https://zenpack-sdk.zenoss.com/en/stable/managing-zenpacks-4.html#naming-a-zenpack"
There was a problem hiding this comment.
I think it's better to explain the error in place - not provide some external link to some "magic" ZenPack naming requirements.
There was a problem hiding this comment.
I agree that it's a good idea to perform this check and also to provide direct feedback. The main issue with this PR, though, is that the monolithic zenpacklib.py file is now vestigial and is not the appropriate place for the change.
I took your suggestion and created a similar change here:
#420
and also added a check for the length of the ZenPack namespace (since that might go wrong as well).
There was a problem hiding this comment.
ok, I'll close this PR in favour of #420
Added a check, that ZP name starts with "ZenPacks." to avoid typos and
errors like #415