-
Notifications
You must be signed in to change notification settings - Fork 18
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
To achieve this, we vendor the cli docs generator.
- Loading branch information
Showing
4 changed files
with
102 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,99 @@ | ||
"""Generate markdown for the manifestoo cli. | ||
Extracted from https://github.com/tiangolo/typer-cli, to avoid a dependency | ||
on typer-cli which is not compatible with the latest typer release. | ||
Copyright (c) 2020 Sebastián Ramírez (MIT License). | ||
""" | ||
from pathlib import Path | ||
from typing import cast | ||
|
||
import typer | ||
from click import Command, Context, Group | ||
|
||
from manifestoo.main import app | ||
|
||
|
||
def get_docs_for_click( | ||
*, | ||
obj: Command, | ||
ctx: typer.Context, | ||
indent: int = 0, | ||
name: str = "", | ||
call_prefix: str = "", | ||
) -> str: | ||
docs = "#" * (1 + indent) | ||
command_name = name or obj.name | ||
if call_prefix: | ||
command_name = f"{call_prefix} {command_name}" | ||
title = f"`{command_name}`" if command_name else "CLI" | ||
docs += f" {title}\n\n" | ||
if obj.help: | ||
docs += f"{obj.help}\n\n" | ||
usage_pieces = obj.collect_usage_pieces(ctx) | ||
if usage_pieces: | ||
docs += "**Usage**:\n\n" | ||
docs += "```console\n" | ||
docs += "$ " | ||
if command_name: | ||
docs += f"{command_name} " | ||
docs += f"{' '.join(usage_pieces)}\n" | ||
docs += "```\n\n" | ||
args = [] | ||
opts = [] | ||
for param in obj.get_params(ctx): | ||
rv = param.get_help_record(ctx) | ||
if rv is not None: | ||
if param.param_type_name == "argument": | ||
args.append(rv) | ||
elif param.param_type_name == "option": | ||
opts.append(rv) | ||
if args: | ||
docs += "**Arguments**:\n\n" | ||
for arg_name, arg_help in args: | ||
docs += f"* `{arg_name}`" | ||
if arg_help: | ||
docs += f": {arg_help}" | ||
docs += "\n" | ||
docs += "\n" | ||
if opts: | ||
docs += "**Options**:\n\n" | ||
for opt_name, opt_help in opts: | ||
docs += f"* `{opt_name}`" | ||
if opt_help: | ||
docs += f": {opt_help}" | ||
docs += "\n" | ||
docs += "\n" | ||
if obj.epilog: | ||
docs += f"{obj.epilog}\n\n" | ||
if isinstance(obj, Group): | ||
group: Group = cast(Group, obj) | ||
commands = group.list_commands(ctx) | ||
if commands: | ||
docs += "**Commands**:\n\n" | ||
for command in commands: | ||
command_obj = group.get_command(ctx, command) | ||
assert command_obj | ||
docs += f"* `{command_obj.name}`" | ||
command_help = command_obj.get_short_help_str() | ||
if command_help: | ||
docs += f": {command_help}" | ||
docs += "\n" | ||
docs += "\n" | ||
for command in commands: | ||
command_obj = group.get_command(ctx, command) | ||
assert command_obj | ||
use_prefix = "" | ||
if command_name: | ||
use_prefix += f"{command_name}" | ||
docs += get_docs_for_click( | ||
obj=command_obj, ctx=ctx, indent=indent + 1, call_prefix=use_prefix | ||
) | ||
return docs | ||
|
||
|
||
if __name__ == "__main__": | ||
command = typer.main.get_command(app) | ||
ctx = Context(command) | ||
doc = get_docs_for_click(obj=command, ctx=ctx, name="manifestoo").strip() + "\n" | ||
Path(__file__).parent.joinpath("cli.md").write_text(doc) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
Relax the typer dependency version constraint. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters