haml_lint 0.60.0 → 0.61.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8bf4b2b435129bea13f5c1b32aabf202f5e8731264df179e3e7a9c16017b8654
-  data.tar.gz: 34a95aa1ac68c54a513d9431be449f5a53963d77e7d451cfa532c60ff08fe08f
+  metadata.gz: 62ac7e2f95151a5906ccd99c47f5d948db8502aedf5423fa421666e90922d79e
+  data.tar.gz: 39f4f0952d37d191662215f919a1ee62bf38a4a9f93b4b5ad87545f334a97f6b
 SHA512:
-  metadata.gz: a65d869de4f21555cc165baccae390ae09202de3d6aea707404806d0ee40bdd1d5916d7ab3ae9a7b4a0d35c1a4a5a8c89da3cb317389877460e03f48b5577c54
-  data.tar.gz: 84ccd1349eb889e3b516f42e4919eb0003566f01ba62a01b05cce28aeb801138c6f725eac054c23073997f0e67e452765ac78c03bfe710639c9742828b85521d
+  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/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/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.0'
 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.0
 platform: ruby
 authors:
 - Shane da Silva
 bindir: bin
 cert_chain: []
-date: 2025-01-30 00:00:00.000000000 Z
+date: 2025-02-24 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