Class: BetterTranslate::Generators::InstallGenerator

Inherits:
Rails::Generators::Base
  • Object
show all
Defined in:
lib/generators/better_translate/install/install_generator.rb

Overview

Rails generator for installing BetterTranslate

Creates initializer and config files for Rails applications.

Examples:

Run generator

rails generate better_translate:install

Instance Method Summary collapse

Instance Method Details

#create_config_file ⇒ void

This method returns an undefined value.

Create YAML config file



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/generators/better_translate/install/install_generator.rb', line 32

def create_config_file
  sample_config = {
    "provider" => "chatgpt",
    "openai_key" => "YOUR_OPENAI_API_KEY",
    "gemini_key" => "YOUR_GEMINI_API_KEY",
    "anthropic_key" => "YOUR_ANTHROPIC_API_KEY",
    "source_language" => "en",
    "target_languages" => [
      { "short_name" => "it", "name" => "Italian" },
      { "short_name" => "es", "name" => "Spanish" },
      { "short_name" => "fr", "name" => "French" }
    ],
    "input_file" => "config/locales/en.yml",
    "output_folder" => "config/locales",
    "verbose" => true,
    "dry_run" => false,
    "translation_mode" => "override",
    "preserve_variables" => true,
    "global_exclusions" => [], # : Array[String]
    "exclusions_per_language" => {}, # : Hash[String, Array[String]]
    "model" => nil,
    "temperature" => 0.3,
    "max_tokens" => 2000,
    "timeout" => 30,
    "max_retries" => 3,
    "rate_limit" => 10
  }

  create_file "config/better_translate.yml", sample_config.to_yaml
end

#create_initializer_file ⇒ void

This method returns an undefined value.

Create initializer file



24
25
26
 
# File 'lib/generators/better_translate/install/install_generator.rb', line 24

def create_initializer_file
  template "initializer.rb.tt", "config/initializers/better_translate.rb"
end

#show_readme ⇒ void

This method returns an undefined value.

Show post-install message



67
68
69
 
# File 'lib/generators/better_translate/install/install_generator.rb', line 67

def show_readme
  readme "README" if behavior == :invoke
end