View Source Igniter.Project.Module (igniter v0.5.0)

Codemods and utilities for interacting with modules

Summary

Types

location_type()

Placement instruction for a module.

Functions

create_module(igniter, module_name, contents, opts \\ [])

Creates a new file & module in its appropriate location.

find_all_matching_modules(igniter, predicate)

find_and_update_module(igniter, module_name, updater)

Finds a module and updates its contents. Returns {:error, igniter} if the module could not be found. Do not discard this igniter.

find_and_update_module!(igniter, module_name, updater)

Finds a module and updates its contents. Raises an error if it doesn't exist

find_and_update_or_create_module(igniter, module_name, contents, updater, opts \\ [])

Finds a module and updates its contents wherever it is.

find_module(igniter, module_name)

Finds a module, returning a new igniter, and the source and zipper location. This new igniter should not be discarded.

find_module!(igniter, module_name)

Finds a module, raising an error if its not found.

module_exists(igniter, module_name)

Checks if a module is defined somewhere in the project. The returned igniter should not be discarded.

module_exists?(igniter, module_name) deprecated

Checks if a module is defined somewhere in the project. The returned igniter should not be discarded.

module_name(igniter, suffix)

Given a suffix, returns a module name with the prefix of the current project.

module_name_prefix(igniter)

The module name prefix based on the mix project's module name

parse(module_name)

Parses a string into a module name

proper_location(igniter, module_name, type \\ :source_folder)

Determines where a module should be placed in a project.

Types

location_type()

@type location_type() ::
  :source_folder | {:source_folder, String.t()} | :test | :test_support

Placement instruction for a module.

:source_folder - The first source folder of the project
{:source_folder, path} - The selected source folder, i.e "lib"
:test - Creating a test file
:test_support - Creating a test support file

Functions

create_module(igniter, module_name, contents, opts \\ [])

Creates a new file & module in its appropriate location.

Options

:location - A location type. See t:location_type for more.

find_all_matching_modules(igniter, predicate)

@spec find_all_matching_modules(igniter :: Igniter.t(), (module(),
                                                   Sourceror.Zipper.t() ->
                                                     boolean())) ::
  {Igniter.t(), [module()]}

find_and_update_module(igniter, module_name, updater)

@spec find_and_update_module(Igniter.t(), module(), (Sourceror.Zipper.t() ->
                                                 {:ok, Sourceror.Zipper.t()}
                                                 | :error)) ::
  {:ok, Igniter.t()} | {:error, Igniter.t()}

Finds a module and updates its contents. Returns {:error, igniter} if the module could not be found. Do not discard this igniter.

find_and_update_module!(igniter, module_name, updater)

@spec find_and_update_module!(Igniter.t(), module(), (Sourceror.Zipper.t() ->
                                                  {:ok, Sourceror.Zipper.t()}
                                                  | :error)) ::
  Igniter.t()

Finds a module and updates its contents. Raises an error if it doesn't exist

find_and_update_or_create_module(igniter, module_name, contents, updater, opts \\ [])

Finds a module and updates its contents wherever it is.

If the module does not yet exist, it is created with the provided contents. In that case, the path is determined with Igniter.Code.Module.proper_location/2, but may optionally be overwritten with options below.

Options

:path - Path where to create the module, relative to the project root. Default: nil (uses :kind to determine the path).

find_module(igniter, module_name)

@spec find_module(Igniter.t(), module()) ::
  {:ok, {Igniter.t(), Rewrite.Source.t(), Sourceror.Zipper.t()}}
  | {:error, Igniter.t()}

Finds a module, returning a new igniter, and the source and zipper location. This new igniter should not be discarded.

In general, you should not use the returned source and zipper to update the module, instead, use this to interrogate the contents or source in some way, and then call find_and_update_module/3 with a function to perform an update.

find_module!(igniter, module_name)

@spec find_module!(Igniter.t(), module()) ::
  {Igniter.t(), Rewrite.Source.t(), Sourceror.Zipper.t()} | no_return()

Finds a module, raising an error if its not found.

See find_module/2 for more information.

module_exists(igniter, module_name)

@spec module_exists(Igniter.t(), module()) :: {boolean(), Igniter.t()}

Checks if a module is defined somewhere in the project. The returned igniter should not be discarded.

module_exists?(igniter, module_name)

This function is deprecated. Use `module_exists/2` instead..

Checks if a module is defined somewhere in the project. The returned igniter should not be discarded.

module_name(igniter, suffix)

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

Given a suffix, returns a module name with the prefix of the current project.

module_name_prefix(igniter)

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

The module name prefix based on the mix project's module name

parse(module_name)

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

Parses a string into a module name

proper_location(igniter, module_name, type \\ :source_folder)

@spec proper_location(Igniter.t(), module(), location_type()) :: String.t()

Determines where a module should be placed in a project.