normalizeComment() — supabase Function Reference

Source Code

apps/docs/features/docs/Reference.typeSpec.ts lines 227–277

function normalizeComment(original: TypedocComment | Comment | undefined): Comment | undefined {
  if (!original) return

  if ('shortText' in original || 'text' in original) {
    // This is the old comment type, just return it
    return original
  }

  const comment: Comment = {}

  if ('summary' in original) {
    comment.shortText = original.summary.map((part) => part.text).join('')
  }

  if ('modifierTags' in original) {
    comment.tags = original.modifierTags.map((tag) => ({ tag: tag.replace(/^@/, ''), text: '' }))
  }

  // Extract @example tags from blockTags
  if ('blockTags' in original && Array.isArray(original.blockTags)) {
    const exampleTags = original.blockTags.filter((tag) => tag.tag === '@example')
    if (exampleTags.length > 0) {
      comment.examples = exampleTags.map((tag, index) => {
        // Use the name if provided, otherwise generate a default name
        const name = tag.name || `Example ${index + 1}`
        // Convert name to kebab-case for id
        const id = name
          .toLowerCase()
          .replace(/[^a-z0-9]+/g, '-')
          .replace(/^-|-$/g, '')
        // Join content to get the full text
        const fullText = tag.content.map((part) => part.text).join('')

        // Check if there's a "Response:" section and split it
        const responseMatch = fullText.match(/\n\s*Response:\s*\n/i)
        let code = fullText
        let response: string | undefined = undefined

        if (responseMatch) {
          const splitIndex = responseMatch.index! + responseMatch[0].length
          code = fullText.substring(0, responseMatch.index!).trim()
          response = fullText.substring(splitIndex).trim()
        }

        return { id, name, code, response }
      })
    }
  }

  return comment
}