gen_template_code_quality v0.1.0 CodeQuality
Code Quality Template
A mix gen template for quickly bootstrapping a mix project.
Quickstart
$ mix template.install gen_template_code_quality
$ mix gen code_quality «project_name»
$ cd «project_name»
$ mix deps.get
Installation
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 hex mix_templates
$ mix archive.install hex mix_generator
Then you can install this template using
$ mix template.install hex gen_template_code_quality
Use
To create a new project run:
$ mix gen code_quality «project_name»
$ cd «project_name»
$ mix deps.get
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
based_on()
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.
clean_up(assigns)
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.
name()
Return the name of this template as an atom. This is the name passed to the gen command.
options()
Return the list of options supported by this template.
short_desc()
Return the short description of this template, or nil.
source_dir()
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$
.