grisp_tools_configure (grisp_tools v2.8.0)

View Source

Summary

Types

--- API -----------------------------------------------------------------------

Functions

{Long, Short, Type, Default, Descr}

The parameters defined directly inside this function won't be ask in the interactive part of the CLI

Types

set_opts/0

-type set_opts() ::
          #set_opts{prompt :: string(),
                    long :: atom(),
                    short :: char() | undefined,
                    type :: setting_type(),
                    default :: none | string() | boolean(),
                    description :: string(),
                    dep_setting_fun :: function(),
                    hint :: string()}.

--- API -----------------------------------------------------------------------

setting/0

-type setting() ::
          {atom(), char() | undefined, string(), {setting_type(), string() | boolean()}, string()}.

setting_type/0

-type setting_type() :: string | trim_string | boolean | latin1.

Functions

run(State)

{Long, Short, Type, Default, Descr}

settings()

-spec settings() -> [setting()].

The parameters defined directly inside this function won't be ask in the interactive part of the CLI