Function API_DOCS

scripts/docs.js:198–224

(content, options)

      return `${pluginDocs}`
    },
    API_DOCS(content, options) {
      const fileContents = fs.readFileSync(path.join(__dirname, '..', 'packages/analytics-core/src/index.js'), 'utf-8')
      const unsortedDocBlocs = dox.parseComments(fileContents, { raw: true, skipSingleStar: true })

      const end = unsortedDocBlocs.filter((element) => {
        return PLUGIN_KEYS.includes(element.ctx.name)
      })
      const begin = unsortedDocBlocs.filter((element) => {
        return !PLUGIN_KEYS.includes(element.ctx.name)
      })
      const docBlocs = begin.concat(end).filter((element) => {
        return !element.ctx.name.match(/(Payload|Context)$/)
      })
      let updatedContent = ''
      const removeItems = ['analytics.instance', 'analytics.return']
      docBlocs.forEach((data) => {
        const niceName = formatName(data.ctx.name)
        if (!removeItems.includes(niceName)) {
          updatedContent += `### ${formatName(data.ctx.name)}\n\n`
          updatedContent += `${data.description.full}\n\n`
          updatedContent += `${formatArguments(data.tags)}`
          updatedContent += formatExample(data.tags).join('\n')
          updatedContent += `\n`
        }
      })
      return updatedContent.replace(/^\s+|\s+$/g, '')
    }
  }
}