middleman-scss-lint 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7ced6cb64fd1fc67f72b822d36bd843cfb3caf17
+  data.tar.gz: 53a3decae36a0972724579040e018802487fb58e
+SHA512:
+  metadata.gz: a292db3d03697c40393a2dbac678a449eeea366ef5299d6fdea7551cb25f8cf52fe50cf46c42222786bf659ee2d23ef2c075a8ed6fbf10a3937c60b7875c6960
+  data.tar.gz: 96701362cd916a9592ffd05a6523439cc7e80a7b4c0370517b4eed3306f44937ba8abba49900e5d2a6cf8b9cdd6f16aa8d76713f79730be534e2cb1e018c0106

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.DS_Store
+.sass-cache
+build

data/.travis.yml

@@ -0,0 +1,19 @@
+language: ruby
+bundler_args: --without development
+rvm:
+  - ruby-head
+  - 2.2
+  - 2.1
+  - 2.0
+  - 1.9.3
+os:
+  - linux
+  - osx
+cache: bundler
+sudo: false
+matrix:
+  fast_finish: true
+  allow_failures:
+    - rvm: ruby-head
+env: TEST=true
+script: bundle exec rake test

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'middleman-core', github: 'middleman/middleman', branch: 'master'
+gem 'middleman-cli', github: 'middleman/middleman', branch: 'master'
+
+gem 'cucumber',  '~> 2.0'
+gem 'aruba',     '~> 0.6'
+
+gem 'bundler',   '>= 1.6'
+gem 'rake',      '>= 10.3'

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+require 'cucumber/rake/task'
+
+task :default => :test
+
+Cucumber::Rake::Task.new(:test, 'Run features that should pass') do |task|
+  task.cucumber_opts = '--color --tags ~@wip --strict --format pretty'
+end

data/features/lint.feature

@@ -0,0 +1 @@
+Feature: Scss Lint

data/features/support/env.rb

@@ -0,0 +1,7 @@
+PROJECT_ROOT_PATH = File.dirname(File.dirname(File.dirname(__FILE__)))
+ENV['TEST'] = 'true'
+ENV['CONTRACTS'] = 'true'
+
+# require 'middleman'
+require 'middleman-core/step_definitions'
+require File.join(PROJECT_ROOT_PATH, 'lib', 'middleman-scss-lint')

data/fixtures/lint-app/config.rb

@@ -0,0 +1 @@
+activate :scss_lint#, fail_build: true, config: 'empty-config.yaml'

data/fixtures/lint-app/empty-config.yaml

@@ -0,0 +1,10 @@
+---
+linters:
+  ColorKeyword:
+    enabled: false
+  ColorVariable:
+    enabled: false
+  FinalNewline:
+    enabled: false
+  ImportantRule:
+    enabled: false

data/fixtures/lint-app/source/stylesheets/site.css.scss

@@ -0,0 +1,3 @@
+body {
+  background: black !important;
+}

data/lib/middleman-scss-lint.rb

@@ -0,0 +1,7 @@
+require 'middleman-core'
+require_relative 'middleman-scss-lint/version'
+
+::Middleman::Extensions.register(:scss_lint) do
+  require_relative 'middleman-scss-lint/extension'
+  ::Middleman::ScssLint::Extension
+end

data/lib/middleman-scss-lint/extension.rb

@@ -0,0 +1,102 @@
+module Middleman
+  module ScssLint
+    class Extension < ::Middleman::Extension
+      option :config, nil, 'Path to config file'
+      option :fail_build, false, 'If the build should fail if lint does not pass.'
+
+      def ready
+        require 'rainbow'
+        require 'rainbow/ext/string'
+
+        result = run_once
+
+        if app.build?
+          if options[:fail_build] && !result
+            logger.error "== SCSSLint failed"
+            exit(1)
+          end
+        else
+          logger.info "== SCSSLint succeeded" if result
+          watch_and_run
+        end
+      end
+
+      def run_once
+        paths = app.sitemap.resources
+            .select { |r| File.extname(r.source_file) == '.scss' }
+            .map { |r| r.source_file }
+
+        run_linter(paths)
+      end
+
+      def watch_and_run
+        app.files.on_change :source do |changed|
+          changed_scss = changed.select do |f|
+            f[:full_path].extname == '.scss'
+          end
+
+          if changed_scss.length > 0
+            result = run_linter(changed_scss.map { |r| r[:full_path].to_s })
+            logger.info "== SCSSLint succeeded" if result
+          end
+        end
+      end
+
+      def run_linter(files_to_lint)
+        logger.info "== Linting SCSS"
+
+        cli_args = ['--format', 'JSON']
+        cli_args = cli_args + ['--config', options[:config]] if options[:config]
+        cli_args = cli_args + files_to_lint
+
+        begin
+          output = ""
+
+          ::IO.popen("bundle exec scss-lint #{cli_args.join(' ')}", 'r') do |pipe|
+            while buf = pipe.gets
+              output << buf
+            end
+          end
+
+          error_count = 0
+
+          result = ::JSON.parse(output)
+
+          result.each do |file_path, lints|
+            relative_path = file_path.sub(app.root, '')
+
+            lints.each do |descr|
+              msg = "#{location(relative_path, descr)} #{type(descr)} #{message(descr)}"
+
+              error_count += 1
+
+              if descr["severity"] == "warning"
+                logger.warn msg
+              else
+                logger.error msg
+              end 
+            end
+          end
+
+          error_count <= 0
+        rescue ::Errno::ENOENT => e
+          logger.error "== SCSSLint: Command failed with message: #{e.message}"
+          exit(1)
+        end
+      end
+
+      def location(path, descr)
+        "#{path.color(:cyan)}:#{descr["line"].to_s.color(:magenta)}"
+      end
+
+      def type(descr)
+        descr["severity"] == "error" ? '[E]'.color(:red) : '[W]'.color(:yellow)
+      end
+
+      def message(descr)
+        linter_name = "#{descr["linter"]}: ".color(:green)
+        "#{linter_name}#{descr["reason"]}"
+      end
+    end
+  end
+end

data/lib/middleman-scss-lint/version.rb

@@ -0,0 +1,5 @@
+module Middleman
+  module ScssLint
+    VERSION = '0.1.0'.freeze
+  end
+end

data/middleman-scss-lint.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'middleman-scss-lint/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'middleman-scss-lint'
+  spec.version       = Middleman::ScssLint::VERSION
+  spec.authors       = ['Thomas Reynolds']
+  spec.email         = ['me@tdreyno.com']
+  spec.summary       = 'ScssLint integration with Middleman'
+  spec.homepage      = 'https://github.com/middleman/middleman-scss-lint'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.test_files    = `git ls-files -- {features,fixtures}/*`.split($/)
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'middleman-core', '>= 4.0.0'
+  spec.add_dependency 'scss_lint', '~> 0.40'
+  spec.add_dependency 'rainbow'
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: middleman-scss-lint
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Thomas Reynolds
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: middleman-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: scss_lint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.40'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.40'
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- me@tdreyno.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- features/lint.feature
+- features/support/env.rb
+- fixtures/lint-app/config.rb
+- fixtures/lint-app/empty-config.yaml
+- fixtures/lint-app/source/stylesheets/site.css.scss
+- lib/middleman-scss-lint.rb
+- lib/middleman-scss-lint/extension.rb
+- lib/middleman-scss-lint/version.rb
+- middleman-scss-lint.gemspec
+homepage: https://github.com/middleman/middleman-scss-lint
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.8
+signing_key: 
+specification_version: 4
+summary: ScssLint integration with Middleman
+test_files:
+- features/lint.feature
+- features/support/env.rb
+- fixtures/lint-app/config.rb
+- fixtures/lint-app/empty-config.yaml
+- fixtures/lint-app/source/stylesheets/site.css.scss