Skip to content

Pattern support#249

Merged
erunion merged 18 commits intoreadmeio:mainfrom
garrett-wade:patternSupport
Mar 2, 2022
Merged

Pattern support#249
erunion merged 18 commits intoreadmeio:mainfrom
garrett-wade:patternSupport

Conversation

@garrett-wade
Copy link
Copy Markdown
Contributor

@garrett-wade garrett-wade commented Mar 1, 2022

Adding support for custom comment pattern specification

This is initial enhancement to support the following issue readmeio/oas#603.

This enhancement:

  • added an optional pattern argument command-line argument with help text
  • added pattern attribute and get/set methods to Options object
  • added loadPattern method to Loader to load json file that contains specification of pattern
  • added section in swaggerInline in index file to handle adding the loaded pattern file to the options variable
  • ensured backwards compatibility if no pattern is specified
  • expanded test coverage to cover all changes

Testing

Refer to the can extract comments from custom pattern and custom file test in the extractor.test.js file to see a detailed test of the additional functionality.

Loading
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants