danger-stylelint 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ded5a9803e7b6b96a18500ba6e6a992cc88b4013ced414a42d6a4190ac1a360d
+  data.tar.gz: 21a218d102dbb9d1fd1c4b0ba0100745c5cc90db29e5bc6e04658699e8e42bda
+SHA512:
+  metadata.gz: 0d55c4ae5cab67830437e3356ae87af82348a4538be236401092d53b2cd8301c8c51f5c2b20dfc38a4db4eae33959b5ed28902e7855b672b3cb3cd69729d7687
+  data.tar.gz: 127f31323be63997c23c15ebc08cbea399eec302c61442606afe4949617b26960b51bb2c4e96931eb95c6ba550da4cf4cd7a0171649f3bde1c73331c5a7a5cf6

data/.gitignore

@@ -0,0 +1,4 @@
+.DS_Store
+pkg
+.idea/
+.yardoc

data/.rubocop.yml

@@ -0,0 +1,148 @@
+# Defaults can be found here: https://github.com/bbatsov/rubocop/blob/master/config/default.yml
+
+# If you don't like these settings, just delete this file :)
+
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+  Enabled: true
+
+# kind_of? is a good way to check a type
+Style/ClassCheck:
+  EnforcedStyle: kind_of?
+
+# specs sometimes have useless assignments, which is fine
+Lint/UselessAssignment:
+  Exclude:
+    - '**/spec/**/*'
+
+# We could potentially enable the 2 below:
+Layout/FirstHashElementIndentation:
+  Enabled: false
+
+Layout/HashAlignment:
+  Enabled: false
+
+# HoundCI doesn't like this rule
+Layout/DotPosition:
+  Enabled: false
+
+# We allow !! as it's an easy way to convert ot boolean
+Style/DoubleNegation:
+  Enabled: false
+
+# Cop supports --auto-correct.
+Lint/UnusedBlockArgument:
+  Enabled: false
+
+# We want to allow class Fastlane::Class
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Metrics/AbcSize:
+  Max: 60
+
+# The %w might be confusing for new users
+Style/WordArray:
+  MinSize: 19
+
+# raise and fail are both okay
+Style/SignalException:
+  Enabled: false
+
+# Better too much 'return' than one missing
+Style/RedundantReturn:
+  Enabled: false
+
+# Having if in the same line might not always be good
+Style/IfUnlessModifier:
+  Enabled: false
+
+# and and or is okay
+Style/AndOr:
+  Enabled: false
+
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 350
+
+Metrics/CyclomaticComplexity:
+  Max: 17
+
+# Configuration parameters: AllowURI, URISchemes.
+Layout/LineLength:
+  Max: 370
+
+# Configuration parameters: CountKeywordArgs.
+Metrics/ParameterLists:
+  Max: 10
+
+Metrics/PerceivedComplexity:
+  Max: 18
+
+# Sometimes it's easier to read without guards
+Style/GuardClause:
+  Enabled: false
+
+# something = if something_else
+# that's confusing
+Style/ConditionalAssignment:
+  Enabled: false
+
+# Better to have too much self than missing a self
+Style/RedundantSelf:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 60
+
+# We're not there yet
+Style/Documentation:
+  Enabled: false
+
+# Adds complexity
+Style/IfInsideElse:
+  Enabled: false
+
+# danger specific
+
+Style/BlockComments:
+  Enabled: false
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+# FIXME: 25
+Metrics/BlockLength:
+  Max: 345
+  Exclude:
+    - "**/*_spec.rb"
+
+Style/MixinGrouping:
+  Enabled: false
+
+Naming/FileName:
+  Enabled: false
+
+Layout/HeredocIndentation:
+  Enabled: false
+
+Style/SpecialGlobalVars:
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    "%":  ()
+    "%i": ()
+    "%q": ()
+    "%Q": ()
+    "%r": "{}"
+    "%s": ()
+    "%w": ()
+    "%W": ()
+    "%x": ()
+
+Security/YAMLLoad:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+cache:
+  directories:
+    - bundle
+
+rvm:
+  - 2.6
+  - 2.7
+
+script:
+    - bundle exec rake spec

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in danger-stylelint.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,170 @@
+PATH
+  remote: .
+  specs:
+    danger-stylelint (0.0.1)
+      danger-plugin-api (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.2)
+    claide (1.1.0)
+    claide-plugins (0.9.2)
+      cork
+      nap
+      open4 (~> 1.3)
+    coderay (1.1.3)
+    colored2 (3.1.2)
+    cork (0.3.0)
+      colored2 (~> 3.1)
+    danger (8.6.1)
+      claide (~> 1.0)
+      claide-plugins (>= 0.9.2)
+      colored2 (~> 3.1)
+      cork (~> 0.1)
+      faraday (>= 0.9.0, < 2.0)
+      faraday-http-cache (~> 2.0)
+      git (~> 1.7)
+      kramdown (~> 2.3)
+      kramdown-parser-gfm (~> 1.0)
+      no_proxy_fix
+      octokit (~> 4.7)
+      terminal-table (>= 1, < 4)
+    danger-plugin-api (1.0.0)
+      danger (> 2.0)
+    diff-lcs (1.5.0)
+    faraday (1.10.0)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0)
+      faraday-multipart (~> 1.0)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.0)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      faraday-retry (~> 1.0)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-http-cache (2.2.0)
+      faraday (>= 0.8)
+    faraday-httpclient (1.0.1)
+    faraday-multipart (1.0.3)
+      multipart-post (>= 1.2, < 3)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    faraday-retry (1.0.3)
+    ffi (1.15.5)
+    formatador (1.1.0)
+    git (1.11.0)
+      rchardet (~> 1.8)
+    guard (2.18.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.13.0)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    kramdown (2.4.0)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    listen (3.0.7)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9.7)
+    lumberjack (1.2.8)
+    method_source (1.0.0)
+    multipart-post (2.1.1)
+    nap (1.1.0)
+    nenv (0.3.0)
+    no_proxy_fix (0.1.2)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    octokit (4.22.0)
+      faraday (>= 0.9)
+      sawyer (~> 0.8.0, >= 0.5.3)
+    open4 (1.3.4)
+    parallel (1.22.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (4.0.7)
+    rainbow (3.1.1)
+    rake (10.5.0)
+    rb-fsevent (0.11.1)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rchardet (1.8.0)
+    regexp_parser (2.4.0)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.29.1)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.17.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.18.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    sawyer (0.8.2)
+      addressable (>= 2.3.5)
+      faraday (> 0.8, < 2.0)
+    shellany (0.0.1)
+    terminal-table (3.0.2)
+      unicode-display_width (>= 1.1.1, < 3)
+    thor (1.2.1)
+    unicode-display_width (2.1.0)
+    webrick (1.7.0)
+    yard (0.9.27)
+      webrick (~> 1.7.0)
+
+PLATFORMS
+  x86_64-darwin-18
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  danger-stylelint!
+  guard (~> 2.14)
+  guard-rspec (~> 4.7)
+  listen (= 3.0.7)
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.4)
+  rubocop
+  yard
+
+BUNDLED WITH
+   2.3.8

data/Guardfile

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# A guardfile for making Danger Plugins
+# For more info see https://github.com/guard/guard#readme
+
+# To run, use `bundle exec guard`.
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE.txt

@@ -0,0 +1,23 @@
+Copyright (c) 2022 Nimble
+
+MIT License
+
+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,73 @@
+<p align="center">
+  <img alt="Nimble logo" src="https://assets.nimblehq.co/logo/light/logo-light-text-320.png" />
+</p>
+
+<h2 align="center">Danger Stylelint</h3>
+<p align="center">A Plugin for Ruby or Ruby on Rails projects to warn CSS issues. The checks are performed using <a href="https://stylelint.io/">Stylelint<a></p>
+
+-------
+
+## Prerequisites
+
+To use this plugin, your project must have successfully setup [Danger](https://danger.systems/guides/getting_started.html)
+
+You would also need to install `stylelint` into your project
+
+    $ npm install -D stylelint
+
+## Installation
+
+Simply run the following in your project.
+
+    $ gem install danger-stylelint
+
+
+## Usage
+
+To use the extension, add the following to your Dangerfile
+
+```ruby
+stylelint.lint
+```
+
+### Options
+
+| Options               	| Required 	| Default Value                 	| Description                                	|
+|-----------------------	|----------	|-------------------------------	|--------------------------------------------	|
+| stylelint.config_file 	| No       	| nil                           	| Path to a Stylelint configuration file.    	|
+| stylelint.changes_only   	| No       	| false                         	| Comment only on changed lines              	|
+| stylelint.bin_path    	| No       	| ./node_modules/.bin/stylelint 	| Path to the node installation of Stylelint 	|
+
+To use an option, add it before running stylelint
+
+```ruby
+stylelint.config_file = "./.stylelintrc"
+stylelint.lint
+```
+
+## Development
+
+1. Clone this repo
+2. Run `bundle install` to setup dependencies.
+3. Run `bundle exec rake spec` to run the tests.
+4. Use `bundle exec guard` to automatically have tests run as you make changes.
+5. Make your changes.
+
+## License
+
+This project is Copyright (c) 2014-2022 Nimble. It is free software,
+and may be redistributed under the terms specified in the [LICENSE] file.
+
+[LICENSE]: /LICENSE.txt
+
+## About
+
+![Nimble](https://assets.nimblehq.co/logo/dark/logo-dark-text-160.png)
+
+This project is maintained and funded by Nimble.
+
+We love open source and do our part in sharing our work with the community!
+See [our other projects][community] or [hire our team][hire] to help build your product.
+
+[community]: https://github.com/nimblehq
+[hire]: https://nimblehq.co/

data/Rakefile

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+
+RSpec::Core::RakeTask.new(:specs)
+
+task default: :specs
+
+task :spec do
+  Rake::Task["specs"].invoke
+  Rake::Task["rubocop"].invoke
+  Rake::Task["spec_docs"].invoke
+end
+
+desc "Run RuboCop on the lib/specs directory"
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.patterns = ["lib/**/*.rb", "spec/**/*.rb"]
+end
+
+desc "Ensure that the plugin passes `danger plugins lint`"
+task :spec_docs do
+  sh "bundle exec danger plugins lint"
+end

data/danger-stylelint.gemspec

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "stylelint/gem_version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "danger-stylelint"
+  spec.version       = Stylelint::VERSION
+  spec.authors       = ["Nimble"]
+  spec.email         = ["dev@nimblehq.co"]
+  spec.description   = "Report Stylelint issues to PRs"
+  spec.summary       = "A Danger plugin for Ruby or Ruby on Rails projects to warn Stylelint issues"
+  spec.homepage      = "https://github.com/nimblehq/danger-stylelint"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "danger-plugin-api", "~> 1.0"
+
+  # General ruby development
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  # Testing support
+  spec.add_development_dependency "rspec", "~> 3.4"
+
+  # Linting code and docs
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "yard"
+
+  # Makes testing easy via `bundle exec guard`
+  spec.add_development_dependency "guard", "~> 2.14"
+  spec.add_development_dependency "guard-rspec", "~> 4.7"
+
+  # If you want to work on older builds of ruby
+  spec.add_development_dependency "listen", "3.0.7"
+
+  # This gives you the chance to run a REPL inside your tests
+  # via:
+  #
+  #    require 'pry'
+  #    binding.pry
+  #
+  # This will stop test execution and let you inspect the results
+  spec.add_development_dependency "pry"
+end

data/lib/danger_plugin.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "stylelint/plugin"

data/lib/danger_stylelint.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "stylelint/gem_version"

data/lib/stylelint/gem_version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Stylelint
+  VERSION = "1.0.0"
+end

data/lib/stylelint/plugin.rb

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+require "mkmf"
+require "json"
+
+module Danger
+  # Lint stylesheets using [stylelint](http://stylelint.io/).
+  # Results are send as inline comment.
+  #
+  # @example Run stylelint with changed files only
+  #
+  #          stylelint.changes_only = true
+  #          stylelint.lint
+  #
+  # @see  nimblehq/danger-stylelint
+  # @tags lint, stylelint, css, scss, sass
+  #
+  class DangerStylelint < Plugin
+    DEFAULT_BIN_PATH = "./node_modules/.bin/stylelint"
+
+    # An path to stylelint's config file
+    # @return [String]
+    attr_accessor :config_file
+
+    # Enable changes_only
+    # Only show messages within changed files.
+    # @return [Boolean]
+    attr_accessor :changes_only
+
+    # A path of stylelint's bin
+    # @return [String]
+    attr_writer :bin_path
+
+    def bin_path
+      @bin_path ||= DEFAULT_BIN_PATH
+    end
+
+    # Specify extensions of target file
+    # Default is [".css, .scss, .sass"]
+    # @return [Array]
+    attr_writer :target_extensions
+
+    def target_extensions
+      @target_extensions ||= %w(.css .scss .sass)
+    end
+
+    # Lints css files.
+    # Generates `errors` and `warnings` according to stylelint's config.
+    #
+    # @return  [void]
+    #
+    def lint
+      lint_results
+        .reject { |result| result.nil? || result["warnings"].length.zero? }
+        .map { |result| send_comment result }
+    end
+
+    private
+
+    # Get stylelint bin path
+    #
+    # return [String]
+    def stylelint_path
+      raise "stylelint is not installed" unless File.exist?(bin_path)
+
+      bin_path
+    end
+
+    # Get all lintable files
+    #
+    # return [String]
+    def all_lintable_files
+      "**/*{#{target_extensions.join(',')}}"
+    end
+
+    # Get all the changed files
+    #
+    # return [Array]
+    def all_changed_files
+      ((git.modified_files - git.deleted_files - git.renamed_files.map { |r| r[:before] }) + git.added_files + git.renamed_files.map { |r| r[:after] })
+    end
+
+    # Get lint result with respect to the changes_only option
+    #
+    # return [Hash]
+    def lint_results
+      bin = stylelint_path
+      return run_lint(bin, all_lintable_files) unless changes_only
+
+      all_changed_files.select { |f| target_extensions.include?(File.extname(f)) }
+        .map { |f| f.gsub("#{Dir.pwd}/", "") }
+        .map { |f| run_lint(bin, f).first }
+    end
+
+    # Run stylelint against file(s).
+    #
+    # @param   [String] bin
+    #          The binary path of stylelint
+    #
+    # @param   [String] file
+    #          File to be linted
+    #
+    # return [Hash]
+    def run_lint(bin, file)
+      command = "#{bin} -f json"
+      command << " --config #{config_file}" if config_file
+      result = `#{command} "#{file}"`
+      JSON.parse(result)
+    end
+
+    # Send comment with danger's warn or fail method.
+    #
+    # @return [void]
+    def send_comment(result)
+      dir = "#{Dir.pwd}/"
+
+      result["warnings"].each do |warning|
+        filename = result["source"].gsub(dir, "")
+        method = warning["severity"] == "error" ? "fail" : "warn"
+        send(method, warning["text"], file: filename, line: warning["line"])
+      end
+    end
+  end
+end

data/spec/fixtures/error.json

@@ -0,0 +1,53 @@
+[
+  {
+    "source": "danger-stylelint/spec/fixtures/error.scss",
+    "deprecations": [],
+    "invalidOptionWarnings": [],
+    "parseErrors": [],
+    "errored": true,
+    "warnings": [
+      {
+        "line": 7,
+        "column": 34,
+        "rule": "declaration-block-trailing-semicolon",
+        "severity": "error",
+        "text": "Expected a trailing semicolon (declaration-block-trailing-semicolon)"
+      },
+      {
+        "line": 11,
+        "column": 35,
+        "rule": "declaration-block-trailing-semicolon",
+        "severity": "error",
+        "text": "Expected a trailing semicolon (declaration-block-trailing-semicolon)"
+      },
+      {
+        "line": 17,
+        "column": 35,
+        "rule": "declaration-block-trailing-semicolon",
+        "severity": "error",
+        "text": "Expected a trailing semicolon (declaration-block-trailing-semicolon)"
+      },
+      {
+        "line": 1,
+        "column": 1,
+        "rule": "selector-class-pattern",
+        "severity": "error",
+        "text": "Selector should be written in lowercase with hyphens (selector-class-pattern)"
+      },
+      {
+        "line": 16,
+        "column": 5,
+        "rule": "selector-max-compound-selectors",
+        "severity": "error",
+        "text": "Expected \".slickDots :global li.slick-active button::before\" to have no more than 3 compound selectors (selector-max-compound-selectors)"
+      },
+      {
+        "line": 15,
+        "column": 22,
+        "rule": "selector-no-qualifying-type",
+        "severity": "error",
+        "text": "Unexpected qualifying type selector (selector-no-qualifying-type)"
+      }
+    ]
+  }
+]

data/spec/fixtures/error.scss

@@ -0,0 +1,20 @@
+.slickDots {
+  @apply fixed left-0 mb-[42px];
+
+  li {
+    button::before,
+    button:focus::before {
+      @apply text-white opacity-20
+    }
+
+    button:hover::before {
+      @apply text-white opacity-100
+    }
+  }
+
+  :global li.slick-active {
+    button::before {
+      @apply text-white opacity-100
+    }
+  }
+}

data/spec/fixtures/valid.json

@@ -0,0 +1,10 @@
+[
+  {
+    "source": "danger-stylelint/spec/fixtures/valid.scss",
+    "deprecations": [],
+    "invalidOptionWarnings": [],
+    "parseErrors": [],
+    "errored": false,
+    "warnings": []
+  }
+]

data/spec/fixtures/valid.scss

@@ -0,0 +1,5 @@
+/* stylelint-disable selector-class-pattern */
+.rangeSlider {
+  @apply h-0.5 w-full mt-[91px] appearance-none;
+}
+/* stylelint-enable selector-class-pattern */

data/spec/spec_helper.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require "pathname"
+ROOT = Pathname.new(File.expand_path("..", __dir__))
+$:.unshift("#{ROOT}lib".to_s)
+$:.unshift("#{ROOT}spec".to_s)
+
+require "bundler/setup"
+require "pry"
+
+require "rspec"
+require "danger"
+
+if `git remote -v` == ""
+  puts "You cannot run tests without setting a local git remote on this repo"
+  puts "It's a weird side-effect of Danger's internals."
+  exit(0)
+end
+
+# Use coloured output, it's the best.
+RSpec.configure do |config|
+  config.filter_gems_from_backtrace "bundler"
+  config.color = true
+  config.tty = true
+end
+
+require "danger_plugin"
+
+# These functions are a subset of https://github.com/danger/danger/blob/master/spec/spec_helper.rb
+# If you are expanding these files, see if it's already been done ^.
+
+# A silent version of the user interface,
+# it comes with an extra function `.string` which will
+# strip all ANSI colours from the string.
+
+# rubocop:disable Lint/NestedMethodDefinition
+def testing_ui
+  @output = StringIO.new
+  def @output.winsize
+    [20, 9999]
+  end
+
+  cork = Cork::Board.new(out: @output)
+  def cork.string
+    out.string.gsub(/\e\[([;\d]+)?m/, "")
+  end
+  cork
+end
+# rubocop:enable Lint/NestedMethodDefinition
+
+# Example environment (ENV) that would come from
+# running a PR on TravisCI
+def testing_env
+  {
+    "HAS_JOSH_K_SEAL_OF_APPROVAL" => "true",
+    "TRAVIS_PULL_REQUEST" => "800",
+    "TRAVIS_REPO_SLUG" => "artsy/eigen",
+    "TRAVIS_COMMIT_RANGE" => "759adcbd0d8f...13c4dc8bb61d",
+    "DANGER_GITHUB_API_TOKEN" => "123sbdq54erfsd3422gdfio"
+  }
+end
+
+# A stubbed out Dangerfile for use in tests
+def testing_dangerfile
+  env = Danger::EnvironmentManager.new(testing_env)
+  Danger::Dangerfile.new(env, testing_ui)
+end

data/spec/stylelint_spec.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+require File.expand_path("spec_helper", __dir__)
+
+module Danger
+  describe Danger::DangerStylelint do
+    it "should be a plugin" do
+      expect(Danger::DangerStylelint.new(nil)).to be_a Danger::Plugin
+    end
+
+    describe "with Dangerfile" do
+      let(:stylelint) { testing_dangerfile.stylelint }
+      let(:warnings) { stylelint.status_report[:warnings] }
+      let(:errors) { stylelint.status_report[:errors] }
+      let(:messages) { stylelint.status_report[:messages] }
+      let(:markdowns) { stylelint.status_report[:markdowns] }
+
+      before do
+        allow(stylelint.git).to receive(:deleted_files).and_return([])
+        allow(stylelint.git).to receive(:added_files).and_return([])
+        allow(stylelint.git).to receive(:modified_files).and_return([])
+        allow(stylelint.git).to receive(:renamed_files).and_return([])
+        stub_const("Danger::DangerStylelint::DEFAULT_BIN_PATH", "spec/fixtures/stylelint")
+      end
+
+      it "does not make an empty message" do
+        allow(stylelint).to receive(:lint).and_return("[]")
+
+        stylelint.lint
+
+        expect(warnings).to eq([])
+        expect(errors).to eq([])
+        expect(messages).to eq([])
+        expect(markdowns).to eq([])
+      end
+
+      it "fails if stylelint not installed" do
+        allow(stylelint).to receive(:bin_path).and_return("")
+
+        expect { stylelint.lint }.to raise_error("stylelint is not installed")
+      end
+
+      describe "#lint" do
+        let(:valid_result) { JSON.parse(File.read("spec/fixtures/valid.json")) }
+        let(:error_result) { JSON.parse(File.read("spec/fixtures/error.json")) }
+
+        it "lints all files when changes_only is disabled by default" do
+          allow(stylelint).to receive(:all_lintable_files).and_return("spec/fixtures/error.scss")
+          allow(stylelint).to receive(:run_lint)
+            .with(anything, /error.scss/).and_return(error_result)
+
+          stylelint.lint
+
+          expect(warnings.length).to eq(0)
+          expect(errors.length).to eq(6)
+          expect(messages.length).to eq(0)
+          expect(markdowns.length).to eq(0)
+          expect(errors).to eq(
+            [
+              "Expected a trailing semicolon (declaration-block-trailing-semicolon)",
+              "Expected a trailing semicolon (declaration-block-trailing-semicolon)",
+              "Expected a trailing semicolon (declaration-block-trailing-semicolon)",
+              "Selector should be written in lowercase with hyphens (selector-class-pattern)",
+              "Expected \".slickDots :global li.slick-active button::before\" to have no more than 3 compound selectors (selector-max-compound-selectors)",
+              "Unexpected qualifying type selector (selector-no-qualifying-type)"
+            ]
+          )
+        end
+
+        it "lints only changed files when changes_only is enabled" do
+          allow(stylelint.git).to receive(:modified_files)
+            .and_return(["spec/fixtures/valid.scss"])
+          allow(stylelint).to receive(:run_lint)
+            .with(anything, /valid.scss/).and_return(valid_result)
+
+          stylelint.changes_only = true
+          stylelint.lint
+
+          expect(warnings.length).to eq(0)
+          expect(errors.length).to eq(0)
+          expect(messages.length).to eq(0)
+          expect(markdowns.length).to eq(0)
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,211 @@
+--- !ruby/object:Gem::Specification
+name: danger-stylelint
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Nimble
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-05-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: danger-plugin-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.7
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Report Stylelint issues to PRs
+email:
+- dev@nimblehq.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- danger-stylelint.gemspec
+- lib/danger_plugin.rb
+- lib/danger_stylelint.rb
+- lib/stylelint/gem_version.rb
+- lib/stylelint/plugin.rb
+- spec/fixtures/error.json
+- spec/fixtures/error.scss
+- spec/fixtures/stylelint
+- spec/fixtures/valid.json
+- spec/fixtures/valid.scss
+- spec/spec_helper.rb
+- spec/stylelint_spec.rb
+homepage: https://github.com/nimblehq/danger-stylelint
+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: []
+rubygems_version: 3.2.15
+signing_key:
+specification_version: 4
+summary: A Danger plugin for Ruby or Ruby on Rails projects to warn Stylelint issues
+test_files:
+- spec/fixtures/error.json
+- spec/fixtures/error.scss
+- spec/fixtures/stylelint
+- spec/fixtures/valid.json
+- spec/fixtures/valid.scss
+- spec/spec_helper.rb
+- spec/stylelint_spec.rb