Function validateExampleImports

repos/effect/packages/tools/jsdocs/src/Jsdocs.ts:2417–2474

(
  code: string,
  policy: ExampleImportPolicy
)

): { readonly files: ReadonlyArray<JSDocModelFile>; readonly added: boolean } {
  const diagnosticsByFile = new Map(files.map((file) => [file.file, [...file.diagnostics]]))
  const resolve = createJSDocApiSeeLinkResolver(apis)
  let added = false
  for (const file of files) {
    if (file.imports === undefined || file.moduleJSDoc === undefined) continue
    const sourceFile = context.sourceFilesByFile.get(file.file)
    const diagnostics = diagnosticsByFile.get(file.file)
    if (sourceFile === undefined || diagnostics === undefined) continue
    for (const tag of moduleSeeTags(file, sourceFile, context)) {
      for (const link of tag.links) {
        const item = unresolvedPublicSeeDiagnostic({
          ...link,
          resolution: resolve({ moduleName: file.imports.module, namespacePath: [] }, link)
        })
        if (item === undefined || diagnostics.some((diagnostic) => sameDiagnostic(diagnostic, item))) continue
        diagnostics.push(item)
        added = true
      }
    }
  }
  if (!added) return { files, added }
  return {
    added,
    files: files.map((file) => ({
      ...file,
      diagnostics: diagnosticsByFile.get(file.file) ?? file.diagnostics
    }))
  }
}

function buildJSDocApisWithPublicSeeDiagnostics(
  files: ReadonlyArray<JSDocModelFile>,
  context?: {
    readonly sourceFilesByFile: ReadonlyMap<string, ts.SourceFile>
    readonly checker: ts.TypeChecker
    readonly entry: ProgramCacheEntry
    readonly cwd: string
  }
): {
  readonly files: ReadonlyArray<JSDocModelFile>
  readonly apis: ReadonlyArray<JSDocApi>
} {
  let current = files
  for (let index = 0; index < 5; index++) {
    const apis = buildJSDocApis(current)
    const publicSee = appendPublicSeeDiagnostics(current, apis)
    const moduleSee = context === undefined
      ? { files: publicSee.files, added: false }
      : appendModulePublicSeeDiagnostics(publicSee.files, apis, context)
    const next = { files: moduleSee.files, added: publicSee.added || moduleSee.added }
    if (!next.added) return { files: current, apis }
    current = next.files
  }
  return { files: current, apis: buildJSDocApis(current) }
}

interface ExampleImportPolicy {
  readonly allowedNamedBySource: ReadonlyMap<string, ReadonlySet<string>>
  readonly namespaceModuleBySource: ReadonlyMap<string, { readonly barrelModule: string; readonly name: string }>