haml_lint 0.59.0 → 0.61.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 15d3baf951722e2a699bc903a0848affa4a05b38939c67554e0410dfb9b817bb
-  data.tar.gz: d143ca9d7330ff3f4d7e32fa306be4a520258627f34b0ddd7536964ebdd45c05
+  metadata.gz: 62ac7e2f95151a5906ccd99c47f5d948db8502aedf5423fa421666e90922d79e
+  data.tar.gz: 39f4f0952d37d191662215f919a1ee62bf38a4a9f93b4b5ad87545f334a97f6b
 SHA512:
-  metadata.gz: 85296a42fbb76f5033401ecd2825efafe5efad954ec2e312af2133a468afe1b92f1c95269a571cbfe9cc9366ecc244a257d7e3e4b756911c921820f7d181beb1
-  data.tar.gz: 90309db3dbfa97deb00561fd6479d82e14519fe3ba59bcc80da456731ab3c830afe389bd958df382748b3d0906fdde4a3c7abe110b99151d1be797e4e1cde63f
+  metadata.gz: 21bdfc9e4ac041b44dbf6ca6d1ceca373f54d210c5c6035bc9e47ff0be3c772a4fcbfcbd4b3fe0131facb3e42a816d9a8d7dbae824bf66198a3453daff8c865a
+  data.tar.gz: 2a459e90165257a12086205ff8bad69dd39845873e7d95888788f56b538be330f69bca13deb3c993ae77d05e7f8c43586db3be737a9d3af178adcc2919a6f9fd

data/config/default.yml

@@ -102,6 +102,13 @@ linters:
     enabled: true
     style: space
 
+  StrictLocals:
+    enabled: false
+    file_types: partials
+    matchers:
+      all: .*
+      partials: \A_.*\.haml\z
+
   TagName:
     enabled: true
 

data/config/forced_rubocop_config.yml

@@ -45,6 +45,18 @@ Layout/EndAlignment:
 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

data/lib/haml_lint/linter/instance_variables.rb

@@ -21,7 +21,7 @@ module HamlLint
       return unless enabled?
 
       if node.parsed_script.contains_instance_variables?
-        record_lint(node, "Avoid using instance variables in #{file_types} views")
+        record_lint(node, failure_message)
       end
     end
 
@@ -41,10 +41,27 @@ module HamlLint
 
       visit_script(node) ||
         if node.parsed_attributes.contains_instance_variables?
-          record_lint(node, "Avoid using instance variables in #{file_types} views")
+          record_lint(node, failure_message)
         end
     end
 
+    # Checks for instance variables in :ruby filters when the linter is enabled.
+    #
+    # @param [HamlLint::Tree::FilterNode]
+    # @return [void]
+    def visit_filter(node)
+      return unless enabled?
+      return unless node.filter_type == 'ruby'
+      return unless ast = parse_ruby(node.text)
+
+      ast.each_node do |i|
+        if i.type == :ivar
+          record_lint(node, failure_message)
+          break
+        end
+      end
+    end
+
     private
 
     # Tracks whether the linter is enabled for the file.
@@ -75,5 +92,13 @@ module HamlLint
     def matcher
       @matcher ||= Regexp.new(config['matchers'][file_types] || '\A_.*\.haml\z')
     end
+
+    # The error message when an ivar is found
+    #
+    # @api private
+    # @return [String]
+    def failure_message
+      "Avoid using instance variables in #{file_types} views"
+    end
   end
 end

data/lib/haml_lint/linter/strict_locals.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module HamlLint
+  # Checks for the presence of a `locals` magic comment at the beginning of a partial.
+  class Linter::StrictLocals < Linter
+    include LinterRegistry
+
+    DummyNode = Struct.new(:line)
+
+    # Enables the linter if the tree is for the right file type.
+    #
+    # @param [HamlLint::Tree::RootNode] the root of a syntax tree
+    # @return [true, false] whether the linter is enabled for the tree
+    def visit_root(root)
+      return unless enabled?(root)
+
+      first_children = root.children.first
+      return if first_children.is_a?(HamlLint::Tree::HamlCommentNode) &&
+                    first_children.is_strict_locals?
+
+      record_lint(DummyNode.new(1), failure_message)
+    end
+
+    private
+
+    # Checks whether the linter is enabled for the file.
+    #
+    # @api private
+    # @return [true, false]
+    def enabled?(root)
+      matcher.match(File.basename(root.file)) ? true : false
+    end
+
+    # The type of files the linter is configured to check.
+    #
+    # @api private
+    # @return [String]
+    def file_types
+      @file_types ||= config['file_types'] || 'partial'
+    end
+
+    # The matcher to use for testing whether to check a file by file name.
+    #
+    # @api private
+    # @return [Regexp]
+    def matcher
+      @matcher ||= Regexp.new(config['matchers'][file_types] || '\A_.*\.haml\z')
+    end
+
+    # The error message when an `locals` comment is not found.
+    #
+    # @api private
+    # @return [String]
+    def failure_message
+      'Expected a strict `-# locals: ()` comment at the beginning of the file'
+    end
+  end
+end

data/lib/haml_lint/options.rb

@@ -10,7 +10,7 @@ module HamlLint
     # @param args [Array<String>] arguments passed via the command line
     # @return [Hash] parsed options
     def parse(args)
-      @options = {}
+      @options = default_options
 
       OptionParser.new do |parser|
         parser.banner = "Usage: #{APP_NAME} [options] [file1, file2, ...]"
@@ -32,6 +32,10 @@ module HamlLint
 
     private
 
+    def default_options
+      { parallel: true }
+    end
+
     def add_linter_options(parser) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
       parser.on('--auto-gen-config', 'Generate a configuration file acting as a TODO list') do
         @options[:auto_gen_config] = true
@@ -56,6 +60,10 @@ module HamlLint
         @options[:parallel] = true
       end
 
+      parser.on('--no-parallel', 'Disable parallel linter runs') do
+        @options[:parallel] = false
+      end
+
       parser.on('-a', '--auto-correct', 'Auto-correct offenses (only when it’s safe)') do
         @options[:autocorrect] = :safe
       end

data/lib/haml_lint/tree/haml_comment_node.rb

@@ -25,6 +25,13 @@ module HamlLint::Tree
              .rstrip
     end
 
+    # Returns whether this comment contains a `locals` directive.
+    #
+    # @return [Boolean]
+    def is_strict_locals?
+      text.lstrip.start_with?('locals:')
+    end
+
     private
 
     def contained_directives

data/lib/haml_lint/version.rb

@@ -2,5 +2,5 @@
 
 # Defines the gem version.
 module HamlLint
-  VERSION = '0.59.0'
+  VERSION = '0.61.0'
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: haml_lint
 version: !ruby/object:Gem::Version
-  version: 0.59.0
+  version: 0.61.0
 platform: ruby
 authors:
 - Shane da Silva
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-28 00:00:00.000000000 Z
+date: 2025-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: haml
@@ -134,6 +133,7 @@ files:
 - lib/haml_lint/linter/ruby_comments.rb
 - lib/haml_lint/linter/space_before_script.rb
 - lib/haml_lint/linter/space_inside_hash_attributes.rb
+- lib/haml_lint/linter/strict_locals.rb
 - lib/haml_lint/linter/syntax.rb
 - lib/haml_lint/linter/tag_name.rb
 - lib/haml_lint/linter/trailing_empty_lines.rb
@@ -201,7 +201,6 @@ homepage: https://github.com/sds/haml-lint
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -216,8 +215,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: HAML lint tool
 test_files: []