BreezeNew.Config (breeze_new v0.5.1)

Copy Markdown

Configuration shared by the TUI and non-interactive generator.

Summary

Types

t()

@type t() :: %BreezeNew.Config{
  app_name: String.t(),
  breeze_dep: {:hex, String.t()},
  breeze_timeline_dep: {:hex, String.t()},
  cache_size: pos_integer() | :dynamic,
  commit_message: String.t(),
  deps_get: boolean(),
  init_git: boolean(),
  inspector: boolean(),
  live_reload: boolean(),
  module_name: String.t(),
  mouse: boolean(),
  storybook: boolean(),
  target: String.t(),
  template: :blank | :counter | :list | :kitchen_sink | :ssh,
  termite_ssh_dep: {:hex, String.t()},
  theme:
    :dracula
    | :commander
    | :gruvbox
    | :catppuccin
    | :nord
    | :solarized_light
    | :solarized_dark
    | :system,
  theme_cycle: boolean(),
  timeline: boolean()
}

Functions

new(name, opts \\ [])

@spec new(String.t(), keyword()) :: {:ok, t()} | {:error, String.t()}

templates()

@spec templates() :: [atom()]

themes()

@spec themes() :: [atom()]

validate(config)

@spec validate(t()) :: :ok | {:error, String.t()}