Skip to content

plugin-options

parsePluginOptions ⇒ ParsedPluginOptions

Parses the provided plugin options

Kind: global constant
Returns: ParsedPluginOptions - An object containing:

  • include: Array of patterns to include.
  • exclude: Array of patterns to exclude.
  • srcFolder: The source folder path, with './' prefix removed.
  • jsDocConfigPath: The path to the JSDoc configuration file.
  • codeFolder: The folder where the code resides.
  • docsFolder: The destination folder for the generated documentation.
  • title: The title for the documentation.
  • readme: The path to the README file.
  • rmPattern: Array of patterns to remove.
  • partials: Array of partial templates.
  • helpers: Array of helper functions.
ParamTypeDescription
optionsPluginOptionsThe plugin options to be parsed.

Released under the MIT License.