Function importGuidance

packages/tools/jsdocs/src/Jsdocs.ts:1995–2031

(
  imports: ParsedJSDocImports,
  kind: JSDocApiKind,
  bucket: ExportBucket | null,
  apiName: string
)

}

function importGuidance(
  imports: ParsedJSDocImports,
  kind: JSDocApiKind,
  bucket: ExportBucket | null,
  apiName: string
): JSDocApiImportGuidance | null {
  if (kind !== "root-declaration" || bucket !== "value" || !isIdentifierName(apiName)) {
    return null
  }
  if (imports.flatNames.includes(apiName) && imports.barrel !== null) {
    return {
      style: "named-barrel",
      importDeclaration: `import { ${apiName} } from "${imports.barrel.module}"`,
      usage: apiName
    }
  }
  if (imports.barrel?.type === "namespace") {
    if (!isIdentifierName(imports.barrel.name)) return null
    return {
      style: "namespace-barrel",
      importDeclaration: `import { ${imports.barrel.name} } from "${imports.barrel.module}"`,
      usage: `${imports.barrel.name}.${apiName}`
    }
  }
  if (imports.barrel?.type === "flat") {
    return {
      style: "named-barrel",
      importDeclaration: `import { ${apiName} } from "${imports.barrel.module}"`,
      usage: apiName
    }
  }
  return {
    style: "named-module",
    importDeclaration: `import { ${apiName} } from "${imports.module}"`,
    usage: apiName
  }
}

function makeApi(input: {
  readonly file: JSDocModelFile