roger_jshint 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 38422ff3dff1e9446962b856fdc19e75fd5d1635
-  data.tar.gz: c52a4f983c6222f05bff8b680b9dd4c2bcfffab5
+  metadata.gz: 173aefd6d7edd876af67a041bbe007a505f26519
+  data.tar.gz: 87c805c257ed31095a847af6596c9ad6d1a78791
 SHA512:
-  metadata.gz: cb88a897643f3a03eaf60ecfec3367342047f9f512ad540f28ee0c2956c0cf721992529181b0b79f7393e17717fd6d765063d1243a8cd2c94ace0f47449d2fff
-  data.tar.gz: 55e95cd5352a15724e1094e286ee67e4bcdd01bb50a5a46a3ea2929ae424dcaf4e33f93d67da09e54f6b67da570e596cf208d54a69419d52c5fd3ae63e2efcb9
+  metadata.gz: 7505cad99b8b2c88085c7d3bb843af5dde840e87d80eea935409050facbf223bd672b67d183494f0ce9ced312b2b9d699bf83001d7b082174ff81ce69b71620f
+  data.tar.gz: 365153eb8ab08abca4e8d5d61295c4854139b7db992bac137e4f32d368abb1d18e522aaf71988818684a9e6bbcf6f58809fa8237293071ea9134e457acecd668

data/README.md

@@ -1,4 +1,25 @@
 roger_jshint
 ============
 
-Lint JavaScript files within Roger
+Lint JavaScript files from within Roger. This plugin uses [jshint](https://github.com/jshint/jshint). If present, .jshintrc in your project will be used. If not, jshint will walk the directory tree upwards until a .jshintrc file is found. As a last resort, [jshint's default configuration](https://raw.githubusercontent.com/jshint/jshint/master/examples/.jshintrc) is used.
+
+## Installation
+* Install jshint using npm: ```npm install jshint -g```
+
+* Add ```gem 'roger_jshint'``` to your Gemfile
+
+* Add this to your Mockupfile:
+```
+mockup.test do |t|
+  t.use :jshint
+end
+```
+
+* (Optional) put a .jshintrc in your project's root directory.
+
+## Running
+Execute ```roger test jshint```.
+
+## License
+
+This project is released under the [MIT license](LICENSE).

data/lib/roger_jshint.rb

@@ -0,0 +1,3 @@
+module RogerJsHint; end
+
+require File.dirname(__FILE__) + '/roger_jshint/lint'

data/lib/roger_jshint/jsonreporter.js

@@ -0,0 +1,18 @@
+"use strict";
+
+module.exports = {
+  reporter: function (res) {
+    var errors = [];
+
+    res.forEach(function (r) {
+      var file = r.file;
+      var err = r.error;
+
+      errors.push([file, err.line, err.character, err.reason]);
+    });
+
+    if (errors) {
+      process.stdout.write(JSON.stringify(errors) + "\n");
+    }
+  }
+};

data/lib/roger_jshint/lint.rb

@@ -0,0 +1,65 @@
+require 'json'
+require 'roger/test'
+
+module RogerJsHint
+  # JS linter plugin for Roger
+  class Lint
+    JSHINT = 'jshint'
+    JSHINT_COMMAND = "#{JSHINT} --reporter=" +
+                     File.expand_path('jsonreporter.js', File.dirname(__FILE__)) + ' '
+
+    # @param [Hash] options The options
+    # @option options [Array] :match Files to match
+    # @option options [Array[Regexp]] :skip An array of file regular expressions to specifiy which files to skip.
+    def initialize(options = {})
+      @options = {
+        :match => ['html/**/*.js'],
+        :skip => []
+      }
+      @options.update(options) if options
+    end
+
+    def detect_jshint
+      `#{JSHINT} -v`
+      rescue Errno::ENOENT
+        raise 'Could not find jshint. Install jshint using npm.'
+    end
+
+    def report(test, file_path, lints)
+      success = true
+      if lints.empty?
+        test.log(self, "No erors in #{file_path}")
+      else
+        lints.each do |lint|
+          test.log(self,
+                   "#{lint[0]}:#{lint[1]} " \
+                   "#{lint[2]}: #{lint[3]}")
+        end
+        success = false
+      end
+      success
+    end
+
+    # @param [Hash] options The options
+    # @option options [Array] :match Files to match
+    # @option options [Array[Regexp]] :skip An array of file regular expressions to specifiy which files to skip.
+    def call(test, options)
+      options = {}.update(@options).update(options)
+
+      detect_jshint
+      test.log(self, 'JS-linting files')
+
+      test.get_files(options[:match], options[:skip]).each do |file_path|
+        output = `#{JSHINT_COMMAND} #{file_path}`
+        if output.start_with? 'ERROR'
+          fail "Could not load file #{file_path}"
+        else
+          lint = JSON.parse output
+          report(test, file_path, lint)
+        end
+      end
+    end
+  end
+end
+
+Roger::Test.register :jshint, RogerJsHint::Lint

data/roger_jshint.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.authors = ['Hans Krutzer']
+  s.email = ['info@digitpaint.nl', 'hans@digitpaint.nl']
+  s.name = 'roger_jshint'
+  s.version = '0.0.2'
+  s.homepage = 'https://github.com/hkrutzer/roger_scsslinter'
+
+  s.summary = 'Lint JavaScript files within Roger'
+  s.description = <<-EOF
+    Lint JavaScript files from within Roger, using jshint.
+    Will use .jshintrc.
+  EOF
+  s.licenses = ['MIT']
+
+  s.date = Time.now.strftime('%Y-%m-%d')
+
+  s.files = `git ls-files`.split("\n")
+  s.require_paths = ['lib']
+
+  s.add_dependency 'roger', '~> 0.13', '>= 0.13.0'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: roger_jshint
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Hans Krutzer
@@ -14,22 +14,22 @@ dependencies:
   name: roger
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0.12'
-    - - ">="
+        version: '0.13'
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 0.12.5
+        version: 0.13.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0.12'
-    - - ">="
+        version: '0.13'
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 0.12.5
+        version: 0.13.0
 description: |2
       Lint JavaScript files from within Roger, using jshint.
       Will use .jshintrc.
@@ -40,9 +40,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
+- .gitignore
 - LICENSE
 - README.md
+- lib/roger_jshint.rb
+- lib/roger_jshint/jsonreporter.js
+- lib/roger_jshint/lint.rb
+- roger_jshint.gemspec
 homepage: https://github.com/hkrutzer/roger_scsslinter
 licenses:
 - MIT
@@ -53,17 +57,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.4
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: Lint JavaScript files within Roger