Commit d640a643 authored by Rene Saarsoo's avatar Rene Saarsoo
Browse files

Extract Lint class for reporting docs errors.

parent 6d601fb2

lib/jsduck/app.rb

+2 −31
Original line number Diff line number Diff line
@@ -16,6 +16,7 @@ require 'jsduck/logger' 
require 'jsduck/guides'

require 'jsduck/categories'

require 'jsduck/jsonp'

require 'jsduck/lint'

require 'json'

require 'fileutils'
@@ -99,8 +100,7 @@ module JsDuck 
      result = @timer.time(:aggregating) { aggregate(parsed_files) }

      relations = @timer.time(:aggregating) { filter_classes(result) }

      Aliases.new(relations).resolve_all

      warn_globals(relations)

      warn_unnamed(relations)

      Lint.new(relations).run



      @guides = Guides.new(get_doc_formatter(relations), @guides_order)

      if @guides_dir
@@ -179,35 +179,6 @@ module JsDuck 
      Relations.new(classes, @external_classes)

    end



    # print warning for each global member

    def warn_globals(relations)

      global = relations["global"]

      return unless global

      global[:members].each_key do |type|

        global.members(type).each do |member|

          name = member[:name]

          file = member[:filename]

          line = member[:linenr]

          Logger.instance.warn("Global #{type}: #{name} in #{file} line #{line}")

        end

      end

    end



    # print warning for each member with no name

    def warn_unnamed(relations)

      relations.each do |cls|

        cls[:members].each_pair do |type, members|

          members.each do |member|

            if !member[:name] || member[:name] == ""

              file = member[:filename]

              line = member[:linenr]

              Logger.instance.warn("Unnamed #{type} in #{file} line #{line}")

            end

          end

        end

      end

    end



    # Given all classes, generates namespace tree and writes it

    # in JSON form into a file.

    def write_tree(filename, relations)

lib/jsduck/lint.rb

0 → 100644
+50 −0
Original line number Diff line number Diff line 
require 'jsduck/logger'



module JsDuck



  # Reports bugs and problems in documentation

  class Lint

    attr_accessor :relations



    def initialize(relations)

      @relations = relations

    end



    # Runs the linter

    def run

      warn_globals

      warn_unnamed

    end



    # print warning for each global member

    def warn_globals

      global = @relations["global"]

      return unless global

      global[:members].each_key do |type|

        global.members(type).each do |member|

          name = member[:name]

          file = member[:filename]

          line = member[:linenr]

          Logger.instance.warn("Global #{type}: #{name} in #{file} line #{line}")

        end

      end

    end



    # print warning for each member with no name

    def warn_unnamed

      @relations.each do |cls|

        cls[:members].each_pair do |type, members|

          members.each do |member|

            if !member[:name] || member[:name] == ""

              file = member[:filename]

              line = member[:linenr]

              Logger.instance.warn("Unnamed #{type} in #{file} line #{line}")

            end

          end

        end

      end

    end



  end



end