guard-sass-lint 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 24f41fb1829db2288ba8e50aebe76b1b67aba875
+  data.tar.gz: ce474b4bd7a2861259e68aa6cbe97041101f8ebb
+SHA512:
+  metadata.gz: dddea4b7fc6957fbdd7448aa68b415eefd5fc845d96a17b336073924fce3281559d8639444b21e519bfa3f1c41d8a2c0778e2e8cb8d3e7d74436dd5ca51e64b5
+  data.tar.gz: c22528f74dfbb52172d66a30265e3efac8ca5ef87afb61295f9285c84b2d2479fdcdd04277611fea27fa03952aa6f2ec4445927e35546d75f86b925234099c4e

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/node_modules/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.14.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in guard-sass-lint.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Daniel Hanson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,41 @@
+# Guard::Sass::Lint
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/guard/sass/lint`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'guard-sass-lint'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install guard-sass-lint
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/guard-sass-lint.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "guard/sass/lint"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/guard-sass-lint.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'guard/sass/lint/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'guard-sass-lint'
+  spec.version       = Guard::Sass::Lint::VERSION
+  spec.authors       = ['Daniel Hanson']
+  spec.email         = ['hansondr@gmail.com']
+
+  spec.summary       = 'Guard sass-lint wrapper'
+  spec.description   = 'Automatically run sass-lint on your SASS'
+  spec.homepage      = 'https://github.com/hansondr/guard-sass-lint'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'guard-compat', '~> 1.2'
+  spec.add_dependency 'colorize', '~> 0.8'
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/lib/guard-sass-lint.rb

@@ -0,0 +1,5 @@
+require 'guard/sass/lint/version'
+require 'guard/sass/lint/linter'
+require 'guard/sass/lint/runner'
+require 'guard/sass/lint/all_runner'
+require 'guard/sass/lint/railtie' if defined?(Rails)

data/lib/guard/sass-lint.rb

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

data/lib/guard/sass/lint/all_runner.rb

@@ -0,0 +1,57 @@
+require 'colorize'
+
+module Guard
+  module Sass
+    module Lint
+      class AllRunner
+        def initialize(linter)
+          @linter = linter
+          @results = {}
+        end
+
+        def run
+          $stdout.sync = true
+
+          sass_files.each do |file|
+            calculate_result @linter.lint(file)
+            print '.'
+          end
+
+          display_final_result
+        end
+
+        def lint(filename)
+          calculate_result
+        end
+
+        private
+
+        def sass_files
+          @sass_files ||= Dir.glob('*/**/*.scss').sort
+        end
+
+        def calculate_result(result_data)
+          if !result_data.nil? && !result_data.empty?
+            data = result_data.first
+            file_path = data['filePath']
+            warnings = data['warningCount'].to_i
+            errors = data['errorCount'].to_i
+            @results[file_path] = { warn: warnings, error: errors }
+          end
+        end
+
+        def display_final_result
+          puts "\n"
+          puts ' Error Warn' if @results.present?
+          @results.each do |file, counts|
+            errors = sprintf('%4d', counts[:error]).red
+            warns = sprintf('%4d', counts[:warn]).yellow
+            puts "  #{errors} #{warns} - #{file}"
+          end
+
+          @results = {}
+        end
+      end
+    end
+  end
+end

data/lib/guard/sass/lint/linter.rb

@@ -0,0 +1,79 @@
+module Guard
+  module Sass
+    module Lint
+      class Linter
+        OUTPUT_FILE = 'tmp/sass_lint_results.json'.freeze
+
+        def initialize(config_location = nil)
+          @config_location = config_location
+          @results = {}
+        end
+
+        def lint(file)
+          clear_results
+          system lint_command(file)
+          result_data
+        end
+
+        private
+
+        def root
+          File.expand_path('../../../../..', __FILE__)
+        end
+
+        def sass_lint_dir
+          @sass_lint_dir ||= File.join(root, 'node_modules', 'sass-lint')
+        end
+
+        def lint_command(filename)
+          [linter, config, format, output, additional, filename, quiet].join(' ')
+        end
+
+        def linter
+          File.join(sass_lint_dir, 'bin', 'sass-lint.js')
+        end
+
+        def config
+          "-c #{config_file}"
+        end
+
+        def config_file
+          @config_location || default_config
+        end
+
+        def default_config
+          File.join(sass_lint_dir, 'docs', 'sass-lint.yml')
+        end
+
+        def format
+          '-f json'
+        end
+
+        def additional
+          '--no-exit --verbose'
+        end
+
+        def output
+          "-o #{OUTPUT_FILE}"
+        end
+
+        def quiet
+          ' >/dev/null 2>&1'
+        end
+
+        def result_data
+          @result_data ||= result_json_file || []
+        end
+
+        def clear_results
+          File.delete(OUTPUT_FILE) if File.exists?(OUTPUT_FILE)
+          @result_data = nil
+        end
+
+        def result_json_file
+          JSON.parse(File.new(OUTPUT_FILE).read) if File.exists?(OUTPUT_FILE)
+        end
+      end
+    end
+  end
+end

data/lib/guard/sass/lint/railtie.rb

@@ -0,0 +1,11 @@
+module Guard
+  module Sass
+    module Lint
+      class Railtie < Rails::Railtie
+        rake_tasks do
+          load 'tasks/sasslint.rake'
+        end
+      end
+    end
+  end
+end

data/lib/guard/sass/lint/runner.rb

@@ -0,0 +1,49 @@
+require 'colorize'
+
+module Guard
+  module Sass
+    module Lint
+      class Runner
+        def initialize(file, linter)
+          @file = file
+          @linter = linter
+        end
+
+        def run
+          display_result @linter.lint(@file)
+        end
+
+        def display_result(result_data)
+          result_data.each do |data|
+            if data['warningCount'] > 0 || data['errorCount'] > 0
+              puts "⌕ #{data['filePath']}"
+              data['messages'].each { |msg| puts format_message(msg) }
+            end
+          end
+
+          puts clean_message if result_data.empty?
+        end
+
+        private
+
+        def format_message(data)
+          location = [sprintf("%4d", data['line']), sprintf("%-4d", data['column'])].join(':')
+          rule = sprintf("%-25s", "(#{data['ruleId']})")
+          message = "  #{rule} #{location} - #{data['message']}"
+          case data['severity']
+          when 1
+            message.green
+          when 2
+            message.yellow
+          else
+            message
+          end
+        end
+
+        def clean_message
+          ['✓'.green, @file].join(' ')
+        end
+      end
+    end
+  end
+end

data/lib/guard/sass/lint/version.rb

@@ -0,0 +1,7 @@
+module Guard
+  module Sass
+    module Lint
+      VERSION = "0.1.0"
+    end
+  end
+end

data/lib/guard/sasslint.rb

@@ -0,0 +1,69 @@
+require 'guard/compat/plugin'
+require 'rake'
+require 'mkmf'
+
+module Guard
+  class Sasslint < Plugin
+    RAKETASK = 'sasslint:run'.freeze
+
+    def initialize(options = {})
+      enforce_js_dependencies!
+
+      @config = options.fetch(:config, nil)
+      @run_at_start = options.fetch(:run_at_start, false)
+      load 'Rakefile'
+
+      super options
+    end
+
+    def start
+      UI.info 'sasslint starting...'
+      run_all if @run_at_start
+    end
+
+    def run_all
+      UI.info 'sasslint ⇒ all sass'
+      lint
+    end
+
+    def run_on_changes(paths)
+      paths.each { |path| lint path }
+    end
+
+    private
+
+    def lint(file = nil)
+      ::Rake::Task[RAKETASK].reenable
+      ::Rake::Task[RAKETASK].invoke(file, @config)
+    end
+
+    def enforce_js_dependencies!
+      if !find_dependency 'yarnpkg'
+        UI.error 'Unable to locate the yarnpkg library'
+        UI.error 'To install yarn visit: https://yarnpkg.com/en/docs/install'
+        exit 1
+      end
+
+      if !find_dependency 'node'
+        UI.error 'Unable to locate the node binary'
+        UI.error 'Depending on OS and install method used you may need to symlink node to nodejs'
+        exit 1
+      end
+    end
+
+    # this hacky workaround prevents mkmf from polluting the project with
+    # mkmf.log files
+    def find_dependency(executable)
+      old_mkmf_log = MakeMakefile::Logging.instance_variable_get(:@logfile)
+      set_mkmf_log(nil)
+      path_to_cmd = find_executable0(executable)
+      set_mkmf_log(old_mkmf_log)
+
+      path_to_cmd
+    end
+
+    def set_mkmf_log(logfile = File::NULL)
+      MakeMakefile::Logging.instance_variable_set(:@logfile, logfile)
+    end
+  end
+end