Contents

require 'jsduck/exporter/app'
require 'jsduck/batch_formatter'
require 'jsduck/template_dir'
require 'jsduck/index_html'
require 'jsduck/app_data'
require 'jsduck/class_writer'
require 'jsduck/source/writer'
require 'jsduck/inline_examples'
require 'fileutils'

module JsDuck

  # Performs the generation of docs web app.
  class WebWriter
    def initialize(relations, assets, parsed_files, opts)
      @relations = relations
      @assets = assets
      @parsed_files = parsed_files
      @opts = opts
    end

    def write
      clean_output_dir

      write_template_files
      write_app_data

      # class-formatting is done in parallel which breaks the links
      # between source files and classes. Therefore it MUST to be done
      # after writing sources which needs the links to work.
      write_source if @opts.source
      format_classes

      write_inline_examples if @opts.tests

      write_classes

      @assets.write
    end

    def write_template_files
      TemplateDir.new(@opts).write
      IndexHtml.new(@assets, @opts).write
    end

    def write_app_data
      AppData.new(@relations, @assets, @opts).write(@opts.output_dir+"/data.js")
    end

    def write_source
      source_writer = Source::Writer.new(@parsed_files)
      source_writer.write(@opts.output_dir + "/source")
    end

    def write_inline_examples
      examples = InlineExamples.new
      examples.add_classes(@relations)
      examples.add_guides(@assets.guides)
      examples.write(@opts.output_dir+"/inline-examples.js")
    end

    def write_classes
      class_writer = ClassWriter.new(Exporter::App, @relations, @opts)
      class_writer.write(@opts.output_dir+"/output", ".js")
    end

    # -- util routines --

    def clean_output_dir
      FileUtils.rm_rf(@opts.output_dir)
    end

    def format_classes
      BatchFormatter.format_all!(@relations, @assets, @opts)
    end

  end

end

Version data entries

7 entries across 7 versions & 1 rubygems

Version	Path
jsduck-4.4.0	lib/jsduck/web_writer.rb
jsduck-4.3.2	lib/jsduck/web_writer.rb
jsduck-4.3.1	lib/jsduck/web_writer.rb
jsduck-4.3.0	lib/jsduck/web_writer.rb
jsduck-4.2.1	lib/jsduck/web_writer.rb
jsduck-4.2.0	lib/jsduck/web_writer.rb
jsduck-4.1.1	lib/jsduck/web_writer.rb