slim_lint 0.35.0 → 0.37.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9478570d94e93349a03f9f7a67789f3c0ff356bd8bd95ee7fe5628248eaaab9
-  data.tar.gz: 23bc11a5e84b251523397d12bcf0c776d8755373fffbfa7ce183353fe8a86b73
+  metadata.gz: 1ab51b789afce474d3a969052cf00dc0760a2d98706aa74d2d5f2daf2c58ad44
+  data.tar.gz: ad86883e7bb179a3f7f7c01c2aad5e07d57c359f790ca3541d3da78f3af17516
 SHA512:
-  metadata.gz: f40d2b1af0278fd5f2ea727f0a7ee39322df8b7c1ddf155ece528ac7f99c8dd8b0284af8d622e05eec9ef229544fd953b1f6a51cea9e11d35c23bba1d7d7c7c3
-  data.tar.gz: 6c96c5b859896bf1a3d04fe1ca336cfae1e7c15bbcb89f5a6143d1b952ec3508febab94dd4fa618fbbed98405bbaed941cd6a94bb3c2e2bad3a1bdc04ddb5574
+  metadata.gz: 7223d666bd6ae4e0c266431a5ab8edd34a89a7862ca6a7b7aca9f7171fcea57016a622ea95794372f11579ad62136e97279d54988f4c5e70f7bc3305f71c916e
+  data.tar.gz: 5de9a96b2055eeeae3f5af80053bf0af37f85d7821c874de7584da6a8a0837811dfe84aca1461c1b7c27c541bef306d08adb73d516a7efb3400790858b1b6d17

data/lib/slim_lint/corrector.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module SlimLint
+  # Applies the corrections attached to a set of lints to a document's
+  # source, producing the corrected source text.
+  class Corrector
+    # @param document [SlimLint::Document] document the lints were reported against
+    def initialize(document)
+      @document = document
+    end
+
+    # 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)
+      # `-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)
+
+      correction_groups(lints).each do |line_number, line_lints|
+        index = line_number - 1
+        next unless index.between?(0, lines.length - 1)
+
+        lines[index, 1] = apply_corrections(lines[index], line_lints)
+      end
+
+      @document.source_prefix + lines.join("\n")
+    end
+
+    private
+
+    # 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/document.rb

@@ -15,6 +15,12 @@ module SlimLint
     # @return [String] original source code
     attr_reader :source
 
+    # @return [String] source code before optional frontmatter removal
+    attr_reader :original_source
+
+    # @return [String] source removed before linting, such as frontmatter
+    attr_reader :source_prefix
+
     # @return [Array<String>] original source code as an array of lines
     attr_reader :source_lines
 
@@ -36,8 +42,9 @@ module SlimLint
     # @param source [String] Slim code to parse
     # @raise [SlimLint::Exceptions::ParseError] if there was a problem parsing the document
     def process_source(source)
-      @source = process_encoding(source)
-      @source = strip_frontmatter(source)
+      @original_source = process_encoding(source)
+      @source = strip_frontmatter(@original_source)
+      @source_prefix = @original_source[0, @original_source.length - @source.length] || ''
       @source_lines = @source.split("\n")
 
       engine = SlimLint::Engine.new(file: @file)

data/lib/slim_lint/lint.rb

@@ -18,6 +18,15 @@ 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
+    #   (`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
+    attr_accessor :corrected
+
     # Creates a new lint.
     #
     # @param linter [SlimLint::Linter]
@@ -25,12 +34,16 @@ module SlimLint
     # @param line [Fixnum]
     # @param message [String]
     # @param severity [Symbol]
-    def initialize(linter, filename, line, message, severity = :warning)
-      @linter   = linter
-      @filename = filename
-      @line     = line || 0
-      @message  = message
-      @severity = severity
+    # @param correction [Proc, nil] maps a line of source to its corrected version
+    def initialize(linter, filename, line, message, severity = :warning, # rubocop:disable Metrics/ParameterLists
+                   correction: nil)
+      @linter     = linter
+      @filename   = filename
+      @line       = line || 0
+      @message    = message
+      @severity   = severity
+      @correction = correction
+      @corrected  = false
     end
 
     # Return whether this lint has a severity of error.
@@ -39,5 +52,19 @@ module SlimLint
     def error?
       @severity == :error
     end
+
+    # Return whether this lint has a known automatic correction.
+    #
+    # @return [Boolean]
+    def correctable?
+      !@correction.nil?
+    end
+
+    # Return whether this lint's correction has been applied.
+    #
+    # @return [Boolean]
+    def corrected?
+      @corrected
+    end
   end
 end

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/quote_consistency.rb

@@ -4,6 +4,7 @@ module SlimLint
   # Checks for consistent quote usage in HTML attributes
   class Linter::QuoteConsistency < Linter
     include LinterRegistry
+    support_autocorrect
 
     MSG = 'Inconsistent quote style. %s'
 
@@ -19,15 +20,42 @@ module SlimLint
 
       if enforced_style == :single_quotes && double_quotes.any?
         report_lint(node,
-                    format(MSG, "Use single quotes for attribute values (')"))
+                    format(MSG, "Use single quotes for attribute values (')"),
+                    correction: ->(source_line) { correct_quotes(source_line, '"', "'") })
       elsif enforced_style == :double_quotes && single_quotes.any?
         report_lint(node,
-                    format(MSG, 'Use double quotes for attribute values (")'))
+                    format(MSG, 'Use double quotes for attribute values (")'),
+                    correction: ->(source_line) { correct_quotes(source_line, "'", '"') })
       end
     end
 
     private
 
+    def correct_quotes(source_line, from, to)
+      state = { quote: nil, corrected: [] }
+      source_line.scan(/\\.|['"]|[^\\'"]+/).each do |token|
+        correct_quote_token(token, state, from, to)
+      end
+      state[:corrected].join
+    end
+
+    def correct_quote_token(token, state, from, to)
+      return state[:corrected] << token if token.length > 1 || token.start_with?('\\')
+
+      if state[:quote]
+        close_quote_token(token, state, from, to)
+      else
+        state[:quote] = token
+        state[:corrected] << (token == from ? to : token)
+      end
+    end
+
+    def close_quote_token(token, state, from, to)
+      replacement = token == state[:quote] && token == from ? to : token
+      state[:corrected] << replacement
+      state[:quote] = nil if token == state[:quote]
+    end
+
     def enforced_style
       config['enforced_style']&.to_sym || :single_quotes
     end

data/lib/slim_lint/linter/redundant_div.rb

@@ -5,6 +5,7 @@ module SlimLint
   # already implies a div.
   class Linter::RedundantDiv < Linter
     include LinterRegistry
+    support_autocorrect
 
     MESSAGE = '`div` is redundant when %s attribute shortcut is present'
 
@@ -16,7 +17,8 @@ module SlimLint
       attr = captures[:attr_name]
       next unless %w[class id].include?(attr)
 
-      report_lint(sexp, MESSAGE % attr)
+      report_lint(sexp, MESSAGE % attr,
+                  correction: ->(line) { line.sub(/\bdiv(?=[.#])/, '') })
     end
   end
 end

data/lib/slim_lint/linter/tag_case.rb

@@ -4,12 +4,16 @@ module SlimLint
   # Searches for tags with uppercase characters.
   class Linter::TagCase < Linter
     include LinterRegistry
+    support_autocorrect
 
     on [:html, :tag] do |sexp|
       _, _, name = sexp
       next unless name[/[A-Z]/]
 
-      report_lint(sexp, "Tag `#{name}` should be written as `#{name.downcase}`")
+      report_lint(sexp, "Tag `#{name}` should be written as `#{name.downcase}`",
+                  correction: ->(line) {
+                    line.sub(/\b#{Regexp.escape(name.to_s)}\b/, name.downcase)
+                  })
     end
   end
 end

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/trailing_whitespace.rb

@@ -4,6 +4,7 @@ module SlimLint
   # Checks for trailing whitespace.
   class Linter::TrailingWhitespace < Linter
     include LinterRegistry
+    support_autocorrect
 
     on_start do |_sexp|
       dummy_node = Struct.new(:line)
@@ -12,7 +13,8 @@ module SlimLint
         next unless line =~ /\s+$/
 
         report_lint(dummy_node.new(index + 1),
-                    'Line contains trailing whitespace')
+                    'Line contains trailing whitespace',
+                    correction: lambda(&:rstrip))
       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

@@ -15,6 +15,21 @@ module SlimLint
     #   lints for the subject instead of the linter itself.
     attr_reader :lints
 
+    class << self
+      # Declares that this linter can automatically correct (some of) the
+      # offenses it reports.
+      def support_autocorrect
+        @supports_autocorrect = true
+      end
+
+      # Returns whether this linter declared autocorrect support.
+      #
+      # @return [Boolean]
+      def supports_autocorrect?
+        @supports_autocorrect || false
+      end
+    end
+
     # Initializes a linter with the specified configuration.
     #
     # @param config [Hash] configuration for this linter
@@ -49,10 +64,15 @@ module SlimLint
     #
     # @param node [#line] node to extract the line number from
     # @param message [String] error/warning to display to the user
-    def report_lint(node, message)
+    # @param correction [Proc, nil] maps the offending line of source to its
+    #   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)
 
-      @lints << SlimLint::Lint.new(self, @document.file, node.line, message)
+      @lints << SlimLint::Lint.new(self, @document.file, node.line, message,
+                                   correction: correction)
     end
 
     # Parse Ruby code into an abstract syntax tree.

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
@@ -48,6 +55,11 @@ module SlimLint
                 'Specify which reporter you want to use to generate the output') do |reporter|
         @options[:reporter] = load_reporter_class(reporter.capitalize)
       end
+
+      parser.on('-a', '--autocorrect',
+                'Automatically correct offenses that support it') do
+        @options[:autocorrect] = true
+      end
     end
 
     # Returns the class of the specified Reporter.

data/lib/slim_lint/report.rb

@@ -19,7 +19,7 @@ module SlimLint
     end
 
     def failed?
-      @lints.any?
+      @lints.any? { |lint| !lint.corrected? }
     end
   end
 end

data/lib/slim_lint/reporter/default_reporter.rb

@@ -35,7 +35,8 @@ module SlimLint
         log.success("#{lint.linter.name}: ", false)
       end
 
-      log.log lint.message
+      log.log lint.message, false
+      lint.corrected? ? log.success(' [Corrected]') : log.newline
     end
   end
 end

data/lib/slim_lint/runner.rb

@@ -20,7 +20,8 @@ module SlimLint
       if options[:stdin_file_path].nil?
         files = extract_applicable_files(config, options)
         lints = files.map do |file|
-          collect_lints(File.read(file), file, linter_selector, config)
+          collect_lints(File.read(file), file, linter_selector, config,
+                        autocorrect: options[:autocorrect])
         end.flatten
       else
         files = [options[:stdin_file_path]]
@@ -53,16 +54,34 @@ module SlimLint
     # @param file [String] path to file to lint
     # @param linter_selector [SlimLint::LinterSelector]
     # @param config [SlimLint::Configuration]
-    def collect_lints(file_content, file_name, linter_selector, config)
+    # @param autocorrect [Boolean] whether to write corrections back to the file
+    def collect_lints(file_content, file_name, linter_selector, config, autocorrect: false)
       begin
         document = SlimLint::Document.new(file_content, file: file_name, config: config)
       rescue SlimLint::Exceptions::ParseError => e
         return [SlimLint::Lint.new(nil, file_name, e.lineno, e.error, :error)]
       end
 
-      linter_selector.linters_for_file(file_name).map do |linter|
+      lints = linter_selector.linters_for_file(file_name).map do |linter|
         linter.run(document)
       end.flatten
+
+      correct_lints(document, file_name, lints) if autocorrect
+
+      lints
+    end
+
+    # Applies any available corrections to the given file's lints and writes
+    # the result back to disk if anything changed.
+    #
+    # @param document [SlimLint::Document]
+    # @param file_name [String] path to file to correct
+    # @param lints [Array<SlimLint::Lint>]
+    def correct_lints(document, file_name, lints)
+      corrected_source = SlimLint::Corrector.new(document).correct(lints)
+      return if corrected_source == document.original_source
+
+      File.write(file_name, corrected_source)
     end
 
     # Returns the list of files that should be linted given the specified

data/lib/slim_lint/version.rb

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

data/lib/slim_lint.rb

@@ -30,6 +30,7 @@ require_relative 'slim_lint/sexp_visitor'
 require_relative 'slim_lint/lint'
 require_relative 'slim_lint/ruby_parser'
 require_relative 'slim_lint/linter'
+require_relative 'slim_lint/corrector'
 require_relative 'slim_lint/reporter'
 require_relative 'slim_lint/report'
 require_relative 'slim_lint/linter_selector'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: slim_lint
 version: !ruby/object:Gem::Version
-  version: 0.35.0
+  version: 0.37.0
 platform: ruby
 authors:
 - Shane da Silva
@@ -109,6 +109,7 @@ files:
 - lib/slim_lint/configuration.rb
 - lib/slim_lint/configuration_loader.rb
 - lib/slim_lint/constants.rb
+- lib/slim_lint/corrector.rb
 - lib/slim_lint/document.rb
 - lib/slim_lint/engine.rb
 - lib/slim_lint/exceptions.rb
@@ -167,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