pronto-stylelint 0.10.2 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed4f93468ad34cfbe7b933ad8497795430601b76461387cd3b412bc1c4080fe8
-  data.tar.gz: e6c413926171309786afa3d750eccc47217355dd9503661b2de78f66c5c71669
+  metadata.gz: 72aadfab27603a70d2693342dd21de34d2029d2dde321ff65813375f6d2ff06d
+  data.tar.gz: 965e9c5d044b55e4895812025d4482f63b1db1d71e7e51db2f6cc56cbbaadfaa
 SHA512:
-  metadata.gz: 1b54dca362245ca45d139415afeed46d9a3d5c325ee9217e8f0fb61c1ecc267e7aa1ded98e962cc15c6c02cff4b903ad8560cc3d5bba534cf14bef8b799c35a4
-  data.tar.gz: 9c9583201f8a43ae48b4ec8135d20696b0d22ff54ee6c869b8e48c28c7f45b422b74eeaf23d72b29b04f54f39b5e5edaa6e7316da390e211d40ef5a72f35893d
+  metadata.gz: 62ea066e712ea0c8632b2d9502481e6c9e2dc11e23b72f4a2e4e9c01e803fa87b92d27e3fe83731613f2597ae301f035b3f1e2420008987b4c0b50d697a91652
+  data.tar.gz: fe4cac1fc9d5a28963fac3739141797f7b01ad9a3d757ae816c29972f74b53624bd2e2fb5ad3c4d11a98c933647648e3e5e9533e37b659a1403a1230aa5f5a44

data/README.md

@@ -7,13 +7,13 @@
 
 Pronto runner for [stylelint](http://stylelint.io), the mighty, modern CSS linter. [What is Pronto?](https://github.com/prontolabs/pronto)
 
-Uses official stylelint executable installed by `npm`.
+Uses the official stylelint executable installed by `npm`.
 
 Heavily inspired by [doits/pronto-eslint_npm](https://github.com/doits/pronto-eslint_npm).
 
 ## Prerequisites
 
-You'll need to install [stylelint by yourself with npm](http://stylelint.io/user-guide/cli/). If `stylelint` is in your `PATH`, everything will simply work, otherwise you have to provide pronto-stylelint your custom executable path (see [below](#configuration-of-stylelint)).
+You'll need to install [stylelint by yourself with npm](http://stylelint.io/user-guide/cli/). If `stylelint` is in your `PATH`, everything will simply work, otherwise, you have to provide pronto-stylelint your custom executable path (see [below](#configuration-of-stylelint)).
 
 ## Configuration of stylelint
 
@@ -21,9 +21,9 @@ Configuring stylelint via [.stylelintrc and consorts](http://stylelint.io/user-g
 
 ## Configuration of pronto-stylelint
 
-pronto-stylelint can be configured by placing a `.pronto_stylelint.yml` inside the directory where pronto is run.
+pronto-stylelint can be configured by adding to the [pronto configuration file](https://github.com/prontolabs/pronto?tab=readme-ov-file#configuration) `.pronto.yml`.
 
-Following options are available:
+The following options are available:
 
 | Option               | Meaning                                                                                  | Default                                   |
 | -------------------- | ---------------------------------------------------------------------------------------- | ----------------------------------------- |
@@ -34,8 +34,9 @@ Following options are available:
 Example configuration to call custom stylelint executable and specify custom options:
 
 ```yaml
-# .pronto_stylelint.yml
-stylelint_executable: '/my/custom/node/path/.bin/stylelint'
-files_to_lint: '\.(c|sc)ss$'
-cli_options: '--config /custom/stylelintrc'
+# .pronto.yml
+stylelint:
+  stylelint_executable: '/my/custom/node/path/.bin/stylelint'
+  files_to_lint: '\.(c|sc)ss$'
+  cli_options: '--config /custom/stylelintrc'
 ```

data/lib/pronto/stylelint/config.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'pronto'
+
+module Pronto
+  class Stylelint < Runner
+    class Config
+      EXECUTABLE_DEFAULT = 'stylelint'
+      FILES_TO_LINT_DEFAULT = /\.(c|sc|sa|le)ss$/.freeze
+
+      def stylelint_executable
+        stylelint_config['stylelint_executable'] || EXECUTABLE_DEFAULT
+      end
+
+      def cli_options
+        "#{stylelint_config['cli_options']} -f json".strip
+      end
+
+      def files_to_lint
+        config_files_to_lint || FILES_TO_LINT_DEFAULT
+      end
+
+      def git_repo_path
+        @git_repo_path ||= Rugged::Repository.discover(File.expand_path(Dir.pwd)).workdir
+      end
+
+      private
+
+      def config_files_to_lint
+        return unless stylelint_config['files_to_lint']
+
+        if stylelint_config['files_to_lint'].is_a?(Regexp)
+          stylelint_config['files_to_lint']
+        else
+          Regexp.new(stylelint_config['files_to_lint'])
+        end
+      end
+
+      def stylelint_config
+        @stylelint_config ||= Pronto::ConfigFile.new.to_h['stylelint'] || {}
+      end
+    end
+  end
+end

data/lib/pronto/stylelint/linter.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require 'pronto'
+require 'shellwords'
+require 'open3'
+
+module Pronto
+  class Stylelint < Runner
+    class Linter
+      extend Forwardable
+
+      attr_reader :stylelint_config
+
+      def_delegators(
+        :stylelint_config,
+        :stylelint_executable,
+        :cli_options,
+        :git_repo_path
+      )
+
+      private :stylelint_executable, :cli_options, :git_repo_path
+
+      STYLELINT_FAILURE = 'Stylelint failed to run'
+      STATUS_CODES = {
+        0 => :success,
+        1 => :fatal_error,
+        2 => :lint_problem,
+        64 => :invalid_cli_usage,
+        78 => :invalid_configuration_file
+      }.freeze
+
+      def initialize(patch, stylelint_config)
+        @patch = patch
+        @stylelint_config = stylelint_config
+        @stylint_major_version = nil
+      end
+
+      def run
+        Dir.chdir(git_repo_path) do
+          Open3.popen3(cli_command) do |_stdin, stdout, stderr, thread|
+            JSON.parse(
+              case thread_status(thread)
+              when :success, :lint_problem
+                out = stdout.read
+                out.empty? ? stderr.read : out
+              else
+                puts "#{STYLELINT_FAILURE} - #{thread_status(thread)}:\n#{stderr.read}"
+                '[]'
+              end
+            )
+          end
+        end
+      end
+
+      private
+
+      def cli_command
+        "#{stylelint_executable} #{escaped_file_path} #{cli_options}"
+      end
+
+      def escaped_file_path
+        Shellwords.escape(@patch.new_file_full_path.to_s)
+      end
+
+      # Status codes:
+      # https://stylelint.io/user-guide/cli/#exit-codes
+      def thread_status(thread)
+        STATUS_CODES[thread.value.exitstatus] || :unknown
+      end
+    end
+  end
+end

data/lib/pronto/stylelint/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Pronto
   module StylelintVersion
-    VERSION = '0.10.2'.freeze
+    VERSION = '0.11.0'
   end
 end

data/lib/pronto/stylelint.rb

@@ -1,70 +1,47 @@
+# frozen_string_literal: true
+
 require 'pronto'
 require 'shellwords'
+require 'open3'
+require 'pronto/stylelint/config'
+require 'pronto/stylelint/linter'
 
 module Pronto
   class Stylelint < Runner
-    CONFIG_FILE = '.pronto_stylelint.yml'.freeze
-    CONFIG_KEYS = %w(stylelint_executable files_to_lint cli_options).freeze
-
-    attr_writer :stylelint_executable, :cli_options
-
-    def initialize(patches, commit = nil)
-      super(patches, commit)
-      read_config
-    end
+    extend Forwardable
 
-    def stylelint_executable
-      @stylelint_executable || 'stylelint'.freeze
-    end
+    attr_reader :stylelint_config
 
-    def cli_options
-      "#{@cli_options} -f json".strip
-    end
+    def_delegators(
+      :stylelint_config,
+      :files_to_lint
+    )
+    private :files_to_lint
 
-    def files_to_lint
-      @files_to_lint || /\.(c|sc|sa|le)ss$/.freeze
-    end
-
-    def files_to_lint=(regexp)
-      @files_to_lint = regexp.is_a?(Regexp) ? regexp : Regexp.new(regexp)
-    end
-
-    def read_config
-      config_file = File.join(git_repo_path, CONFIG_FILE)
-      return unless File.exist?(config_file)
-      config = YAML.load_file(config_file)
+    def initialize(patches, commit = nil)
+      super
 
-      CONFIG_KEYS.each do |config_key|
-        next unless config[config_key]
-        send("#{config_key}=", config[config_key])
-      end
+      @stylelint_config ||= Pronto::Stylelint::Config.new
     end
 
     def run
       return [] if !@patches || @patches.count.zero?
 
       @patches
-        .select { |patch| patch.additions > 0 }
-        .select { |patch| style_file?(patch.new_file_full_path) }
-        .map { |patch| inspect(patch) }
-        .flatten.compact
+        .select { |patch| patch.additions.positive? && style_file?(patch.new_file_full_path) }
+        .flat_map { |patch| inspect(patch) }
+        .compact
     end
 
     private
 
-    def git_repo_path
-      @git_repo_path ||= Rugged::Repository.discover(File.expand_path(Dir.pwd)).workdir
-    end
-
     def inspect(patch)
-      offences = run_stylelint(patch)
-      clean_up_stylelint_output(offences)
-        .map do |offence|
-          patch
-            .added_lines
-            .select { |line| line.new_lineno == offence['line'] }
-            .map { |line| new_message(offence, line) }
-        end
+      clean_up_stylelint_output(Linter.new(patch, stylelint_config).run).flat_map do |offence|
+        patch
+          .added_lines
+          .select { |line| line.new_lineno == offence['line'] }
+          .map { |line| new_message(offence, line) }
+      end
     end
 
     def new_message(offence, line)
@@ -78,23 +55,14 @@ module Pronto
       files_to_lint =~ path.to_s
     end
 
-    def run_stylelint(patch)
-      Dir.chdir(git_repo_path) do
-        escaped_file_path = Shellwords.escape(patch.new_file_full_path.to_s)
-        JSON.parse(
-          `#{stylelint_executable} #{escaped_file_path} #{cli_options}`
-        )
-      end
-    end
-
     def clean_up_stylelint_output(output)
       # 1. Filter out offences without a warning or error
       # 2. Get the messages for that file
       # 3. Ignore errors without a line number for now
       output
-        .select { |offence| offence['warnings'].size > 0 }
-        .map { |offence| offence['warnings'] }
-        .flatten.select { |offence| offence['line'] }
+        .select { |offence| offence['warnings'].size.positive? }
+        .flat_map { |offence| offence['warnings'] }
+        .select { |offence| offence['line'] }
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pronto-stylelint
 version: !ruby/object:Gem::Version
-  version: 0.10.2
+  version: 0.11.0
 platform: ruby
 authors:
 - Kevin Jalbert
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-24 00:00:00.000000000 Z
+date: 2025-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pronto
@@ -50,34 +50,6 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.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'
 description:
 email: kevin.j.jalbert@gmail.com
 executables: []
@@ -89,6 +61,8 @@ files:
 - LICENSE
 - README.md
 - lib/pronto/stylelint.rb
+- lib/pronto/stylelint/config.rb
+- lib/pronto/stylelint/linter.rb
 - lib/pronto/stylelint/version.rb
 homepage: https://github.com/kevinjalbert/pronto-stylelint
 licenses:
@@ -110,7 +84,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - stylelint (in PATH)
-rubygems_version: 3.1.4
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: Pronto runner for stylelint, the mighty, modern CSS linter.