jslint-rb 0.5 → 0.6

data/lib/jslint-rb/error.rb

@@ -1,6 +1,20 @@
 module JslintRb
+  ##
+  #This object encapsulates the output from JSHint.  Does some
+  #minimal formatting
   class Error
-    attr_reader :line_number, :character, :reason, :evidence
+    ##
+    #Line number the JSHint error occured on
+    attr_reader :line_number
+    ##
+    #Column number of the JSHint error
+    attr_reader :character
+    ##
+    #The actual error that was discovered
+    attr_reader :reason
+    ##
+    #The snippet of code that caused the error
+    attr_reader :evidence
 
     def initialize(jsobject)
       @line_number = jsobject["line"]

data/lib/jslint-rb/formatter.rb

@@ -14,20 +14,39 @@ module JslintRb
       errors.each do |error|
         fmt_err = "#{filename}:#{error.line_number}:"\
           "#{error.character}:#{error.reason}"
-        fmt_err << " | #{error.evidence}" unless error.evidence.nil?
         results << fmt_err
       end
       results
     end
 
-    def initialize(formatter)
-      if formatter.nil?
-        puts 'Please enter a formatter class'
+    ##
+    #Multiline output suitible for a terminal window
+    MULTI_LINE = Proc.new do |errors, filename|
+      results = []
+
+      #header
+      results << "#########################################"
+      results << "# Lint output for: #{filename}"
+      results << "#########################################"
+
+      errors.each do |error|
+        results << "Error occured on line #{error.line_number} at col #{error.character}:"
+        results << "    #{error.reason}"
+        results << "EVIDENCE: #{error.evidence}" unless error.evidence.nil?
+        results << "\n"
       end
-      @command = formatter
+      results
     end
 
+    ##
+    #Uses MULTI_LINE as a default
+    def initialize(formatter)
+      formatter = JslintRb::Formatter::MULTI_LINE if formatter.nil?
+      @command = formatter
+    end
 
+    ##
+    #Put the formatted JSHINT results to STDOUT
     def print(errors, filename)
       output = @command.call(errors, filename)
       puts output

data/lib/jslint-rb/option_parser.rb

@@ -7,11 +7,16 @@ module JslintRb
     require 'optparse'
     require 'yaml'
 
+    ##
+    #The options for JSHint and global vars to exclude from
+    #undef error reports
     attr_reader :options
+    ##
+    #The file that we are executing JSHint against
     attr_reader :filename
 
     ##
-    #These are just some defaults that I wanted.
+    #These are just some JSHINT defaults that I wanted.
     #Part of the fun in writing software is imposing your
     #opinions on people.
     DEFAULT_OPT =
@@ -28,6 +33,10 @@ module JslintRb
       eqnull: true
     }
 
+    ##
+    #The default globals are tailored for some of my projects
+    #and ExtJS.  Should probably turn this into something more
+    #generic
     DEFAULT_GLOBALS = {
       Ext: true,
       console: true,
@@ -42,8 +51,6 @@ module JslintRb
       @options = {
         #Location of the jslint.js file
         lint_location: File.expand_path("js/jshint.js", File.dirname(__FILE__)),
-        #tempfile location; make sure it's writable by your user
-        temp_file: 'jslint_wrap.tmp',
         #this is passed to JSLint so that it will not falsely call
         #an undefined error on them
         global_vars: {},
@@ -57,6 +64,8 @@ module JslintRb
       parse_cmdline_args
     end
 
+    private
+
     def load_globals globals
       globals.each do |global|
         key,value = global.split(':')
@@ -88,17 +97,28 @@ module JslintRb
       return if config_file.nil?
       config = YAML::load(config_file)
       return if config == false
-      load_globals config['global_vars'] unless config['global_vars'].nil?
-      load_lint_configs config['lint_options'] unless config['lint_options'].nil?
-      get_formatter_constant config['formatter_proc'] unless config['formatter_proc'].nil?
+
+      config.each do |key, val|
+        if key == 'global_vars'
+          load_globals val
+        elsif key == 'lint_options'
+          load_lint_configs val
+        elsif key == 'formatter_proc'
+          get_formatter_constant val
+        end
+      end
+
     end
 
+    ##
+    #Uses optparse to turn the cmdline arguments into
+    #config objects
     def parse_cmdline_args
 
       ARGV.options do |opt|
         opt.banner = "Usage: jslint-rb [FILENAME] [OPTIONS]"
 
-        opt.on('-o', "--options ['OPTIONNAME : VALUE',]", Array,
+        opt.on('-o', "--options ['OPTIONNAME : VALUE']", Array,
                "List of JsHint options. "\
                "Passing default : true will "\
                "enable default options") do |options|
@@ -111,8 +131,9 @@ module JslintRb
         end
 
         opt.on('-f', "--format FORMAT", String,
-               "The string constant for the Formatter proc:
-                                      VIM -- format for VIM make errorformat"
+               "The string constant for the Formatter proc
+                                       Options:
+                                         VIM -- format for VIM make errorformat"
               ) do |option|
           get_formatter_constant option
         end

data/lib/jslint-rb/runner.rb

@@ -1,10 +1,8 @@
 module JslintRb
-##
-#The main ruby file that you call to run JSLint
-#It is setup with some default options, that you will
-#have to edit the class to override. Once I turn this
-#into a gem, you'll be able to set these by config file
-#or command line options.
+  ##
+  #This class uses ExecJS to execute the JSHINT function with the
+  #config options provided.  Uses MultiJson to dump the Ruby objects to
+  #well formatted JS.
   class Runner
     require 'execjs'
     require 'multi_json'
@@ -14,8 +12,10 @@ module JslintRb
       @config = options
     end
 
+    ##
+    #Executes JSHint, with the options and globals provided.
+    #Converts the JS output to an array of JslintRb::Error objects
     def execute
-      #set_globals
       context = ExecJS.compile(File.read(@config[:lint_location]))
       output = context.exec("JSHINT(#{MultiJson.dump(File.read(@filename))},"\
                             "#{MultiJson.dump(@config[:lint_options])},"\
@@ -24,18 +24,5 @@ module JslintRb
       output.compact.map {|x| JslintRb::Error.new(x) }
     end
 
-    ##
-    #This prepends a list of globals to the file you're working on.
-    #Saves it off to the location defined by @config[:temp_file]
-    def set_globals
-      f = File.open(@filename, 'r')
-      contents = "/*global #{@config[:global_vars]} */ #{f.read}"
-      f.close
-
-      tmp_file_handle = File.open(@config[:temp_file], "w")
-      tmp_file_handle.write(contents)
-      tmp_file_handle.close()
-    end
-
   end#Runner
 end#JslintRb

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jslint-rb
 version: !ruby/object:Gem::Version
-  version: '0.5'
+  version: '0.6'
   prerelease: 
 platform: ruby
 authors: