execjslint 0.9.0

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012, Mint Digital
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,87 @@
+ExecJSLint
+==========
+
+ExecJSLint is a thin Ruby wrapper that uses ExecJS to execute [Douglas Crockford's JSLint][jslint].
+
+Usage
+-----
+
+```ruby
+js = File.open('path/to/my.js')
+results = ExecJSLint.run(js)
+if result.problems.any?
+  puts "You suck at JavaScript!"
+  puts results.problems
+else
+  puts "GREAT SUCCESS!"
+end
+```
+
+If you're looking to use this in a Rails app, take a look at
+[examples/jslint.rake][rake].
+
+Requirements
+------------
+
+You'll need one of the [supported ExecJS runtimes][execjs-runtimes]. OS X
+comes with JavaScriptCore by default, so you likely don't need to install
+anything.
+
+JSLint Options
+--------------
+
+Right now, `ExecJSLint` does not support setting global JSLint options, so you'll
+have to include them in a `/*jslint */` comment at the top of each file.
+`jslint.js` will automatically parse and apply options specified like this. A
+full list of options is available on [jslint.com][jslint-options].
+
+Using an Alternate jslint.js
+----------------------------
+
+ExecJSLint depends on the `jslint-source` gem, which is a ruby packaging
+of the official [jslint.js][jslintjs]. By default, ExecJSLint depends on the
+latest version of the `jslint-source` gem. As there are no official releases
+of JSLint, `jslint-source` is versioned according to [the date at the top of
+jslint.js][jslint-date] (eg, `2012.01.23`). rubygems.org has a [full list of
+`jslint-source` gem versions][source-versions].
+
+To override this, you can specify an explicit dependency on `jslint-source`,
+for example, using bundler:
+
+```
+gem 'execjslint'
+gem 'jslint-source', '2011.01.23'
+```
+
+You can also explicitly specify a local copy of `jslint.js` to use by setting
+the `JSLINT_PATH` env variable.
+
+```
+$ JSLINT_PATH=../lib/jslint.js rake jslint
+```
+
+Similar Projects
+----------------
+
+ExecJSLint is meant to be as simple as possible. If it doesn't fit your needs,
+you may want to try one of these projects:
+
+* [geraud/jslint][geraud] - rubygem that provides a standalone `jslint` script
+  that can be run from the command line. Supports Rhino and Node JavaScript
+  engines.
+
+* [psionides/jslint\_on\_rails][on-rails] - rubygem meant for integrating JSLint into a
+  Rails application. Uses Rhino JavaScript engine.
+
+* [rondevera/jslintmate][jslintmate] - TextMate plugin for running JSLint. Uses JSC.
+
+[jslint]: <http://jslint.com/>
+[rake]: <https://github.com/mintdigital/jslint/blob/master/examples/jslint.rake>
+[execjs-runtimes]: <https://github.com/sstephenson/execjs/blob/master/README.md>
+[jslintjs]: <https://github.com/douglascrockford/JSLint/blob/master/jslint.js>
+[jslint-date]: <https://github.com/douglascrockford/JSLint/blob/master/jslint.js#L2>
+[jslint-options]: <http://www.jslint.com/lint.html#options>
+[source-versions]: <http://rubygems.org/gems/jslint-source/versions>
+[geraud]: <https://github.com/geraud/jslint>
+[on-rails]: <https://github.com/psionides/jslint_on_rails>
+[jslintmate]: <https://github.com/rondevera/jslintmate>

data/lib/execjslint.rb

@@ -0,0 +1 @@
+require 'jslint'

data/lib/jslint.rb

@@ -0,0 +1,50 @@
+require 'execjs'
+require 'jslint/source'
+
+module JSLint
+  # Internal: The ExecJS Context in which to run JSLINT().
+  #
+  # Provides a small helper function JSLINTR to return both the JSLINT()
+  # return value and the JSLINT.errors object.
+  def self.context
+    ExecJS.compile(
+      JSLint::Source.contents + "\n" +
+      "function JSLINTR(source) { return [JSLINT(source),JSLINT.errors]; };"
+    )
+  end
+
+  # Public: Run JSLint over some JavaScript source.
+  #
+  # source - some String-like or IO-like JavaScript source.
+  def self.run(source)
+    source = source.respond_to?(:read) ? source.read : source
+    Result.new(*context.call("JSLINTR", source))
+  end
+
+  class Result
+    def initialize(valid, errors)
+      @valid = valid
+      @errors = errors
+    end
+
+    # Public: Did the JavaScript source pass JSLint without errors?
+    #
+    # This is the return value of the JSLINT() function.
+    #
+    # Returns true iff JSLint found no errors.
+    def valid?
+      @valid
+    end
+
+    # Public: A nicely formatted list of errors with their line number.
+    #
+    # Returns an Array of Strings.
+    def error_messages
+      # @errors will have a 'nil' last element if JSLINT it hit a catastrophic
+      # error before it finished looking at the whole file, so we 'compact'.
+      @errors.compact.map {|e|
+        "#{e['line']}:#{e['character']}: #{e['reason']}"
+      }
+    end
+  end
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: execjslint
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+  prerelease: 
+platform: ruby
+authors:
+- Dean Strelau
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jslint-source
+  requirement: &70336901655220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70336901655220
+- !ruby/object:Gem::Dependency
+  name: execjs
+  requirement: &70336901654700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70336901654700
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70336901654180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70336901654180
+description: ! '    A bridge to run JSLint from Ruby via ExecJS.
+
+'
+email: dean@mintdigital.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/execjslint.rb
+- lib/jslint.rb
+- LICENSE
+- README.md
+homepage: http://github.com/mintdigital/execjslint
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: ExecJS JSLint Bridge
+test_files: []