openvox-lint 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd99ac3fc7637de4bda009ad83ca4b89fbf861316db186f039a8b0405c062cbc
-  data.tar.gz: 4747a1300a899ede28ddaea30a3f5488ae7ee5e294cad55ad1f4721fc55110fa
+  metadata.gz: 0c88e7f7c408afd3a75f203e4b9be28bc34fdbea11bba5245f5315a930cca516
+  data.tar.gz: 3096af92ef4d33f90c50529778930d51a979992ca62e2a96990d5e2b1a8e1936
 SHA512:
-  metadata.gz: e260e0c5a26c9da084e03b835da830981d79fc6af3e32f5fd6644e80da03c4e01d095e4a6badeb581ff8e47467d21802efe6ad3ab1197be0c8046154c6cf37e8
-  data.tar.gz: 6ef7e4f2244b3247012fc5e446505f1d373418e9c226c3c62e003aae26ef3d970f3a84cd63b1d66237a6176a3af85a3a41b9c8368036e2e34f8ff8d220404c9c
+  metadata.gz: b7d189b56162653881f90a3ff60cdbfda158e252425904e0bd4e49b7adb169a78ba13214dfdd3439498125b9892d6d7e8bdae4fc247711fb3a43d501d5cb7a88
+  data.tar.gz: db0220c84a03ce7f32acb448410ccd3ac61b1733c193b8f765a4eb91080bdf295c041f205e4e0841737b7a00a8c30975803115d2979e309eb090b7dfbfdf78c6

data/CHANGELOG.md

@@ -2,6 +2,16 @@
 
 All notable changes to openvox-lint will be documented in this file.
 
+## [1.0.1] - 2026-02-09
+
+### Fixed
+
+- **space_before_arrow**: No longer generates false positives on properly
+  aligned `=>` arrows.  In a multi-parameter resource block, only the
+  parameter with the longest key name is expected to have a single space
+  before `=>`.  Shorter keys may have additional padding spaces for
+  alignment and these are no longer flagged.
+
 ## [1.0.0] - 2025-02-09
 
 ### Added

data/DOCUMENTATION.md

@@ -46,7 +46,7 @@ the lexer token types, the plugin system, and integration guidance.
 
 | Constant | Value | Description |
 |----------|-------|-------------|
-| `VERSION` | `'1.0.0'` | Gem version |
+| `VERSION` | `'1.0.1'` | Gem version |
 
 ### Class Methods
 
@@ -312,6 +312,61 @@ report.format(problems, io: file) # to file
 
 ## Complete Check Reference
 
+### Whitespace & Alignment Checks
+
+#### `space_before_arrow` (WARNING)
+
+Controls spacing before `=>` (hash rocket) in resource parameter blocks.
+In Puppet manifests, it is standard practice to vertically align `=>`
+arrows within a resource body.  This means the parameter with the
+**longest key name** has exactly one space before `=>`, and all shorter
+keys have additional padding spaces to bring their `=>` into alignment.
+
+The check groups `=>` tokens by line proximity.  Within each group it
+identifies the longest key and only flags that key if it has more than
+one space before `=>`.  Shorter keys are permitted extra spaces for
+alignment.  A single-parameter resource with extra space before `=>`
+is always flagged (nothing to align with).
+
+**Good — properly aligned (no warnings):**
+```puppet
+file { '/etc/nginx/nginx.conf':
+  ensure  => file,
+  content => template('nginx/nginx.conf.erb'),
+  owner   => 'root',
+  group   => 'root',
+  mode    => '0644',
+}
+```
+
+Here `content` is the longest key (7 characters).  It has a single space
+before `=>`.  All other keys (`ensure`, `owner`, `group`, `mode`) have
+padding to align their `=>` with `content =>`'s column.  No warnings.
+
+**Bad — longest key has extra space:**
+```puppet
+file { '/tmp/foo':
+  ensure  => present,
+  mode    => '0644',
+  owner   => 'root',
+}
+```
+
+`ensure` is the longest key (6 chars) but has 2 spaces before `=>`.
+The check flags `ensure` only; `mode` and `owner` padding is fine.
+
+**Bad — single parameter with extra space:**
+```puppet
+package { 'httpd':
+  ensure   => installed,
+}
+```
+
+Only one parameter — no alignment context — the 3 extra spaces are
+flagged.
+
+---
+
 ### Puppet 8 / OpenVox 8 Migration Checks
 
 These are the most important checks for users upgrading from Puppet 7 or

data/README.md

@@ -162,7 +162,7 @@ openvox-lint ships with **38 built-in checks** organized into categories:
 | `trailing_whitespace` | warning | No trailing whitespace at end of lines |
 | `hard_tabs` | warning | Use 2-space soft tabs, not literal tabs |
 | `line_length` | warning | Lines should not exceed 140 characters |
-| `space_before_arrow` | warning | At most one space before `=>` |
+| `space_before_arrow` | warning | Only the longest key in an aligned block should have one space before `=>` |
 | `strict_indent` | warning | Indentation must use 2-space increments |
 
 ### Arrow Alignment (1 check)

data/lib/openvox-lint/plugins/checks/space_before_arrow.rb

@@ -1,20 +1,98 @@
 # frozen_string_literal: true
 
-# There should be at most one space before a hash rocket (=>)
-# when there is only one parameter.
+# In a block of aligned hash rockets (=>), only the parameter with the
+# longest key name should have exactly one space before =>.  All shorter
+# keys are expected to have extra padding to keep the arrows aligned.
+#
+# This check fires only when:
+#   - A => has more than one space before it AND is the longest key in its
+#     alignment group (no reason for extra spaces), OR
+#   - A => has more than one space before it AND is the only => on its line
+#     group (nothing to align with).
 OpenvoxLint.new_check(:space_before_arrow) do
   def check
+    # Collect every FARROW token together with its preceding whitespace
+    # and the key token that precedes that whitespace.
+    farrow_entries = []
     tokens.each_with_index do |tok, i|
       next unless tok.type == :FARROW
-      next if i == 0
-      prev = tokens[i - 1]
-      next unless prev.type == :WHITESPACE
-      next if prev.value.length <= 1
-      # Allow if this is in a multi-param aligned block
-      # (arrow_alignment handles that)
-      notify :warning,
-        message: "more than one space before => (found #{prev.value.length})",
-        line: tok.line, column: prev.column
+      next if i < 2
+
+      ws = tokens[i - 1]
+      next unless ws.type == :WHITESPACE
+
+      # The key token is whatever sits before the whitespace. It could be
+      # a NAME, SSTRING, STRING, VARIABLE, CLASSREF, etc.
+      key = tokens[i - 2]
+      farrow_entries << { arrow: tok, whitespace: ws, key: key }
+    end
+
+    return if farrow_entries.empty?
+
+    # Group arrows that belong to the same aligned block.  Arrows on
+    # consecutive lines (gap <= 2) belong to the same group — same
+    # heuristic used by the arrow_alignment check.
+    groups = group_entries(farrow_entries)
+
+    groups.each do |group|
+      if group.size == 1
+        # Single parameter — no alignment needed, max one space.
+        entry = group.first
+        if entry[:whitespace].value.length > 1
+          notify :warning,
+            message: "more than one space before => (found #{entry[:whitespace].value.length})",
+            line: entry[:arrow].line,
+            column: entry[:whitespace].column
+        end
+      else
+        # Multiple parameters — find the longest key.  Only the longest
+        # key (the one that sets the alignment column) should have a
+        # single space.  Flag it if it has extra spaces.
+        max_key_len = group.map { |e| key_length(e[:key]) }.max
+
+        group.each do |entry|
+          ws_len = entry[:whitespace].value.length
+          next if ws_len <= 1       # exactly one space — always fine
+          klen = key_length(entry[:key])
+
+          # This is the longest key (or tied for longest).  It should
+          # have exactly one space before =>.
+          if klen == max_key_len && ws_len > 1
+            notify :warning,
+              message: "more than one space before => (found #{ws_len})",
+              line: entry[:arrow].line,
+              column: entry[:whitespace].column
+          end
+
+          # Shorter keys: extra spaces are expected for alignment — no warning.
+        end
+      end
+    end
+  end
+
+  private
+
+  # Group entries by line proximity.  Entries whose arrows appear on
+  # lines within 2 of each other belong to the same group.
+  def group_entries(entries)
+    groups  = []
+    current = [entries.first]
+
+    entries[1..].each do |entry|
+      if entry[:arrow].line - current.last[:arrow].line <= 2
+        current << entry
+      else
+        groups << current
+        current = [entry]
+      end
     end
+    groups << current unless current.empty?
+    groups
+  end
+
+  # Calculate the display length of a key token.  For quoted strings
+  # the length includes the quotes, matching what the developer sees.
+  def key_length(key_token)
+    key_token.value.length
   end
 end

data/lib/openvox-lint/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OpenvoxLint
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openvox-lint
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Johnny Sheets