Class: YARD::CLI::I18n

Inherits:

Yardoc

• Object
• Command
• YardoptsCommand
• Yardoc
• YARD::CLI::I18n

show all

Defined in:

lib/yard/cli/i18n.rb

Overview

Constant Summary

Instance Attribute Summary (collapse)

• - (Array<String>) apis inherited from Yardoc

  Keep track of which APIs are to be shown.

• - (Array<String>) assets inherited from Yardoc

  A list of assets to copy after generation.

• - (Array<String>) excluded inherited from Yardoc

  List of excluded paths (regexp matches).

• - (Array<String>) files inherited from Yardoc

  List of Ruby source files to process.

• - (Boolean) generate inherited from Yardoc

  Whether to generate output.

• - (Boolean) has_markup inherited from Yardoc

  Whether markup option was specified.

• - (Array<Symbol>) hidden_tags inherited from Yardoc

  A list of tags to hide from templates.

• - (Boolean) list inherited from Yardoc

  Whether to print a list of objects.

• - (Hash) options inherited from Yardoc readonly

  The hash of options passed to the template.

• - (String) options_file inherited from YardoptsCommand

  The options file name (defaults to YardoptsCommand::DEFAULT_YARDOPTS_FILE).

• - (Boolean) save_yardoc inherited from Yardoc

  Whether objects should be serialized to .yardoc db.

• - (Boolean) statistics inherited from Yardoc

  Whether to print statistics after parsing.

• - (Boolean) use_cache inherited from Yardoc

  Whether to use the existing yardoc db if the .yardoc already exists.

• - (Boolean) use_document_file inherited from YardoptsCommand

  Whether to parse options from .document.

• - (Boolean) use_yardopts_file inherited from YardoptsCommand

  Whether to parse options from .yardopts.

• - (Array<Symbol>) visibilities inherited from Yardoc

  Keep track of which visibilities are to be shown.

Instance Method Summary (collapse)

• - (Object) description
• - (I18n) initialize constructor

  A new instance of I18n.

• - (Object) run(*args)

13
14
15
16

# File 'lib/yard/cli/i18n.rb', line 13

def initialize
  super
  @options.serializer.basepath = "po/yard.pot"
end

18
19
20

# File 'lib/yard/cli/i18n.rb', line 18

def description
  'Generates .pot file from source code and extra documentation'
end

22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39

# File 'lib/yard/cli/i18n.rb', line 22

def run(*args)
  if args.size == 0 || !args.first.nil?
    # fail early if arguments are not valid
    return unless parse_arguments(*args)
  end

  YARD.parse(files, excluded)

  serializer = options.serializer
  pot_file_path = Pathname.new(serializer.basepath).expand_path
  pot_file_dir_path, pot_file_basename = pot_file_path.split
  relative_base_path = Pathname.pwd.relative_path_from(pot_file_dir_path)
  serializer.basepath = pot_file_dir_path.to_s
  serializer.serialize(pot_file_basename.to_s,
                       generate_pot(relative_base_path.to_s))

  true
end