guard-slimlint 1.4.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 14b281a7110ec5e1176f8e57dc91b18c1569b3eec1a14c19d17f7cf99ab814e2
-  data.tar.gz: a2ec22b0621349fadca501979d70687eceb86b4232a25241d5e78ba9987d0611
+  metadata.gz: 47da81ec1db0fb4fa7809b0bd5403413f6572ab142508b9d8a979718f75aa873
+  data.tar.gz: a8309923aa75cd04905c61473d3e403c0ac9a0bc4e293a24aa1c8bc9ecd1d951
 SHA512:
-  metadata.gz: 6096c002fa6518d50a22fcf29e9c98b9fc38f6b500f9cf043074feedd896c6e394bf96e3b949831044dd0517e6323de4a145ba90066c934443c3b68f67c01dde
-  data.tar.gz: 2864c784c00d06c76fdae85d2c1ea2c4b9ea5a689853ad5d376cc391e74482fb75a1c2bbaef7155052b2b9f86e0cf974f9efac618a378ffaf7bc3ad9a7dfd4e1
+  metadata.gz: cd5617c218afc0f9bfcb3f9ef72b2b89fb3ca70d0ca108f7dce1d07ca8db921404aa8af7688cea10937747cdfcc8769087a74ed02a2d43bb84d6ae2cb4a2685f
+  data.tar.gz: 41a792aa16d6d22345126120c6df3bf5f0242271351d71f70b39f98ae1f77b1eecb664705e5468a016f8125b2176ecb2aa30ab77f75acfb61827403f355da26d

data/CHANGELOG.md

@@ -6,6 +6,58 @@ follows [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
 
+## [2.1.0] - 2026-09-14
+
+### Added
+
+- `autocorrect:` option, default `false`, to automatically correct offences that
+  support it using `slim-lint -a`. Offences are corrected in-place on disk. If all
+  offences are corrected, the run succeeds cleanly.
+- Non-boolean values passed to `autocorrect:`, `all_on_start:`, or `halt_on_fail:`
+  raise an `ArgumentError` on startup.
+
+## [2.0.0] - 2026-09-07
+
+A behaviour release. The plugin still runs slim-lint as a subprocess, which
+was a deliberate decision: Guard is a long-running process, and loading the
+linter into it would freeze `.slim-lint.yml` at startup and let RuboCop's
+caches grow all day. Four of the five comparable Guard plugins shell out for
+the same reason.
+
+### Changed
+
+- **`notify_on` now defaults to `:change`.** Notifications fire only when the
+  outcome flips, green to red or red to green. Saving a broken template twenty
+  times while fixing it produces one notification instead of twenty. Pass
+  `notify_on: :failure` for the old behaviour.
+- **Ruby 3.3 or newer is required.** 3.2 reached end of life in March 2026.
+- **`run_all` lints the directories Guard watches** rather than always
+  sweeping `.`. A `directories` line in your Guardfile now narrows it. Without
+  one, behaviour is unchanged.
+- The Guardfile template watches `app/views` rather than every `.html.slim`
+  file anywhere in the project, and re-lints when `.slim-lint.yml` changes.
+- Option readers are no longer writable. `notify_on` and `all_on_start` are
+  read once at construction, so the writers only ever looked useful.
+
+### Added
+
+- `cli:` option, forwarding arbitrary arguments to slim-lint as a String or an
+  Array. This covers `-c`, linter selection and anything slim-lint adds later
+  without a new option here for each.
+- `halt_on_fail:` option, default `true`, to opt out of failing Guard's task.
+- An unrecognised `notify_on` now raises at startup instead of silently
+  disabling notifications for the whole session.
+- Exit statuses that do not come from slim-lint itself now explain themselves.
+  Status 1 is Bundler failing to load the command, and 127 is a missing binary;
+  neither mentions Slim, so the bare number used to send people hunting for
+  lint errors in templates that were fine.
+
+### Removed
+
+- The `colorize` runtime dependency. It monkeypatched `String` in every host
+  application to colour two log lines. Guard's own `Compat::UI.color` does the
+  same job, so the plugin now adds nothing to your object space.
+
 ## [1.4.0] - 2026-09-04
 
 The gem had not been touched since 2019 and could no longer be developed on any
@@ -75,7 +127,9 @@ without changing the plugin's interface.
 - `all_on_start` is honoured, so the plugin no longer lints everything on
   startup when the option is disabled.
 
-[Unreleased]: https://github.com/mike927/guard-slimlint/compare/v1.4.0...HEAD
+[Unreleased]: https://github.com/mike927/guard-slimlint/compare/v2.1.0...HEAD
+[2.1.0]: https://github.com/mike927/guard-slimlint/compare/v2.0.0...v2.1.0
+[2.0.0]: https://github.com/mike927/guard-slimlint/compare/v1.4.0...v2.0.0
 [1.4.0]: https://github.com/mike927/guard-slimlint/compare/v1.3.2...v1.4.0
 [1.3.2]: https://github.com/mike927/guard-slimlint/compare/v1.3.1...v1.3.2
 [1.3.1]: https://github.com/mike927/guard-slimlint/compare/v1.3.0...v1.3.1

data/README.md

@@ -6,7 +6,7 @@
 Guard::SlimLint runs [slim-lint](https://github.com/sds/slim-lint) automatically
 every time a Slim template is added or changed.
 
-Requires Ruby 3.1 or newer.
+Requires Ruby 3.3 or newer.
 
 ## Installation
 
@@ -24,12 +24,6 @@ Then run:
 bundle install
 ```
 
-Or install it yourself:
-
-```
-gem install guard-slimlint
-```
-
 ## Usage
 
 Add the plugin to your Guardfile:
@@ -50,27 +44,48 @@ Linting itself is configured by slim-lint, not by this plugin. Put a
 ## Options
 
 ```ruby
-guard :slimlint, notify_on: :failure, all_on_start: true do
+guard :slimlint, notify_on: :change, cli: '-c config/.slim-lint.yml' do
   watch(%r{^app/views/.+\.slim$})
+  watch(%r{(?:.+/)?\.slim-lint\.yml$}) { |m| File.dirname(m[0]) }
 end
 ```
 
 | Option | Default | Meaning |
 |--------|---------|---------|
-| `notify_on` | `:failure` | When to send a desktop notification. One of `:failure`, `:success`, `:both`, `:none`. |
+| `notify_on` | `:change` | When to send a desktop notification. One of `:change`, `:failure`, `:success`, `:both`, `:none`. |
 | `all_on_start` | `true` | Lint everything once when Guard starts. |
+| `halt_on_fail` | `true` | Tell Guard the task failed, so a group's `halt_on_fail` can stop the rest of it. |
+| `autocorrect` | `false` | Automatically correct offences that support it using `slim-lint -a`. |
+| `cli` | none | Extra arguments passed straight to slim-lint. String or Array. |
+
+An unrecognised `notify_on` or non-boolean option raises at startup rather than silently going quiet.
+
+### Autocorrect
+
+Setting `autocorrect: true` automatically runs `slim-lint -a`, fixing offences that support auto-correction directly on disk. If all offences in a file are corrected, slim-lint exits with status 0 and Guard reports success. If uncorrectable offences remain, slim-lint exits with status 65 and Guard reports the remaining offences.
+
+Because auto-correction modifies files in-place, Guard's file listener detects the disk write and re-lints the now-clean template. The default `notify_on: :change` ensures this follow-up pass stays quiet and does not send duplicate desktop notifications.
+
+### Notifications
+
+`:change` notifies only when the outcome flips, green to red or red to green.
+Saving a broken file twenty times while you fix it produces one notification,
+not twenty. `:failure` notifies on every failing run, which is the older
+behaviour if you prefer it.
+
+Notifications come from Guard itself. On macOS, add `terminal-notifier-guard`
+to your Gemfile, or you will only see the terminal window title change.
 
-Desktop notifications come from Guard itself. On macOS, add
-`terminal-notifier-guard` to your Gemfile to get them.
+### Running everything
 
-Guard's `halt_on_fail` group option is respected. Put the plugin in a group with
-`halt_on_fail: true` to stop the rest of the group when linting fails.
+`run_all` lints the directories Guard is watching, so a `directories` line in
+your Guardfile narrows it. Without one it falls back to the whole project.
 
 ## Exit status handling
 
 slim-lint reports its outcome with sysexits codes. This plugin treats status 65
 as "offences were found" and every other non-zero status as slim-lint itself
-failing, which is reported through `Guard::UI.error` with the status. A
+failing, which is reported through `Guard::Compat::UI.error` with the status. A
 misconfigured `.slim-lint.yml` or a crash is therefore not mistaken for a lint
 failure.
 

data/lib/guard/slimlint/templates/Guardfile

@@ -1,6 +1,14 @@
 # available options:
-#   notify_on:
-#     failure, success, both, none
-guard :slimlint, notify_on: :failure do
-  watch(/^.+(\.html\.slim)$/)
+#   notify_on:    change (default), failure, success, both, none
+#   all_on_start: true (default), false
+#   halt_on_fail: true (default), false
+#   autocorrect:  false (default), true
+#   cli:          extra arguments for slim-lint, e.g. '-c config/.slim-lint.yml'
+guard :slimlint, notify_on: :change do
+  # Rails views. For a non-Rails project, watch wherever your templates live,
+  # for example watch(%r{^templates/.+\.slim$})
+  watch(%r{^app/views/.+\.slim$})
+
+  # Re-lint when the slim-lint configuration itself changes.
+  watch(%r{(?:.+/)?\.slim-lint\.yml$}) { |m| File.dirname(m[0]) }
 end

data/lib/guard/slimlint/version.rb

@@ -2,6 +2,6 @@
 
 module Guard
   class SlimLintVersion
-    VERSION = '1.4.0'
+    VERSION = '2.1.0'
   end
 end

data/lib/guard/slimlint.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 require 'English'
+require 'shellwords'
 require 'guard/compat/plugin'
-require 'colorize'
 
 module Guard
   class SlimLint < Plugin
@@ -12,11 +12,36 @@ module Guard
     EXIT_SUCCESS = 0
     EXIT_LINT_FAILURE = 65
 
-    attr_accessor :notify_on, :all_on_start
+    # Recognised :notify_on values. :change notifies only when the outcome
+    # flips, which is what stops a long editing session from producing one
+    # notification per save.
+    NOTIFY_MODES = %i[change failure success both none].freeze
+
+    # Statuses that are not slim-lint's own sysexits codes, paired with what a
+    # user is most likely looking at. Bundler exits 1 when it cannot load the
+    # command, and a shell exits 127 when the binary is missing; neither says
+    # anything about Slim, so the bare number sends people hunting for lint
+    # errors that do not exist.
+    STATUS_HINTS = {
+      1 => 'the bundle is probably out of sync, try bundle install',
+      127 => 'slim-lint is not on PATH, check that the gem is installed'
+    }.freeze
+
+    AUTOCORRECT_FLAGS = %w[-a --autocorrect --auto-correct -A --autocorrect-all].freeze
+
+    attr_reader :notify_on, :all_on_start, :halt_on_fail, :cli, :autocorrect
 
     def initialize(options = {})
-      @notify_on    = options.fetch(:notify_on, :failure)
+      @notify_on    = options.fetch(:notify_on, :change)
       @all_on_start = options.fetch(:all_on_start, true)
+      @halt_on_fail = options.fetch(:halt_on_fail, true)
+      @cli          = options[:cli]
+      @autocorrect  = options.fetch(:autocorrect, false)
+      # Assume the project starts green, so a clean first run stays quiet
+      # under :change instead of announcing that nothing is wrong.
+      @last_success = true
+
+      validate_options!
       super
     end
 
@@ -25,7 +50,7 @@ module Guard
     end
 
     def run_all
-      run
+      run(lint_targets)
     end
 
     def run_on_modifications(paths)
@@ -38,7 +63,41 @@ module Guard
 
     private
 
-    def run(paths = ['.'])
+    def validate_options!
+      validate_notify_on!
+      validate_boolean!(:all_on_start, all_on_start)
+      validate_boolean!(:halt_on_fail, halt_on_fail)
+      validate_boolean!(:autocorrect, autocorrect)
+    end
+
+    def validate_notify_on!
+      return if NOTIFY_MODES.include?(notify_on)
+
+      raise ArgumentError,
+            "unknown :notify_on #{notify_on.inspect}, expected one of " \
+            "#{NOTIFY_MODES.map(&:inspect).join(', ')}"
+    end
+
+    def validate_boolean!(name, value)
+      return if [true, false].include?(value)
+
+      raise ArgumentError, ":#{name} must be true or false, got #{value.inspect}"
+    end
+
+    # The directories Guard was told to watch, so run_all honours a
+    # `directories` line in the Guardfile instead of always sweeping the
+    # whole project.
+    def lint_targets
+      dirs = Compat.watched_directories.map(&:to_s)
+      dirs.empty? ? ['.'] : dirs
+    rescue NotImplementedError
+      # guard-compat raises this when Guard's CLI is not loaded, which
+      # happens when the plugin is driven programmatically rather than by
+      # `guard`. Linting the whole project is what run_all did before 2.0.0.
+      ['.']
+    end
+
+    def run(paths)
       status = lint(paths)
 
       case status
@@ -54,57 +113,65 @@ module Guard
     # @param paths [Array<String>]
     # @return [Integer, nil] the exit status, or nil if slim-lint never ran
     def lint(paths)
-      system('slim-lint', *paths)
+      system('slim-lint', *cli_args, *paths)
       $CHILD_STATUS&.exitstatus
     end
 
+    def cli_args
+      args = case cli
+             when Array then cli.map(&:to_s)
+             when String then cli.shellsplit
+             else []
+             end
+
+      args.unshift('-a') if autocorrect && !args.intersect?(AUTOCORRECT_FLAGS)
+      args
+    end
+
     def report_success
-      UI.info 'No Slim offences detected'.green
-      check_and_notify(true)
+      Compat::UI.info(Compat::UI.color('No Slim offences detected', :green))
+      finish(true, 'No slim offences')
     end
 
     def report_offences
-      UI.info 'Slim offences have been detected'.red
-      check_and_notify(false)
-      throw :task_has_failed
+      Compat::UI.info(Compat::UI.color('Slim offences have been detected', :red))
+      finish(false, 'Slim offences detected')
     end
 
     def report_error(status)
       message = error_message(status)
-      UI.error message
-      check_and_notify(false, message)
-      throw :task_has_failed
+      Compat::UI.error(message)
+      finish(false, message)
     end
 
     def error_message(status)
       return 'slim-lint could not be run' if status.nil?
 
-      "slim-lint exited with status #{status}"
+      message = "slim-lint exited with status #{status}"
+      hint = STATUS_HINTS[status]
+      hint ? "#{message}: #{hint}" : message
+    end
+
+    # Notifies if the configured mode calls for it, records the outcome so
+    # :change can compare against it next time, then hands back to Guard.
+    def finish(success, message)
+      notify(success, message) if notification_allowed?(success)
+      @last_success = success
+      throw :task_has_failed if halt_on_fail && !success
     end
 
-    def notification_allowed?(result)
+    def notification_allowed?(success)
       case notify_on
-      when :failure then !result
-      when :success then result
+      when :change then success != @last_success
+      when :failure then !success
+      when :success then success
       when :both then true
       else false
       end
     end
 
-    def check_and_notify(result, message = default_message(result))
-      notify(result, message) if notification_allowed?(result)
-    end
-
-    def image(result)
-      result ? :success : :failed
-    end
-
-    def default_message(result)
-      result ? 'No slim offences' : 'Slim offences detected'
-    end
-
-    def notify(result, message = default_message(result))
-      Notifier.notify(message, title: 'Slim-lint results', image: image(result))
+    def notify(success, message)
+      Compat::UI.notify(message, title: 'Slim-lint results', image: success ? :success : :failed)
     end
   end
 end

metadata

@@ -1,35 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: guard-slimlint
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Michal Gajowiak
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-09-04 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: colorize
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.8'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.8'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
@@ -171,7 +150,6 @@ metadata:
   changelog_uri: https://github.com/mike927/guard-slimlint/blob/master/CHANGELOG.md
   bug_tracker_uri: https://github.com/mike927/guard-slimlint/issues
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -179,15 +157,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.1'
+      version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Guard plugin that runs slim-lint automatically
 test_files: []