gen_template_component v0.1.3 GenTemplateComponent View Source

Templates for Elixir projects that contain state

Based on the keynote by Dave Thomas at Empex NYC 2018 about how we are all writing Elixir incorrectly.

Bootstrap

Before you can use this template (or any other template), you need to install mix gen.

This template is installed using the template.install mix task. Projects are generated from it using the mix gen task.

So, before using templates for the first time, you need to install these two tasks:

$ mix archive.install mix_templates
$ mix archive.install mix_generator

Then you can install this template using

$ mix template.install gen_template_component

New Component

To generate your new Elixir component

mix gen component «name» [ --into «path» ] [--module «module»]

«Module» must be a valid Elixir module name or alias.

Link to this section Summary

Functions

Return the name or path of a template that this template is based upon. That template will be processed first, and then this one will be executed

Override this function to do any cleanup after your template has been copied into the user project. One use of this is to remove unwanted files created by a template upon which this template is based

Return the name of this template as an atom. This is the name passed to the gen command

Return the list of options supported by this template

Return the short description of this template, or nil

Return the absolute path to the tree that is to be copied when instantiating this template. This top-level dir will typically just contain a directory called $APP_NAME$

Link to this section Functions

Return the name or path of a template that this template is based upon. That template will be processed first, and then this one will be executed.

Override this function to do any cleanup after your template has been copied into the user project. One use of this is to remove unwanted files created by a template upon which this template is based.

Return the name of this template as an atom. This is the name passed to the gen command.

Return the list of options supported by this template.

Return the short description of this template, or nil.

Return the absolute path to the tree that is to be copied when instantiating this template. This top-level dir will typically just contain a directory called $APP_NAME$.