haml_lint 0.53.0 → 0.76.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 49bb0bec15e96c047439560e80f83eaf6f4c3baec24a12b1f10248f1d2f347d3
-  data.tar.gz: 153f65eda76c5751bbae1d02fc49d0d4477f401bb273096ad9308868b9d21288
+  metadata.gz: 188328ae96f24b3a739665a5d3ccc7271a753afbe0ae63a1fbe3f33897492caa
+  data.tar.gz: 52b39c0992433545f610c7c18af3d06b224027edea3a9cdb97f71c7c1cf4f8c5
 SHA512:
-  metadata.gz: a4d2c2682e7b12d9aaf8164054f3533c0667f5f6035bfbf5ef6bbb694a40f9a70d9d13a9aa56dabf27131be27e74d346c9eff642a65d0e2aac8992ebc1999fba
-  data.tar.gz: 343aee9ed9bf4a766640aabbbaf96af9a5c36261fb6e6943b9a0b9eadcb5c75bc5a15665cae30c3c4c8925b307ecca837130fb04cf1d14a74549978db235f60c
+  metadata.gz: 31c53c1177acc7679c9f3c5b633a2b14278252f447ddea3b03c9d49e82d6e3d4587d44803e7b2b5ca677b726702c1a716cb02c848b8d2b71ed7bd402b78d8519
+  data.tar.gz: 253e971535ea2d8c38340e2e13a882fbe215cded72f5faa96b26dd88bb39024efe5b03d8334cc7692de4edbab2a7e49db9d4bb55a6a55e10319b52e3770a9ea4

data/config/default.yml

@@ -3,7 +3,7 @@
 # This is an opinionated list of which hooks are valuable to run and what their
 # out of the box settings should be.
 
-# Whether to ignore frontmatter at the beginning of HAML documents for
+# Whether to ignore frontmatter at the beginning of Haml documents for
 # frameworks such as Jekyll/Middleman
 skip_frontmatter: false
 
@@ -50,8 +50,8 @@ linters:
 
   Indentation:
     enabled: true
-    character: space # or tab
-    width: 2 # ignored if character == tab
+    character: space  # or tab
+    width: 2  # ignored if character == tab
 
   InlineStyles:
     enabled: true
@@ -88,8 +88,10 @@ linters:
 
   RuboCop:
     enabled: true
-    # Users can ignore cops using this configuration instead of editing their rubocop configuration.
-    # Mostly there for backward compatibility.
+    # Cops listed here are skipped entirely (passed to RuboCop via `--except`), both when
+    # reporting and when auto-correcting. This is the way to disable a cop only for Haml files,
+    # and the only way to disable a forced cop (see config/forced_rubocop_config.yml), since the
+    # forced configuration always overrides `Enabled: false` set in your own .rubocop.yml.
     ignored_cops: []
 
   RubyComments:
@@ -102,6 +104,13 @@ linters:
     enabled: true
     style: space
 
+  StrictLocals:
+    enabled: false
+    file_types: partials
+    matchers:
+      all: .*
+      partials: \A_.*\.haml\z
+
   TagName:
     enabled: true
 
@@ -111,6 +120,9 @@ linters:
   TrailingWhitespace:
     enabled: true
 
+  UnescapedHtml:
+    enabled: true
+
   UnnecessaryInterpolation:
     enabled: true
 

data/config/forced_rubocop_config.yml

@@ -1,7 +1,7 @@
 # These are some configurations that are required for RuboCop because:
-# * HAML-Lint compiles ruby code with a particular format. If the rules mis-match that format,
-#   HAML-Lint would generate lints that the user cannot fix.
-# * HAML-Lint can autocorrect code only if the result matches some specific format
+# * Haml-Lint compiles ruby code with a particular format. If the rules mis-match that format,
+#   Haml-Lint would generate lints that the user cannot fix.
+# * Haml-Lint can autocorrect code only if the result matches some specific format
 #
 # So these configuration should not be overwritable by users.
 
@@ -31,20 +31,32 @@ Layout/CaseIndentation:
   IndentOneStep: false # Need to force the `false`
 
 # Need this cop so that code gets formatted similarly to Haml's indentation,
-# since HAML-Lint relies on Ruby's indentation being the same as Haml's.
+# since Haml-Lint relies on Ruby's indentation being the same as Haml's.
 Layout/ElseAlignment:
   Enabled: true
 
 # Need this cop so that code gets formatted similarly to Haml's indentation,
-# since HAML-Lint relies on Ruby's indentation being the same as Haml's.
+# since Haml-Lint relies on Ruby's indentation being the same as Haml's.
 Layout/EndAlignment:
   EnforcedStyleAlignWith: start_of_line
   Enabled: true
 
-# We generate the ruby content, this is basically useless and should be a lint in HAML-Lint
+# We generate the ruby content, this is basically useless and should be a lint in Haml-Lint
 Layout/EndOfLine:
   Enabled: false
 
+# Complying with this lint requires the use of pipes which causes a conflict with MultilinePipe.
+Layout/FirstArrayElementLineBreak:
+  Enabled: false
+
+# Complying with this lint requires the use of pipes which causes a conflict with MultilinePipe.
+Layout/FirstHashElementLineBreak:
+  Enabled: false
+
+# Complying with this lint requires the use of pipes which causes a conflict with MultilinePipe.
+Layout/FirstMethodArgumentLineBreak:
+  Enabled: false
+
 # Turning this cop on can turn
 # = content_tag(:span) do
 #   - foo
@@ -78,14 +90,14 @@ Metrics/BlockNesting:
 Naming/FileName:
   Enabled: false
 
-# HAML doesn't properly support multiline blocks using { }, only using do/end.
+# Haml doesn't properly support multiline blocks using { }, only using do/end.
 # If you don't consider the { } block for indentation, things "works", but the indentation is misleading.
 # For example, this works:
 # - a = lambda {
 # - if abc
 #  - something
 # - }
-# But if you indented the 2 lines within { }, then HAML would add an extra `end` and the generated
+# But if you indented the 2 lines within { }, then Haml would add an extra `end` and the generated
 # ruby would be invalid.
 Style/BlockDelimiters:
   # So we need this cop to cleanup those cases and turn them to `end`.
@@ -94,7 +106,7 @@ Style/BlockDelimiters:
   # We don't allow the default "Can be anything" exception for lambda/proc
   <%= rubocop_version < '1.33' ? 'IgnoredMethods' : 'AllowedMethods' %>: []
 
-# We don't support correcting HAML comments
+# We don't support correcting Haml comments
 Style/CommentAnnotation:
   AutoCorrect: false
 
@@ -132,7 +144,7 @@ Style/RedundantStringEscape:
 <% end %>
 
 # In some case, this cop can cause a change in the spacing.
-# In HAML 5.2, going from (absurd example for clarity):
+# In Haml 5.2, going from (absurd example for clarity):
 #   = 'abc' rescue nil
 #   = 'def'
 # to:
@@ -149,7 +161,7 @@ Style/RescueModifier:
 
 # Cops that remove commas can be a problem when lines are split on multiple ones.
 # If we have a big array on more than one line, the removal of the comma generates
-# invalid HAML
+# invalid Haml
 Style/SymbolArray:
   Enabled: false
 
@@ -158,7 +170,7 @@ Style/UnlessElse:
   AutoCorrect: false
 
 # If an array of strings was on multiple lines, this cop will make a %w(...) on multiple lines.
-# Without the comma at the end of the first line, there the resulting HAML will be invalid, since the only
+# Without the comma at the end of the first line, there the resulting Haml will be invalid, since the only
 # case where a script can change line is after a comma.
 Style/WordArray:
   AutoCorrect: false
@@ -169,7 +181,7 @@ Layout/TrailingEmptyLines:
 
 <% if rubocop_version < '1.8.1' %>
 # There were a few bugs with this cop that got fixed in this version.
-# Before, those bugs would generate invalid Ruby code and that would make it look like HAML-lint is
+# Before, those bugs would generate invalid Ruby code and that would make it look like Haml-lint is
 # responsible, at least from the user's point of view.
 Style/StringConcatenation:
   Enabled: false

data/lib/haml_lint/adapter.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'haml_lint/adapter/haml_5'
-require 'haml_lint/adapter/haml_6'
-require 'haml_lint/exceptions'
+require_relative 'adapter/haml_5'
+require_relative 'adapter/haml_6'
+require_relative 'exceptions'
 
 module HamlLint
   # Determines the adapter to use for the current Haml version
@@ -19,7 +19,8 @@ module HamlLint
       version = haml_version
       case version
       when '~> 5.0', '~> 5.1', '~> 5.2' then HamlLint::Adapter::Haml5
-      when '~> 6.0', '~> 6.0.a', '~> 6.1', '~> 6.2', '~> 6.3' then HamlLint::Adapter::Haml6
+      when '~> 6.0', '~> 6.0.a', '~> 6.1', '~> 6.2', '~> 6.3', '~> 6.4' then HamlLint::Adapter::Haml6
+      when '~> 7.0', '~> 7.1', '~> 7.2' then HamlLint::Adapter::Haml6
       else fail HamlLint::Exceptions::UnknownHamlVersion, "Cannot handle Haml version: #{version}"
       end
     end

data/lib/haml_lint/cli.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'haml_lint'
-require 'haml_lint/options'
+require_relative '../haml_lint'
+require_relative 'options'
 
 require 'sysexits'
 
@@ -100,7 +100,11 @@ module HamlLint
     # @return [HamlLint::Reporter]
     def reporter_from_options(options)
       if options[:auto_gen_config]
-        HamlLint::Reporter::DisabledConfigReporter.new(log, limit: options[:auto_gen_exclude_limit] || 15)
+        HamlLint::Reporter::DisabledConfigReporter.new(
+          log,
+          limit: options[:auto_gen_exclude_limit] || HamlLint::Reporter::DisabledConfigReporter::DEFAULT_EXCLUDE_LIMIT,
+          options: options
+        )
       else
         options.fetch(:reporter, HamlLint::Reporter::DefaultReporter).new(log)
       end

data/lib/haml_lint/constants.rb

@@ -6,5 +6,5 @@ module HamlLint
   APP_NAME = 'haml-lint'
 
   REPO_URL = 'https://github.com/sds/haml-lint'
-  BUG_REPORT_URL = "#{REPO_URL}/issues"
+  BUG_REPORT_URL = "#{REPO_URL}/issues".freeze
 end

data/lib/haml_lint/directive.rb

@@ -3,7 +3,7 @@
 module HamlLint
   # Handles linter configuration transformation via Haml comments.
   class Directive
-    LINTER_REGEXP = /(?:[A-Z]\w+)/.freeze
+    LINTER_REGEXP = /(?:[A-Z]\w+)/
 
     DIRECTIVE_REGEXP = /
       # "haml-lint:" with optional spacing
@@ -14,7 +14,7 @@ module HamlLint
 
       # "all" or a comma-separated list (with optional spaces) of linters
       (?<linters>all | (?:#{LINTER_REGEXP}\s*,\s*)* #{LINTER_REGEXP})
-    /x.freeze
+    /x
 
     # Constructs a directive from source code as a given line.
     #

data/lib/haml_lint/document.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'haml_lint/adapter'
+require_relative 'adapter'
 
 module HamlLint
   # Represents a parsed Haml document and its associated metadata.
@@ -14,6 +14,9 @@ module HamlLint
     # @return [String] Haml template file path
     attr_reader :file
 
+    # @return [Boolean] true if source changes (from autocorrect) should be written to stdout instead of disk
+    attr_reader :write_to_stdout
+
     # @return [HamlLint::Tree::Node] Root of the parse tree
     attr_reader :tree
 
@@ -36,10 +39,12 @@ module HamlLint
     # @param source [String] Haml code to parse
     # @param options [Hash]
     # @option options :file [String] file name of document that was parsed
+    # @option options :write_to_stdout [Boolean] true if source changes should be written to stdout
     # @raise [Haml::Parser::Error] if there was a problem parsing the document
     def initialize(source, options)
       @config = options[:config]
       @file = options.fetch(:file, STRING_SOURCE)
+      @write_to_stdout = options[:write_to_stdout]
       @source_was_changed = false
       process_source(source)
     end
@@ -82,7 +87,11 @@ module HamlLint
       if file == STRING_SOURCE
         raise HamlLint::Exceptions::InvalidFilePath, 'Cannot write without :file option'
       end
-      File.write(file, unstrip_frontmatter(source))
+      if @write_to_stdout
+        $stdout << unstrip_frontmatter(source)
+      else
+        File.write(file, unstrip_frontmatter(source))
+      end
       @source_was_changed = false
     end
 
@@ -123,8 +132,8 @@ module HamlLint
     # @param original_tree [Haml::Parser::ParseNode]
     # @return [Haml::Tree::Node]
     def process_tree(original_tree)
-      # Remove the trailing empty HAML comment that the parser creates to signal
-      # the end of the HAML document
+      # Remove the trailing empty Haml comment that the parser creates to signal
+      # the end of the Haml document
       if Gem::Requirement.new('~> 4.0.0').satisfied_by?(Gem.loaded_specs['haml'].version)
         original_tree.children.pop
       end
@@ -133,7 +142,7 @@ module HamlLint
       convert_tree(original_tree)
     end
 
-    # Converts a HAML parse tree to a tree of {HamlLint::Tree::Node} objects.
+    # Converts a Haml parse tree to a tree of {HamlLint::Tree::Node} objects.
     #
     # This provides a cleaner interface with which the linters can interact with
     # the parse tree.

data/lib/haml_lint/exceptions.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Collection of exceptions that can be raised by the HAML Lint application.
+# Collection of exceptions that can be raised by the Haml Lint application.
 module HamlLint::Exceptions
   # Raised when a {Configuration} could not be loaded from a file.
   class ConfigurationError < StandardError; end
@@ -17,7 +17,7 @@ module HamlLint::Exceptions
   # Raised when an invalid file path is specified
   class InvalidFilePath < StandardError; end
 
-  # Raised when a problem occurs parsing a HAML document.
+  # Raised when a problem occurs parsing a Haml document.
   class ParseError < ::Haml::SyntaxError; end
 
   # Raised when attempting to execute `Runner` with options that would result in

data/lib/haml_lint/extensions/haml_util_unescape_interpolation_tracking.rb

@@ -14,8 +14,8 @@ module Haml::Util
     Thread.current[:haml_lint_unescape_interpolation_to_original_cache] ||= {}
   end
 
-  # As soon as a HamlLint::Document has finished processing a HAML souce, this gets called to
-  # get a copy of this cache and clear up for the next HAML processing
+  # As soon as a HamlLint::Document has finished processing a Haml source, this gets called to
+  # get a copy of this cache and clear up for the next Haml processing
   def self.unescape_interpolation_to_original_cache_take_and_wipe
     value = unescape_interpolation_to_original_cache.dup
     unescape_interpolation_to_original_cache.clear

data/lib/haml_lint/haml_visitor.rb

@@ -2,7 +2,7 @@
 
 module HamlLint
   # Provides an interface which when included allows a class to visit nodes in
-  # the parse tree of a HAML document.
+  # the parse tree of a Haml document.
   module HamlVisitor
     def visit(node)
       # Keep track of whether this block was consumed by the visitor. This

data/lib/haml_lint/lint.rb

@@ -1,11 +1,14 @@
 # frozen_string_literal: true
 
 module HamlLint
-  # Contains information about a problem or issue with a HAML document.
+  # Contains information about a problem or issue with a Haml document.
   class Lint
     # @return [Boolean] If the error was corrected by auto-correct
     attr_reader :corrected
 
+    # @return [Boolean] If the error could be corrected by auto-correct
+    attr_reader :correctable
+
     # @return [String] file path to which the lint applies
     attr_reader :filename
 
@@ -28,13 +31,14 @@ module HamlLint
     # @param line [Fixnum]
     # @param message [String]
     # @param severity [Symbol]
-    def initialize(linter, filename, line, message, severity = :warning, corrected: false) # rubocop:disable Metrics/ParameterLists
+    def initialize(linter, filename, line, message, severity = :warning, corrected: false, correctable: false) # rubocop:disable Metrics/ParameterLists
       @linter   = linter
       @filename = filename
       @line     = line || 0
       @message  = message
       @severity = Severity.new(severity)
       @corrected = corrected
+      @correctable = correctable
     end
 
     # Return whether this lint has a severity of error.
@@ -45,7 +49,8 @@ module HamlLint
     end
 
     def inspect
-      "#{self.class.name}(corrected=#{corrected}, filename=#{filename}, line=#{line}, " \
+      "#{self.class.name}(corrected=#{corrected}, correctable=#{correctable}, " \
+        "filename=#{filename}, line=#{line}, " \
         "linter=#{linter.class.name}, message=#{message}, severity=#{severity})"
     end
   end

data/lib/haml_lint/linter/alignment_tabs.rb

@@ -3,12 +3,29 @@
 module HamlLint
   # Checks for tabs that are placed for alignment of tag content
   class Linter::AlignmentTabs < Linter
-    REGEX = /[^\s*]\t+/.freeze
+    include LinterRegistry
+
+    supports_autocorrect(true)
+    autocorrect_safe(false)
+
+    REGEX = /[^\s*]\t+/
+    # Same as +REGEX+, but captures the character preceding the alignment tabs
+    # so it can be kept while the tabs themselves are collapsed to a space.
+    CORRECTION_REGEX = /([^\s*])\t+/
 
     def visit_tag(node)
-      if REGEX.match?(node.source_code)
-        record_lint(node, 'Avoid using tabs for alignment')
-      end
+      return unless REGEX.match?(node.source_code)
+
+      record_lint(node, 'Avoid using tabs for alignment', corrected: correct(node))
+    end
+
+    private
+
+    # @return [Boolean] whether a correction was applied
+    def correct(node)
+      index = node.line - 1
+      line = autocorrected_lines[index]
+      correct_line(index, line.gsub(CORRECTION_REGEX) { "#{::Regexp.last_match(1)} " })
     end
   end
 end

data/lib/haml_lint/linter/class_attribute_with_static_value.rb

@@ -18,15 +18,19 @@ module HamlLint
   class Linter::ClassAttributeWithStaticValue < Linter
     include LinterRegistry
 
+    supports_autocorrect(true)
+
     STATIC_TYPES = %i[str sym].freeze
 
-    VALID_CLASS_REGEX = /^-?[_a-zA-Z]+[_a-zA-Z0-9-]*$/.freeze
+    VALID_CLASS_REGEX = /^-?[_a-zA-Z]+[_a-zA-Z0-9-]*$/
 
     def visit_tag(node)
-      return unless contains_class_attribute?(node.dynamic_attributes_sources)
+      class_value = static_class_value(node.dynamic_attributes_sources)
+      return unless class_value
 
+      corrected = correct_class_attribute(node, class_value)
       record_lint(node, 'Avoid defining `class` in attributes hash ' \
-                        'for static class names')
+                        'for static class names', corrected: corrected)
     end
 
     private
@@ -35,28 +39,64 @@ module HamlLint
       code.start_with?('{') && code.end_with?('}')
     end
 
-    def contains_class_attribute?(attributes_sources)
+    # @return [String, nil]
+    def static_class_value(attributes_sources)
       attributes_sources.each do |code|
         ast_root = parse_ruby(surrounded_by_braces?(code) ? code : "{#{code}}")
         next unless ast_root # RuboCop linter will report syntax errors
 
         ast_root.children.each do |pair|
-          return true if static_class_attribute_value?(pair)
+          value = static_class_attribute_value(pair)
+          return value if value
         end
       end
 
-      false
+      nil
     end
 
-    def static_class_attribute_value?(pair)
-      return false if (children = pair.children).empty?
+    # @return [String, nil]
+    def static_class_attribute_value(pair)
+      return nil if (children = pair.children).empty?
 
       key, value = children
 
-      STATIC_TYPES.include?(key.type) &&
-        key.children.first.to_sym == :class &&
-        STATIC_TYPES.include?(value.type) &&
-        value.children.first =~ VALID_CLASS_REGEX
+      return nil unless STATIC_TYPES.include?(key.type) &&
+                        key.children.first.to_sym == :class &&
+                        STATIC_TYPES.include?(value.type)
+
+      class_name = value.children.first.to_s
+      VALID_CLASS_REGEX.match?(class_name) ? class_name : nil
+    end
+
+    # @return [Boolean]
+    def correct_class_attribute(node, class_value)
+      hash_source = node.hash_attributes_source
+      return false unless hash_source
+      return false if hash_source.include?("\n")
+      return false unless node.dynamic_attributes_source.keys == [:hash]
+      return false unless sole_pair?(node.dynamic_attributes_sources)
+      return false if node.static_classes.flatten.include?(class_value)
+
+      index = node.line - 1
+      line = autocorrected_lines[index]
+      old = "#{node.static_attributes_source}#{hash_source}"
+      return false unless line.include?(old)
+
+      new = "#{node.static_attributes_source}.#{class_value}"
+      correct_line(index, line.sub(old, new))
+    end
+
+    # Whether the attribute hash contains exactly one key/value pair (the class).
+    #
+    # @return [Boolean]
+    def sole_pair?(attributes_sources)
+      return false unless attributes_sources.size == 1
+
+      code = attributes_sources.first
+      ast_root = parse_ruby(surrounded_by_braces?(code) ? code : "{#{code}}")
+      return false unless ast_root
+
+      ast_root.children.size == 1
     end
   end
 end

data/lib/haml_lint/linter/classes_before_ids.rb

@@ -5,11 +5,7 @@ module HamlLint
   class Linter::ClassesBeforeIds < Linter
     include LinterRegistry
 
-    # Map of prefixes to the type of tag component
-    TYPES_BY_PREFIX = {
-      '.' => :class,
-      '#' => :id,
-    }.freeze
+    supports_autocorrect(true)
 
     MSG = '%s should be listed before %s (%s should precede %s)'
 
@@ -23,14 +19,27 @@ module HamlLint
         next unless next_val.start_with?(first) &&
                     current_val.start_with?(second)
 
+        corrected = correct_attribute_order(node, components)
         failure_message = format(MSG, *(attribute_type_order + [next_val, current_val]))
-        record_lint(node, failure_message)
+        record_lint(node, failure_message, corrected: corrected)
         break
       end
     end
 
     private
 
+    # @param node [HamlLint::Tree::TagNode]
+    # @param components [Array<String>] the `.class`/`#id` components in source order
+    # @return [Boolean]
+    def correct_attribute_order(node, components)
+      classes, ids = components.partition { |component| component.start_with?('.') }
+      new_source = (ids_first? ? ids + classes : classes + ids).join
+
+      index = node.line - 1
+      line = autocorrected_lines[index]
+      correct_line(index, line.sub(node.static_attributes_source, new_source))
+    end
+
     def attribute_prefix_order
       default = %w[. #]
       default.reverse! if ids_first?

data/lib/haml_lint/linter/consecutive_comments.rb

@@ -5,6 +5,9 @@ module HamlLint
   class Linter::ConsecutiveComments < Linter
     include LinterRegistry
 
+    supports_autocorrect(true)
+    autocorrect_safe(false)
+
     COMMENT_DETECTOR = ->(child) { child.type == :haml_comment }
 
     def visit_haml_comment(node)
@@ -16,13 +19,29 @@ module HamlLint
         config['max_consecutive'] + 1,
       ) do |group|
         group.each { |group_node| reported_nodes << group_node }
+        corrected = correct_group(group)
         record_lint(group.first,
-                    "#{group.count} consecutive comments can be merged into one")
+                    "#{group.count} consecutive comments can be merged into one",
+                    corrected: corrected)
       end
     end
 
     private
 
+    # @return [Boolean]
+    def correct_group(group)
+      first_index = group.first.line - 1
+      continuation_indent = "#{autocorrected_lines[first_index][/\A\s*/]}   "
+
+      changed = false
+      group[1..].each do |group_node|
+        index = group_node.line - 1
+        line = autocorrected_lines[index]
+        changed = true if correct_line(index, continuation_indent + line.sub(/\A\s*-#\s?/, ''))
+      end
+      changed
+    end
+
     def possible_group(node)
       node.subsequents.unshift(node)
     end