Function appendExampleImportDiagnostics

packages/tools/jsdocs/src/Jsdocs.ts:2584–2625

(files: ReadonlyArray<JSDocModelFile>)

}

function appendExampleImportDiagnostics(files: ReadonlyArray<JSDocModelFile>): ReadonlyArray<JSDocModelFile> {
  const policy = createExampleImportPolicy(files)
  const checkExamples = (
    examples: ReadonlyArray<ParsedExample>,
    range: readonly [number, number] = [0, 0] as const
  ): ReadonlyArray<JSDocModelDiagnostic> =>
    examples.flatMap((example) => validateExampleImports(example.code, policy).map((item) => ({ ...item, range })))
  const checkModuleExamples = (moduleJSDoc: ParsedModuleJSDoc | undefined): ReadonlyArray<JSDocModelDiagnostic> => {
    if (moduleJSDoc === undefined) return []
    const block = parseLooseJSDocBlock(moduleJSDoc.raw, [moduleJSDoc.range[0], moduleJSDoc.range[1]])
    if (block.internal) return []
    return checkExamples(parseModuleExamples(block).examples, moduleJSDoc.range)
  }
  const checkMembers = (members: ReadonlyArray<ParsedMember>): ReadonlyArray<JSDocModelDiagnostic> =>
    members.flatMap((member) => [
      ...checkExamples(member.examples),
      ...checkMembers(member.members)
    ])
  const checkNamespaces = (namespaces: ReadonlyArray<ParsedNamespace>): ReadonlyArray<JSDocModelDiagnostic> =>
    namespaces.flatMap((namespace) => [
      ...checkExamples(namespace.examples),
      ...namespace.declarations.flatMap((declaration) => [
        ...checkExamples(declaration.examples),
        ...checkMembers(declaration.members)
      ]),
      ...checkNamespaces(namespace.namespaces)
    ])
  return files.map((file) => {
    const diagnostics = [
      ...file.diagnostics,
      ...checkModuleExamples(file.moduleJSDoc),
      ...file.declarations.flatMap((declaration) => [
        ...checkExamples(declaration.examples),
        ...checkMembers(declaration.members)
      ]),
      ...checkNamespaces(file.namespaces)
    ]
    return diagnostics.length === file.diagnostics.length
      ? file
      : { ...file, diagnostics: uniqueModelDiagnostics(diagnostics) }
  })
}

function uniqueModelDiagnostics(
  diagnostics: ReadonlyArray<JSDocModelDiagnostic>