jsduck 5.0.0.beta01 → 5.0.0.beta2

data/lib/jsduck/exporter/full.rb

@@ -6,40 +6,37 @@ module JsDuck
     # Exporter for all the class docs.
     class Full
       def initialize(relations, opts={})
-        @relations = relations
-        # opts parameter is here just for compatibility with other exporters
+        # parameters are just for compatibility with other exporters
       end
 
-      # Returns all data in Class object as hash.
+      # Returns a hash of class data, with :members field expanded
+      # into list of all members (including those inherited from
+      # parents and mixins).
       def export(cls)
         # Make copy of the internal data structure of a class
         # so our modifications on it will be safe.
         h = cls.internal_doc.clone
 
-        h[:members] = {}
-        h[:statics] = {}
-        TagRegistry.member_type_names.each do |tagname|
-          h[:members][tagname] = export_members(cls, {:tagname => tagname, :static => false})
-          h[:statics][tagname] = export_members(cls, {:tagname => tagname, :static => true})
-        end
-        h[:component] = cls.inherits_from?("Ext.Component")
-        h[:superclasses] = cls.superclasses.collect {|c| c[:name] }
-        h[:subclasses] = @relations.subclasses(cls).collect {|c| c[:name] }.sort
-        h[:mixedInto] = @relations.mixed_into(cls).collect {|c| c[:name] }.sort
-        h[:alternateClassNames] = cls[:alternateClassNames].sort if cls[:alternateClassNames]
-
-        h[:mixins] = cls.deps(:mixins).collect {|c| c[:name] }.sort
-        h[:parentMixins] = cls.parent_deps(:mixins).collect {|c| c[:name] }.sort
-        h[:requires] = cls.deps(:requires).collect {|c| c[:name] }.sort
-        h[:uses] = cls.deps(:uses).collect {|c| c[:name] }.sort
+        h[:members] = export_members(cls)
 
         h
       end
 
       private
 
-      # Looks up members, and sorts them so that constructor method is first
-      def export_members(cls, cfg)
+      # Generates flat list of all members
+      def export_members(cls)
+        groups = []
+        TagRegistry.member_type_names.each do |tagname|
+          groups << export_members_group(cls, {:tagname => tagname, :static => false})
+          groups << export_members_group(cls, {:tagname => tagname, :static => true})
+        end
+        groups.flatten
+      end
+
+      # Looks up members of given type, and sorts them so that
+      # constructor method is first
+      def export_members_group(cls, cfg)
         ms = cls.find_members(cfg)
         ms.sort! {|a,b| a[:name] <=> b[:name] }
         cfg[:tagname] == :method ? constructor_first(ms) : ms

data/lib/jsduck/format/doc.rb

@@ -1,4 +1,3 @@
-require 'rubygems'
 require 'strscan'
 require 'rdiscount'
 require 'jsduck/format/html_stack'

data/lib/jsduck/format/html_stack.rb

@@ -78,9 +78,8 @@ module JsDuck
       end
 
       def warn(msg, tags)
-        ctx = @doc_context
         tag_list = tags.map {|tag| "<#{tag}>" }.join(", ")
-        Logger.warn(:html, "#{msg}: #{tag_list}", ctx[:filename], ctx[:linenr])
+        Logger.warn(:html, "#{msg}: #{tag_list}", @doc_context)
       end
 
       def void?(tag)

data/lib/jsduck/format/subproperties.rb

@@ -50,9 +50,9 @@ module JsDuck
         else
           context = @formatter.doc_context
           if tp.error == :syntax
-            Logger.warn(:type_syntax, "Incorrect type syntax #{type}", context[:filename], context[:linenr])
+            Logger.warn(:type_syntax, "Incorrect type syntax #{type}", context)
           else
-            Logger.warn(:type_name, "Unknown type #{type}", context[:filename], context[:linenr])
+            Logger.warn(:type_name, "Unknown type #{type}", context)
           end
           Util::HTML.escape(type)
         end

data/lib/jsduck/inline/auto_link.rb

@@ -97,7 +97,7 @@ module JsDuck
       end
 
       def warn_magic_link(msg)
-        Logger.warn(:link_auto, msg, @doc_context[:filename], @doc_context[:linenr])
+        Logger.warn(:link_auto, msg, @doc_context)
       end
 
     end

data/lib/jsduck/inline/img.rb

@@ -38,7 +38,7 @@ module JsDuck
       def apply_tpl(url, alt_text)
         img = @images.get(url)
         if !img
-          Logger.warn(:image, "Image #{url} not found.", @doc_context[:filename], @doc_context[:linenr])
+          Logger.warn(:image, "Image #{url} not found.", @doc_context)
           img = {}
         end
 

data/lib/jsduck/inline/link.rb

@@ -62,15 +62,13 @@ module JsDuck
           text = cls
         end
 
-        file = @doc_context[:filename]
-        line = @doc_context[:linenr]
         if !@relations[cls]
-          Logger.warn(:link, "#{full_link} links to non-existing class", file, line)
+          Logger.warn(:link, "#{full_link} links to non-existing class", @doc_context)
           return text
         elsif member
           ms = @renderer.find_members(cls, {:name => member, :tagname => type, :static => static})
           if ms.length == 0
-            Logger.warn(:link, "#{full_link} links to non-existing member", file, line)
+            Logger.warn(:link, "#{full_link} links to non-existing member", @doc_context)
             return text
           end
 
@@ -82,11 +80,11 @@ module JsDuck
             instance_ms = ms.find_all {|m| !m[:static] }
             if instance_ms.length > 1
               alternatives = instance_ms.map {|m| "#{m[:tagname]} in #{m[:owner]}" }.join(", ")
-              Logger.warn(:link_ambiguous, "#{full_link} is ambiguous: "+alternatives, file, line)
+              Logger.warn(:link_ambiguous, "#{full_link} is ambiguous: "+alternatives, @doc_context)
             elsif instance_ms.length == 0
               static_ms = ms.find_all {|m| m[:static] }
               alternatives = static_ms.map {|m| "static " + m[:tagname].to_s }.join(", ")
-              Logger.warn(:link_ambiguous, "#{full_link} is ambiguous: "+alternatives, file, line)
+              Logger.warn(:link_ambiguous, "#{full_link} is ambiguous: "+alternatives, @doc_context)
             end
           end
 

data/lib/jsduck/inline/video.rb

@@ -46,8 +46,7 @@ module JsDuck
       # applies the video template of the specified type
       def apply_tpl(type, url, alt_text)
         unless @templates.has_key?(type)
-          ctx = @doc_context
-          Logger.warn(nil, "Unknown video type #{type}", ctx[:filename], ctx[:linenr])
+          Logger.warn(nil, "Unknown video type #{type}", @doc_context)
         end
 
         @templates[type].gsub(/(%\w)/) do

data/lib/jsduck/js/ast.rb

@@ -286,7 +286,7 @@ module JsDuck
           else
             m[:private] = true
           end
-          m[:autodetected] = true
+          m[:autodetected] = {:tagname => m[:tagname]}
         end
 
         if docset

data/lib/jsduck/js/esprima.rb

@@ -1,11 +1,15 @@
-require 'v8'
+require 'execjs'
 require 'jsduck/util/json'
 require 'jsduck/util/singleton'
 
 module JsDuck
   module Js
 
-    # Runs Esprima.js through V8.
+    # Runs Esprima.js through JavaScript runtime selected by ExecJS.
+    # Normally this will be V8 engine within therubyracer gem, but when
+    # JSDuck is installed through some other means than rubygems, then
+    # one could use any of the runtimes supported by ExecJS.  (NodeJS
+    # for example.)
     #
     # Initialized as singleton to avoid loading the esprima.js more
     # than once - otherwise performace will severely suffer.
@@ -13,23 +17,34 @@ module JsDuck
       include Util::Singleton
 
       def initialize
-        @v8 = V8::Context.new
-        esprima = File.dirname(File.expand_path(__FILE__))+"/esprima/esprima.js";
+        esprima_path = File.dirname(File.expand_path(__FILE__)) + "/esprima/esprima.js"
+        esprima = IO.read(esprima_path)
 
         # Esprima attempts to assign to window.esprima, but our v8
         # engine has no global window variable defined.  So define our
         # own and then grab esprima out from it again.
-        @v8.eval("var window = {};")
-        @v8.load(esprima)
-        @v8.eval("var esprima = window.esprima;")
+        source = <<-EOJS
+          if (typeof window === "undefined") {
+              var window = {};
+          }
+
+          #{esprima}
+
+          var esprima = window.esprima;
+
+          function runEsprima(js) {
+            return JSON.stringify(esprima.parse(js, {comment: true, range: true, raw: true}));
+          }
+        EOJS
+
+        @context = ExecJS.compile(source)
       end
 
       # Parses JavaScript source code using Esprima.js
       #
       # Returns the resulting AST
       def parse(input)
-        @v8['js'] = input
-        json = @v8.eval("JSON.stringify(esprima.parse(js, {comment: true, range: true, raw: true}))")
+        json = @context.call("runEsprima", input)
         return Util::Json.parse(json, :max_nesting => false)
       end
 

data/lib/jsduck/logger.rb

@@ -17,6 +17,8 @@ module JsDuck
         [:inheritdoc, "@inheritdoc referring to unknown class or member"],
         [:extend, "@extend/mixin/requires/uses referring to unknown class"],
         [:tag, "Use of unsupported @tag"],
+        [:tag_repeated, "An @tag used multiple times, but only once allowed"],
+        [:tag_syntax, "@tag syntax error"],
         [:link, "{@link} to unknown class or member"],
         [:link_ambiguous, "{@link} is ambiguous"],
         [:link_auto, "Auto-detected link to unknown class or member"],
@@ -24,7 +26,7 @@ module JsDuck
 
         [:alt_name, "Name used as both classname and alternate classname"],
         [:name_missing, "Member or parameter has no name"],
-        [:no_doc, "Member or class without documentation"],
+        [:no_doc, "Public class or member without documentation"],
         [:dup_param, "Method has two parameters with the same name"],
         [:dup_member, "Class has two members with the same name"],
         [:req_after_opt, "Required parameter comes after optional"],
@@ -33,7 +35,7 @@ module JsDuck
         [:sing_static, "Singleton class member marked as @static"],
         [:type_syntax, "Syntax error in {type definition}"],
         [:type_name, "Unknown type referenced in {type definition}"],
-        [:enum, "Enum with invalid values of no values at all"],
+        [:enum, "Enum with invalid values or no values at all"],
 
         [:image, "{@img} referring to missing file"],
         [:image_unused, "An image exists in --images dir that's not used"],
@@ -50,7 +52,7 @@ module JsDuck
       # When running JSDuck app, the Options class enables most warnings.
       @warnings = {}
       @warning_docs.each do |w|
-        @warnings[w[0]] = false
+        @warnings[w[0]] = {:enabled => false, :patterns => []}
       end
 
       @shown_warnings = {}
@@ -63,15 +65,26 @@ module JsDuck
       end
     end
 
-    # Enabled or disables a particular warning
-    # or all warnings when type == :all
-    def set_warning(type, enabled)
+    # Enables or disables a particular warning
+    # or all warnings when type == :all.
+    # Additionally a filename pattern can be specified.
+    def set_warning(type, enabled, pattern=nil)
       if type == :all
+        # When used with a pattern, only add the pattern to the rules
+        # where it can have an effect - otherwise we get a warning.
         @warnings.each_key do |key|
-          @warnings[key] = enabled
+          set_warning(key, enabled, pattern) unless pattern && @warnings[key][:enabled] == enabled
         end
       elsif @warnings.has_key?(type)
-        @warnings[type] = enabled
+        if pattern
+          if @warnings[type][:enabled] == enabled
+            warn(nil, "Warning rule '#{enabled ? '+' : '-'}#{type}:#{pattern}' has no effect")
+          else
+            @warnings[type][:patterns] << Regexp.new(Regexp.escape(pattern))
+          end
+        else
+          @warnings[type] = {:enabled => enabled, :patterns => []}
+        end
       else
         warn(nil, "Warning of type '#{type}' doesn't exist")
       end
@@ -79,7 +92,7 @@ module JsDuck
 
     # get documentation for all warnings
     def doc_warnings
-      @warning_docs.map {|w| " #{@warnings[w[0]] ? '+' : '-'}#{w[0]} - #{w[1]}" }
+      @warning_docs.map {|w| " #{@warnings[w[0]][:enabled] ? '+' : '-'}#{w[0]} - #{w[1]}" }
     end
 
     # Prints warning message.
@@ -93,21 +106,46 @@ module JsDuck
     # warnings greatly also when run multiple processes.
     #
     # Optionally filename and line number will be inserted to message.
+    # These two last arguments can also be supplied as one hash of:
+    #
+    #     {:filename => "foo.js", :linenr => 17}
+    #
     def warn(type, msg, filename=nil, line=nil)
+      if filename.is_a?(Hash)
+        line = filename[:linenr]
+        filename = filename[:filename]
+      end
+
       msg = paint(:yellow, "Warning: ") + format(filename, line) + " " + msg
 
-      if type == nil || @warnings[type]
+      if warning_enabled?(type, filename)
         if !@shown_warnings[msg]
           $stderr.puts msg
           @shown_warnings[msg] = true
         end
-      elsif !@warnings.has_key?(type)
-        warn(nil, "Unknown warning type #{type}")
       end
 
       return false
     end
 
+    # True when the warning is enabled for the given type and filename
+    # combination.
+    def warning_enabled?(type, filename)
+      if type == nil
+        true
+      elsif !@warnings.has_key?(type)
+        warn(nil, "Unknown warning type #{type}")
+        false
+      else
+        rule = @warnings[type]
+        if rule[:patterns].any? {|re| filename =~ re }
+          !rule[:enabled]
+        else
+          rule[:enabled]
+        end
+      end
+    end
+
     # Formats filename and line number for output
     def format(filename=nil, line=nil)
       out = ""

data/lib/jsduck/members_index.rb

@@ -97,9 +97,8 @@ module JsDuck
           if hash1[name]
             hash1.delete(name)
           else
-            ctx = m[:files][0]
             msg = "@hide used but #{m[:tagname]} #{m[:name]} not found in parent class"
-            Logger.warn(:hide, msg, ctx[:filename], ctx[:linenr])
+            Logger.warn(:hide, msg, m[:files][0])
           end
         else
           if hash1[name]

data/lib/jsduck/merger.rb

@@ -45,14 +45,32 @@ module JsDuck
     def general_merge(h, docs, code)
       # Merge in all items in docs that don't occour already in result.
       docs.each_pair do |key, value|
-        h[key] = value unless h.has_key?(key)
+        h[key] = value unless h.has_key?(key) || Merger::explicit?(key)
       end
       # Then add all in the items from code not already in result.
       code.each_pair do |key, value|
-        h[key] = value unless h.has_key?(key)
+        h[key] = value unless h.has_key?(key) || Merger::explicit?(key)
       end
     end
 
+    # True when given key gets merged explicitly and should therefore
+    # be skipped when auto-merging.
+    def self.explicit?(key)
+      @explicit = explictly_merged_fields unless @explicit
+      @explicit[key]
+    end
+
+    # Generates a lookup-hash of tagnames which are explicitly merged.
+    def self.explictly_merged_fields
+      mergers = {}
+      member_types = TagRegistry.member_type_names + [:class]
+      tags = member_types.map {|type| TagRegistry.mergers(type) }.flatten.uniq
+      tags.each do |tag|
+        mergers[tag.tagname] = true
+      end
+      mergers
+    end
+
   end
 
 end

data/lib/jsduck/options.rb

@@ -24,6 +24,8 @@ module JsDuck
     attr_accessor :footer
     attr_accessor :head_html
     attr_accessor :body_html
+    attr_accessor :css
+    attr_accessor :message
     attr_accessor :welcome
     attr_accessor :guides
     attr_accessor :videos
@@ -46,7 +48,6 @@ module JsDuck
     attr_accessor :template_dir
     attr_accessor :template_links
     attr_accessor :extjs_path
-    attr_accessor :data_path
     attr_accessor :local_storage_db
     attr_accessor :touch_examples_ui
     attr_accessor :ext_namespaces
@@ -91,14 +92,16 @@ module JsDuck
       ]
       @ext4_events = nil
 
-      @version = "5.0.0.beta01"
+      @version = "5.0.0.beta2"
 
       # Customizing output
       @title = "Documentation - JSDuck"
       @header = "<strong>Documentation</strong> JSDuck"
-      @footer = "Generated with <a href='https://github.com/senchalabs/jsduck'>JSDuck</a> #{@version}."
+      @footer = format_footer("Generated on {DATE} by {JSDUCK} {VERSION}.")
       @head_html = ""
       @body_html = ""
+      @css = ""
+      @message = ""
       @welcome = nil
       @guides = nil
       @videos = nil
@@ -125,7 +128,6 @@ module JsDuck
       @template_dir = @root_dir + "/template-min"
       @template_links = false
       @extjs_path = "extjs/ext-all.js"
-      @data_path = nil # This gets assigned in JsDuck::WebWriter after writing the data file.
       @local_storage_db = "docs"
       @touch_examples_ui = false
       @imports = []
@@ -138,6 +140,8 @@ module JsDuck
       Logger.set_warning(:all, true)
       Logger.set_warning(:link_auto, false)
       Logger.set_warning(:param_count, false)
+
+      @optparser = create_option_parser
     end
 
     # Make options object behave like hash.
@@ -150,16 +154,25 @@ module JsDuck
     end
 
     def parse!(argv)
-      create_option_parser.parse!(argv).each do |fname|
-        read_filenames(canonical(fname))
-      end
+      parse_options(argv)
+      auto_detect_config_file
       validate
 
-      @custom_tag_paths.each {|path| TagRegistry.load_from(path) }
+      if @custom_tag_paths.length > 0
+        TagRegistry.reconfigure(@custom_tag_paths)
+      else
+        # Ensure the TagRegistry get instantiated just once.
+        # Otherwise the parallel processing causes multiple requests
+        # to initialize the TagRegistry, resulting in loading the Tag
+        # definitions multiple times.
+        TagRegistry.instance
+      end
     end
 
+    private
+
     def create_option_parser
-      optparser = JsDuck::OptionParser.new do | opts |
+      return JsDuck::OptionParser.new do | opts |
         opts.banner = "Usage: jsduck [options] files/dirs..."
         opts.separator ""
         opts.separator "For example:"
@@ -227,6 +240,9 @@ module JsDuck
           "",
           "An alternative to listing all options on command line.",
           "",
+          "When the current directory contains jsduck.json file",
+          "then options are automatically read from there.",
+          "",
           "See also: https://github.com/senchalabs/jsduck/wiki/Config-file") do |path|
           path = canonical(path)
           if File.exists?(path)
@@ -238,7 +254,7 @@ module JsDuck
           # treat paths inside JSON config relative to the location of
           # config file.  When done, switch back to current working dir.
           @working_dir = File.dirname(path)
-          optparser.parse!(config).each {|fname| read_filenames(canonical(fname)) }
+          parse_options(config)
           @working_dir = nil
         end
 
@@ -265,11 +281,14 @@ module JsDuck
         opts.on('--footer=TEXT',
           "Custom footer text for the documentation.",
           "",
-          "Defaults to: 'Generated with JSDuck {VERSION}.'",
+          "The text can contain various placeholders:",
+          "",
+          "  {DATE} - current date and time.",
+          "  {JSDUCK} - link to JSDuck homepage.",
+          "  {VERSION} - JSDuck version number.",
           "",
-          "'{VERSION}' is a placeholder that will get substituted",
-          "with the current version of JSDuck.  See --version.") do |text|
-          @footer = text.gsub(/\{VERSION\}/, @version)
+          "Defaults to: 'Generated on {DATE} by {JSDUCK} {VERSION}.'") do |text|
+          @footer = format_footer(text)
         end
 
         opts.on('--head-html=HTML',
@@ -277,9 +296,12 @@ module JsDuck
           "",
           "Useful for adding extra <style> and other tags.",
           "",
+          "Also a name of an HTML file can be passed.",
+          "Then the contents of that file will be read in.",
+          "",
           "This option can be used repeatedly to append several",
           "things to the header.") do |html|
-          @head_html += html
+          @head_html += maybe_file(html)
         end
 
         opts.on('--body-html=HTML',
@@ -287,9 +309,32 @@ module JsDuck
           "",
           "Useful for adding extra markup to the page.",
           "",
+          "Also a name of an HTML file can be passed.",
+          "Then the contents of that file will be read in.",
+          "",
           "This option can be used repeatedly to append several",
           "things to the body.") do |html|
-          @body_html += html
+          @body_html += maybe_file(html)
+        end
+
+        opts.on('--css=CSS',
+          "Extra CSS rules to include to the page.",
+          "",
+          "Also a name of a CSS file can be passed.",
+          "Then the contents of that file will be read in.",
+          "",
+          "This option can be used repeatedly to append multiple",
+          "chunks of CSS.") do |css|
+          @css += maybe_file(css)
+        end
+
+        opts.on('--message=HTML',
+          "(Warning) message to show prominently.",
+          "",
+          "Useful for warning users that they are viewing an old",
+          "version of the docs, and prividing a link to the new",
+          "version.") do |html|
+          @message += html
         end
 
         opts.on('--welcome=PATH',
@@ -546,7 +591,7 @@ module JsDuck
           @touch_examples_ui = true
         end
 
-        opts.on('--ignore-html=TAG',
+        opts.on('--ignore-html=TAG1,TAG2', Array,
           "Ignore a particular unclosed HTML tag.",
           "",
           "Normally all tags like <foo> that aren't followed at some",
@@ -557,8 +602,10 @@ module JsDuck
           "",
           "Useful for ignoring the ExtJS preprocessor directives",
           "<locale> and <debug> which would otherwise be reported",
-          "as unclosed tags.") do |tag|
-          @ignore_html[tag] = true
+          "as unclosed tags.") do |tags|
+          tags.each do |tag|
+            @ignore_html[tag] = true
+          end
         end
 
         opts.separator ""
@@ -568,24 +615,40 @@ module JsDuck
         opts.on('-v', '--verbose',
           "Turns on excessive logging.",
           "",
-          "Log messages are writted to STDERR.") do
+          "Log messages are written to STDERR.") do
           Logger.verbose = true
         end
 
         opts.on('--warnings=+A,-B,+C', Array,
           "Turns warnings selectively on/off.",
           "",
-          " +all - to turn on all warnings",
+          " +all - to turn on all warnings.",
+          " -all - to turn off all warnings.",
+          "",
+          "Additionally a pattern can be specified to only apply the",
+          "setting for a particular set of files.  For example to turn",
+          "off all warnings related to chart classes:",
+          "",
+          " -all:extjs/src/chart",
+          "",
+          "Note, that the order of the rules matters.  When you first",
+          "say +link and then -all, the result will be that all warnings",
+          "get disabled.",
+          "",
+          "Currently one can't mix disabling and enabling file patterns.",
+          "For example  --warnings=-link,+link:/src,-link:/src/ux  will",
+          "ignore the last rule about /src/ux.",
           "",
           "List of all available warning types:",
           "(Those with '+' in front of them default to on)",
           "",
           *Logger.doc_warnings) do |warnings|
           warnings.each do |op|
-            if op =~ /^([-+]?)(.*)$/
+            if op =~ /^([-+]?)(\w+)(?::(.*))?$/
               enable = !($1 == "-")
               name = $2.to_sym
-              Logger.set_warning(name, enable)
+              path = $3
+              Logger.set_warning(name, enable, path)
             end
           end
         end
@@ -628,6 +691,14 @@ module JsDuck
           @template_links = true
         end
 
+        opts.on('-d', '--debug',
+          "Same as --template=template --template-links.",
+          "",
+          "Useful shorthand during development.") do
+          @template_dir = canonical("template")
+          @template_links = true
+        end
+
         opts.on('--extjs-path=PATH',
           "Path for main ExtJS JavaScript file.",
           "",
@@ -669,8 +740,20 @@ module JsDuck
           exit
         end
       end
+    end
+
+    # Parses the given command line options
+    # (could have also been read from config file)
+    def parse_options(options)
+      @optparser.parse!(options).each {|fname| read_filenames(canonical(fname)) }
+    end
 
-      return optparser
+    # Reads jsduck.json file in current directory
+    def auto_detect_config_file
+      fname = Dir.pwd + "/jsduck.json"
+      if File.exists?(fname)
+        parse_options(read_json_config(fname))
+      end
     end
 
     # Reads JSON configuration from file and returns an array of
@@ -724,6 +807,17 @@ module JsDuck
       end.flatten
     end
 
+    # When given string is a file, returns the contents of the file.
+    # Otherwise returns the string unchanged.
+    def maybe_file(str)
+      path = canonical(str)
+      if File.exists?(path)
+        Util::IO.read(path)
+      else
+        str
+      end
+    end
+
     # Converts relative path to full path
     #
     # Especially important for running on Windows where C:\foo\bar
@@ -733,6 +827,13 @@ module JsDuck
       File.expand_path(path, @working_dir)
     end
 
+    # Replace special placeholders in footer text
+    def format_footer(text)
+      jsduck = "<a href='https://github.com/senchalabs/jsduck'>JSDuck</a>"
+      date = Time.new.strftime('%a %d %b %Y %H:%M:%S')
+      text.gsub(/\{VERSION\}/, @version).gsub(/\{JSDUCK\}/, jsduck).gsub(/\{DATE\}/, date)
+    end
+
     # Runs checks on the options
     def validate
       if @input_files.length == 0 && !@welcome && !@guides && !@videos && !@examples