Function buildCommandSection

scripts/docs/src/generate-cli-docs.ts:382–485

({
  command,
  rootName,
  ancestors,
  depth,
  useRootIntro,
}: BuildCommandSectionOptions)

};

function buildCommandSection({
  command,
  rootName,
  ancestors,
  depth,
  useRootIntro,
}: BuildCommandSectionOptions): Content[] {
  const nodes: Content[] = [];
  const commandPath = getCommandPath(rootName, ancestors, command);
  const isRootCommand = ancestors.length === 0;
  const shouldUseIntro = isRootCommand && useRootIntro;
  const headingContent = shouldUseIntro
    ? "Introduction"
    : [createInlineCode(commandPath)];

  nodes.push(createHeading(depth, headingContent));

  const description = command.description();
  if (description) {
    nodes.push(createParagraph(description));
  }

  const usage = buildUsage(command);
  if (usage) {
    const sectionDepth = shouldUseIntro ? depth : Math.min(depth + 1, 6);
    nodes.push(createHeading(sectionDepth, "Usage"));
    nodes.push({
      type: "paragraph",
      children: [createInlineCode(usage)],
    });
  }

  const aliases = command.aliases();
  if (aliases.length > 0) {
    const sectionDepth = shouldUseIntro ? depth : Math.min(depth + 1, 6);
    nodes.push(createHeading(sectionDepth, "Aliases"));
    nodes.push(
      createList(
        aliases.map((alias) => createListItem([createInlineCode(alias)])),
      ),
    );
  }

  const args = command.registeredArguments ?? [];
  if (args.length > 0) {
    const sectionDepth = shouldUseIntro ? depth : Math.min(depth + 1, 6);
    nodes.push(createHeading(sectionDepth, "Arguments"));
    nodes.push(createList(buildArgumentListItems(args)));
  }

  const visibleOptions = command.options.filter((option) => !option.hidden);
  if (visibleOptions.length > 0) {
    const { flags, valueOptions } = partitionOptions(visibleOptions);
    const sectionDepth = shouldUseIntro ? depth : Math.min(depth + 1, 6);

    if (valueOptions.length > 0) {
      nodes.push(createHeading(sectionDepth, "Options"));
      nodes.push(