class MStrap::Project
- MStrap::Project
- Reference
- Object
Included Modules
Defined in:
mstrap/project.crClass Method Summary
-
.for(project_def : Defs::ProjectDef)
Factory constructor for
Project
from a project definition
Instance Method Summary
-
#clone
Clones the project from Git
-
#cname : String
Returns canonical name for the project.
-
#git_upstream_uri
Returns a usable Git URI for the project's upstream, or nil if not specified
-
#git_uri
Returns a usable Git URI for the project
-
#hostname : String
Returns hostname for the project.
-
#name : String
Returns friendly display name for the project.
-
#path : String
Returns path to the project on the filesystem.
-
#port : Int32?
Returns the port for the project, if configured.
-
#pull
Updates the project from Git, including auto-stashing any unstaged and uncommited changes.
-
#repo : String
Returns the configured GitHub path or URI for the project's repo.
-
#repo_upstream : String?
Returns the configured GitHub path or URI for the project's upstream repo, if configured.
-
#run_scripts? : Bool
Returns whether to execute and scripts-to-rule-them-all scripts, if they exist.
-
#runtimes : Array(String)?
Returns the language runtimes of the project, if specified.
-
#upstream
Returns the NGINX upstream for the project.
-
#web? : Bool
Returns whether the project is a web project.
-
#websocket? : Bool
Returns whether the project requires a websocket connection
Instance methods inherited from module MStrap::DSL::System
cmd(env : Hash | Nil, command : String, args : Array(String) | Nil, **kwargs)
cmd,
has_command?(command_name : String, **kwargs) : Bool
has_command?
Instance methods inherited from module MStrap::DSL::Logging
log(msg)
log,
logc(msg)
logc,
logd(msg)
logd,
logn(msg)
logn,
logw(msg)
logw,
success(msg)
success
Class Method Detail
Factory constructor for Project
from a project definition
Instance Method Detail
Updates the project from Git, including auto-stashing any unstaged and uncommited changes.
Returns the configured GitHub path or URI for the project's upstream repo, if configured.
Returns whether to execute and scripts-to-rule-them-all scripts, if they exist.