@mui/internal-docs-infra/useCode/generateVariantMarkdown.mjs

MUI Infra - internal documentation creation tools.

/**
 * Pure helpers for serializing a code variant's files into a Markdown
 * snippet suitable for pasting into chat or docs.
 */

/**
 * Returns the file extension (without the leading dot) used as the
 * Markdown code-fence language hint. Returns an empty string when the
 * filename has no usable extension.
 */
function getLanguageHint(fileName) {
  const lastDot = fileName.lastIndexOf('.');
  if (lastDot <= 0 || lastDot === fileName.length - 1) {
    return '';
  }
  return fileName.slice(lastDot + 1);
}

/**
 * Returns the filename rendered as a comment in the syntax of the given
 * language, or an empty string when the language has no supported comment
 * syntax for this purpose.
 */
function getFileNameComment(fileName, language) {
  switch (language) {
    case 'js':
    case 'jsx':
    case 'ts':
    case 'tsx':
    case 'mjs':
    case 'cjs':
      return `// ${fileName}`;
    case 'css':
    case 'scss':
    case 'less':
      return `/* ${fileName} */`;
    case 'mdx':
      return `{/* ${fileName} */}`;
    case 'md':
    case 'html':
    case 'svg':
    case 'xml':
      return `<!-- ${fileName} -->`;
    default:
      return '';
  }
}

/**
 * Returns a fence string at least one backtick longer than the longest
 * run of backticks in any of the file sources. This guarantees the fence
 * cannot be terminated by content inside the code block.
 */
function pickFence(files) {
  let longestRun = 2;
  for (const file of files) {
    const matches = file.source.match(/`+/g);
    if (!matches) {
      continue;
    }
    for (const match of matches) {
      if (match.length > longestRun) {
        longestRun = match.length;
      }
    }
  }
  return '`'.repeat(longestRun + 1);
}
export function generateVariantMarkdown({
  title,
  files
}) {
  if (files.length === 0) {
    return '';
  }
  const fence = pickFence(files);
  const sections = [];
  if (title) {
    sections.push(`### ${title}`);
  }
  for (const file of files) {
    const language = getLanguageHint(file.name);
    const body = file.source.replace(/\n+$/, '');
    const comment = getFileNameComment(file.name, language);
    const header = comment ? `${comment}\n\n` : '';
    sections.push(`${fence}${language}\n${header}${body}\n${fence}`);
  }
  return `${sections.join('\n\n')}\n`;
}