Skip to content

⬅️ Back to Table of Contents

📄 markdown.ts

📊 Analysis Summary

Metric Count
🔧 Functions 5
📦 Imports 2
📊 Variables & Constants 3

📚 Table of Contents

🛠️ File Location:

📂 packages/website/src/components/lib/markdown.ts

📦 Imports

Name Source
ConfigModel ../types
parseESLintRC ./parseConfig

Variables & Constants

Name Type Kind Value Exported
code string const `### ${title}\n\n\``${type}\n${value}\n````` ✗
onlyRuleName string const `ruleKeys.length === 1
? ruleKeys[0].replace('@typescript-eslint/', '')
: 'rule name here'` ✗
params { 'eslint-config': string; labels: string; 'playground-link': string; 'repro-code': string; template: string; title: string; 'typescript-config': string; versions: string; } const `{
'eslint-config': module.exports = ${state.eslintrc},
labels: 'bug,package: eslint-plugin,triage',
'playground-link': document.location.toString(),
'repro-code': state.code,
template: '01-bug-report-plugin.yaml',
title: Bug: [${onlyRuleName}] <short description of the issue>,
'typescript-config': state.tsconfig,
versions: generateVersionsTable(state.ts),
}` ✗

Functions

createSummary(value: string, title: string, type: 'json' | 'ts', length: number): string

Code 
function createSummary(
  value: string,
  title: string,
  type: 'json' | 'ts',
  length: number,
): string {
  const code = `### ${title}\n\n\`\`\`${type}\n${value}\n\`\`\``;
  if ((code.match(/\n/g) ?? []).length > length) {
    return `<details>\n<summary>Expand</summary>\n\n${code}\n\n</details>`;
  }
  return code;
}
  • Parameters:
  • value: string
  • title: string
  • type: 'json' | 'ts'
  • length: number
  • Return Type: string
  • Calls:
  • code.match

createSummaryJson(obj: string, field: string, title: string): string

Code 
function createSummaryJson(obj: string, field: string, title: string): string {
  if (obj && obj.length > 0) {
    return createSummary(obj, title, 'json', 10);
  }
  return '';
}
  • Parameters:
  • obj: string
  • field: string
  • title: string
  • Return Type: string
  • Calls:
  • createSummary

generateVersionsTable(tsVersion: string): string

Code 
function generateVersionsTable(tsVersion: string): string {
  return [
    '| package | version |',
    '| -- | -- |',
    `| \`@typescript-eslint/eslint-plugin\` | \`${process.env.TS_ESLINT_VERSION}\` |`,
    `| \`@typescript-eslint/parser\` | \`${process.env.TS_ESLINT_VERSION}\` |`,
    `| \`TypeScript\` | \`${tsVersion}\` |`,
    `| \`ESLint\` | \`${process.env.ESLINT_VERSION}\` |`,
    `| \`node\` | \`web\` |`,
  ].join('\n');
}
  • Parameters:
  • tsVersion: string
  • Return Type: string
  • Calls:
  • [ '| package | version |', '| -- | -- |',| `@typescript-eslint/eslint-plugin` | `${process.env.TS_ESLINT_VERSION}` |,| `@typescript-eslint/parser` | `${process.env.TS_ESLINT_VERSION}` |,| `TypeScript` | `${tsVersion}` |,| `ESLint` | `${process.env.ESLINT_VERSION}` |,| `node` | `web` |, ].join

createMarkdown(state: ConfigModel): string

Code 
export function createMarkdown(state: ConfigModel): string {
  return [
    `[Playground](${document.location.toString()})`,
    createSummary(state.code, 'Code', 'ts', 30),
    createSummaryJson(state.eslintrc, 'rules', 'Eslint config'),
    createSummaryJson(state.tsconfig, 'compilerOptions', 'TypeScript config'),
    generateVersionsTable(state.ts),
  ]
    .filter(Boolean)
    .join('\n\n');
}

  • JSDoc: 

    /**
 * Create a markdown string that user can copy and paste into an issue
 */

  • Parameters:

  • state: ConfigModel
  • Return Type: string
  • Calls:
  • [Playground, createSummary(state.code, 'Code', 'ts', 30), createSummaryJson(state.eslintrc, 'rules', 'Eslint config'), createSummaryJson(state.tsconfig, 'compilerOptions', 'TypeScript config'), generateVersionsTable(state.ts), ] .filter(Boolean) .join

createMarkdownParams(state: ConfigModel): string

Code 
export function createMarkdownParams(state: ConfigModel): string {
  const { rules } = parseESLintRC(state.eslintrc);
  const ruleKeys = Object.keys(rules);

  const onlyRuleName =
    ruleKeys.length === 1
      ? ruleKeys[0].replace('@typescript-eslint/', '')
      : 'rule name here';

  const params = {
    'eslint-config': `module.exports = ${state.eslintrc}`,
    labels: 'bug,package: eslint-plugin,triage',
    'playground-link': document.location.toString(),
    'repro-code': state.code,
    template: '01-bug-report-plugin.yaml',
    title: `Bug: [${onlyRuleName}] <short description of the issue>`,
    'typescript-config': state.tsconfig,
    versions: generateVersionsTable(state.ts),
  };

  return new URLSearchParams(params).toString();
}

  • JSDoc: 

    /**
 * Create a URLSearchParams string for the issue template
 */

  • Parameters:

  • state: ConfigModel
  • Return Type: string
  • Calls:
  • parseESLintRC (from ./parseConfig)
  • Object.keys
  • ruleKeys[0].replace
  • document.location.toString
  • generateVersionsTable
  • new URLSearchParams(params).toString