Class: YARD::CLI::I18n
- Inherits:
-
Yardoc
- Object
- Command
- YardoptsCommand
- Yardoc
- YARD::CLI::I18n
- Defined in:
- lib/yard/cli/i18n.rb
Overview
Support msgminit and msgmerge features?
CLI command to support internationalization (a.k.a. i18n). I18n feature is based on gettext technology. This command generates .pot file from docstring and extra documentation.
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<String>) hidden_apis
inherited
from Yardoc
Keep track of which APIs are to be hidden.
-
- (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)
Constructor Details
- (I18n) initialize
Returns a new instance of I18n
13 14 15 16 |
# File 'lib/yard/cli/i18n.rb', line 13 def initialize super @options.serializer.basepath = "po/yard.pot" end |
Instance Attribute Details
- (Array<String>) assets Originally defined in class Yardoc
Returns a list of assets to copy after generation
- (Array<String>) excluded Originally defined in class Yardoc
Returns list of excluded paths (regexp matches)
- (Array<String>) files Originally defined in class Yardoc
Returns list of Ruby source files to process
- (Boolean) generate Originally defined in class Yardoc
Returns whether to generate output
- (Boolean) has_markup Originally defined in class Yardoc
Returns whether markup option was specified
- (Array<String>) hidden_apis Originally defined in class Yardoc
Keep track of which APIs are to be hidden
- (Array<Symbol>) hidden_tags Originally defined in class Yardoc
Returns a list of tags to hide from templates
- (Boolean) list Originally defined in class Yardoc
Returns whether to print a list of objects
- (Hash) options (readonly) Originally defined in class Yardoc
Returns the hash of options passed to the template.
- (String) options_file Originally defined in class YardoptsCommand
The options file name (defaults to DEFAULT_YARDOPTS_FILE)
- (Boolean) save_yardoc Originally defined in class Yardoc
Returns whether objects should be serialized to .yardoc db
- (Boolean) statistics Originally defined in class Yardoc
Returns whether to print statistics after parsing
- (Boolean) use_cache Originally defined in class Yardoc
Returns whether to use the existing yardoc db if the .yardoc already exists. Also makes use of file checksums to parse only changed files.
- (Boolean) use_document_file Originally defined in class YardoptsCommand
Returns whether to parse options from .document
- (Boolean) use_yardopts_file Originally defined in class YardoptsCommand
Returns whether to parse options from .yardopts
Instance Method Details
- (Object) description
18 19 20 |
# File 'lib/yard/cli/i18n.rb', line 18 def description 'Generates .pot file from source code and extra documentation' end |
- (Object) run(*args)
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 = .serializer pot_file_path = Pathname.new(serializer.basepath). 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 |