Function generateDocumentation

packages/insomnia-inso/src/scripts/docs.ts:86–139

(program: commander.Command)

}

export function generateDocumentation(program: commander.Command): void {
  if (!fs.existsSync(DOCS_DIR)) {
    fs.mkdirSync(DOCS_DIR, { recursive: true });
  }

  const allCommands: any[] = [];

  program.commands.forEach(command => {
    const commandData = generateCommandMarkdown(command, program.options, '');

    allCommands.push({
      name: commandData.name,
      description: commandData.description,
      fileName: commandData.fileName,
      subcommands: commandData.subcommands.map(sub => ({
        name: sub.name(),
        description: sub.description() || 'No description available',
        fileName: `${commandData.name.replace(/\s+/g, '_')}_${sub.name().replace(/\s+/g, '_')}.md`,
      })),
    });

    commandData.subcommands.forEach(sub => {
      generateCommandMarkdown(sub, program.options, commandData.name);
    });
  });

  writeMarkdownFile(
    'index.md',
    `---
title: CLI Documentation
---

${generateOptionsMarkdown(program.options, 'Global Flags')}

## Commands

${allCommands
  .map(
    ({
      name,
      description,
      fileName,
    }) => `- [\`${name}\`](/inso-cli/reference/${fileName.replace('.md', '')}/{{page.release}}/): ${description}
`,
  )
  .join('')}
${allCommands
  .map(
    ({ name, subcommands }) => `${generateSubcommandsMarkdown(name, subcommands)}
`,
  )
  .join('')}`,
  );
}