renovate/tools/docs/utils.ts

import { logger } from '../../lib/logger';
import type { ModuleApi } from '../../lib/types';
import { readFile } from '../utils';

const replaceStart =
  '<!-- Autogenerate in https://github.com/renovatebot/renovatebot.github.io -->';
const replaceStop = '<!-- Autogenerate end -->';

export function capitalize(input: string): string {
  // console.log(input);
  return input[0].toUpperCase() + input.slice(1);
}

export function formatName(input: string): string {
  return input.split('-').map(capitalize).join(' ');
}

export function getDisplayName(
  moduleName: string,
  moduleDefinition: ModuleApi
): string {
  return moduleDefinition.displayName || formatName(moduleName);
}

export function getNameWithUrl(
  moduleName: string,
  moduleDefinition: ModuleApi
): string {
  const displayName = getDisplayName(moduleName, moduleDefinition);
  if (moduleDefinition.url) {
    return `[${displayName}](${moduleDefinition.url})`;
  }
  return displayName;
}

export function replaceContent(content: string, txt: string): string {
  const replaceStartIndex = content.indexOf(replaceStart);
  const replaceStopIndex = content.indexOf(replaceStop);

  if (replaceStartIndex < 0) {
    logger.error('Missing replace placeholder');
    return content;
  }
  return (
    content.slice(0, replaceStartIndex) +
    txt +
    content.slice(replaceStopIndex + replaceStop.length)
  );
}

export function formatUrls(urls: string[] | null | undefined): string {
  if (Array.isArray(urls) && urls.length) {
    return `**References**:\n\n${urls
      .map((url) => ` - [${url}](${url})`)
      .join('\n')}\n\n`;
  }
  return '';
}

export async function formatDescription(
  type: string,
  name: string
): Promise<string> {
  const content = await readFile(`lib/${type}/${name}/readme.md`);
  if (!content) {
    return '';
  }
  return `**Description**:\n\n${content}\n`;
}