Handle hyphens in function names #12
Conversation
|
Hey @zmk-punchbowl thanks so much for this contribution! ❤️
If you could open a separate issue with some more details as to the error/versions used/anything we can use to recreate we'd be happy to look at it. Thanks! |
Thanks @roni-frantchi. I've made an update to the README that is hopefully acceptable. I've moved onto another development priority at the moment, so unfortunately, I'm not sure when I'll be able to repro & document the issue I had with the plugin dependency. If it's working well for you guys, then it may just be in my environment. |
No problem! Thanks for maintaining this useful package. |
In our
serverless.yml, we use hyphens (-) in our function names (for examplenote-get, andnote-create) and this is a legal convention in Serverless. However, we could not use this plugin to document our API because of this (since-is not legally allowed in a Typescript namespace).This PR adjusts the way function names are converted to namespace names using
camelCasefromlodash. For example,note-getbecomesnoteGetandnote_create-multiplewould becomenoteCreateMultiple.I also added a basic test for this (mostly relying on an existing test). Hopefully this helps. Thanks for creating a useful plugin.
Note that in our own usage, I could not get the plugin working with
@conqa/serverless-openapi-documentationand had to swap it out for@martinsson/serverless-openapi-documentation, but since that seems to be unrelated to this issue, I left that in a separate branch for now.