RubyGems - nanoc - Versions diffs - 3.4.3 → 3.5.0b1 - Mend

nanoc 3.4.3 → 3.5.0b1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (85) hide show

data/CONTRIBUTING.md +25 -0
data/Gemfile +3 -1
data/Gemfile.lock +22 -13
data/NEWS.md +27 -0
data/README.md +3 -1
data/lib/nanoc.rb +2 -2
data/lib/nanoc/base/compilation/compiler_dsl.rb +19 -0
data/lib/nanoc/base/core_ext/array.rb +18 -8
data/lib/nanoc/base/core_ext/hash.rb +18 -8
data/lib/nanoc/base/core_ext/pathname.rb +2 -8
data/lib/nanoc/base/plugin_registry.rb +57 -19
data/lib/nanoc/base/result_data/item_rep.rb +3 -15
data/lib/nanoc/base/source_data/item.rb +1 -1
data/lib/nanoc/base/source_data/layout.rb +1 -1
data/lib/nanoc/base/source_data/site.rb +15 -19
data/lib/nanoc/cli.rb +28 -23
data/lib/nanoc/cli/command_runner.rb +4 -0
data/lib/nanoc/cli/commands/autocompile.rb +15 -6
data/lib/nanoc/cli/commands/check.rb +47 -0
data/lib/nanoc/cli/commands/compile.rb +271 -195
data/lib/nanoc/cli/commands/create-site.rb +5 -5
data/lib/nanoc/cli/commands/deploy.rb +16 -4
data/lib/nanoc/cli/commands/prune.rb +3 -3
data/lib/nanoc/cli/commands/show-data.rb +73 -58
data/lib/nanoc/cli/commands/show-rules.rb +1 -1
data/lib/nanoc/cli/commands/validate-css.rb +2 -3
data/lib/nanoc/cli/commands/validate-html.rb +2 -3
data/lib/nanoc/cli/commands/validate-links.rb +5 -11
data/lib/nanoc/cli/commands/view.rb +1 -1
data/lib/nanoc/cli/commands/watch.rb +38 -20
data/lib/nanoc/cli/error_handler.rb +122 -122
data/lib/nanoc/data_sources.rb +2 -0
data/lib/nanoc/data_sources/filesystem_unified.rb +1 -1
data/lib/nanoc/data_sources/filesystem_verbose.rb +1 -1
data/lib/nanoc/data_sources/static.rb +60 -0
data/lib/nanoc/extra.rb +2 -0
data/lib/nanoc/extra/checking.rb +16 -0
data/lib/nanoc/extra/checking/check.rb +33 -0
data/lib/nanoc/extra/checking/checks.rb +19 -0
data/lib/nanoc/extra/checking/checks/css.rb +23 -0
data/lib/nanoc/extra/checking/checks/external_links.rb +149 -0
data/lib/nanoc/extra/checking/checks/html.rb +24 -0
data/lib/nanoc/extra/checking/checks/internal_links.rb +57 -0
data/lib/nanoc/extra/checking/checks/stale.rb +23 -0
data/lib/nanoc/extra/checking/dsl.rb +31 -0
data/lib/nanoc/extra/checking/issue.rb +19 -0
data/lib/nanoc/extra/checking/runner.rb +130 -0
data/lib/nanoc/extra/link_collector.rb +57 -0
data/lib/nanoc/extra/pruner.rb +1 -1
data/lib/nanoc/extra/validators/links.rb +5 -262
data/lib/nanoc/extra/validators/w3c.rb +8 -76
data/lib/nanoc/filters/colorize_syntax.rb +1 -1
data/lib/nanoc/filters/handlebars.rb +2 -2
data/lib/nanoc/filters/less.rb +1 -1
data/lib/nanoc/filters/redcarpet.rb +1 -1
data/lib/nanoc/filters/rubypants.rb +1 -1
data/lib/nanoc/filters/slim.rb +1 -1
data/lib/nanoc/helpers/blogging.rb +163 -104
data/lib/nanoc/helpers/xml_sitemap.rb +9 -3
data/tasks/doc.rake +2 -1
data/test/base/core_ext/array_spec.rb +4 -4
data/test/base/core_ext/hash_spec.rb +7 -7
data/test/base/core_ext/pathname_spec.rb +12 -2
data/test/base/test_compiler_dsl.rb +24 -0
data/test/base/test_item_rep.rb +58 -26
data/test/cli/commands/test_watch.rb +0 -8
data/test/data_sources/test_static.rb +66 -0
data/test/extra/checking/checks/test_css.rb +40 -0
data/test/extra/checking/checks/test_external_links.rb +76 -0
data/test/extra/checking/checks/test_html.rb +40 -0
data/test/extra/checking/checks/test_internal_links.rb +46 -0
data/test/extra/checking/checks/test_stale.rb +49 -0
data/test/extra/checking/test_check.rb +16 -0
data/test/extra/checking/test_dsl.rb +20 -0
data/test/extra/checking/test_runner.rb +15 -0
data/test/extra/test_link_collector.rb +93 -0
data/test/extra/validators/test_links.rb +0 -64
data/test/extra/validators/test_w3c.rb +20 -26
data/test/filters/test_colorize_syntax.rb +15 -0
data/test/filters/test_less.rb +14 -0
data/test/filters/test_pandoc.rb +5 -1
data/test/helpers/test_blogging.rb +52 -8
data/test/helpers/test_xml_sitemap.rb +68 -0
data/test/test_gem.rb +1 -1
metadata +31 -6

data/lib/nanoc/cli/commands/create-site.rb CHANGED

@@ -4,7 +4,7 @@ usage       'create-site [options] path'
 aliases     :create_site, :cs
 summary     'create a site'
 description <<-EOS
-Create a new site at the given path. The site will use the filesystem_unified data source by default, but this can be changed using the --datasource commandline option.
+Create a new site at the given path. The site will use the `filesystem_unified` data source by default, but this can be changed using the `--datasource` commandline option.
 EOS
 required :d, :datasource, 'specify the data source for the new site'
@@ -208,9 +208,9 @@ a:hover {
 #main p {
   margin: 20px 0;
   font-size: 15px;
   line-height: 20px;
 }
@@ -220,7 +220,7 @@ a:hover {
 #main li {
   font-size: 15px;
   line-height: 20px;
 }
@@ -273,7 +273,7 @@ EOS
   <head>
     <meta charset="utf-8">
     <title>A Brand New nanoc Site - <%= @item[:title] %></title>
-    <link rel="stylesheet" type="text/css" href="/style.css" media="screen">
+    <link rel="stylesheet" href="/style.css">
     <!-- you don't need to keep this, but it's cool for stats! -->
     <meta name="generator" content="nanoc <%= Nanoc::VERSION %>">

data/lib/nanoc/cli/commands/deploy.rb CHANGED

@@ -9,15 +9,16 @@ deployer_names = deployers.keys.sort_by { |k| k.to_s }
 usage       'deploy [options]'
 summary     'deploy the compiled site'
 description <<-EOS
-Deploys the compiled site. The compiled site contents in the output directory will be uploaded to the destination, which is specified using the -t/--target option.
+Deploys the compiled site. The compiled site contents in the output directory will be uploaded to the destination, which is specified using the `--target` option.
 Available deployers: #{deployer_names.join(', ')}
 EOS
-option :t, :target,    'specify the location to deploy to', :argument => :required
-flag   :L, :list,      'list available locations to deploy to'
-option :n, :'dry-run', 'show what would be deployed'
+option :t, :target,     'specify the location to deploy to (default: `default`)', :argument => :required
+flag   :C, :'no-check', 'do not run the issue checks marked for deployment'
+flag   :L, :list,       'list available locations to deploy to'
+option :n, :'dry-run',  'show what would be deployed'
 module Nanoc::CLI::Commands
@@ -57,6 +58,17 @@ module Nanoc::CLI::Commands
         raise Nanoc::Errors::GenericTrivial, "The specified deploy target has an unrecognised kind “#{name}” (expected one of #{names.join(', ')})."
       end
+      # Check
+      unless options[:'no-check']
+        puts "Running issue checks…"
+        ok = Nanoc::Extra::Checking::Runner.new(site).run_for_deploy
+        if !ok
+          puts "Issues found, deploy aborted."
+          return
+        end
+        puts "No issues found. Deploying!"
+      end
       # Run
       deployer = deployer_class.new(
         site.config[:output_dir],

data/lib/nanoc/cli/commands/prune.rb CHANGED

@@ -5,10 +5,10 @@ summary     'remove files not managed by nanoc from the output directory'
 description <<-EOS
 Find all files in the output directory that do not correspond to an item
 managed by nanoc and remove them. Since this is a hazardous operation, an
-additional --yes flag is needed as confirmation.
+additional `--yes` flag is needed as confirmation.
-Also see the auto_prune site configuration option in config.yaml, which will
-automatically prune after compilation.
+Also see the `auto_prune` site configuration option in `config.yamlz, which
+will automatically prune after compilation.
 EOS
 flag :y, :yes,       'confirm deletion'

data/lib/nanoc/cli/commands/show-data.rb CHANGED

@@ -13,26 +13,59 @@ module Nanoc::CLI::Commands
   class ShowData < ::Nanoc::CLI::CommandRunner
     def run
-      # Make sure we are in a nanoc site directory
-      print "Loading site data... "
       self.require_site
-      puts "done"
-      puts
       # Get data
-      items   = self.site.items
-      reps    = items.map { |i| i.reps }.flatten
-      layouts = self.site.layouts
+      items     = self.site.items
+      item_reps = items.map { |i| i.reps }.flatten
+      layouts   = self.site.layouts
       # Get dependency tracker
       compiler = self.site.compiler
       compiler.load
       dependency_tracker = compiler.dependency_tracker
-      # Print item dependencies
-      puts '=== Item dependencies ======================================================='
-      puts
+      # Print data
+      self.print_item_dependencies(items, dependency_tracker)
+      self.print_item_rep_paths(items)
+      self.print_item_rep_outdatedness(items, compiler)
+      self.print_layouts(layouts, compiler)
+    end
+  protected
+    def sorted_with_prev(objects)
+      prev = nil
+      objects.sort_by { |o| o.identifier }.each do |object|
+        yield(object, prev)
+        prev = object
+      end
+    end
+    def sorted_reps_with_prev(items)
+      prev = nil
       items.sort_by { |i| i.identifier }.each do |item|
+        item.reps.sort_by { |r| r.name.to_s }.each do |rep|
+          yield(rep, prev)
+          prev = rep
+        end
+      end
+    end
+    def print_header(title)
+      header = '=' * 78
+      header[3..(title.length+5)] = " #{title} "
+      puts
+      puts header
+      puts
+    end
+    def print_item_dependencies(items, dependency_tracker)
+      self.print_header('Item dependencies')
+      self.sorted_with_prev(items) do |item, prev|
+        puts if prev
         puts "item #{item.identifier} depends on:"
         predecessors = dependency_tracker.objects_causing_outdatedness_of(item).sort_by { |i| i ? i.identifier : '' }
         predecessors.each do |pred|
@@ -43,63 +76,45 @@ module Nanoc::CLI::Commands
           end
         end
         puts "  (nothing)" if predecessors.empty?
-        puts
       end
+    end
-      # Print representation paths
-      puts '=== Representation paths ===================================================='
-      puts
-      items.sort_by { |i| i.identifier }.each do |item|
-        item.reps.sort_by { |r| r.name.to_s }.each do |rep|
-          puts "item #{item.identifier}, rep #{rep.name}:"
-          if rep.raw_paths.empty?
-            puts "  (not written)"
-          end
-          length = rep.raw_paths.keys.map { |s| s.to_s.length }.max
-          rep.raw_paths.each do |snapshot_name, raw_path|
-            puts "  [ %-#{length}s ] %s" % [ snapshot_name, raw_path ]
-          end
-        end
-        puts
-      end
+    def print_item_rep_paths(items)
+      self.print_header('Item representation paths')
-      # Print representation outdatedness
-      puts '=== Representation outdatedness ============================================='
-      puts
-      items.sort_by { |i| i.identifier }.each do |item|
-        item.reps.sort_by { |r| r.name.to_s }.each do |rep|
-          puts "item #{item.identifier}, rep #{rep.name}:"
-          outdatedness_reason = compiler.outdatedness_checker.outdatedness_reason_for(rep)
-          if outdatedness_reason
-            puts "  is outdated: #{outdatedness_reason.message}"
-          else
-            puts "  is not outdated"
-          end
+      self.sorted_reps_with_prev(items) do |rep, prev|
+        puts if prev
+        puts "item #{rep.item.identifier}, rep #{rep.name}:"
+        if rep.raw_paths.empty?
+          puts "  (not written)"
+        end
+        length = rep.raw_paths.keys.map { |s| s.to_s.length }.max
+        rep.raw_paths.each do |snapshot_name, raw_path|
+          puts "  [ %-#{length}s ] %s" % [ snapshot_name, raw_path ]
         end
-        puts
       end
+    end
-      # Print layout dependencies
-      puts '=== Layout dependencies ====================================================='
-      puts
-      layouts.sort_by { |l| l.identifier }.each do |layout|
-        puts "layout #{layout.identifier} depends on:"
-        predecessors = dependency_tracker.objects_causing_outdatedness_of(layout).sort_by { |i| i ? i.identifier : '' }
-        predecessors.each do |pred|
-          if pred
-            puts "  [ #{format '%6s', pred.type} ] #{pred.identifier}"
-          else
-            puts "  ( removed item )"
-          end
+    def print_item_rep_outdatedness(items, compiler)
+      self.print_header('Item representation outdatedness')
+      self.sorted_reps_with_prev(items) do |rep, prev|
+        puts if prev
+        puts "item #{rep.item.identifier}, rep #{rep.name}:"
+        outdatedness_reason = compiler.outdatedness_checker.outdatedness_reason_for(rep)
+        if outdatedness_reason
+          puts "  is outdated: #{outdatedness_reason.message}"
+        else
+          puts "  is not outdated"
         end
-        puts "  (nothing)" if predecessors.empty?
-        puts
       end
+    end
-      # Print layouts
-      puts '=== Layouts'
-      puts
-      layouts.sort_by { |l| l.identifier }.each do |layout|
+    def print_layouts(layouts, compiler)
+      self.print_header('Layouts')
+      self.sorted_with_prev(layouts) do |layout, prev|
+        puts if prev
         puts "layout #{layout.identifier}:"
         outdatedness_reason = compiler.outdatedness_checker.outdatedness_reason_for(layout)
         if outdatedness_reason

data/lib/nanoc/cli/commands/show-rules.rb CHANGED

@@ -4,7 +4,7 @@ usage       'show-rules [thing]'
 aliases     :explain
 summary     'describe the rules for each item'
 description <<-EOS
-Prints the rules used for all items and layouts in the current site. An argument can be given, which can be either an item identifier (e.g. /foo/), the path to the source file (e.g. content/foo.html) or the path to the output file (e.g. output/foo.html).
+Prints the rules used for all items and layouts in the current site.
 EOS
 module Nanoc::CLI::Commands

data/lib/nanoc/cli/commands/validate-css.rb CHANGED

@@ -3,6 +3,7 @@
 usage       'validate-css [options]'
 aliases     :validate_css, :vcss
 summary     'validate the site’s CSS'
+be_hidden
 description <<-EOS
 Validates the site’s CSS files.
 EOS
@@ -12,9 +13,7 @@ module Nanoc::CLI::Commands
   class ValidateCSS < ::Nanoc::CLI::CommandRunner
     def run
-      require_site
-      validator = ::Nanoc::Extra::Validators::W3C.new(site.config[:output_dir], [ :css ])
-      validator.run
+      Nanoc::CLI.run %w( check css )
     end
   end

data/lib/nanoc/cli/commands/validate-html.rb CHANGED

@@ -3,6 +3,7 @@
 usage       'validate-html [options]'
 aliases     :validate_html, :vhtml
 summary     'validate the site’s HTML'
+be_hidden
 description <<-EOS
 Validates the site’s HTML files.
 EOS
@@ -12,9 +13,7 @@ module Nanoc::CLI::Commands
   class ValidateHTML < ::Nanoc::CLI::CommandRunner
     def run
-      require_site
-      validator = ::Nanoc::Extra::Validators::W3C.new(site.config[:output_dir], [ :html ])
-      validator.run
+      Nanoc::CLI.run %w( check html )
     end
   end

data/lib/nanoc/cli/commands/validate-links.rb CHANGED

@@ -3,6 +3,7 @@
 usage       'validate-links [options]'
 aliases     :validate_links, :vlink
 summary     'validate links in site'
+be_hidden
 description <<-EOS
 Validates the site’s links. By default, both internal and external links will be checked.
 EOS
@@ -15,17 +16,10 @@ module Nanoc::CLI::Commands
   class ValidateLinks < ::Nanoc::CLI::CommandRunner
     def run
-      require_site
-      dir             = site.config[:output_dir]
-      index_filenames = site.config[:index_filenames]
-      validator = ::Nanoc::Extra::Validators::Links.new(
-        dir,
-        index_filenames,
-        :internal => (options[:external] ? false : true),
-        :external => (options[:internal] ? false : true))
-      validator.run
+      checks = []
+      checks << 'ilinks' if options[:internal]
+      checks << 'elinks' if options[:external]
+      Nanoc::CLI.run [ 'check', checks ].flatten
     end
   end

data/lib/nanoc/cli/commands/view.rb CHANGED

@@ -3,7 +3,7 @@
 usage       'view [options]'
 summary     'start the web server that serves static files'
 description <<-EOS
-Start the static web server. Unless specified, the web server will run on port 3000 and listen on all IP addresses. Running this static web server requires 'adsf' (not 'asdf'!).
+Start the static web server. Unless specified, the web server will run on port 3000 and listen on all IP addresses. Running this static web server requires `adsf` (not `asdf`!).
 EOS
 required :H, :handler, 'specify the handler to use (webrick/mongrel/...)'

data/lib/nanoc/cli/commands/watch.rb CHANGED

@@ -11,7 +11,7 @@ module Nanoc::CLI::Commands
   class Watch < ::Nanoc::CLI::CommandRunner
     def run
-      require 'fssm'
+      require 'listen'
       require 'pathname'
       require_site
@@ -20,12 +20,12 @@ module Nanoc::CLI::Commands
       @notifier = Notifier.new
       # Define rebuilder
-      rebuilder = lambda do |base, relative|
+      rebuilder = lambda do |file_path|
         # Determine filename
-        if base.nil? || relative.nil?
+        if file_path.nil?
           filename = nil
         else
-          filename = ::Pathname.new(File.join([ base, relative ])).relative_path_from(::Pathname.new(Dir.getwd)).to_s
+          filename = ::Pathname.new(file_path).relative_path_from(::Pathname.new(Dir.getwd)).to_s
         end
         # Notify
@@ -63,24 +63,33 @@ module Nanoc::CLI::Commands
       end
       # Rebuild once
-      rebuilder.call(nil, nil)
+      rebuilder.call(nil)
       # Get directories to watch
-      dirs_to_watch  = watcher_config[:dirs_to_watch]  || %w( content layouts lib )
-      files_to_watch = watcher_config[:files_to_watch] || %w( config.yaml Rules rules Rules.rb rules.rb' )
-      files_to_watch.delete_if { |f| !File.file?(f) }
+      dirs_to_watch  = watcher_config[:dirs_to_watch]  || ['content', 'layouts', 'lib']
+      files_to_watch = watcher_config[:files_to_watch] || ['config.yaml', 'Rules', 'rules', 'Rules.rb', 'rules.rb']
+      files_to_watch = Regexp.new(files_to_watch.map { |name| "#{Regexp.quote(name)}$"}.join("|"))
+      ignore_dir = Regexp.new(Dir.glob("*").map{|dir| dir if File::ftype(dir) == "directory" }.compact.join("|"))
       # Watch
       puts "Watching for changes…"
-      watcher = lambda do |*args|
-        update(&rebuilder)
-        delete(&rebuilder)
-        create(&rebuilder)
-      end
-      monitor = FSSM::Monitor.new
-      dirs_to_watch.each  { |dir|      monitor.path(dir, '**/*', &watcher) }
-      files_to_watch.each { |filename| monitor.file(filename, &watcher)    }
-      monitor.run
+        callback = Proc.new do |modified, added, removed|
+          rebuilder.call(modified[0]) if modified[0]
+          rebuilder.call(added[0]) if added[0]
+          rebuilder.call(removed[0]) if removed[0]
+        end
+        listener = Listen::MultiListener.new(*dirs_to_watch).change(&callback)
+        listener_root = Listen::MultiListener.new('', :filter => files_to_watch, :ignore => ignore_dir).change(&callback)
+        begin
+          listener_root.start(false)
+          listener.start
+        rescue Interrupt
+          listener.stop
+          listener_root.stop
+        end
     end
     # Allows sending user notifications in a cross-platform way.
@@ -105,12 +114,21 @@ module Nanoc::CLI::Commands
       def tool
         @tool ||= begin
-          TOOLS.find { |t| !`#{FIND_BINARY_COMMAND} #{t}`.empty? }
-        rescue Errno::ENOENT
-          nil
+          require 'terminal-notifier'
+          'terminal-notify'
+        rescue LoadError
+          begin
+            TOOLS.find { |t| !`#{FIND_BINARY_COMMAND} #{t}`.empty? }
+          rescue Errno::ENOENT
+            nil
+          end
         end
       end
+      def terminal_notify(message)
+        TerminalNotifier.notify(message, :title => "nanoc")
+      end
       def growlnotify(message)
         system('growlnotify', '-m', message)
       end

data/lib/nanoc/cli/error_handler.rb CHANGED

@@ -58,6 +58,10 @@ module Nanoc::CLI
           exit!(0)
         end
       end
+      Signal.trap('USR1') do
+        puts "Caught USR1; dumping a stack trace"
+        puts caller.map { |i| "  #{i}" }.join("\n")
+      end
       # Run
       yield
@@ -89,7 +93,12 @@ module Nanoc::CLI
     # @return [void]
     def print_error(error)
       write_compact_error(error, $stderr)
-      File.open('crash.log', 'w') { |io| write_verbose_error(error, io) }
+      File.open('crash.log', 'w') do |io|
+        cio = Nanoc::CLI.wrap_in_cleaning_stream(io)
+        cio.add_stream_cleaner(::Nanoc::CLI::StreamCleaners::ANSIColors)
+        write_verbose_error(error, cio)
+      end
     end
     # Writes a compact representation of the error, suitable for a terminal, on
@@ -107,48 +116,13 @@ module Nanoc::CLI
       stream.puts
       stream.puts "Captain! We’ve been hit!"
-      # Exception and resolution (if any)
-      stream.puts
-      stream.puts format_title('Message:')
-      stream.puts
-      stream.puts "#{error.class}: #{error.message}"
-      resolution = self.resolution_for(error)
-      stream.puts "#{resolution}" if resolution
-      # Compilation stack
-      stream.puts
-      stream.puts format_title('Compilation stack:')
-      stream.puts
-      if self.stack.empty?
-        stream.puts "  (empty)"
-      else
-        self.stack.reverse.each do |obj|
-          if obj.is_a?(Nanoc::ItemRep)
-            stream.puts "  - [item]   #{obj.item.identifier} (rep #{obj.name})"
-          else # layout
-            stream.puts "  - [layout] #{obj.identifier}"
-          end
-        end
-      end
-      # Backtrace
-      stream.puts
-      stream.puts format_title('Stack trace:')
-      stream.puts
-      count = 10
-      error.backtrace[0...count].each_with_index do |item, index|
-        stream.puts "  #{index}. #{item}"
-      end
-      if error.backtrace.size > count
-        puts "  ... #{error.backtrace.size - count} more lines omitted. See full crash log for details."
-      end
+      # Sections
+      self.write_error_message(    stream, error)
+      self.write_compilation_stack(stream, error)
+      self.write_stack_trace(      stream, error)
       # Issue link
-      stream.puts
-      stream.puts "If you believe this is a bug in nanoc, please do report it at"
-      stream.puts "-> https://github.com/ddfreyne/nanoc/issues/new <-"
-      stream.puts
-      stream.puts "A detailed crash log has been written to ./crash.log."
+      self.write_issue_link(stream)
     end
     # Writes a verbose representation of the error on the given stream.
@@ -161,86 +135,19 @@ module Nanoc::CLI
     #
     # @return [void]
     def write_verbose_error(error, stream)
-      # Date and time
+      # Header
       stream.puts "Crashlog created at #{Time.now}"
-      stream.puts
-      # Exception and resolution (if any)
-      stream.puts '=== MESSAGE:'
-      stream.puts
-      stream.puts "#{error.class}: #{error.message}"
-      resolution = self.resolution_for(error)
-      stream.puts "#{resolution}" if resolution
-      stream.puts
-      # Compilation stack
-      stream.puts '=== COMPILATION STACK:'
-      stream.puts
-      if self.stack.empty?
-        stream.puts "  (empty)"
-      else
-        self.stack.reverse.each do |obj|
-          if obj.is_a?(Nanoc::ItemRep)
-            stream.puts "  - [item]   #{obj.item.identifier} (rep #{obj.name})"
-          else # layout
-            stream.puts "  - [layout] #{obj.identifier}"
-          end
-        end
-      end
-      stream.puts
-      # Backtrace
-      stream.puts '=== BACKTRACE:'
-      stream.puts
-      stream.puts error.backtrace.to_enum(:each_with_index).map { |item, index| "  #{index}. #{item}" }.join("\n")
-      stream.puts
-      # Version information
-      stream.puts '=== VERSION INFORMATION:'
-      stream.puts
-      stream.puts Nanoc.version_information
-      stream.puts
-      # System information
-      begin
-        uname = `uname -a`
-        stream.puts '=== SYSTEM INFORMATION:'
-        stream.puts
-        stream.puts uname
-        stream.puts
-      rescue Errno::ENOENT
-      end
-      # Installed gems
-      stream.puts '=== INSTALLED GEMS:'
-      stream.puts
-      self.gems_and_versions.each do |g|
-        stream.puts "  #{g.first} #{g.last.join(', ')}"
-      end
-      stream.puts
-      # Environment
-      stream.puts '=== ENVIRONMENT:'
-      stream.puts
-      ENV.sort.each do |e|
-        stream.puts "#{e.first} => #{e.last.inspect}"
-      end
-      stream.puts
-      # Gemfile
-      if File.exist?('Gemfile.lock')
-        stream.puts '=== GEMFILE.LOCK:'
-        stream.puts
-        stream.puts File.read('Gemfile.lock')
-        stream.puts
-      end
-      # Load paths
-      stream.puts '=== $LOAD_PATH:'
-      stream.puts
-      $LOAD_PATH.each_with_index do |i, index|
-        stream.puts "  #{index}. #{i}"
-      end
+      # Sections
+      self.write_error_message(      stream, error, :verbose => true)
+      self.write_compilation_stack(  stream, error, :verbose => true)
+      self.write_stack_trace(        stream, error, :verbose => true)
+      self.write_version_information(stream,        :verbose => true)
+      self.write_system_information( stream,        :verbose => true)
+      self.write_installed_gems(     stream,        :verbose => true)
+      self.write_environment(        stream,        :verbose => true)
+      self.write_gemfile_lock(       stream,        :verbose => true)
+      self.write_load_paths(         stream,        :verbose => true)
     end
   protected
@@ -267,6 +174,7 @@ module Nanoc::CLI
       (compiler && compiler.stack) || []
     end
+    # @return [Hash<String, Array>] A hash containing the gem names as keys and gem versions as value
     def gems_and_versions
       gems = {}
       Gem::Specification.find_all.sort_by { |s| [ s.name, s.version ] }.each do |spec|
@@ -287,12 +195,12 @@ module Nanoc::CLI
       'erubis'         => 'erubis',
       'escape'         => 'escape',
       'fog'            => 'fog',
-      'fssm'           => 'fssm',
       'haml'           => 'haml',
       'handlebars'     => 'hbs',
       'json'           => 'json',
       'kramdown'       => 'kramdown',
       'less'           => 'less',
+      'listen'         => 'listen',
       'markaby'        => 'markaby',
       'maruku'         => 'maruku',
       'mime/types'     => 'mime-types',
@@ -338,8 +246,100 @@ module Nanoc::CLI
       end
     end
-    def format_title(s)
-      "\e[1m\e[31m" + s + "\e[0m"
+    def write_section_header(stream, title, params={})
+      stream.puts
+      if params[:verbose]
+        stream.puts '===== ' + title.upcase + ':'
+      else
+        stream.puts "\e[1m\e[31m" + title + ':' + "\e[0m"
+      end
+      stream.puts
+    end
+    def write_error_message(stream, error, params={})
+      self.write_section_header(stream, 'Message', params)
+      stream.puts "#{error.class}: #{error.message}"
+      resolution = self.resolution_for(error)
+      stream.puts "#{resolution}" if resolution
+    end
+    def write_compilation_stack(stream, error, params={})
+      self.write_section_header(stream, 'Compilation stack', params)
+      if self.stack.empty?
+        stream.puts "  (empty)"
+      else
+        self.stack.reverse.each do |obj|
+          if obj.is_a?(Nanoc::ItemRep)
+            stream.puts "  - [item]   #{obj.item.identifier} (rep #{obj.name})"
+          else # layout
+            stream.puts "  - [layout] #{obj.identifier}"
+          end
+        end
+      end
+    end
+    def write_stack_trace(stream, error, params={})
+      self.write_section_header(stream, 'Stack trace', params)
+      count = params[:verbose] ? -1 : 10
+      error.backtrace[0...count].each_with_index do |item, index|
+        stream.puts "  #{index}. #{item}"
+      end
+      if error.backtrace.size > count
+        stream.puts "  ... #{error.backtrace.size - count} more lines omitted. See full crash log for details."
+      end
+    end
+    def write_issue_link(stream, params={})
+      stream.puts
+      stream.puts "If you believe this is a bug in nanoc, please do report it at"
+      stream.puts "-> https://github.com/ddfreyne/nanoc/issues/new <-"
+      stream.puts
+      stream.puts "A detailed crash log has been written to ./crash.log."
+    end
+    def write_version_information(stream, params={})
+      self.write_section_header(stream, 'Version information', params)
+      stream.puts Nanoc.version_information
+    end
+    def write_system_information(stream, params={})
+      begin
+        uname = `uname -a`
+        self.write_section_header(stream, 'System information', params)
+        stream.puts uname
+      rescue Errno::ENOENT
+      end
+    end
+    def write_installed_gems(stream, params={})
+      self.write_section_header(stream, 'Installed gems', params)
+      self.gems_and_versions.each do |g|
+        stream.puts "  #{g.first} #{g.last.join(', ')}"
+      end
+    end
+    def write_environment(stream, params={})
+      self.write_section_header(stream, 'Environment', params)
+      ENV.sort.each do |e|
+        stream.puts "#{e.first} => #{e.last.inspect}"
+      end
+    end
+    def write_gemfile_lock(stream, params={})
+      if File.exist?('Gemfile.lock')
+        self.write_section_header(stream, 'Gemfile.lock', params)
+        stream.puts File.read('Gemfile.lock')
+      end
+    end
+    def write_load_paths(stream, params={})
+      self.write_section_header(stream, 'Load paths', params)
+      $LOAD_PATH.each_with_index do |i, index|
+        stream.puts "  #{index}. #{i}"
+      end
     end
   end