require 'jsduck/option_parser'
require 'jsduck/meta_tag_registry'
require 'jsduck/logger'
require 'jsduck/util/json'
require 'jsduck/util/os'
require 'jsduck/util/io'
require 'jsduck/util/parallel'
module JsDuck
# Keeps command line options
class Options
attr_accessor :input_files
attr_accessor :output_dir
attr_accessor :ignore_global
attr_accessor :external_classes
attr_accessor :ext4_events
# Customizing output
attr_accessor :title
attr_accessor :header
attr_accessor :footer
attr_accessor :head_html
attr_accessor :body_html
attr_accessor :message
attr_accessor :welcome
attr_accessor :guides
attr_accessor :videos
attr_accessor :examples
attr_accessor :categories_path
attr_accessor :source
attr_accessor :images
attr_accessor :link_tpl
attr_accessor :img_tpl
attr_accessor :export
attr_accessor :seo
attr_accessor :eg_iframe
attr_accessor :examples_base_url
attr_accessor :tests
attr_accessor :comments_url
attr_accessor :comments_domain
attr_accessor :search
attr_accessor :ignore_html
# Debugging
attr_accessor :warnings_exit_nonzero
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
attr_accessor :imports
attr_accessor :new_since
def initialize
@input_files = []
@output_dir = nil
@ignore_global = false
@external_classes = [
# JavaScript builtins
"Object",
"String",
"Number",
"Boolean",
"RegExp",
"Function",
"Array",
"Arguments",
"Date",
# JavaScript builtin error classes
# https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Error
"Error",
"EvalError",
"RangeError",
"ReferenceError",
"SyntaxError",
"TypeError",
"URIError",
# DOM
"HTMLElement",
"XMLElement",
"NodeList",
"TextNode",
"CSSStyleSheet",
"CSSStyleRule",
"Event",
# Special anything-goes type
"Mixed",
]
@ext4_events = nil
@meta_tag_paths = []
@version = "4.10.1"
# Customizing output
@title = "Documentation - JSDuck"
@header = "Documentation JSDuck"
@footer = format_footer("Generated on {DATE} by {JSDUCK} {VERSION}.")
@head_html = ""
@body_html = ""
@message = ""
@welcome = nil
@guides = nil
@videos = nil
@examples = nil
@categories_path = nil
@source = true
@images = []
@link_tpl = '%a'
# Note that we wrap image template inside because {@img} often
# appears inline within text, but that just looks ugly in HTML
@img_tpl = '
'
@export = nil
@seo = false
@eg_iframe = nil
@examples_base_url = "extjs-build/examples/"
@tests = false
@comments_url = nil
@comments_domain = nil
@search = {}
@ignore_html = {}
# Debugging
@warnings_exit_nonzero = false
@root_dir = File.dirname(File.dirname(File.dirname(__FILE__)))
@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
@ext_namespaces = ["Ext"]
@imports = []
@new_since = nil
# Turn multiprocessing off by default in Windows
Util::Parallel.in_processes = Util::OS::windows? ? 0 : nil
# enable all warnings except :link_auto
Logger.set_warning(:all, true)
Logger.set_warning(:link_auto, false)
@optparser = create_option_parser
end
# Make options object behave like hash.
# This allows us to substitute it with hash in unit tests.
def [](key)
send(key)
end
def parse!(argv)
parse_options(argv)
auto_detect_config_file
validate
reg = MetaTagRegistry.new
reg.load([:builtins] + @meta_tag_paths)
reg[:new].create_tooltip!(@imports, @new_since)
MetaTagRegistry.instance = reg
end
private
def create_option_parser
return JsDuck::OptionParser.new do | opts |
opts.banner = "Usage: jsduck [options] files/dirs..."
opts.separator ""
opts.separator "For example:"
opts.separator ""
opts.separator " # Documentation for builtin JavaScript classes like Array and String"
opts.separator " jsduck --output output/dir --builtin-classes"
opts.separator ""
opts.separator " # Documentation for your own JavaScript"
opts.separator " jsduck --output output/dir input-file.js some/input/dir"
opts.separator ""
opts.separator "The main options:"
opts.separator ""
opts.on('-o', '--output=PATH',
"Directory to write all this documentation.",
"",
"This option is REQUIRED. When the directory exists,",
"it will be overwritten. Give dash '-' as argument",
"to write docs to STDOUT (works only with --export).") do |path|
@output_dir = path == "-" ? :stdout : canonical(path)
end
opts.on('--export=TYPE',
"Exports docs in JSON.",
"",
"TYPE is one of:",
"",
"- full - full class docs.",
"- examples - extracts inline examples from classes.") do |format|
export_type = format.to_sym
if [:full, :examples].include?(export_type)
@export = export_type
else
Logger.fatal("Unsupported export type: '#{export_type}'")
exit(1)
end
end
opts.on('--builtin-classes',
"Includes docs for JavaScript builtins.",
"",
"Docs for the following classes are included:",
"",
"- Array",
"- Boolean",
"- Date",
"- Function",
"- Number",
"- Object",
"- RegExp",
"- String") do
read_filenames(@root_dir + "/js-classes")
end
opts.on('--seo', "Enables SEO-friendly print version.",
"",
"Instead of index.html creates index.php that will serve",
"the regular docs, print-friendly docs, and search-engine-",
"friendly docs (the latter two are pretty much the same).") do
@seo = true
end
opts.on('--config=PATH',
"Loads config options from JSON file.",
"",
"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)
config = read_json_config(path)
else
Logger.fatal("The config file #{path} doesn't exist")
exit(1)
end
# 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)
parse_options(config)
@working_dir = nil
end
opts.on('--encoding=NAME', "Input encoding (defaults to UTF-8).") do |encoding|
JsDuck::Util::IO.encoding = encoding
end
opts.separator ""
opts.separator "Customizing output:"
opts.separator ""
opts.on('--title=TEXT',
"Custom title text for the documentation.",
"",
"Defaults to 'Documentation - JSDuck'",
"",
"The title will be used both inside and in",
"the header of the page. Inside page header the left",
"part (from ' - ' separator) will be shown in bold.") do |text|
@title = text
@header = text.sub(/^(.*?) +- +/, "<strong>\\1 </strong>")
end
opts.on('--footer=TEXT',
"Custom footer text for the documentation.",
"",
"The text can contain various placeholders:",
"",
" {DATE} - current date and time.",
" {JSDUCK} - link to JSDuck homepage.",
" {VERSION} - JSDuck version number.",
"",
"Defaults to: 'Generated on {DATE} by {JSDUCK} {VERSION}.'") do |text|
@footer = format_footer(text)
end
opts.on('--head-html=HTML',
"HTML for the <head> section of index.html.",
"",
"Useful for adding extra <style> and other tags.",
"",
"This option can be used repeatedly to append several",
"things to the header.") do |html|
@head_html += html
end
opts.on('--body-html=HTML',
"HTML for the <body> section of index.html.",
"",
"Useful for adding extra markup to the page.",
"",
"This option can be used repeatedly to append several",
"things to the body.") do |html|
@body_html += html
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',
"File with content for welcome page.",
"",
"Either HTML or Markdown file with content for welcome page.",
"HTML file must only contain the <body> part of the page.",
"Markdown file must have a .md or .markdown extension.",
"",
"See also: https://github.com/senchalabs/jsduck/wiki/Welcome-page") do |path|
@welcome = canonical(path)
end
opts.on('--guides=PATH',
"JSON file describing the guides.",
"",
"The file should be in a dir containing the actual guides.",
"A guide is a dir containing README.md, icon.png, and",
"other images referenced by the README.md file.",
"",
"See also: https://github.com/senchalabs/jsduck/wiki/Guides") do |path|
@guides = canonical(path)
end
opts.on('--videos=PATH',
"JSON file describing the videos.",
"",
"See also: https://github.com/senchalabs/jsduck/wiki/Videos") do |path|
@videos = canonical(path)
end
opts.on('--examples=PATH',
"JSON file describing the examples.",
"",
"See also: https://github.com/senchalabs/jsduck/wiki/Examples") do |path|
@examples = canonical(path)
end
opts.on('--categories=PATH',
"JSON file defining categories for classes.",
"",
"Without this option the classes will be categorized",
"based on how they are namespaced.",
"",
"See also: https://github.com/senchalabs/jsduck/wiki/Categories") do |path|
@categories_path = canonical(path)
end
opts.on('--no-source',
"Turns off the output of source files.") do
@source = false
end
opts.on('--images=PATH',
"Path for images referenced by {@img} tag.",
"",
"Several paths can be specified by using the option",
"multiple times. This option only applies to {@img}",
"tags used in API (classes/members) documentation.",
"Images used in guides must be located inside the",
"directory of the specific guide.") do |path|
@images << canonical(path)
end
opts.on('--tests',
"Creates page for testing inline examples.") do
@tests = true
end
opts.on('--import=VERSION:PATH',
"Imports docs generating @since & @new.",
"",
"For example:",
"",
" --import='1.0:/path/to/first/version'",
" --import='2.0:/path/to/second/version'",
" --import='3.0'",
"",
"Several versions can be imported using the option multiple",
"times. The last version must always be the current one",
"without the :PATH portion.",
"",
"JSDuck will then check in which version every class/member",
"first appears in and tag it with an appropriate @since tag.",
"Things appearing only in the latest version will also get",
"a @new tag (unless --new-since option is used).",
"",
"See also: https://github.com/senchalabs/jsduck/wiki/@since") do |v|
if v =~ /\A(.*?):(.*)\Z/
@imports << {:version => $1, :path => canonical($2)}
else
@imports << {:version => v}
end
end
opts.on('--new-since=VERSION',
"Since when to label items with @new tag.",
"",
"The VERSION must be one of the version names defined",
"with --import option.",
"",
"Defaults to the last version listed by --import.") do |v|
@new_since = v
end
opts.on('--comments-url=URL',
"Address of comments server.",
"",
"For example: http://projects.sencha.com/auth",
"",
"Must be used together with --comments-domain option.") do |url|
@comments_url = url
end
opts.on('--comments-domain=STRING',
"A name identifying the subset of comments.",
"",
"A string consisting of <name>/<version>.",
"",
"For example: ext-js/4",
"",
"Must be used together with --comments-url option.") do |domain|
@comments_domain = domain
end
opts.on('--search-url=URL',
"Address of guides search server.",
"",
"When supplied, the search for guides is performed through this",
"external service and the results merged together with API search.",
"The search server must respond to JSONP requests.",
"",
"For example: http://sencha.com/docsearch",
"",
"Must be used together with --search-domain option.",
"",
"This option is EXPERIMENTAL.") do |url|
@search[:url] = url
end
opts.on('--search-domain=STRING',
"A name identifying the subset to search from.",
"",
"A string consisting of <name>/<version>.",
"",
"Tells the search engine which product and version",
"to include into search.",
"",
"For example: Ext JS/4.2.0",
"",
"Must be used together with --search-url option.",
"",
"This option is EXPERIMENTAL.") do |domain|
@search[:product], @search[:version] = domain.split(/\//)
end
opts.separator ""
opts.separator "Tweaking:"
opts.separator ""
opts.on('--meta-tags=PATH',
"Path to custom meta-tag implementations.",
"",
"Can be a path to single Ruby file or a directory.",
"",
"This option can be used repeatedly to include multiple",
"meta tags from different places.",
"",
"See also: https://github.com/senchalabs/jsduck/wiki/Custom-tags") do |path|
@meta_tag_paths << canonical(path)
end
opts.on('--ignore-global',
"Turns off the creation of 'global' class.",
"",
"The 'global' class gets created when members that",
"don't belong to any class are found - all these",
"members will be placed into the 'global' class.",
"",
"Using this option won't suppress the warning that's",
"given when global members are found. For that you",
"need to additionally use --warnings=-global") do
@ignore_global = true
end
opts.on('--external=Foo,Bar,Baz', Array,
"Declares list of external classes.",
"",
"These classes will then no more generate warnings",
"when used in type definitions or inherited from.",
"",
"Multiple classes can be given in comma-separated list,",
"or by using the option repeatedly.",
"",
"The wildcard '*' can be used to match a set of classes",
"e.g. to ignore all classes of a particular namespace:",
"--external='Foo.*'") do |classes|
@external_classes += classes
end
opts.on('--[no-]ext4-events',
"Forces Ext4 options param on events.",
"",
"In Ext JS 4 and Sencha Touch 2 all event handlers are",
"passed an additional options object at the end of the",
"parameters list. This options object is skipped in the",
"documentation of Ext4/Touch2 events, so it needs to be",
"appended by JSDuck.",
"",
"The default is to auto-detect if we're using Ext JS 4",
"or Sencha Touch 2 based on whether the code defines",
"classes using Ext.define(), and only then append the",
"options parameter. This should work most of the time.",
"",
"Use this option to override the auto-detection.") do |e|
@ext4_events = e
end
opts.on('--examples-base-url=URL',
"Base URL for examples with relative URL-s.",
" ",
"Defaults to: 'extjs-build/examples/'") do |path|
@examples_base_url = path
end
opts.on('--link=TPL',
"HTML template for replacing {@link}.",
"",
"Possible placeholders:",
"",
"%c - full class name (e.g. 'Ext.Panel')",
"%m - class member name prefixed with member type",
" (e.g. 'method-urlEncode')",
"%# - inserts '#' if member name present",
"%- - inserts '-' if member name present",
"%a - anchor text for link",
"",
"Defaults to: '<a href=\"#!/api/%c%-%m\" rel=\"%c%-%m\" class=\"docClass\">%a</a>'") do |tpl|
@link_tpl = tpl
end
opts.on('--img=TPL',
"HTML template for replacing {@img}.",
"",
"Possible placeholders:",
"",
"%u - URL from @img tag (e.g. 'some/path.png')",
"%a - alt text for image",
"%w - width of image",
"%h - height of image",
"",
"Defaults to: '<p><img src=\"%u\" alt=\"%a\" width=\"%w\" height=\"%h\"></p>'") do |tpl|
@img_tpl = tpl
end
opts.on('--eg-iframe=PATH',
"HTML file used to display inline examples.",
"",
"The file will be used inside <iframe> that renders the",
"example. Not just any HTML file will work - it needs to",
"define loadInlineExample function that will be called",
"with the example code.",
"",
"See also: https://github.com/senchalabs/jsduck/wiki/Inline-examples") do |path|
@eg_iframe = canonical(path)
end
opts.on('--ext-namespaces=Ext,Foo', Array,
"Additional Ext JS namespaces to recognize.",
"",
"Defaults to 'Ext'",
"",
"Useful when using Ext JS in sandbox mode where instead",
"of Ext.define() your code contains YourNs.define().",
"In such case pass --ext-namespaces=Ext,YourNS option",
"and JSDuck will recognize both Ext.define() and",
"YourNs.define() plus few other things that depend on",
"Ext namespace like Ext.emptyFn.") do |ns|
@ext_namespaces = ns
end
opts.on('--touch-examples-ui',
"Turns on phone/tablet UI for examples.",
"",
"This is a very Sencha Touch 2 docs specific option.",
"Effects both normal- and inline-examples.") do
@touch_examples_ui = true
end
opts.on('--ignore-html=TAG',
"Ignore a particular unclosed HTML tag.",
"",
"Normally all tags like <foo> that aren't followed at some",
"point with </foo> will get automatically closed by JSDuck",
"and a warning will be generated. Except standard void tags",
"like <img> and <br>. Use this option to specify additional",
"tags not requirering a closing tag.",
"",
"Useful for ignoring the ExtJS preprocessor directives",
"<locale> and <debug> which would otherwise be reported",
"as unclosed tags.") do |tag|
@ignore_html[tag] = true
end
opts.separator ""
opts.separator "Debugging:"
opts.separator ""
opts.on('-v', '--verbose',
"Turns on excessive logging.",
"",
"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",
"",
"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 =~ /^([-+]?)(.*)$/
enable = !($1 == "-")
name = $2.to_sym
Logger.set_warning(name, enable)
end
end
end
opts.on('--warnings-exit-nonzero',
"Exits with non-zero exit code on warnings.",
"",
"By default JSDuck only exits with non-zero exit code",
"when a fatal error is encountered (code 1).",
"",
"With this option the exit code will be 2 when any warning",
"gets printed.") do
@warnings_exit_nonzero = true
end
opts.on('--[no-]color',
"Turn on/off colorized terminal output.",
"",
"By default the colored output is on, but gets disabled",
"automatically when output is not an interactive terminal",
"(or when running on Windows system).") do |on|
Logger.colors = on
end
opts.on('-p', '--processes=COUNT',
"The number of parallel processes to use.",
"",
"Defaults to the number of processors/cores.",
"",
"Set to 0 to disable parallel processing completely.",
"This is often useful in debugging to get deterministic",
"results.",
"",
"In Windows this option is disabled.") do |count|
Util::Parallel.in_processes = count.to_i
end
opts.on('--pretty-json',
"Turns on pretty-printing of JSON.",
"",
"This is useful when studying the JSON files generated",
"by --export option. But the option effects any JSON",
"that gets generated, so it's also useful when debugging",
"the resource files generated for the docs app.") do
Util::Json.pretty = true
end
opts.on('--template=PATH',
"Dir containing the UI template files.",
"",
"Useful when developing the template files.") do |path|
@template_dir = canonical(path)
end
opts.on('--template-links',
"Creates symlinks to UI template files.",
"",
"Useful for template files development.",
"Only works on platforms supporting symbolic links.") do
@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.",
"",
"This is the ExtJS file that's used by the docs app UI.",
"",
"Defaults to extjs/ext-all.js",
"",
"Useful for switching to extjs/ext-all-debug.js in development.") do |path|
@extjs_path = path # NB! must be relative path
end
opts.on('--local-storage-db=NAME',
"Prefix for LocalStorage database names.",
"",
"Defaults to 'docs'") do |name|
@local_storage_db = name
end
opts.on('-h', '--help[=--some-option]',
"Use --help=--option for help on option.",
"",
"For example To get help on --processes option any of the",
"following will work:",
"",
" --help=--processes",
" --help=processes",
" --help=-p",
" --help=p") do |v|
if v
puts opts.help_single(v)
else
puts opts.help
end
exit
end
opts.on('--version', "Prints JSDuck version") do
puts "JSDuck " + @version
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
# 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
# config options that can be feeded into optparser.
def read_json_config(fname)
config = []
json = Util::Json.read(fname)
json.each_pair do |key, value|
if key == "--"
# filenames
config += Array(value).map(&:to_s)
elsif value == true
# simple switch
config += [key.to_s]
else
# An option with value or with multiple values.
# In the latter case, add the option multiple times.
Array(value).each do |v|
config += [key.to_s, v.to_s]
end
end
end
config
end
# scans directory for .js files or simply adds file to input files list
def read_filenames(fname)
if File.exists?(fname)
if File.directory?(fname)
Dir[fname+"/**/*.{js,css,scss}"].each {|f| @input_files << f }
elsif fname =~ /\.jsb3$/
extract_jsb_files(fname).each {|fn| read_filenames(fn) }
else
@input_files << fname
end
else
Logger.warn(nil, "File not found", fname)
end
end
# Extracts files of first build in jsb file
def extract_jsb_files(jsb_file)
json = Util::Json.read(jsb_file)
basedir = File.dirname(jsb_file)
return json["builds"][0]["packages"].map do |package_id|
package = json["packages"].find {|p| p["id"] == package_id }
(package ? package["files"] : []).map do |file|
File.expand_path(basedir + "/" + file["path"] + file["name"])
end
end.flatten
end
# Converts relative path to full path
#
# Especially important for running on Windows where C:\foo\bar
# pathnames are converted to C:/foo/bar which ruby can work on
# more easily.
def canonical(path)
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
Logger.fatal("You should specify some input files, otherwise there's nothing I can do :(")
exit(1)
elsif @output_dir == :stdout && !@export
Logger.fatal("Output to STDOUT only works when using --export option")
exit(1)
elsif ![nil, :full, :api, :examples].include?(@export)
Logger.fatal("Unknown export format: #{@export}")
exit(1)
elsif @output_dir != :stdout
if !@output_dir
Logger.fatal("You should also specify an output directory, where I could write all this amazing documentation")
exit(1)
elsif File.exists?(@output_dir) && !File.directory?(@output_dir)
Logger.fatal("The output directory is not really a directory at all :(")
exit(1)
elsif !File.exists?(File.dirname(@output_dir))
Logger.fatal("The parent directory for #{@output_dir} doesn't exist")
exit(1)
elsif !@export && !File.exists?(@template_dir + "/extjs")
Logger.fatal("Oh noes! The template directory does not contain extjs/ directory :(")
Logger.fatal("Please copy ExtJS over to template/extjs or create symlink.")
Logger.fatal("For example:")
Logger.fatal(" $ cp -r /path/to/ext-4.0.0 " + @template_dir + "/extjs")
exit(1)
elsif !@export && !File.exists?(@template_dir + "/resources/css")
Logger.fatal("Oh noes! CSS files for custom ExtJS theme missing :(")
Logger.fatal("Please compile SASS files in template/resources/sass with compass.")
Logger.fatal("For example:")
Logger.fatal(" $ compass compile " + @template_dir + "/resources/sass")
exit(1)
end
end
end
end
end