Ignore dotted params

src/docs-report/api-extractor.ts

@@ -20,6 +20,7 @@
   lookupFile
 } from '../utils'
 import { EntryPoint } from '../interfaces'
+import { readFileSync } from 'fs'
 
 export const generateApiExtractorReport = async (
   entryPoint: EntryPoint,
@@ -78,6 +79,15 @@
   const category = getCategoryFromApiExtractor(message.category)
   const messageId = message.messageId
 
+  // Hack to support destructured param names
+  // TODO: Watch https://github.com/microsoft/tsdoc/issues/19
+  if (
+    messageId === 'tsdoc-param-tag-with-invalid-name' &&
+    checkIsValidParamName(message)
+  ) {
+    return
+  }
+
   const fullMessageId = `${category}:${messageId}`
   if (ignoreMessages.includes(fullMessageId)) {
     console.info(`Ignoring message: ${fullMessageId}`)
@@ -220,3 +230,39 @@
 
   return { typings, main }
 }
+
+const checkIsValidParamName = (message: ExtractorMessage): boolean => {
+  const sourceLineWords = readSourceLineWords(
+    message.sourceFilePath!,
+    message.sourceFileLine!,
+    message.sourceFileColumn!
+  )
+  if (sourceLineWords.length >= 2) {
+    const paramName = sourceLineWords[1]
+    if (isValidParamNameWithDot(paramName)) {
+      console.info('Ignoring paramName with dotted notation: ', paramName)
+      return true
+    }
+  }
+  return false
+}
+
+const readSourceLineWords = (
+  filePath: string,
+  line: number,
+  column: number
+): string => {
+  const fileContent = readFileSync(filePath, 'utf8')
+  const lines = fileContent.split('\n')
+  if (line > lines.length) return ''
+
+  const targetLine = lines[line - 1] // Lines are 1-indexed, arrays are 0-indexed
+  const words = targetLine.slice(column - 1).split(/\s+/) // Columns are 1-indexed
+  console.info('>>> Words:', words)
+  return words[0]
+}
+
+const isValidParamNameWithDot = (variableName: string): boolean => {
+  const regex = /^[a-zA-Z_$][\w$]*(\.[a-zA-Z_$][\w$]*)*$/
+  return regex.test(variableName)
+}