@spec add_pipeline(Igniter.t(), atom(), String.t(), Keyword.t()) :: Igniter.t()

Adds a pipeline to a Phoenix router.

Options

• :router - The router module to append to. Will be looked up if not provided.
• :arg2 - The second argument to the scope macro. Must be a value (typically a module).

@spec add_scope(Igniter.t(), String.t(), String.t(), Keyword.t()) :: Igniter.t()

Adds a scope to a Phoenix router.

Options

• :router - The router module to append to. Will be looked up if not provided.
• :arg2 - The second argument to the scope macro. Must be a value (typically a module).

@spec append_to_pipeline(Igniter.t(), atom(), String.t(), Keyword.t()) :: Igniter.t()

Appends code to a Phoenix router pipeline.

Options

• :router - The router module to append to. Will be looked up if not provided.

@spec append_to_scope(Igniter.t(), String.t(), String.t(), Keyword.t()) :: Igniter.t()

Appends to a phoenix router scope.

Relatively limited currently only exact matches of a top level route, second argument, and pipelines.

Options

• :router - The router module to append to. Will be looked up if not provided.
• :arg2 - The second argument to the scope macro. Must be a value (typically a module).
• :with_pipelines - A list of pipelines that the pipeline must be using to be considered a match.

@spec controller?(Igniter.t(), module()) :: boolean()

Returns true if the module is a Phoenix controller

@spec endpoints_for_router(igniter :: Igniter.t(), router :: module()) ::
  {Igniter.t(), [module()]}

Gets the list of endpoints that use a given router

@spec html?(Igniter.t(), module()) :: boolean()

Returns true if the module is a Phoenix HTML module

@spec list_routers(Igniter.t()) :: {Igniter.t(), [module()]}

Lists all routers found in the project.

@spec move_to_router_use(Igniter.t(), Sourceror.Zipper.t()) ::
  :error | {:ok, Sourceror.Zipper.t()}

Moves to the use statement in a module that matches use TheirWebModule, :router

@spec select_router(Igniter.t(), String.t()) :: {Igniter.t(), module() | nil}

Selects a router to be used in a later step. If only one router is found, it will be selected automatically.

If no routers exist, {igniter, nil} is returned.

If multiple routes are found, the user is prompted to select one of them.

@spec web_module(Igniter.t()) :: module()

Returns the web module name for the current app

@spec web_module_name() :: module()

Returns the web module name for the current app

@spec web_module_name(String.t()) :: module()

Generates a module name that lives in the Web directory of the current app.

@spec web_module_name(Igniter.t(), String.t()) :: module()

Generates a module name that lives in the Web directory of the current app.