Method format_options

samcli/cli/command.py:115–142

(self, ctx: click.Context, formatter: RootCommandHelpTextFormatter)

        return commands

    def format_options(self, ctx: click.Context, formatter: RootCommandHelpTextFormatter):  # type: ignore
        # NOTE(sriram-mv): `ignore` is put in place here for mypy even though it is the correct behavior,
        # as the `formatter_class` can be set in subclass of Command. If ignore is not set,
        # mypy raises argument needs to be HelpFormatter as super class defines it.
        # NOTE(sriram-mv): Re-order options so that they come after the commands.
        self.format_commands(ctx, formatter)

        opts = []
        for param in self.get_params(ctx):
            row = param.get_help_record(ctx)
            if row is not None:
                term, help_text = row
                opts.append(RowDefinition(name=term, text=help_text))

        if opts:
            with formatter.indented_section(name="Options", extra_indents=1):
                formatter.write_rd(opts)

        with formatter.indented_section(name="Examples", extra_indents=1):
            with formatter.indented_section(name="Get Started", extra_indents=1):
                formatter.write_text_rows(
                    [
                        RowDefinition(
                            name=click.style(f"$ {ctx.command_path} init"),
                            extra_row_modifiers=[ShowcaseRowModifier()],
                        ),
                    ],
                )

    def format_commands(self, ctx: click.Context, formatter: RootCommandHelpTextFormatter):  # type: ignore
        # NOTE(sriram-mv): `ignore` is put in place here for mypy even though it is the correct behavior,