jslint-v8 1.0.1 → 1.1.0

data/Gemfile.lock

@@ -1,16 +1,16 @@
 PATH
   remote: .
   specs:
-    jslint-v8 (1.0.0)
+    jslint-v8 (1.1.0)
       therubyracer (~> 0.9.4)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    libv8 (3.3.10.2)
-    rake (0.9.2)
-    test-unit (2.3.2)
-    therubyracer (0.9.4)
+    libv8 (3.3.10.4)
+    rake (0.9.2.2)
+    test-unit (2.4.5)
+    therubyracer (0.9.9)
       libv8 (~> 3.3.10)
 
 PLATFORMS

data/README.markdown

@@ -1 +1,51 @@
 [![Build Status](https://secure.travis-ci.org/whoward/jslint-v8.png)](http://travis-ci.org/whoward/jslint-v8)
+
+# Description
+
+JSLintV8 is simply a ruby wrapper that helps you run JSLint as an automated
+code quality standards tool inside your projects.  It's geared towards being run
+in a continuous integration process (CI), such as Jenkins.
+
+While it is focused on Ruby projects it can just as easily be used for any other 
+language out there so long as you have Ruby installed on your system.
+
+Like it's name implies we run JSLint on the JavaScript V8 interpreter so, in 
+other words, it runs really really fast.
+
+# How to use
+
+1. Make sure you have Ruby and Rubygems installed on your computer (most operating systems except for Windows have this already)
+
+2. In your console run: ```gem install jslint-v8```
+
+3. Run the following command ```jslint-v8 path/to/file.js```
+
+For full details on using the command line interface simply type ```jslint-v8```
+
+# Rake Task
+
+In addition to the CLI you can also set up a Rake task to automatically run against
+a set of files.  Inside your Rakefile add the following:
+
+```ruby
+   require 'rake'
+   require 'jslint-v8'
+
+   namespace :js do
+      JSLintV8::RakeTask.new do |task|
+         task.name = "lint"
+         task.include_pattern = "app/javascripts/**/*.js"
+         task.exclude_pattern = "app/javascripts/{generated,lib}/**/*.js"
+      end
+   end
+```
+
+Modify the settings as needed.  This code will make a task "js:lint" which will
+run against all javascript files under ```app/javascripts``` except under 
+```app/javascripts/lib``` and ```app/javascripts/generated```
+
+# Contributing
+
+Whatever works, but my preference is for you to fork this repository on github
+and write your changes on a separate branch.  When finished you can send them
+to me by issuing a pull request.

data/bin/jslint-v8

@@ -2,15 +2,39 @@
 require 'rubygems'
 require File.expand_path("../lib/jslint-v8", File.dirname(__FILE__))
 
-if ARGV.empty?
-  puts "usage: #{File.basename(__FILE__)} FILES"
-  exit 1
+def print_usage
+   STDERR.puts JSLintV8::OptionParser.new.help
+   exit(255)
 end
 
+# if no parameters are passed then print usage and exit
+print_usage if ARGV.empty?
+
+# parse the options out of the command line
+begin
+   parser = JSLintV8::OptionParser.new
+   parser.parse!
+rescue SystemExit => e
+   # exit with a failing status code, happens with the -h and -v options
+   exit(255)
+rescue Exception => e
+   # print out an error message and exit with a failing exit code
+   STDERR.puts "#{$0}: #{e.message} (#{e.class.to_s})"
+   exit(255)
+end
+
+# if no parameters are left (nothing beyond options given) then print usage and exit
+print_usage if ARGV.empty?
+
+# set up a formatter for standard output
 formatter = JSLintV8::Formatter.new(STDOUT)
 
+# set up a runner
+runner = JSLintV8::Runner.new(ARGV)
+runner.jslint_options.merge!(parser.options[:lint_options])
+
 # get a list of all failed files, printing . or * along the way depending on the result
-lint_result = JSLintV8::Runner.new(ARGV).run do |file, errors|
+lint_result = runner.run do |file, errors|
   formatter.tick(errors)
 end
 

data/lib/jslint-v8.rb

@@ -3,4 +3,6 @@ module JSLintV8 end
 require File.expand_path("jslint-v8/runner", File.dirname(__FILE__))
 require File.expand_path("jslint-v8/rake_task", File.dirname(__FILE__))
 require File.expand_path("jslint-v8/lint_error", File.dirname(__FILE__))
-require File.expand_path("jslint-v8/formatter", File.dirname(__FILE__))
+require File.expand_path("jslint-v8/formatter", File.dirname(__FILE__))
+require File.expand_path("jslint-v8/option_parser", File.dirname(__FILE__))
+require File.expand_path("jslint-v8/version", File.dirname(__FILE__))

data/lib/jslint-v8/formatter.rb

@@ -27,7 +27,11 @@ module JSLintV8
 
          out.print "\nFailures:\n\n"
 
-         result.each do |file, errors|
+         # we iterate the sorted keys to prevent a brittle test and also the output
+         # should be nicer as it will be guaranteed to be alphabetized
+         result.keys.sort.each do |file|
+            errors = result[file]
+
             out.print "#{file}:\n"
             errors.each do |error|
                out.print "   line #{error.line_number} character #{error.character} #{error.reason}\n"

data/lib/jslint-v8/option_parser.rb

@@ -0,0 +1,39 @@
+require 'optparse'
+
+module JSLintV8
+   class OptionParser < ::OptionParser
+
+      attr_reader :options
+
+      def initialize
+         super
+
+         @options = {}
+         @options[:lint_options] = {}
+
+         self.version = JSLintV8::Version::STRING
+         self.banner  = "#{self.banner} <filepattern>..."
+
+         Runner::DefaultOptions.keys.each do |option|
+            default = Runner::DefaultOptions[option] ? "on" : "off"
+
+            long  = "--[no-]#{option}"
+            desc  = "#{Runner::OptionDescriptions[option]} (default=#{default})"
+
+            on(long, desc) do |value|
+               options[:lint_options][option] = value
+            end
+         end
+
+         on("-h", "--help", "Show this message") do
+            STDERR.puts self.help
+            exit(-1)
+         end
+
+         on("-v", "--version", "Show version") do
+            STDERR.puts "#{self.program_name} version #{JSLintV8::Version::STRING}"
+            exit(-1)
+         end
+      end
+   end
+end

data/lib/jslint-v8/rake_task.rb

@@ -18,6 +18,15 @@ module JSLintV8
     # output stream for this task
     attr_accessor :output_stream
 
+    # custom lint options for the task
+    attr_accessor :lint_options
+
+    # metaprogrammatically define accessors for each lint option expected
+    Runner::DefaultOptions.keys.each do |key|
+      define_method(key)       { lint_options[key] }
+      define_method("#{key}=") {|value| lint_options[key] = value }
+    end
+
     def initialize
       # a default name
       @name = "lint"
@@ -34,6 +43,9 @@ module JSLintV8
       # by default use standard output for writing information
       @output_stream = STDOUT
 
+      # by default provide no overridden lint options
+      @lint_options = {}
+
       # if a block was given allow the block to call elements on this object
       yield self if block_given?
 
@@ -72,7 +84,9 @@ module JSLintV8
   private
     
     def runner
-      JSLintV8::Runner.new(files_to_run)
+      runner = JSLintV8::Runner.new(files_to_run)
+      runner.jslint_options.merge!(lint_options)
+      runner
     end
 
   end

data/lib/jslint-v8/runner.rb

@@ -4,6 +4,100 @@ module JSLintV8
    class Runner
       JSLintLibraryFilename = File.expand_path("js/jslint.js", File.dirname(__FILE__))
 
+      DefaultOptions =  {
+         "asi" => false,
+         "bitwise" => true,
+         "boss" => false,
+         "browser" => false,
+         "couch" => false,
+         "curly" => false,
+         "debug" => false,
+         "devel" => false,
+         "dojo" => false,
+         "eqeqeq" => true,
+         "eqnull" => false,
+         "es5" => false,
+         "evil" => false,
+         "expr" => false,
+         "forin" => false,
+         "globalstrict" => false,
+         "immed" => true,
+         "jquery" => false,
+         "latedef" => false,
+         "laxbreak" => false,
+         "loopfunc" => false,
+         "mootools" => false,
+         "newcap" => true,
+         "noarg" => false,
+         "node" => false,
+         "noempty" => false,
+         "nonew" => false,
+         "nomen" => true,
+         "onevar" => true,
+         "passfail" => false,
+         "plusplus" => true,
+         "prototypejs" => false,
+         "regexdash" => false,
+         "regexp" => true,
+         "rhino" => false,
+         "undef" => true,
+         "scripturl" => false,
+         "shadow" => false,
+         "strict" => false,
+         "sub" => false,
+         "supernew" => false,
+         "trailing" => false,
+         "white" => false,
+         "wsh" => false
+      }.freeze
+
+      OptionDescriptions =  {
+         "asi"          => "if automatic semicolon insertion should be tolerated",
+         "bitwise"      => "if bitwise operators should not be allowed",
+         "boss"         => "if advanced usage of assignments should be allowed",
+         "browser"      => "if the standard browser globals should be predefined",
+         "couch"        => "if CouchDB globals should be predefined",
+         "curly"        => "if curly braces around blocks should be required (even in if/for/while)",
+         "debug"        => "if debugger statements should be allowed",
+         "devel"        => "if logging globals should be predefined (console, alert, etc.)",
+         "dojo"         => "if Dojo Toolkit globals should be predefined",
+         "eqeqeq"       => "if === should be required",
+         "eqnull"       => "if == null comparisons should be tolerated",
+         "es5"          => "if ES5 syntax should be allowed",
+         "evil"         => "if eval should be allowed",
+         "expr"         => "if ExpressionStatement should be allowed as Programs",
+         "forin"        => "if for in statements must filter",
+         "globalstrict" => "if global \"use strict\"; should be allowed (also enables 'strict')",
+         "immed"        => "if immediate invocations must be wrapped in parens",
+         "jquery"       => "if jQuery globals should be predefined",
+         "latedef"      => "if the use before definition should not be tolerated",
+         "laxbreak"     => "if line breaks should not be checked",
+         "loopfunc"     => "if functions should be allowed to be defined within loops",
+         "mootools"     => "if MooTools globals should be predefined",
+         "newcap"       => "if constructor names must be capitalized",
+         "noarg"        => "if arguments.caller and arguments.callee should be disallowed",
+         "node"         => "if the Node.js environment globals should be predefined",
+         "noempty"      => "if empty blocks should be disallowed",
+         "nonew"        => "if using `new` for side-effects should be disallowed",
+         "nomen"        => "if names should be checked",
+         "onevar"       => "if only one var statement per function should be allowed",
+         "passfail"     => "if the scan should stop on first error",
+         "plusplus"     => "if increment/decrement should not be allowed",
+         "prototypejs"  => "if Prototype and Scriptaculous globals should be predefined",
+         "regexdash"    => "if unescaped last dash (-) inside brackets should be tolerated",
+         "regexp"       => "if the . should not be allowed in regexp literals",
+         "rhino"        => "if the Rhino environment globals should be predefined",
+         "undef"        => "if variables should be declared before used",
+         "scripturl"    => "if script-targeted URLs should be tolerated",
+         "shadow"       => "if variable shadowing should be tolerated",
+         "strict"       => "require the \"use strict\"; pragma",
+         "sub"          => "if all forms of subscript notation are tolerated",
+         "supernew"     => "if `new function () { ... };` and `new Object;` should be tolerated",
+         "trailing"     => "if trailing whitespace rules apply",
+         "white"        => "if strict whitespace rules apply",
+         "wsh"          => "if the Windows Scripting Host environment globals should be predefined",
+      }.freeze
+
       attr_reader :file_list
 
       def initialize(files)
@@ -63,19 +157,7 @@ module JSLintV8
       end
 
       def jslint_options
-         {
-            "bitwise" => true,
-            "eqeqeq" => true,
-            "immed" => true,
-            "newcap" => true,
-            "nomen" => true,
-            "onevar" => true,
-            "plusplus" => true,
-            "regexp" => true,
-            "rhino" => true,
-            "undef" => true,
-            "white" => true
-         }
+         @jslint_options ||= DefaultOptions.dup
       end
 
    end

data/lib/jslint-v8/version.rb

@@ -2,8 +2,8 @@
 module JSLintV8
   module Version
      MAJOR = 1
-     MINOR = 0
-     PATCH = 1
+     MINOR = 1
+     PATCH = 0
      BUILD = nil
     
      STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.')

data/test/test_cli.rb

@@ -9,10 +9,35 @@ class TestCli < Test::Unit::TestCase
   end
 
   def test_empty_args
-    result = `#{Executable}`
+    # capture standard error by redirecting it to standard out
+    result = `#{Executable} 2>&1`
 
-    assert_equal "usage: jslint-v8 FILES\n", result
-    assert_equal false, $?.success?
+    assert_match /^Usage/, result
+    assert_equal 255, $?.exitstatus
+  end
+
+  def test_version_output
+    # capture standard error by redirecting it to standard out
+    result = `#{Executable} -v 2>&1`
+
+    assert_equal erb_fixture("version-output"), result
+    assert_equal 255, $?.exitstatus
+  end
+
+  def test_help_output
+    # capture standard error by redirecting it to standard out
+    result = `#{Executable} -h foo.js bar.js baz.js 2>&1`
+
+    assert_match /^Usage/, result
+    assert_equal 255, $?.exitstatus
+  end
+
+  def test_only_options_given
+    # capture standard error by redirecting it to standard out
+    result = `#{Executable} --browser --jquery 2>&1`
+
+    assert_match /^Usage/, result
+    assert_equal 255, $?.exitstatus
   end
 
   def test_valid

data/test/test_runner.rb

@@ -43,6 +43,17 @@ class TestRunner < Test::Unit::TestCase
     assert_equal @runner.runtime.object_id, first.object_id
   end
 
+  def test_overrideable_options
+    # have same values as default options
+    assert_equal @runner.jslint_options, JSLintV8::Runner::DefaultOptions
+
+    # but not be the options
+    assert_not_equal @runner.jslint_options.object_id, JSLintV8::Runner::DefaultOptions.object_id
+
+    # but be memoized
+    assert_equal @runner.jslint_options.object_id, @runner.jslint_options.object_id
+  end
+
   def test_jslint_function_proxy
     assert_not_nil @runner.jslint_function
   end

data/test/test_task.rb

@@ -52,23 +52,38 @@ class TestTask < Test::Unit::TestCase
     assert_equal STDOUT, task.output_stream
   end
 
+  def test_default_lint_options
+    task = JSLintV8::RakeTask.new
+
+    assert_equal({}, task.lint_options)
+  end
+
   def test_creation_block
     tempfile = Tempfile.new("foo")
 
     task = JSLintV8::RakeTask.new do |task|
       task.name = "foo"
+      
       task.description = "Points out the bad codezzzz"
+      
       task.include_pattern = "js/**/*.js"
       task.exclude_pattern = "js/**/*.txt"
+
       task.output_stream = tempfile
+
+      task.browser = true
+      task.strict = true
     end
 
     rake_task = Rake.application.lookup("foo")
 
+    expected_options = {"browser" => true, "strict" => true}
+
     assert_equal "foo", rake_task.name
     assert_equal "Points out the bad codezzzz", rake_task.comment
     assert_equal "js/**/*.js", task.include_pattern
     assert_equal "js/**/*.txt", task.exclude_pattern
+    assert_equal expected_options, task.lint_options
     assert_equal tempfile.object_id, task.output_stream.object_id
   end
 
@@ -83,6 +98,19 @@ class TestTask < Test::Unit::TestCase
     assert_equal expected_files, task.files_to_run
   end
 
+  def test_custom_lint_options
+    task = JSLintV8::RakeTask.new do |task|
+      task.browser = true
+      task.evil = true
+    end
+
+    runner = task.send(:runner)
+
+    assert_equal true,  runner.jslint_options["browser"]
+    assert_equal true,  runner.jslint_options["evil"]
+    assert_equal false, runner.jslint_options["rhino"]
+  end
+
   def test_valid_output
     result = String.new
 

metadata

@@ -1,131 +1,107 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: jslint-v8
-version: !ruby/object:Gem::Version 
-  hash: 21
+version: !ruby/object:Gem::Version
+  version: 1.1.0
   prerelease: 
-  segments: 
-  - 1
-  - 0
-  - 1
-  version: 1.0.1
 platform: ruby
-authors: 
+authors:
 - William Howard
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-08-31 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-02-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: therubyracer
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &71601450 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 51
-        segments: 
-        - 0
-        - 9
-        - 4
+      - !ruby/object:Gem::Version
         version: 0.9.4
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *71601450
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &71601100 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: test-unit
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *71601100
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: &71600860 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id003
-description: Ruby gem wrapper for a jslint cli.  Uses the The Ruby Racer library for performance reasons targeted for usage in CI environments and backed up with a full test suite.
+  prerelease: false
+  version_requirements: *71600860
+description: Ruby gem wrapper for a jslint cli.  Uses the The Ruby Racer library for
+  performance reasons targeted for usage in CI environments and backed up with a full
+  test suite.
 email: whoward.tke@gmail.com
-executables: 
+executables:
 - jslint-v8
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README.markdown
-files: 
+files:
 - lib/jslint-v8/formatter.rb
-- lib/jslint-v8/runner.rb
 - lib/jslint-v8/rake_task.rb
-- lib/jslint-v8/lint_error.rb
 - lib/jslint-v8/version.rb
+- lib/jslint-v8/runner.rb
+- lib/jslint-v8/option_parser.rb
+- lib/jslint-v8/lint_error.rb
 - lib/jslint-v8.rb
 - lib/jslint-v8/js/jslint.js
 - Gemfile
 - Gemfile.lock
 - bin/jslint-v8
 - README.markdown
-- test/test_task.rb
-- test/test_lint_error.rb
-- test/helper.rb
 - test/test_runner.rb
-- test/suite.rb
-- test/test_formatter.rb
 - test/test_cli.rb
+- test/helper.rb
+- test/test_formatter.rb
+- test/test_task.rb
+- test/suite.rb
+- test/test_lint_error.rb
 homepage: http://github.com/whoward/jslint-v8
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.6
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: JSLint CLI and rake tasks via therubyracer (JavaScript V8 gem)
-test_files: 
-- test/test_task.rb
-- test/test_lint_error.rb
-- test/helper.rb
+test_files:
 - test/test_runner.rb
-- test/suite.rb
-- test/test_formatter.rb
 - test/test_cli.rb
+- test/helper.rb
+- test/test_formatter.rb
+- test/test_task.rb
+- test/suite.rb
+- test/test_lint_error.rb