slim_lint 0.36.0 → 0.37.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd046afc687f2cd47b2766c90af0d4cee87282f818f60954530dc9e579a3a797
-  data.tar.gz: a6378966b0a438ba9cdf86f5771262f7e7eebb4a40b1b915ec95a68a7d51eb05
+  metadata.gz: 1ab51b789afce474d3a969052cf00dc0760a2d98706aa74d2d5f2daf2c58ad44
+  data.tar.gz: ad86883e7bb179a3f7f7c01c2aad5e07d57c359f790ca3541d3da78f3af17516
 SHA512:
-  metadata.gz: 13c3f8d0aacd071c62fdd1ddea37c690a48a53df0170a32575cced14ad6e828ca6a2a1bccbcc6cdd915cbf54a4b917d02099a75f51c08417395861a53b6933d4
-  data.tar.gz: d063b8fe3e5620ecc68a1bb6b2a38ceb0b5431971ec94c6a3cb4059be77d8b87e122c2ef7fae4cc1c4b1325bc9c5ffbb59d237b19caf22974977086410cf614d
+  metadata.gz: 7223d666bd6ae4e0c266431a5ab8edd34a89a7862ca6a7b7aca9f7171fcea57016a622ea95794372f11579ad62136e97279d54988f4c5e70f7bc3305f71c916e
+  data.tar.gz: 5de9a96b2055eeeae3f5af80053bf0af37f85d7821c874de7584da6a8a0837811dfe84aca1461c1b7c27c541bef306d08adb73d516a7efb3400790858b1b6d17

data/lib/slim_lint/corrector.rb

@@ -12,33 +12,55 @@ module SlimLint
     # Applies every correctable lint's correction to the document's source
     # and marks each applied lint as corrected.
     #
+    # A correction maps the current text of its line to the corrected text:
+    # returning `nil` removes the line entirely, and returning a string
+    # containing embedded newlines replaces the line with multiple lines.
+    # Corrections are applied from the last line to the first so that a
+    # correction which adds or removes lines never invalidates the line
+    # numbers of corrections still waiting to be applied.
+    #
     # @param lints [Array<SlimLint::Lint>]
     # @return [String] the corrected source
     def correct(lints)
-      lines = @document.source_lines.dup
+      # `-1` keeps a trailing empty element when the source ends with a
+      # newline, so the array can be joined back with "\n" to exactly
+      # reproduce the source (including its trailing newline, or lack of one).
+      lines = @document.source.split("\n", -1)
 
-      lints.select(&:correctable?).group_by(&:line).each do |line_number, line_lints|
+      correction_groups(lints).each do |line_number, line_lints|
         index = line_number - 1
-        next unless lines[index]
+        next unless index.between?(0, lines.length - 1)
 
-        line_lints.each do |lint|
-          lines[index] = lint.correction.call(lines[index])
-          lint.corrected = true
-        end
+        lines[index, 1] = apply_corrections(lines[index], line_lints)
       end
 
-      corrected_source(lines)
+      @document.source_prefix + lines.join("\n")
     end
 
     private
 
-    # @param lines [Array<String>]
-    # @return [String]
-    def corrected_source(lines)
-      source = lines.join("\n")
-      trailing_newlines = @document.source[/\n+\z/]
-      source += trailing_newlines if trailing_newlines
-      @document.source_prefix + source
+    # Groups correctable lints by line number, ordered from the last line to
+    # the first, so that a correction which adds or removes lines never
+    # invalidates the line numbers of corrections still waiting to be applied.
+    #
+    # @param lints [Array<SlimLint::Lint>]
+    # @return [Array<(Integer, Array<SlimLint::Lint>)>]
+    def correction_groups(lints)
+      lints.select(&:correctable?).group_by(&:line).sort_by { |line_number, _| -line_number }
+    end
+
+    # @param line [String] current text of the line
+    # @param line_lints [Array<SlimLint::Lint>] lints reported on this line
+    # @return [Array<String>] replacement line(s) for this line, possibly empty
+    def apply_corrections(line, line_lints)
+      line_lints.each do |lint|
+        break if line.nil?
+
+        line = lint.correction.call(line)
+        lint.corrected = true
+      end
+
+      line.nil? ? [] : line.split("\n", -1)
     end
   end
 end

data/lib/slim_lint/lint.rb

@@ -18,8 +18,10 @@ module SlimLint
     # @return [Symbol] whether this lint is a warning or an error
     attr_reader :severity
 
-    # @return [Proc, nil] maps a line of source to its corrected version, or
-    #   `nil` if this lint has no known automatic correction
+    # @return [Proc, nil] maps a line of source to its corrected version
+    #   (`nil` to remove the line, or a string with embedded newlines to
+    #   replace it with multiple lines), or `nil` if this lint has no known
+    #   automatic correction
     attr_reader :correction
 
     # @return [Boolean] whether this lint's correction has been applied

data/lib/slim_lint/linter/comment_control_statement.rb

@@ -4,6 +4,7 @@ module SlimLint
   # Searches for control statements with only comments.
   class Linter::CommentControlStatement < Linter
     include LinterRegistry
+    support_autocorrect
 
     on [:slim, :control] do |sexp|
       _, _, code = sexp
@@ -16,7 +17,10 @@ module SlimLint
 
       report_lint(sexp,
                   "Slim code comments (`/#{comment}`) are preferred over " \
-                  "control statement comments (`-##{comment}`)")
+                  "control statement comments (`-##{comment}`)",
+                  correction: ->(line) {
+                    line.sub(/-\s*#{Regexp.escape(code.to_s)}/, "/#{comment}")
+                  })
     end
   end
 end

data/lib/slim_lint/linter/control_statement_spacing.rb

@@ -4,10 +4,17 @@ module SlimLint
   # Checks for missing or superfluous spacing before and after control statements.
   class Linter::ControlStatementSpacing < Linter
     include LinterRegistry
+    support_autocorrect
 
     MESSAGE_OUTPUT = 'Please add a space before and after the `=`'
     MESSAGE_CONTROL = 'Please add a space after the `-`'
 
+    # Matches the tag/attribute-shortcut selector, the `=`-based operator
+    # (`=`, `==`, `=<`, `=>`, `=<>`, `==<`, `==>`, `==<>`), and the whitespace
+    # surrounding the operator, so it can be normalized to a single space on
+    # either side without touching the Ruby code that follows.
+    OUTPUT_SPACING = /^(\s*)(\S+?)(\s*)(=[=<>]*)(\s*)/
+
     on [:html, :tag, anything, [],
          [:slim, :output, anything, capture(:ruby, anything)]] do |sexp|
       # Fetch original Slim code that contains an element with a control statement.
@@ -20,7 +27,8 @@ module SlimLint
 
       next if line =~ /[^ ] ==?<?>? [^ ]/
 
-      report_lint(sexp, MESSAGE_OUTPUT)
+      report_lint(sexp, MESSAGE_OUTPUT,
+                  correction: ->(source_line) { source_line.sub(OUTPUT_SPACING, '\1\2 \4 ') })
     end
 
     on [:slim, :control] do |sexp|
@@ -30,7 +38,8 @@ module SlimLint
 
       next if line =~ /^ *- [^ ]/
 
-      report_lint(sexp, MESSAGE_CONTROL)
+      report_lint(sexp, MESSAGE_CONTROL,
+                  correction: ->(source_line) { source_line.sub(/^(\s*)-\s*/, '\1- ') })
     end
 
     private

data/lib/slim_lint/linter/empty_control_statement.rb

@@ -4,12 +4,14 @@ module SlimLint
   # Searches for control statements with no code.
   class Linter::EmptyControlStatement < Linter
     include LinterRegistry
+    support_autocorrect
 
     on [:slim, :control] do |sexp|
       _, _, code = sexp
       next unless code[/\A\s*\Z/]
 
-      report_lint(sexp, 'Empty control statement can be removed')
+      report_lint(sexp, 'Empty control statement can be removed',
+                  correction: ->(_line) { nil })
     end
   end
 end

data/lib/slim_lint/linter/empty_lines.rb

@@ -5,6 +5,7 @@ module SlimLint
   # and for the first blank line in file.
   class Linter::EmptyLines < Linter
     include LinterRegistry
+    support_autocorrect
 
     on_start do |_sexp|
       dummy_node = Struct.new(:line)
@@ -14,7 +15,8 @@ module SlimLint
         if line.blank?
           if was_empty
             report_lint(dummy_node.new(i + 1),
-                        'Extra empty line detected')
+                        'Extra empty line detected',
+                        correction: ->(_line) { nil })
           end
           was_empty = true
         else

data/lib/slim_lint/linter/trailing_blank_lines.rb

@@ -4,6 +4,7 @@ module SlimLint
   # This linter looks for trailing blank lines and a final newline.
   class Linter::TrailingBlankLines < Linter
     include LinterRegistry
+    support_autocorrect
 
     on_start do |_sexp|
       dummy_node = Struct.new(:line)
@@ -11,10 +12,12 @@ module SlimLint
 
       if !document.source.end_with?("\n")
         report_lint(dummy_node.new(document.source_lines.size),
-                    'No blank line in the end of file')
+                    'No blank line in the end of file',
+                    correction: ->(line) { "#{line}\n" })
       elsif document.source.lines.last.blank?
         report_lint(dummy_node.new(document.source.lines.size),
-                    'Multiple empty lines in the end of file')
+                    'Multiple empty lines in the end of file',
+                    correction: ->(_line) { nil })
       end
     end
   end

data/lib/slim_lint/linter/zwsp.rb

@@ -3,6 +3,7 @@
 module SlimLint
   class Linter::Zwsp < Linter
     include LinterRegistry
+    support_autocorrect
 
     MSG = 'Remove zero-width space'
 
@@ -11,7 +12,8 @@ module SlimLint
       document.source_lines.each_with_index do |line, index|
         next unless line.include?("\u200b")
 
-        report_lint(dummy_node.new(index + 1), MSG)
+        report_lint(dummy_node.new(index + 1), MSG,
+                    correction: ->(source_line) { source_line.delete("\u200b") })
       end
     end
   end

data/lib/slim_lint/linter.rb

@@ -65,7 +65,9 @@ module SlimLint
     # @param node [#line] node to extract the line number from
     # @param message [String] error/warning to display to the user
     # @param correction [Proc, nil] maps the offending line of source to its
-    #   corrected version, for linters that declared {support_autocorrect}
+    #   corrected version, for linters that declared {support_autocorrect}.
+    #   Return `nil` to remove the line entirely, or a string containing
+    #   embedded newlines to replace it with multiple lines.
     def report_lint(node, message, correction: nil)
       return if disabled_for_line?(node.line)
 

data/lib/slim_lint/options.rb

@@ -5,6 +5,10 @@ require 'optparse'
 module SlimLint
   # Handles option parsing for the command line application.
   class Options
+    # Path scanned by default when no files or directories are given on the
+    # command line.
+    DEFAULT_FILES = ['.'].freeze
+
     # Parses command line options into an options hash.
     #
     # @param args [Array<String>] arguments passed via the command line
@@ -13,15 +17,18 @@ module SlimLint
       @options = {}
 
       OptionParser.new do |parser|
-        parser.banner = "Usage: #{APP_NAME} [options] [file1, file2, ...]"
+        parser.banner = "Usage: #{APP_NAME} [options] [file1, file2, ...]\n\n" \
+                        'If no files or directories are given, the current ' \
+                        'directory is scanned by default.'
 
         add_linter_options parser
         add_file_options parser
         add_info_options parser
       end.parse!(args)
 
-      # Any remaining arguments are assumed to be files
-      @options[:files] = args
+      # Any remaining arguments are assumed to be files; fall back to
+      # DEFAULT_FILES when none are given
+      @options[:files] = args.empty? ? DEFAULT_FILES : args
 
       @options
     rescue OptionParser::InvalidOption => e

data/lib/slim_lint/version.rb

@@ -2,5 +2,5 @@
 
 # Defines the gem version.
 module SlimLint
-  VERSION = '0.36.0'
+  VERSION = '0.37.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: slim_lint
 version: !ruby/object:Gem::Version
-  version: 0.36.0
+  version: 0.37.0
 platform: ruby
 authors:
 - Shane da Silva
@@ -168,7 +168,11 @@ files:
 homepage: https://github.com/sds/slim-lint
 licenses:
 - MIT
-metadata: {}
+metadata:
+  bug_tracker_uri: https://github.com/sds/slim-lint/issues
+  changelog_uri: https://github.com/sds/slim-lint/blob/main/CHANGELOG.md
+  source_code_uri: https://github.com/sds/slim-lint
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib