class AzuCLI::Generate::Project

• AzuCLI::Generate::Project
• Teeplate::FileTree
• Reference
• Object

Overview

Project generator that creates a new Azu project from templates

Defined in:

azu_cli/generators/project.cr

Constant Summary

OUTPUT_DIR = "./"

Constructors

• .new(project : String, module_name : String, author : String, email : String, license : String = "MIT", project_type : String = "web", database : String = "postgresql", test_framework : String = "spec", ci_setup : String = "GitHub Actions", docker_support : Bool = false, git_init : Bool = true, include_example : Bool = true, include_joobq : Bool = true, env : String = "development")

Instance Method Summary

• #____collect_files(____files)

  :nodoc:

• #__ecr1(____io)
• #__ecr11(____io)
• #__ecr13(____io)
• #__ecr15(____io)
• #__ecr17(____io)
• #__ecr19(____io)
• #__ecr21(____io)
• #__ecr28(____io)
• #__ecr35(____io)
• #__ecr37(____io)
• #__ecr39(____io)
• #__ecr4(____io)
• #__ecr41(____io)
• #__ecr43(____io)
• #__ecr50(____io)
• #__ecr52(____io)
• #__ecr54(____io)
• #__ecr56(____io)
• #__ecr58(____io)
• #__ecr6(____io)
• #__ecr60(____io)
• #__ecr62(____io)
• #__ecr64(____io)
• #__ecr68(____io)
• #__ecr71(____io)
• #__ecr73(____io)
• #__ecr75(____io)
• #__ecr77(____io)
• #__ecr8(____io)
• #api_project? : Bool

  Check if it's an API project type

• #author : String
• #author=(author : String)
• #binary_name : String

  Get the binary name for targets

• #ci_filename : String

  Get CI workflow filename

• #ci_setup : String
• #ci_setup=(ci_setup : String)
• #cli_project? : Bool

  Check if it's a CLI project type

• #database : String
• #database=(database : String)
• #database_adapter : String

  Get database adapter name for dependencies

• #database_adapter_uri_prefix : String
• #database_dependency : String

  Get database dependency for shard.yml

• #database_env_url : String
• #docker_support : Bool
• #docker_support=(docker_support : Bool)
• #email : String
• #email=(email : String)
• #env : String
• #env=(env : String)
• #example_component : String

  Get example endpoint or component based on project type

• #filter(entries)

  Override filter method to conditionally exclude files based on project type

• #git_init : Bool
• #git_init=(git_init : Bool)
• #github_name : String
• #github_name=(github_name : String)
• #has_ci? : Bool

  Check if project should include CI configuration

• #has_joobq? : Bool

  Check if JoobQ should be included

• #include_example : Bool
• #include_example=(include_example : Bool)
• #include_joobq : Bool
• #include_joobq=(include_joobq : Bool)
• #license : String
• #license=(license : String)
• #main_file : String

  Get the main file extension based on project type

• #module_name : String
• #module_name=(module_name : String)
• #project : String

  Project configuration properties

• #project=(project : String)

  Project configuration properties

• #project_type : String
• #project_type=(project_type : String)
• #schema_name : String

  Generate schema class name from project name Examples: "blog" → "BlogDB", "my_blog" → "MyBlogDB"

• #schema_symbol : String

  Generate schema symbol from project name Examples: "blog" → "blog_db", "my_blog" → "my_blog_db"

• #test_dependency : String

  Get test framework dependency

• #test_framework : String
• #test_framework=(test_framework : String)
• #web_project? : Bool

  Check if it's a web project type

Constructor Detail

Instance Method Detail