docusaurus-graphql-plugin/src/converters/pushFields.ts

Docusaurus plugin generating Markdown documentation from a GraphQL schema.

import { GraphQLField } from "graphql";
import { MarkdownConverterOptions } from "../types";
import { pushArguments } from "./pushArguments";
import { escapeSpecialCharacters, parseMarkdown } from "./parseMarkdown";

export function pushFields(
  lines: string[],
  fields: GraphQLField<any, any>[],
  options: MarkdownConverterOptions
): void {
  lines.push(
    `<p style={{ marginBottom: "0.4em" }}><strong>Fields</strong></p>`,
    `\n\n`
  );

  lines.push(`<table>`, `\n`);
  lines.push(`<thead><tr><th>Name</th><th>Description</th></tr></thead>`, `\n`);
  lines.push(`<tbody>`, `\n`);

  fields.forEach((field) => {
    lines.push(`<tr>`, `\n`);
    const typeUrl = options.getTypePath(field.type);
    lines.push(
      `<td>`,
      `\n`,
      `${field.name}`,
      `<br />\n`,
      typeUrl
        ? `<a href="${typeUrl}"><code>${field.type.toJSON()}</code></a>`
        : `<code>${field.type.toJSON()}</code>`,
      `\n`,
      `</td>`,
      `\n`
    );

    lines.push(`<td>`, `\n`);

    if (field.deprecationReason) {
      lines.push(
        `<blockquote>Deprecated: ${escapeSpecialCharacters(
          field.deprecationReason
        )}</blockquote>`,
        `\n\n`
      );
    }

    lines.push(parseMarkdown(field.description || ""), `\n`);

    if (field.args.length > 0) {
      lines.push(`\n`);
      pushArguments(lines, field.args, options);
    }

    lines.push(`</td>`, `\n`);

    lines.push(`</tr>`, `\n`);
  });

  lines.push(`</tbody>`, `\n`);
  lines.push(`</table>`, `\n\n`);
}