bitnami / readme-generator-for-helm

Auto generate READMEs for Helm Charts
https://bitnami.com
Apache License 2.0
212 stars 48 forks source link

Parser should lazy match modifier close bracket #28

Closed Cvetk0 closed 2 years ago

Cvetk0 commented 2 years ago

Description of the change

Add lazy quantifier to modifier parser to allow further square brackets in description. Parser currently consumed entire text up to including final square bracket as a modifier.

Add tests to support fix.

Benefits

Allow additional square brackets in the description when one of the allowed modifiers was already used. This allows using anchor links to other sections of generated README or listing example allowed values.

Possible drawbacks

Applicable issues

Additional information

Checklist

Cvetk0 commented 2 years ago

@miguelaeh, should I just update version to 2.0.0 in package.json and package-lock.json or is there anything else required?

Cvetk0 commented 2 years ago

Hi @miguelaeh, rebased and bumped version to 2.0.1. Hopefully I did it right. Thanks for guidance here, still getting familiar with this process :)