Class: Command::Generate

Inherits:

Base

• Object
• Base
• Command::Generate

Defined in:

lib/command/generate.rb

Constant Summary

NAME =

"generate"

DESCRIPTION =

"Creates base Control Plane config and template files"

LONG_DESCRIPTION =

<<~DESC
  Creates base Control Plane config and template files for a Rails project:
  - infers the app prefix from the current directory and wires staging, review, and production entries
  - infers the Docker base Ruby version from `.ruby-version`, `.tool-versions`, or the app's `Gemfile`
  - preserves repo-defined asset precompile hooks, including React on Rails auto bundle generation
  - detects SQLite in `config/database.yml` and generates persistent `db` and `storage` volume templates instead of the default Postgres workload
DESC

EXAMPLES =

<<~EX
  ```sh
  # Creates .controlplane directory with Control Plane config and starter templates
  cpflow generate
  ```
EX

WITH_INFO_HEADER =

false

VALIDATIONS =

[].freeze

REQUIRES_STARTUP_CHECKS =

false

Constants inherited from Base

Base::ACCEPTS_EXTRA_OPTIONS, Base::ALL_VALIDATIONS, Base::DEFAULT_ARGS, Base::HIDE, Base::OPTIONS, Base::REQUIRES_ARGS, Base::SUBCOMMAND_NAME, Base::USAGE, Base::VALIDATIONS_WITHOUT_ADDITIONAL_OPTIONS, Base::VALIDATIONS_WITH_ADDITIONAL_OPTIONS

Instance Attribute Summary

Attributes inherited from Base

#config

Instance Method Summary

• #call ⇒ Object

Methods inherited from Base

add_app_identity_option, all_commands, all_options, all_options_by_key_name, app_option, #args_join, commit_option, common_options, #cp, cpu_option, detached_option, dir_option, docker_context_option, domain_option, #ensure_docker_running!, entrypoint_option, image_option, #initialize, interactive_option, location_option, log_method_option, logs_limit_option, logs_since_option, memory_option, org_option, #progress, replica_option, #run_command_in_latest_image, #run_cpflow_command, run_release_phase_option, skip_confirm_option, skip_post_creation_hook_option, skip_pre_deletion_hook_option, skip_secret_access_binding_option, skip_secrets_setup_option, staging_branch_option, #step, #step_finish, terminal_size_option, trace_option, upstream_token_option, use_local_token_option, validations_option, verbose_option, version_option, wait_option, #with_retry, workload_option

Methods included from Helpers

normalize_command_name, normalize_option_name, random_four_digits, strip_str_and_validate

Constructor Details

This class inherits a constructor from Command::Base

Instance Method Details

#call ⇒ Object

# File 'lib/command/generate.rb', line 180

def call
  if controlplane_directory_exists?
    Shell.warn("The directory '.controlplane' already exists!")
    return
  end

  Generator.start
end