aboutsummaryrefslogtreecommitdiff
path: root/scripts/apidocs/processing/error.ts
blob: f171d6b4663fb590d9c352b3eed6899a291a1aa3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
import { FakerError } from '../../../src/errors/faker-error';
import type { SourceableNode } from './source';
import { getSourcePath } from './source';

export class FakerApiDocsProcessingError extends FakerError {
  constructor(options: {
    type: string;
    name: string;
    source: string | SourceableNode;
    cause: unknown;
  }) {
    const { type, name, source, cause } = options;
    const sourceText =
      typeof source === 'string' ? source : getSourcePathText(source);
    const causeText = cause instanceof Error ? cause.message : '';
    super(`Failed to process ${type} ${name} at ${sourceText} : ${causeText}`, {
      cause,
    });
  }
}

export function newProcessingError(options: {
  type: string;
  name: string;
  source: string | SourceableNode;
  cause: unknown;
}): FakerApiDocsProcessingError {
  const { cause } = options;

  if (cause instanceof FakerApiDocsProcessingError) {
    return cause;
  }

  return new FakerApiDocsProcessingError(options);
}

function getSourcePathText(source: SourceableNode): string {
  const { filePath, line, column } = getSourcePath(source);
  return `${filePath}:${line}:${column}`;
}