Function jsDocsPlugin

packages/plugin-jsdocs/src/lib/jsdocs-plugin.ts:33–53

(config: JsDocsPluginConfig)

 * @returns Plugin configuration.
 */
export function jsDocsPlugin(config: JsDocsPluginConfig): PluginConfig {
  const jsDocsConfig = validate(jsDocsPluginConfigSchema, config);
  const scoreTargets = jsDocsConfig.scoreTargets;

  const groups = filterGroupsByOnlyAudits(GROUPS, jsDocsConfig);
  const audits = filterAuditsByPluginConfig(jsDocsConfig);

  logAuditsAndGroups(audits, groups);

  return {
    slug: PLUGIN_SLUG,
    title: PLUGIN_TITLE,
    icon: 'folder-docs',
    description: PLUGIN_DESCRIPTION,
    docsUrl: PLUGIN_DOCS_URL,
    groups,
    audits,
    runner: createRunnerFunction(jsDocsConfig),
    ...(scoreTargets && { scoreTargets }),
  };
}