Public: List of options that can be specified on the command line
# File lib/asciidoctor/cli/options.rb, line 9 def initialize(options = {}) self[:attributes] = options[:attributes] || {} self[:input_files] = options[:input_files] || nil self[:output_file] = options[:output_file] || nil self[:safe] = options[:safe] || SafeMode::UNSAFE self[:header_footer] = options[:header_footer] || true self[:template_dirs] = options[:template_dirs] || nil self[:template_engine] = options[:template_engine] || nil if options[:doctype] self[:attributes]['doctype'] = options[:doctype] end if options[:backend] self[:attributes]['backend'] = options[:backend] end self[:eruby] = options[:eruby] || nil self[:compact] = options[:compact] || false self[:verbose] = options[:verbose] || false self[:base_dir] = options[:base_dir] self[:destination_dir] = options[:destination_dir] || nil self[:trace] = false end
# File lib/asciidoctor/cli/options.rb, line 31 def self.parse!(args) Options.new.parse! args end
# File lib/asciidoctor/cli/options.rb, line 35 def parse!(args) opts_parser = OptionParser.new do |opts| opts.banner = <<-EOS Usage: asciidoctor [OPTION]... FILE... Translate the AsciiDoc source FILE or FILE(s) into the backend output format (e.g., HTML 5, DocBook 4.5, etc.) By default, the output is written to a file with the basename of the source file and the appropriate extension. Example: asciidoctor -b html5 source.asciidoc EOS opts.on('-v', '--verbose', 'enable verbose mode (default: false)') do |verbose| self[:verbose] = true end opts.on('-b', '--backend BACKEND', 'set output format backend (default: html5)') do |backend| self[:attributes]['backend'] = backend end opts.on('-d', '--doctype DOCTYPE', ['article', 'book', 'manpage', 'inline'], 'document type to use when rendering output: [article, book, manpage, inline] (default: article)') do |doc_type| self[:attributes]['doctype'] = doc_type end opts.on('-o', '--out-file FILE', 'output file (default: based on input file path); use - to output to STDOUT') do |output_file| self[:output_file] = output_file end opts.on('--safe', 'set safe mode level to safe (default: unsafe)', 'enables include macros, but restricts access to ancestor paths of source file', 'provided for compatibility with the asciidoc command') do self[:safe] = SafeMode::SAFE end opts.on('-S', '--safe-mode SAFE_MODE', ['unsafe', 'safe', 'server', 'secure'], 'set safe mode level explicitly: [unsafe, safe, server, secure] (default: unsafe)', 'disables potentially dangerous macros in source files, such as include::[]') do |safe_mode| self[:safe] = SafeMode.const_get(safe_mode.upcase) end opts.on('-s', '--no-header-footer', 'suppress output of header and footer (default: false)') do self[:header_footer] = false end opts.on('-n', '--section-numbers', 'auto-number section titles in the HTML backend; disabled by default') do self[:attributes]['numbered'] = '' end opts.on('-e', '--eruby ERUBY', ['erb', 'erubis'], 'specify eRuby implementation to render built-in templates: [erb, erubis] (default: erb)') do |eruby| self[:eruby] = eruby end opts.on('-C', '--compact', 'compact the output by removing blank lines (default: false)') do self[:compact] = true end opts.on('-a', '--attribute key[=value],key2[=value2],...', Array, 'a list of document attributes to set in the form of key, key! or key=value pair', 'unless @ is appended to the value, these attributes take precedence over attributes', 'defined in the source document') do |attribs| attribs.each do |attrib| key, val = attrib.split '=', 2 # move leading ! to end for internal processing #if val.nil? && key.start_with?('!') # key = "#{key[1..-1]}!" #end self[:attributes][key] = val || '' end end opts.on('-T', '--template-dir DIR', 'a directory containing custom render templates that override the built-in set (requires tilt gem)', 'may be specified multiple times') do |template_dir| if self[:template_dirs].nil? self[:template_dirs] = [template_dir] elsif self[:template_dirs].is_a? Array self[:template_dirs].push template_dir else self[:template_dirs] = [self[:template_dirs], template_dir] end end opts.on('-E', '--template-engine NAME', 'template engine to use for the custom render templates (loads gem on demand)') do |template_engine| self[:template_engine] = template_engine end opts.on('-B', '--base-dir DIR', 'base directory containing the document and resources (default: directory of source file)') do |base_dir| self[:base_dir] = base_dir end opts.on('-D', '--destination-dir DIR', 'destination output directory (default: directory of source file)') do |dest_dir| self[:destination_dir] = dest_dir end opts.on('--trace', 'include backtrace information on errors (default: false)') do |trace| self[:trace] = true end opts.on_tail('-h', '--help', 'show this message') do $stdout.puts opts return 0 end opts.on_tail('-V', '--version', 'display the version') do $stdout.puts "Asciidoctor #{Asciidoctor::VERSION} [http://asciidoctor.org]" return 0 end end begin infiles = [] opts_parser.parse! args if args.empty? $stderr.puts opts_parser return 1 end # shave off the file to process so that options errors appear correctly if args.size == 1 && args.first == '-' infiles.push args.pop elsif args.each do |file| if (file == '-' || file.start_with?('-')) # warn, but don't panic; we may have enough to proceed, so we won't force a failure $stderr.puts "asciidoctor: WARNING: extra arguments detected (unparsed arguments: #{args.map{|a| "'#{a}'"} * ', '}) or incorrect usage of stdin" else # TODO this glob may not be necessary as the shell should have already performed expansion matches = Dir.glob file if matches.empty? $stderr.puts "asciidoctor: FAILED: input file #{file} missing or cannot be read" return 1 end infiles.concat matches end end end infiles.each do |file| unless file == '-' || File.readable?(file) $stderr.puts "asciidoctor: FAILED: input file #{file} missing or cannot be read" return 1 end end self[:input_files] = infiles if !self[:template_dirs].nil? begin require 'tilt' rescue LoadError $stderr.puts 'asciidoctor: FAILED: tilt could not be loaded; to use a custom backend, you must have the tilt gem installed (gem install tilt)' return 1 end end rescue OptionParser::MissingArgument $stderr.puts "asciidoctor: option #{$!.message}" $stdout.puts opts_parser return 1 rescue OptionParser::InvalidOption, OptionParser::InvalidArgument $stderr.puts "asciidoctor: #{$!.message}" $stdout.puts opts_parser return 1 end self end