Function generateDefinition

packages/nextra/src/server/tsdoc/base.ts:69–174

({
  code,
  exportName = 'default',
  flattened = false
}: BaseArgs)

 * ```
 */
export function generateDefinition({
  code,
  exportName = 'default',
  flattened = false
}: BaseArgs): GeneratedDefinition & (GeneratedType | GeneratedFunction) {
  // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition -- Can't access at top level, fix File not found: /var/task/.../tsconfig.json
  compilerObject ??= project.getTypeChecker().compilerObject
  const sourceFile = project.createSourceFile(DEFAULT_FILENAME, code, {
    overwrite: true
  })
  const output: ExportedDeclarations[] = []
  for (const [key, declaration] of sourceFile.getExportedDeclarations()) {
    if (key === exportName) output.push(...declaration)
  }
  const declaration = output[0]
  if (!declaration) {
    throw new Error(`Can't find "${exportName}" declaration`)
  }
  const declarationFilePath = declaration.getSourceFile().getFilePath()
  const filePath = slash(path.relative(CWD, declarationFilePath))
  const symbol = declaration.getSymbolOrThrow()
  const { comment, tags } = getCommentAndTags(declaration)
  const description = ts.displayPartsToString(comment)
  tags.returns &&= replaceJsDocLinks(tags.returns)

  const definition: GeneratedDefinition = {
    // Skip adding `filePath` to snapshots on test env, since we have tests on Mac and on Windows, they fail
    ...// process.env.NODE_ENV !== 'test' &&
    (filePath !== DEFAULT_FILENAME && { filePath }),
    name: symbol.getName(),
    ...(description && { description }),
    ...(Object.keys(tags).length && { tags })
  }

  const declarationType = declaration.getType()
  const callSignatures = declarationType.getCallSignatures()
  const isFunction = callSignatures.length > 0

  if (!isFunction) {
    const entries = declarationType
      .getProperties()
      .flatMap(prop =>
        getDocEntry({
          symbol: prop,
          declaration,
          flattened
        })
      )
      .filter(entry => !entry.tags || !('internal' in entry.tags))
    if (!entries.length) {
      const typeName = declarationType.getText()
      if (typeName === 'any') {
        throw new Error(
          'Your type is resolved as "any", it seems like you have an issue in "generateDefinition.code" argument.'
        )
      }
      throw new Error(
        `No properties found, check if your type "${typeName}" exist.`