scripts/apidocs/output/source-base-url.ts


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

import { execSync } from 'node:child_process';
import { writeFileSync } from 'node:fs';
import { resolve } from 'node:path';
import { formatTypescript } from '../utils/format';
import { FILE_PATH_API_DOCS } from '../utils/paths';
import { SCRIPT_COMMAND } from './constants';

const pathSourceBaseUrlFile = resolve(FILE_PATH_API_DOCS, 'source-base-url.ts');

/**
 * Writes the source base url to the correct location.
 */
export async function writeSourceBaseUrl(): Promise<void> {
  const baseUrl = getSourceBaseUrl();

  let content = `
  // This file is automatically generated.
  // Run '${SCRIPT_COMMAND}' to update
  export const sourceBaseUrl = '${baseUrl}';
  `.replace(/\n +/, '\n');

  content = await formatTypescript(content);

  writeFileSync(pathSourceBaseUrlFile, content);
}

function getSourceBaseUrl(): string {
  return `https://github.com/faker-js/faker/blob/${getCommitHash() || 'next'}/`;
}

function getCommitHash(): string | undefined {
  try {
    return execSync('git rev-parse --verify HEAD').toString('utf8').trim();
  } catch (error) {
    console.warn('Failed to get commit hash', error);
    return undefined;
  }
}