openvox-lint 1.0.8 → 1.3.0

data/README.md

@@ -4,12 +4,12 @@
 [![Gem Downloads](https://img.shields.io/gem/dt/openvox-lint)](https://rubygems.org/gems/openvox-lint)
 ![Ruby](https://img.shields.io/badge/ruby-%E2%89%A5%202.5-red)
 ![License](https://img.shields.io/badge/license-Apache%202.0-blue)
-![Checks](https://img.shields.io/badge/built--in%20checks-38-brightgreen)
+![Checks](https://img.shields.io/badge/built--in%20checks-37-brightgreen)
 ![Status](https://img.shields.io/badge/status-stable-brightgreen)
 
 **A style-guide linter for OpenVox and Puppet manifests.**
 
-openvox-lint checks your `.pp` manifest files against the [Puppet Style Guide](https://puppet.com/docs/puppet/latest/style_guide.html) and catches common errors, deprecated patterns, legacy facts, strict-mode violations, and Puppet 8+ / OpenVox 8.x language issues.
+openvox-lint checks your `.pp` manifest files against the [OpenVox Language Style Guide](https://docs.openvoxproject.org/openvox/latest/style_guide.html) (and Puppet equivalent) and catches common errors, deprecated patterns, legacy facts, strict-mode violations, and Puppet 8+ / OpenVox 8.x language issues.
 
 Fully compatible with:
 - **OpenVox 8.x** (the community-maintained open-source fork of Puppet)
@@ -25,7 +25,7 @@ Fully compatible with:
 - [Quick Start](#quick-start)
 - [Usage](#usage)
 - [Enabling and Disabling Checks](#enabling-and-disabling-checks)
-- [Built-in Checks (38)](#built-in-checks)
+- [Built-in Checks (37)](#built-in-checks)
 - [Configuration](#configuration)
 - [Output Formats](#output-formats)
 - [Integration](#integration)
@@ -33,6 +33,7 @@ Fully compatible with:
 - [Updating](#updating)
 - [Uninstalling](#uninstalling)
 - [Development](#development)
+- [Contributors](#contributors)
 - [License](#license)
 
 ---
@@ -159,6 +160,27 @@ openvox-lint -f github manifests/
 openvox-lint --fail-on-warnings manifests/
 ```
 
+### Fix mode (`--fix`)
+
+`--fix` automatically corrects problems for the checks that implement fix logic. Fixes are applied in-place and are safe for the supported cases.
+
+Currently supported checks:
+- `trailing_whitespace` — removes trailing spaces/tabs
+- `hard_tabs` — converts tabs to two spaces
+- `quoted_booleans` — changes `'true'` / `'false'` (strings) to unquoted booleans
+- `double_quoted_strings` — converts unnecessary double-quoted strings (no interpolation or escapes) to single quotes
+- `single_quote_string_with_variables` — converts single-quoted strings containing `$variables` to double quotes so interpolation works
+
+Example:
+
+```bash
+openvox-lint --fix manifests/
+# or
+openvox-lint --fix .
+```
+
+After running, re-lint to confirm. Complex structural fixes (e.g. arrow alignment) are not yet implemented.
+
 ---
 
 ## Enabling and Disabling Checks
@@ -182,7 +204,7 @@ openvox-lint --no-line_length-check --no-arrow_alignment-check --no-strict_inden
 Use `--only-checks` to run *only* the checks you specify (everything else is skipped):
 
 ```bash
-# Only check for legacy facts and hiera3 usage
+# Only check for legacy facts and deprecated Hiera 3 functions
 openvox-lint --only-checks legacy_facts,hiera3_function,top_scope_facts manifests/
 
 # Only check for errors (skip all warnings)
@@ -232,13 +254,13 @@ To see every check that openvox-lint can run:
 openvox-lint --list-checks
 ```
 
-This shows the check name, severity (warning or error), and description for all 38 built-in checks.
+This shows the check name, severity (warning or error), and description for all 37 built-in checks.
 
 ---
 
 ## Built-in Checks
 
-openvox-lint ships with **38 built-in checks** organized into categories:
+openvox-lint ships with **37 built-in checks** organized into categories:
 
 ### Whitespace & Formatting (5 checks)
 
@@ -302,13 +324,12 @@ openvox-lint ships with **38 built-in checks** organized into categories:
 | `case_without_default` | warning | Case statements must have a `default` case |
 | `selector_inside_resource` | warning | Don't use selectors inside resource bodies |
 
-### References & Syntax (4 checks)
+### References & Syntax (3 checks)
 
 | Check | Severity | Description |
 |-------|----------|-------------|
 | `leading_zero` | warning | No leading zeros in numbers (except file modes) |
 | `resource_reference_without_title_capital` | warning | Capitalise resource reference types |
-| `relative_classname_inclusion` | warning | Use fully qualified class names |
 | `autoloader_layout` | warning | Class/define name must match file path |
 
 ### Comments (1 check)
@@ -335,7 +356,7 @@ openvox-lint ships with **38 built-in checks** organized into categories:
 |-------|----------|-------------|
 | `legacy_facts` | warning | Legacy facts removed in Puppet 8; use `$facts['...']` |
 | `top_scope_facts` | warning | `$::fact` references; use `$facts['fact']` |
-| `hiera3_function` | **error** | `hiera()` / `hiera_hash()` removed; use `lookup()` |
+| `hiera3_function` | **error** | Deprecated Hiera 3 functions removed; use Hiera 5 `lookup()` |
 | `import_statement` | **error** | `import` removed in Puppet 4+ |
 
 ---
@@ -382,7 +403,7 @@ class foo { # lint:ignore:documentation
 
 ```
 manifests/init.pp:5:15: WARNING: unquoted_file_mode: unquoted file mode
-manifests/init.pp:9:3: ERROR: hiera3_function: 'hiera()' is removed in Puppet 8
+manifests/init.pp:9:3: ERROR: hiera3_function: deprecated Hiera 3 function 'hiera()' — use Hiera 5 lookup() instead
 ```
 
 ### JSON (`-f json`)
@@ -617,14 +638,14 @@ openvox-lint/
 
 ## Comparison with puppet-lint
 
-| Feature | puppet-lint 5.x | openvox-lint 1.0 |
+| Feature | puppet-lint 5.x | openvox-lint 1.3.0 |
 |---------|-----------------|------------------|
 | Ruby requirement | ≥ 3.1 | ≥ 2.5 (RHEL 8, macOS, all modern platforms) |
 | Runtime dependencies | None | None |
-| Built-in checks | ~25 | 38 |
+| Built-in checks | ~25 | 37 |
 | Legacy facts detection | Via plugin | Built-in |
 | Top-scope facts detection | Via plugin | Built-in |
-| Hiera 3 detection | No | Built-in (error) |
+| Deprecated Hiera 3 function detection | No | Built-in (error) |
 | Import statement detection | No | Built-in (error) |
 | Strict indent check | Via plugin | Built-in |
 | GitHub Actions output | No | Built-in (`-f github`) |
@@ -633,7 +654,7 @@ openvox-lint/
 | Custom log format | Yes | Yes (compatible) |
 | OpenVox awareness | No | Yes |
 | Plugin system | Yes | Yes (compatible) |
-| `--fix` support | Yes | Yes |
+| `--fix` support | Yes | Yes (real implementations for trailing_whitespace, hard_tabs, quoted_booleans, double_quoted_strings, single_quote_string_with_variables + line-based) |
 | vim-openvox integration | No | Native |
 
 ---
@@ -650,6 +671,16 @@ Apache License, Version 2.0. See [LICENSE](LICENSE) for details.
 
 ---
 
+## Contributors
+
+Thanks to the following people for their contributions to openvox-lint:
+
+| Contributor | Contribution |
+|-------------|--------------|
+| **[@hbro](https://github.com/hbro)** (Hans Broeckx) | Fixed `legacy_facts` false positives on local variables ([PR #1](https://github.com/cvquesty/openvox-lint/pull/1)) — *First community contribution!* 🎉 |
+
+Want to contribute? See [CONTRIBUTING.md](CONTRIBUTING.md) to get started!
+
 ## Author
 
 Jerald Sheets ([@cvquesty](https://github.com/cvquesty))

data/lib/openvox-lint/linter.rb

@@ -42,6 +42,24 @@ module OpenvoxLint
         fullpath: filepath, configuration: @config,
       )
       @problems.concat(checker.run)
+
+      # Apply --fix: checks' #fix methods (if implemented) mutate the shared
+      # manifest_lines array in place. After all checks, write the (possibly
+      # fixed) content back if it differs. This makes --fix functional for
+      # supported checks. Ensures final newline per style guide.
+      if @config.fix
+        begin
+          fixed_code = lexer.manifest_lines.join("\n") + "\n"
+          if fixed_code != code
+            File.write(filepath, fixed_code)
+          end
+        rescue StandardError => write_err
+          @problems << {
+            path: filepath, line: 0, column: 0, kind: :error,
+            check: :fix, message: "Failed to write fixes: #{write_err.message}",
+          }
+        end
+      end
     rescue StandardError => e
       @problems << {
         path: filepath, line: 0, column: 0, kind: :error,

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

@@ -24,4 +24,20 @@ OpenvoxLint.new_check(:double_quoted_strings) do
         column: tok.column
     end
   end
+
+  # --fix support: convert the double-quoted string (no interp) to single
+  # quotes by swapping the outer delimiters at the reported column.
+  def fix(problem)
+    idx = problem[:line] - 1
+    line = @manifest_lines[idx].dup
+    col = (problem[:column] || 1) - 1
+    if line[col] == '"'
+      end_col = line.index('"', col + 1)
+      if end_col
+        inner = line[(col + 1)...end_col]
+        line[col..end_col] = "'" + inner + "'"
+        @manifest_lines[idx] = line
+      end
+    end
+  end
 end

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

@@ -12,4 +12,11 @@ OpenvoxLint.new_check(:hard_tabs) do
         column: col + 1
     end
   end
+
+  # --fix support: replace all hard tabs with two spaces (simple but effective
+  # for consistent soft-tab style; more sophisticated indent fixers exist).
+  def fix(problem)
+    idx = problem[:line] - 1
+    @manifest_lines[idx] = @manifest_lines[idx].gsub("\t", '  ')
+  end
 end

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

@@ -1,7 +1,17 @@
 # frozen_string_literal: true
 
-# Hiera 3 functions (hiera, hiera_array, hiera_hash, hiera_include)
-# are removed in Puppet 8 / OpenVox 8. Use lookup() instead.
+# Detects deprecated Hiera 3 functions that are removed in Puppet 8 / OpenVox 8.
+#
+# Hiera 3 is fully deprecated.  Only Hiera 5 is supported in Puppet 8+.
+# The legacy hiera() functions were compatibility shims that have been removed.
+#
+# Deprecated functions:
+#   - hiera()         -> lookup()
+#   - hiera_array()   -> lookup(..., Array, 'unique')
+#   - hiera_hash()    -> lookup(..., Hash, 'hash')
+#   - hiera_include() -> lookup(...).include
+#
+# Use the Hiera 5 lookup() function instead.
 OpenvoxLint.new_check(:hiera3_function) do
   HIERA3_FUNCS = %w[hiera hiera_array hiera_hash hiera_include].freeze
 
@@ -9,7 +19,7 @@ OpenvoxLint.new_check(:hiera3_function) do
     tokens.each do |tok|
       next unless tok.type == :NAME && HIERA3_FUNCS.include?(tok.value)
       notify :error,
-        message: "'#{tok.value}()' is removed in Puppet 8 / OpenVox 8 — use lookup() instead",
+        message: "deprecated Hiera 3 function '#{tok.value}()' — use Hiera 5 lookup() instead",
         line: tok.line, column: tok.column
     end
   end

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

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'set'
+
 # Legacy (unstructured) top-scope facts are removed in Puppet 8 / OpenVox 8.
 # Use structured facts via $facts hash instead.
 #
@@ -35,15 +37,57 @@ OpenvoxLint.new_check(:legacy_facts) do
   ].freeze
 
   def check
+    local_vars = collect_local_vars
     tokens.each do |tok|
       next unless tok.type == :VARIABLE
       # Strip leading $ and :: prefix, and any trailing : left by the
       # lexer when a variable is used as a resource title ($fact:).
       name = tok.value.sub(/^\$/, '').sub(/\A::/, '').chomp(':')
       next unless LEGACY_FACTS.include?(name)
+      next if local_vars.include?(name)
       notify :warning,
         message: "legacy fact '#{name}' — use $facts['...'] structured fact instead (Puppet 8 / OpenVox 8)",
         line: tok.line, column: tok.column
     end
   end
+
+  private
+
+  # Collect variable names that are declared locally (class/define parameters
+  # or lambda block parameters) so they are not mistaken for legacy facts.
+  def collect_local_vars
+    local = Set.new
+    toks = tokens
+    i = 0
+    while i < toks.size
+      case toks[i].type
+      when :CLASS, :DEFINE
+        # Skip to the opening LPAREN of the parameter list (stop at LBRACE)
+        j = i + 1
+        j += 1 while j < toks.size && toks[j].type != :LPAREN && toks[j].type != :LBRACE
+        if j < toks.size && toks[j].type == :LPAREN
+          depth = 1
+          j += 1
+          while j < toks.size && depth > 0
+            case toks[j].type
+            when :LPAREN then depth += 1
+            when :RPAREN then depth -= 1
+            when :VARIABLE then local << toks[j].value.sub(/^\$/, '').sub(/\A::/, '') if depth == 1
+            end
+            j += 1
+          end
+        end
+      when :PIPE
+        # Lambda parameter list: |$var1, $var2|
+        j = i + 1
+        while j < toks.size && toks[j].type != :PIPE
+          local << toks[j].value.sub(/^\$/, '').sub(/\A::/, '') if toks[j].type == :VARIABLE
+          j += 1
+        end
+        i = j # skip past closing PIPE
+      end
+      i += 1
+    end
+    local
+  end
 end

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

@@ -13,4 +13,25 @@ OpenvoxLint.new_check(:quoted_booleans) do
         line: tok.line, column: tok.column
     end
   end
+
+  # --fix support: unquote the boolean at the reported column (or fallback
+  # gsub). Assumes the problem points to the start of the quoted value.
+  def fix(problem)
+    idx = problem[:line] - 1
+    line = @manifest_lines[idx].dup
+    col = (problem[:column] || 1) - 1
+    if line[col] == "'" || line[col] == '"'
+      quote = line[col]
+      # Find matching closing quote for this simple boolean token
+      end_col = line.index(quote, col + 1)
+      if end_col && %w[true false].include?(line[(col + 1)...end_col])
+        val = line[(col + 1)...end_col]
+        line[col..end_col] = val
+        @manifest_lines[idx] = line
+        return
+      end
+    end
+    # Fallback (safe for most manifests)
+    @manifest_lines[idx] = line.gsub(/(['"])(true|false)\1/, '\2')
+  end
 end

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

@@ -13,4 +13,20 @@ OpenvoxLint.new_check(:single_quote_string_with_variables) do
         line: tok.line, column: tok.column
     end
   end
+
+  # --fix support: swap outer single quotes to double (may require manual
+  # review for literal $ or inner quotes per style exceptions).
+  def fix(problem)
+    idx = problem[:line] - 1
+    line = @manifest_lines[idx].dup
+    col = (problem[:column] || 1) - 1
+    if line[col] == "'"
+      end_col = line.index("'", col + 1)
+      if end_col
+        inner = line[(col + 1)...end_col]
+        line[col..end_col] = '"' + inner + '"'
+        @manifest_lines[idx] = line
+      end
+    end
+  end
 end

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

@@ -11,4 +11,10 @@ OpenvoxLint.new_check(:trailing_whitespace) do
         column: line.rstrip.length + 1
     end
   end
+
+  # --fix support: strip trailing whitespace from the offending line.
+  def fix(problem)
+    idx = problem[:line] - 1
+    @manifest_lines[idx] = @manifest_lines[idx].rstrip
+  end
 end

data/lib/openvox-lint/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openvox-lint
 version: !ruby/object:Gem::Version
-  version: 1.0.8
+  version: 1.3.0
 platform: ruby
 authors:
 - Jerald Sheets
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-03-04 00:00:00.000000000 Z
+date: 2026-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -53,10 +53,15 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.50'
 description: |
-  openvox-lint is a linter for OpenVox and Puppet manifests. It checks your
-  code against the Puppet style guide and catches common errors including
-  deprecated patterns, legacy facts, strict mode violations, and Puppet 8+
-  language issues. Fully compatible with OpenVox 8.x and Puppet 8.x.
+  openvox-lint is a modern style-guide linter for OpenVox and Puppet manifests.
+  It checks your .pp files against the OpenVox Language Style Guide (the
+  current canonical reference) and catches common errors, deprecated patterns
+  (legacy facts, Hiera 3, import, etc.), strict-mode issues, and Puppet 8+ /
+  OpenVox 8.x problems. Includes real --fix support for many checks.
+
+  Fully compatible with OpenVox 8.x and Puppet 8.x. Drop-in replacement for
+  the archived puppet-lint with better Ruby 2.5+ support and OpenVox-specific
+  checks.
 email:
 - jsheets@xai.com
 executables:
@@ -99,7 +104,6 @@ files:
 - lib/openvox-lint/plugins/checks/parameter_order.rb
 - lib/openvox-lint/plugins/checks/puppet_url_without_modules.rb
 - lib/openvox-lint/plugins/checks/quoted_booleans.rb
-- lib/openvox-lint/plugins/checks/relative_classname_inclusion.rb
 - lib/openvox-lint/plugins/checks/resource_reference_without_title_capital.rb
 - lib/openvox-lint/plugins/checks/selector_inside_resource.rb
 - lib/openvox-lint/plugins/checks/single_quote_string_with_variables.rb
@@ -124,7 +128,7 @@ metadata:
   homepage_uri: https://github.com/cvquesty/openvox-lint
   source_code_uri: https://github.com/cvquesty/openvox-lint
   bug_tracker_uri: https://github.com/cvquesty/openvox-lint/issues
-  changelog_uri: https://github.com/cvquesty/openvox-lint/blob/main/CHANGELOG.md
+  changelog_uri: https://github.com/cvquesty/openvox-lint/blob/development/CHANGELOG.md
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
@@ -141,8 +145,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
+rubygems_version: 3.0.3.1
 signing_key:
 specification_version: 4
-summary: Check OpenVox/Puppet manifests against the style guide
+summary: Check OpenVox/Puppet manifests against the OpenVox Language Style Guide
 test_files: []

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

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-# Use absolute class names in include/require/contain statements.
-OpenvoxLint.new_check(:relative_classname_inclusion) do
-  INCLUDE_FUNCS = %w[include require contain].freeze
-
-  def check
-    sem = semantic_tokens
-    sem.each_with_index do |tok, i|
-      next unless tok.type == :NAME && INCLUDE_FUNCS.include?(tok.value)
-      j = i + 1
-      next if j >= sem.length
-      name_tok = sem[j]
-      next unless name_tok.type == :NAME || name_tok.type == :SSTRING || name_tok.type == :STRING
-      class_name = name_tok.value.gsub(/['"]/, '')
-      next if class_name.start_with?('::') || class_name.empty?
-      # Single-segment names are OK (they're unambiguous)
-      next unless class_name.include?('::')
-      notify :warning,
-        message: "class name '#{class_name}' should be fully qualified (start with ::)",
-        line: name_tok.line, column: name_tok.column
-    end
-  end
-end