Add option --output to crystal docs generator (#4937)

This also changes default output dir to `./docs` instead of `./doc`.
crystal-lang · Oct 26, 2017 · 4b75571 · 4b75571
1 parent c8ee444
commit 4b75571
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 13 deletions.
diff --git a/src/compiler/crystal/command/docs.cr b/src/compiler/crystal/command/docs.cr
@@ -5,6 +5,27 @@
 
 class Crystal::Command
   private def docs
+    output_directory = File.join(".", "docs")
+
+    OptionParser.parse(options) do |opts|
+      opts.banner = <<-'BANNER'
+        Usage: crystal docs [options]
+
+        Generates API documentation from inline docstrings in all Crystal files inside ./src directory.
+
+        Options:
+        BANNER
+
+      opts.on("--output=DIR", "-o DIR", "Set the output directory (default: #{output_directory})") do |value|
+        output_directory = value
+      end
+
+      opts.on("-h", "--help", "Show this message") do
+        puts opts
+        exit
+      end
+    end
+
     if options.empty?
       sources = [Compiler::Source.new("require", %(require "./src/**"))]
       included_dirs = [] of String
@@ -20,6 +41,6 @@ class Crystal::Command
     compiler.wants_doc = true
     result = compiler.top_level_semantic sources
 
-    Doc::Generator.new(result.program, included_dirs).run
+    Doc::Generator.new(result.program, included_dirs, output_directory).run
   end
 end
diff --git a/src/compiler/crystal/tools/doc/generator.cr b/src/compiler/crystal/tools/doc/generator.cr
@@ -28,16 +28,16 @@ class Crystal::Doc::Generator
     },
   }
 
-  def initialize(@program : Program, @included_dirs : Array(String), @dir = "./doc")
-    @base_dir = `pwd`.chomp
+  def initialize(@program : Program, @included_dirs : Array(String), @output_dir : String)
+    @base_dir = Dir.current.chomp
     @types = {} of Crystal::Type => Doc::Type
     @repo_name = ""
     @is_crystal_repo = false
     compute_repository
   end
 
   def run
-    Dir.mkdir_p @dir
+    Dir.mkdir_p @output_dir
 
     types = collect_subtypes(@program)
 
@@ -55,7 +55,7 @@ class Crystal::Doc::Generator
 
   def generate_docs(program_type, types)
     copy_files
-    generate_types_docs types, @dir, types
+    generate_types_docs types, @output_dir, types
     generate_readme program_type, types
   end
 
@@ -72,23 +72,23 @@ class Crystal::Doc::Generator
       body = ""
     end
 
-    File.write "#{@dir}/index.html", MainTemplate.new(body, types, repository_name)
+    File.write File.join(@output_dir, "index.html"), MainTemplate.new(body, types, repository_name)
   end
 
   def copy_files
-    Dir.mkdir_p "#{@dir}/css"
-    Dir.mkdir_p "#{@dir}/js"
+    Dir.mkdir_p File.join(@output_dir, "css")
+    Dir.mkdir_p File.join(@output_dir, "js")
 
-    File.write "#{@dir}/css/style.css", StyleTemplate.new
-    File.write "#{@dir}/js/doc.js", JsTypeTemplate.new
+    File.write File.join(@output_dir, "css", "style.css"), StyleTemplate.new
+    File.write File.join(@output_dir, "js", "doc.js"), JsTypeTemplate.new
   end
 
   def generate_types_docs(types, dir, all_types)
     types.each do |type|
       if type.program?
-        filename = "#{dir}/toplevel.html"
+        filename = File.join(dir, "toplevel.html")
       else
-        filename = "#{dir}/#{type.name}.html"
+        filename = File.join(dir, "#{type.name}.html")
       end
 
       File.write filename, TypeTemplate.new(type, all_types)
@@ -97,7 +97,7 @@ class Crystal::Doc::Generator
 
       subtypes = type.types
       if subtypes && !subtypes.empty?
-        dirname = "#{dir}/#{type.name}"
+        dirname = File.join(dir, type.name)
         Dir.mkdir_p dirname
         generate_types_docs subtypes, dirname, all_types
       end