jslint-rb 0.1 → 0.5

data/README.md

@@ -0,0 +1,40 @@
+#Jslint-rb
+Borne out of a set of Python/Bash scripts I had lugged around for several years. Decided
+to turn into an actual program instead of setting it up on yet another machine.
+
+###Features:
+* Converted to ruby for easy portability
+* Using ExecJS, so no dependency on a particular JS runtime
+* You can specify a list of globals at the commandline (config file in the future)
+  instead of having to update your source code files with ugly /*global x,y,z */
+  declarations
+* will also be able to configure multiple formatters easily for use in different environments
+  (VIM, RubyMine, Continuous Integration, etc)
+
+###Examples:
+
+Install the gem and a js runtime
+```bash
+gem install jslint-rb
+gem install therubyracer
+```
+
+Setup a config file in your $HOME directory, named .jslint-rb.  Then put the following in there
+
+```yaml
+global_vars:
+ - default:true
+formatter_proc: VIM
+lint_options:
+ - default:true
+```
+You should be all set to start linting your Javascript!  Output will be to STDOUT
+
+```bash
+jslint-rb foo.js
+```
+
+####TODO:
+
+1.  Make a task to pull the latest version of JSHint
+2.  Test with MacVim and Windows

data/bin/jslint-rb

@@ -8,6 +8,6 @@ config = JslintRb::OptionParser.new
 instance = JslintRb::Runner.new(config.filename, config.options)
 output = instance.execute
 
-formatter = JslintRb::Formatter.new(JslintRb::Formatter::VIM)
+formatter = JslintRb::Formatter.new(config.options[:formatter_proc])
 
 formatter.print(output, config.filename)

data/lib/jslint-rb/error.rb

@@ -7,6 +7,7 @@ module JslintRb
       @character = jsobject["character"]
       @reason = jsobject["reason"]
       @evidence = jsobject["evidence"]
+      @evidence.strip! unless @evidence.nil?
     end
 
   end

data/lib/jslint-rb/formatter.rb

@@ -12,13 +12,18 @@ module JslintRb
     VIM = Proc.new do |errors, filename|
       results = []
       errors.each do |error|
-        results << "#{filename}:#{error.line_number}:"\
-        "#{error.character}:#{error.reason} -- #{error.evidence.strip}"
+        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'
+      end
       @command = formatter
     end
 

data/lib/jslint-rb/option_parser.rb

@@ -5,6 +5,7 @@ module JslintRb
   #see a list of valid command line opts
   class OptionParser
     require 'optparse'
+    require 'yaml'
 
     attr_reader :options
     attr_reader :filename
@@ -27,6 +28,14 @@ module JslintRb
       eqnull: true
     }
 
+    DEFAULT_GLOBALS = {
+      Ext: true,
+      console: true,
+      Compass: true,
+      currentUser: true
+    }
+
+
     def initialize
       @filename = ARGV[0]
 
@@ -37,12 +46,55 @@ module JslintRb
         temp_file: 'jslint_wrap.tmp',
         #this is passed to JSLint so that it will not falsely call
         #an undefined error on them
-        global_vars: "Ext,console,Compass,currentUser",
+        global_vars: {},
         #A hash of JSHINT options
-        lint_options: {}
-        #default_options: ['white: false', 'nomen: false', 'undef: true']
+        lint_options: {},
+        #Formatter proc to use
+        formatter_proc: nil
       }
 
+      parse_config_file
+      parse_cmdline_args
+    end
+
+    def load_globals globals
+      globals.each do |global|
+        key,value = global.split(':')
+        if key == 'default'
+          @options[:global_vars].merge!(DEFAULT_GLOBALS)
+        else
+          @options[:global_vars][key] = value
+        end
+      end
+    end
+
+    def load_lint_configs options
+      options.each do |lint_opt|
+        key,value = lint_opt.split(':')
+        if key == 'default'
+          @options[:lint_options].merge!(DEFAULT_OPT)
+        else
+          @options[:lint_options][key] = value
+        end
+      end
+    end
+
+    def get_formatter_constant constant
+      @options[:formatter_proc] = eval('JslintRb::Formatter::'<< constant)
+    end
+
+    def parse_config_file
+      config_file = File.read(File.join(ENV['HOME'],'.jslint-rb')) rescue nil
+      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?
+    end
+
+    def parse_cmdline_args
+
       ARGV.options do |opt|
         opt.banner = "Usage: jslint-rb [FILENAME] [OPTIONS]"
 
@@ -50,15 +102,19 @@ module JslintRb
                "List of JsHint options. "\
                "Passing default : true will "\
                "enable default options") do |options|
+          load_lint_configs options
+        end
 
-          options.each do |lint_opt|
-            key,value = lint_opt.split(':')
-            if key == 'default'
-              @options[:lint_options].merge!(DEFAULT_OPT)
-            else
-              @options[:lint_options][key] = value
-            end
-          end
+        opt.on('-g', "--globals  ['GLOBALVAR' : BOOL]", Array,
+               "array of globals.  Set them to true to allow them to be overridden") do |options|
+          load_globals options
+        end
+
+        opt.on('-f', "--format FORMAT", String,
+               "The string constant for the Formatter proc:
+                                      VIM -- format for VIM make errorformat"
+              ) do |option|
+          get_formatter_constant option
         end
 
         opt.on_tail("-h", "--help", 'Show this message') do
@@ -67,7 +123,6 @@ module JslintRb
         end
         opt.parse!
       end
-
     end
 
   end

data/lib/jslint-rb/runner.rb

@@ -15,10 +15,11 @@ module JslintRb
     end
 
     def execute
-      set_globals
+      #set_globals
       context = ExecJS.compile(File.read(@config[:lint_location]))
-      output = context.exec("JSHINT(#{MultiJson.dump(File.read(@config[:temp_file]))},"\
-                            "#{MultiJson.dump(@config[:lint_options])});"\
+      output = context.exec("JSHINT(#{MultiJson.dump(File.read(@filename))},"\
+                            "#{MultiJson.dump(@config[:lint_options])},"\
+                            "#{MultiJson.dump(@config[:global_vars])});"\
                             "return JSHINT.errors")
       output.compact.map {|x| JslintRb::Error.new(x) }
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jslint-rb
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: '0.5'
   prerelease: 
 platform: ruby
 authors:
@@ -16,7 +16,7 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - '='
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.3.2
   type: :runtime
@@ -24,7 +24,7 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - '='
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.3.2
 - !ruby/object:Gem::Dependency
@@ -32,7 +32,7 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - '='
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.3.6
   type: :runtime
@@ -40,10 +40,13 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - '='
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.3.6
-description: Ruby wrapper for JSHint, using execJS
+description: Ruby wrapper to run and format JSHint, using execJS. It supports commandline
+  arguments or a YAML config file to specify global variables and JSHint configs.
+  JavaScript runtime independent so you can start linting without the hassle, on Linux,
+  Windows, or Mac
 email: chris@uberbrodt.net
 executables:
 - jslint-rb
@@ -58,7 +61,7 @@ files:
 - lib/jslint-rb/js/jshint.js
 - lib/jslint-rb/formatter.rb
 - lib/jslint-rb.rb
-- README
+- README.md
 - GPL-3-LICENSE
 homepage: https://github.com/uberbrodt/jslint-rb
 licenses: []
@@ -83,5 +86,5 @@ rubyforge_project:
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: Ruby wrapper to run and format JSLint, using execJS
+summary: Ruby wrapper to run and format JSHint, using execJS.
 test_files: []

data/README

@@ -1,37 +0,0 @@
-Borne out of a set of Python/Bash scripts I had lugged around for several years. Decided
-to turn into an actual program instead of setting it up on yet another machine.
-
-Features:
-* Converted to ruby for easy portability
-* Using ExecJS, so no dependency on a particular JS runtime
-* You can specify a list of globals at the commandline (config file in the future)
-  instead of having to update your source code files with ugly /*global x,y,z */
-  declarations
-* will also be able to configure multiple formatters easily for use in different environments
-  (VIM, RubyMine, Continuous Integration, etc)
-
-UPDATE June 15th 2012:
-
-Got ExecJS integrated, and enabled the formatting so it will work with VIM.
-Also converted to using JSHint instead of JSLint. General refactoring as well,
-but should be good enough for a general beta release
-
-UPDATE June 6th 2012:
-
-Created a ruby version of this script.  Can be used like this:
-
-jslint foo.js [OPTIONS]
-
-requires ruby 1.9.x
-
-This version is missing the pretty formatting for use with VIM/Emacs, but that should be added
-soon.
-
-TODO:
-
-1.  Make a task to pull the latest version of JSHint
-2.  Test with MacVim
-3.  Allow the specification of formatters at the command line
-4.  Allow the spec of Globals from the commandline
-5.  Allow configuration via a YAML file in the users home directory, so that you
-    don't have to input the same commandline options each time