haml_lint 0.60.0 → 0.61.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8bf4b2b435129bea13f5c1b32aabf202f5e8731264df179e3e7a9c16017b8654
-  data.tar.gz: 34a95aa1ac68c54a513d9431be449f5a53963d77e7d451cfa532c60ff08fe08f
+  metadata.gz: 61b19bf998b26f91fc8ea0578a3e189b8edb1d3c31a942c873e1e895747bcd82
+  data.tar.gz: 66b19273123ec6618faade749c390ded3e5ccdb608e2f64b43a4def9f575a298
 SHA512:
-  metadata.gz: a65d869de4f21555cc165baccae390ae09202de3d6aea707404806d0ee40bdd1d5916d7ab3ae9a7b4a0d35c1a4a5a8c89da3cb317389877460e03f48b5577c54
-  data.tar.gz: 84ccd1349eb889e3b516f42e4919eb0003566f01ba62a01b05cce28aeb801138c6f725eac054c23073997f0e67e452765ac78c03bfe710639c9742828b85521d
+  metadata.gz: c279dc5f30fa736cfac959aedfd8dec1bf7e5e25b1a0508989ce1276afa5d8b4ddd802f9a139ab48b773a1a0e4d9f9bd91e599cf63700e3eea383cbfa7407bc4
+  data.tar.gz: 88a18703c06bcc0b95e0072d3ca0e3970302d7807bba29bcb05d2ad8f43dcbf184d76015dc13924d41e7acfcd36762cd6c0eefe3e46d58eae4d26dd8ef2cae2a

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/lib/haml_lint/linter/strict_locals.rb

@@ -0,0 +1,61 @@
+# 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_child = root.children.first
+      return if first_child.is_a?(HamlLint::Tree::HamlCommentNode) &&
+                    first_child.is_strict_locals?
+
+      # Check whether this linter is disabled by a comment
+      return if first_child.disabled?(self)
+
+      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/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.60.0'
+  VERSION = '0.61.1'
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: haml_lint
 version: !ruby/object:Gem::Version
-  version: 0.60.0
+  version: 0.61.1
 platform: ruby
 authors:
 - Shane da Silva
 bindir: bin
 cert_chain: []
-date: 2025-01-30 00:00:00.000000000 Z
+date: 2025-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: haml
@@ -133,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