template_generator

searchNodes=[{"doc":"Generator task entrypoint This module centralize all steps required to create a new project based on the given template","ref":"Generator.html","title":"Generator","type":"module"},{"doc":"Generates a new project based on template","ref":"Generator.html#generate/2","title":"Generator.generate/2","type":"function"},{"doc":"Resolves paths for git template option","ref":"Generator.Path.Adapters.GitResolver.html","title":"Generator.Path.Adapters.GitResolver","type":"module"},{"doc":"","ref":"Generator.Path.Adapters.GitResolver.html#resolve/1","title":"Generator.Path.Adapters.GitResolver.resolve/1","type":"function"},{"doc":"Resolves paths for json template option","ref":"Generator.Path.Adapters.JsonResolver.html","title":"Generator.Path.Adapters.JsonResolver","type":"module"},{"doc":"","ref":"Generator.Path.Adapters.JsonResolver.html#resolve/1","title":"Generator.Path.Adapters.JsonResolver.resolve/1","type":"function"},{"doc":"Resolves paths for local template option","ref":"Generator.Path.Adapters.LocalResolver.html","title":"Generator.Path.Adapters.LocalResolver","type":"module"},{"doc":"Resolves all paths for the given local project template","ref":"Generator.Path.Adapters.LocalResolver.html#resolve/2","title":"Generator.Path.Adapters.LocalResolver.resolve/2","type":"function"},{"doc":"Project template path creator","ref":"Generator.Path.Adapters.PathCreator.html","title":"Generator.Path.Adapters.PathCreator","type":"module"},{"doc":"Creates all paths recursively for the given files and directories tree","ref":"Generator.Path.Adapters.PathCreator.html#create/1","title":"Generator.Path.Adapters.PathCreator.create/1","type":"function"},{"doc":"Project template directory resolutions","ref":"Generator.Path.Adapters.TemplateDirectory.html","title":"Generator.Path.Adapters.TemplateDirectory","type":"module"},{"doc":"Build a new template directory representation","ref":"Generator.Path.Adapters.TemplateDirectory.html#build/3","title":"Generator.Path.Adapters.TemplateDirectory.build/3","type":"function"},{"doc":"Project template file resolutions","ref":"Generator.Path.Adapters.TemplateFile.html","title":"Generator.Path.Adapters.TemplateFile","type":"module"},{"doc":"Build a new template file representation","ref":"Generator.Path.Adapters.TemplateFile.html#build/2","title":"Generator.Path.Adapters.TemplateFile.build/2","type":"function"},{"doc":"Schema representing a template directory","ref":"Generator.Path.Schemas.TemplateDirectory.html","title":"Generator.Path.Schemas.TemplateDirectory","type":"module"},{"doc":"","ref":"Generator.Path.Schemas.TemplateDirectory.html#t:t/0","title":"Generator.Path.Schemas.TemplateDirectory.t/0","type":"type"},{"doc":"Schema representing a template file","ref":"Generator.Path.Schemas.TemplateFile.html","title":"Generator.Path.Schemas.TemplateFile","type":"module"},{"doc":"","ref":"Generator.Path.Schemas.TemplateFile.html#t:t/0","title":"Generator.Path.Schemas.TemplateFile.t/0","type":"type"},{"doc":"Template generator paths context external API","ref":"Generator.Paths.html","title":"Generator.Paths","type":"module"},{"doc":"Creates all paths for the given project","ref":"Generator.Paths.html#create_from_template/1","title":"Generator.Paths.create_from_template/1","type":"function"},{"doc":"Resolves all template paths","ref":"Generator.Paths.html#resolve_template_paths/1","title":"Generator.Paths.resolve_template_paths/1","type":"function"},{"doc":"Project resolutions","ref":"Generator.Project.Adapters.Project.html","title":"Generator.Project.Adapters.Project","type":"module"},{"doc":"Create a new project representation","ref":"Generator.Project.Adapters.Project.html#new/2","title":"Generator.Project.Adapters.Project.new/2","type":"function"},{"doc":"Schema representing a project","ref":"Generator.Project.Schemas.Project.html","title":"Generator.Project.Schemas.Project","type":"module"},{"doc":"","ref":"Generator.Project.Schemas.Project.html#t:t/0","title":"Generator.Project.Schemas.Project.t/0","type":"type"},{"doc":"Template generator projects context external API","ref":"Generator.Projects.html","title":"Generator.Projects","type":"module"},{"doc":"Creates a new project representation","ref":"Generator.Projects.html#new/2","title":"Generator.Projects.new/2","type":"function"},{"doc":"Template resolutions","ref":"Generator.Template.Adapters.Template.html","title":"Generator.Template.Adapters.Template","type":"module"},{"doc":"Build template struct with given template name and project path.","ref":"Generator.Template.Adapters.Template.html#build/2","title":"Generator.Template.Adapters.Template.build/2","type":"function"},{"doc":"Schema representing a Template","ref":"Generator.Template.Schemas.Template.html","title":"Generator.Template.Schemas.Template","type":"module"},{"doc":"","ref":"Generator.Template.Schemas.Template.html#t:t/0","title":"Generator.Template.Schemas.Template.t/0","type":"type"},{"doc":"Template generator templates context external API","ref":"Generator.Templates.html","title":"Generator.Templates","type":"module"},{"doc":"Build template info for an project","ref":"Generator.Templates.html#build/1","title":"Generator.Templates.build/1","type":"function"},{"doc":"Generate new module using template","ref":"Mix.Tasks.Generator.New.html","title":"Mix.Tasks.Generator.New","type":"task"},{"doc":"Callback implementation for Mix.Task.run/1 .","ref":"Mix.Tasks.Generator.New.html#run/1","title":"Mix.Tasks.Generator.New.run/1","type":"function"},{"doc":"Elixir project templates generation.","ref":"readme.html","title":"Template Generator","type":"extras"},{"doc":"PTBR","ref":"readme.html#docs","title":"Template Generator - Docs","type":"extras"},{"doc":"Github Latest > mix archive.install github viniciuslcpereira97/template-generator Specific branch > mix archive.install github viniciuslcpereira97/template-generator branch $BRANCH Specific version > mix archive.install github viniciuslcpereira97/template-generator tag $RELEASE_TAG Hex > mix archive.install hex template_generator","ref":"readme.html#installation","title":"Template Generator - Installation","type":"extras"},{"doc":"Example template folder structure . └ ─ ─ example ├ ─ ─ schemas │ └ ─ ─ example . ex └ ─ ─ services ├ ─ ─ example . ex └ ─ ─ user └ ─ ─ user . ex Set your templates directory's path in your config.exs . config :generator, templates_dir: "./templates", templates: [ my_awesome_template: "example" ] templates_dir : Directory with all available templates templates : the key is an alias for your template and the value is the template folder name found at your templates_dir","ref":"readme.html#configure","title":"Template Generator - Configure","type":"extras"},{"doc":"To create a new project based on an template you should run the following command: > mix generator.new ./apps/my-awesome-new-folder --template=my_awesome_template","ref":"readme.html#usage","title":"Template Generator - Usage","type":"extras"},{"doc":"Project folder structure before running the task . ├ ─ ─ generator . ex ├ ─ ─ mix │ └ ─ ─ tasks │ └ ─ ─ generator . new . ex ├ ─ ─ path │ ├ ─ ─ adapters │ │ ├ ─ ─ git_resolver . ex │ │ ├ ─ ─ json_resolver . ex │ │ ├ ─ ─ local_resolver . ex │ │ ├ ─ ─ path_creator . ex │ │ ├ ─ ─ path_resolver . ex │ │ ├ ─ ─ template_directory . ex │ │ └ ─ ─ template_file . ex │ ├ ─ ─ logic │ └ ─ ─ schemas │ ├ ─ ─ template_directory . ex │ └ ─ ─ template_file . ex ├ ─ ─ paths . ex ├ ─ ─ project │ ├ ─ ─ adapters │ │ └ ─ ─ project . ex │ ├ ─ ─ logic │ └ ─ ─ schemas │ └ ─ ─ project . ex ├ ─ ─ projects . ex ├ ─ ─ template │ ├ ─ ─ adapters │ │ └ ─ ─ template . ex │ ├ ─ ─ logic │ └ ─ ─ schemas │ └ ─ ─ template . ex └ ─ ─ templates . ex Project folder structure after running the task . ├ ─ ─ generator . ex ├ ─ ─ mix │ └ ─ ─ tasks │ └ ─ ─ generator . new . ex ├ ─ ─ my - awesome - new - folder │ ├ ─ ─ schemas │ │ └ ─ ─ example . ex │ └ ─ ─ services │ ├ ─ ─ example . ex │ └ ─ ─ user │ └ ─ ─ user . ex ├ ─ ─ path │ ├ ─ ─ adapters │ │ ├ ─ ─ git_resolver . ex │ │ ├ ─ ─ json_resolver . ex │ │ ├ ─ ─ local_resolver . ex │ │ ├ ─ ─ path_creator . ex │ │ ├ ─ ─ path_resolver . ex │ │ ├ ─ ─ template_directory . ex │ │ └ ─ ─ template_file . ex │ ├ ─ ─ logic │ └ ─ ─ schemas │ ├ ─ ─ template_directory . ex │ └ ─ ─ template_file . ex ├ ─ ─ paths . ex ├ ─ ─ project │ ├ ─ ─ adapters │ │ └ ─ ─ project . ex │ ├ ─ ─ logic │ └ ─ ─ schemas │ └ ─ ─ project . ex ├ ─ ─ projects . ex ├ ─ ─ template │ ├ ─ ─ adapters │ │ └ ─ ─ template . ex │ ├ ─ ─ logic │ └ ─ ─ schemas │ └ ─ ─ template . ex └ ─ ─ templates . ex","ref":"readme.html#results","title":"Template Generator - Results","type":"extras"},{"doc":"Projeto em Elixir para gerar projetos a partir de templates.","ref":"readme_pt_br.html","title":"Template Generator","type":"extras"},{"doc":"EN","ref":"readme_pt_br.html#docs","title":"Template Generator - Docs","type":"extras"},{"doc":"Github Latest > mix archive.install github viniciuslcpereira97/template-generator Branch específica > mix archive.install github viniciuslcpereira97/template-generator branch $BRANCH Versão específica > mix archive.install github viniciuslcpereira97/template-generator tag $RELEASE_TAG Hex > mix archive.install hex template_generator","ref":"readme_pt_br.html#instala%C3%A7%C3%A3o","title":"Template Generator - Instalação","type":"extras"},{"doc":"Estrutura de pastas do template de exemplo . └ ─ ─ example ├ ─ ─ schemas │ └ ─ ─ example . ex └ ─ ─ services ├ ─ ─ example . ex └ ─ ─ user └ ─ ─ user . ex Defina o path do seu diretório de templates no arquivo config.exs . config :generator, templates_dir: "./templates", templates: [ my_awesome_template: "example" ] templates_dir : Diretório com todos os templates disponíveis templates : a chave na lista corresponde ao apelido do seu template utilizado ao rodar o comando mix e o valor corresponde ao nome da pasta do template encontrada no templates_dir","ref":"readme_pt_br.html#configura%C3%A7%C3%A3o","title":"Template Generator - Configuração","type":"extras"},{"doc":"Para criar um novo projeto baseado em um template você deve executar o comando a seguir: > mix generator.new ./apps/my-awesome-new-folder --template=my_awesome_template","ref":"readme_pt_br.html#como-usar","title":"Template Generator - Como usar","type":"extras"},{"doc":"Estrutura de pasta do projeto antes de executar a Task . ├ ─ ─ generator . ex ├ ─ ─ mix │ └ ─ ─ tasks │ └ ─ ─ generator . new . ex ├ ─ ─ path │ ├ ─ ─ adapters │ │ ├ ─ ─ git_resolver . ex │ │ ├ ─ ─ json_resolver . ex │ │ ├ ─ ─ local_resolver . ex │ │ ├ ─ ─ path_creator . ex │ │ ├ ─ ─ path_resolver . ex │ │ ├ ─ ─ template_directory . ex │ │ └ ─ ─ template_file . ex │ ├ ─ ─ logic │ └ ─ ─ schemas │ ├ ─ ─ template_directory . ex │ └ ─ ─ template_file . ex ├ ─ ─ paths . ex ├ ─ ─ project │ ├ ─ ─ adapters │ │ └ ─ ─ project . ex │ ├ ─ ─ logic │ └ ─ ─ schemas │ └ ─ ─ project . ex ├ ─ ─ projects . ex ├ ─ ─ template │ ├ ─ ─ adapters │ │ └ ─ ─ template . ex │ ├ ─ ─ logic │ └ ─ ─ schemas │ └ ─ ─ template . ex └ ─ ─ templates . ex Estrutura de pasta do projeto depois de executar a Task . ├ ─ ─ generator . ex ├ ─ ─ mix │ └ ─ ─ tasks │ └ ─ ─ generator . new . ex ├ ─ ─ my - awesome - new - folder │ ├ ─ ─ schemas │ │ └ ─ ─ example . ex │ └ ─ ─ services │ ├ ─ ─ example . ex │ └ ─ ─ user │ └ ─ ─ user . ex ├ ─ ─ path │ ├ ─ ─ adapters │ │ ├ ─ ─ git_resolver . ex │ │ ├ ─ ─ json_resolver . ex │ │ ├ ─ ─ local_resolver . ex │ │ ├ ─ ─ path_creator . ex │ │ ├ ─ ─ path_resolver . ex │ │ ├ ─ ─ template_directory . ex │ │ └ ─ ─ template_file . ex │ ├ ─ ─ logic │ └ ─ ─ schemas │ ├ ─ ─ template_directory . ex │ └ ─ ─ template_file . ex ├ ─ ─ paths . ex ├ ─ ─ project │ ├ ─ ─ adapters │ │ └ ─ ─ project . ex │ ├ ─ ─ logic │ └ ─ ─ schemas │ └ ─ ─ project . ex ├ ─ ─ projects . ex ├ ─ ─ template │ ├ ─ ─ adapters │ │ └ ─ ─ template . ex │ ├ ─ ─ logic │ └ ─ ─ schemas │ └ ─ ─ template . ex └ ─ ─ templates . ex","ref":"readme_pt_br.html#resultados","title":"Template Generator - Resultados","type":"extras"}]