openvox-lint 1.0.7 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d7e73afd296560df9e4d0aef103a96fd6bf42483db6ceab560e4d8fd3b73813
-  data.tar.gz: 512c4019545161cc37a3e406b1afa3b41499bec7663624b067ee1d263346ceda
+  metadata.gz: 92a172fe1a83c3d684aee5d33ab5d77562cc7f59f226187220b4afd8c491e5b2
+  data.tar.gz: be8d992d5f9ad8773718818bf9c576e50197ed4ca3d9d0ab0d5e568f2f4a2e3f
 SHA512:
-  metadata.gz: fb51dc826fdbbf0419c0049fcd0ccba8e5310769216bb8e04a82af6beb95f053676a91022927cc1a15f8e90345f43d972b9a3c1c24453e29b3a59800338d62f0
-  data.tar.gz: 4a48731cf89acb78c270cffdbc97cd5273c466bb7990d0f1ee8bc4fbc74799a9f38963f6714430ecd7d1b1228a12f3176d9705c137aa850feb97de439694b70d
+  metadata.gz: b720a95e6dd55dea7fdef36831236fad7f586c4916fcec8e13d6e1f8668897f5261c806a525f3d46ccfbacc4291172531a40cb86f76ab2cedba51a15a7d78c85
+  data.tar.gz: 991d2849f7e848fcbd6eace4c09289ffde7509a6df96b1d447f6c4b68b83363ac5ab919627d4bde4cde0a974ca2170ae38e3150070c5d25a84ff48b367103d66

data/CHANGELOG.md

@@ -2,6 +2,183 @@
 
 All notable changes to openvox-lint will be documented in this file.
 
+## [1.3.0] - 2026-05-23
+
+### Fixed / Production Readiness
+
+- **Real `--fix` support implemented** for 5 high-value checks (previously non-functional scaffolding only; all 37 raised `NoFix`):
+  - `trailing_whitespace` — strips trailing ws from lines
+  - `hard_tabs` — replaces `\t` with two spaces
+  - `quoted_booleans` — unquotes `true`/`false` values
+  - `double_quoted_strings` — converts unnecessary `"...` (no interp/escapes) to `'...`
+  - `single_quote_string_with_variables` — converts `'...$var...` to `"...$var...`
+  - Linter now writes mutated `manifest_lines` back to disk on `--fix` (with final-NL normalization per style guide). Fixes are line-based and safe; complex structural fixes (arrow_alignment) remain future work. Tested on real manifests.
+- **`legacy_facts` crash fixed** (in active workspace): `require 'set'` present + exclusion logic for local class/define params and `|$var|` lambdas fully verified (no false positives, no NameError).
+- Removed committed stale `openvox-lint-1.0.8.gem` (violated `.gitignore`).
+- **Version/doc sync**: All references now 1.3.0 (source, docs header, comparison table, this changelog). Bumped for the --fix + hygiene milestone.
+- Updated README links and comparison to point to canonical OpenVox style guide and note real --fix status.
+- Architecture decision: retained OpenVox's lightweight `CheckPlugin` + depth-aware helpers (superior to puppet-lint Data for some cases); added minimal mutation support for fixes without porting heavy token-rewiring singleton.
+
+### Changed
+- `--fix` now production-usable for the listed checks (edits in place like puppet-lint).
+- Style guide references prioritize OpenVox canonical docs.
+
+### Contributors (for 1.3.0)
+- Grok Build (lead modernization per full analysis reports)
+
+## [1.2.0] - 2026-03-12
+
+### Fixed
+
+- **`legacy_facts` false positives on local variables** — The check no longer
+  flags class/define parameters or lambda block parameters that happen to share
+  names with legacy facts (`$path`, `$type`, `$os`, etc.). Previously, any
+  variable with a legacy fact name would trigger a warning, even when it was
+  clearly a locally-scoped parameter with no relation to facts.
+
+  **Contributed by [@hbro](https://github.com/hbro) (Hans Broeckx)** in
+  [PR #1](https://github.com/cvquesty/openvox-lint/pull/1). This is openvox-lint's
+  first community contribution! 🎉
+
+  The fix adds a pre-scan phase that collects all locally declared variable names
+  from:
+  - Class and defined type parameter lists
+  - Lambda block parameter lists (`|$var|`)
+
+  These local variables are then excluded from the legacy fact name check,
+  eliminating false positives while still correctly detecting actual legacy
+  fact references.
+
+### Contributors
+
+- **Hans Broeckx ([@hbro](https://github.com/hbro))** — First community contributor!
+
+## [1.1.1] - 2026-03-12
+
+### Documentation
+
+- **Comprehensive technical documentation rewrite**: Complete overhaul of
+  [DOCUMENTATION.md](DOCUMENTATION.md) with:
+  - Full API reference for all classes (Token, Lexer, CheckPlugin, Configuration,
+    Linter, Report)
+  - Complete documentation for all 37 checks with good/bad code examples
+  - Organized checks by category (Whitespace, Strings, Variables, Resources, etc.)
+  - Comprehensive token types reference
+  - Plugin development guide with examples
+  - Migration guide from puppet-lint
+
+- **New CONTRIBUTING.md**: Added comprehensive contributor guide with:
+  - Development setup instructions
+  - Project structure documentation
+  - Testing instructions
+  - Check plugin writing guide
+  - Coding standards
+  - Release process
+
+- **Hiera 3 → Hiera 5 clarification**: Updated all documentation to clarify
+  that Hiera 3 is fully deprecated and only Hiera 5 is supported in Puppet 8 /
+  OpenVox 8. The `hiera3_function` check now explicitly references "Hiera 5
+  lookup()" as the replacement.
+
+### Changed
+
+- **`hiera3_function` error message**: Improved to explicitly mention Hiera 5:
+  "deprecated Hiera 3 function 'hiera()' — use Hiera 5 lookup() instead"
+
+## [1.1.0] - 2026-03-05
+
+### Removed
+
+- **`relative_classname_inclusion` check**: This check warned when
+  `include`, `require`, or `contain` statements used relative (non-`::`)
+  multi-segment class names instead of fully qualified ones.  Since
+  Puppet 4, the Puppet language resolver correctly handles relative class
+  name resolution, making relative class name inclusion safe and the
+  check obsolete.  The check has been removed entirely.  Users who had
+  disabled it via `--no-relative_classname_inclusion-check` or
+  `.openvox-lint.rc` can safely remove those overrides.
+
+### Changed
+
+- **Check count**: 38 → 37 built-in checks.
+
+## [1.0.8] - 2026-03-04
+
+### Fixed
+
+- **CLI: stale configuration on re-invocation**: The global configuration
+  singleton is now reset at the start of every `CLI#run`.  Repeated
+  invocations in the same Ruby process (Vim plugins, guard, Rake loops)
+  no longer inherit stale `disabled_checks`, `only_checks`, or other
+  settings from a previous run.
+
+- **CLI: `--config` flag ignored when local RC exists**: The `-c` /
+  `--config FILE` flag now takes strict priority.  Previously a local
+  `.openvox-lint.rc` would shadow an explicit `--config` path.
+
+- **lint:ignore / lint:endignore block suppression**: Block-style ignore
+  comments now work as documented.  `# lint:ignore:check_name` on its
+  own line opens a suppression block; `# lint:endignore` closes it.
+  All problems on lines between the two comments are suppressed for
+  the named checks.  Inline ignore comments (on the same line as code)
+  continue to work as before.
+
+- **ignore-paths glob matching with relative/absolute prefixes**: The
+  `--ignore-paths` glob patterns (and the defaults `vendor/**/*.pp`,
+  `pkg/**/*.pp`, `spec/**/*.pp`) now match correctly regardless of
+  whether the file was discovered via `./vendor/foo.pp`, `vendor/foo.pp`,
+  or an absolute path.
+
+- **trailing_comma false positives on non-resource braces**: The
+  `trailing_comma` check now only fires inside resource bodies
+  (`name { ... }`).  It no longer produces false positives on `if`,
+  `unless`, `case`, class bodies, or other brace-delimited contexts
+  where a trailing comma is not expected.
+
+- **arrow_alignment / space_before_arrow contradictory warnings**: The
+  `arrow_alignment` check now defers to `space_before_arrow` when the
+  misalignment in a group is caused by the longest key having extra
+  whitespace.  This eliminates contradictory double-warnings on the
+  same resource block.
+
+- **Unterminated strings and regex now reported as errors**: The lexer
+  now raises `OpenvoxLint::Error` when a single-quoted string,
+  double-quoted string, or regex literal is not terminated before
+  end-of-file.  Previously the lexer silently produced a truncated
+  token covering the rest of the file, leading to wrong lint results.
+
+- **Multi-line string tokens now report correct line number**: String
+  tokens that span multiple lines now record the **starting** line
+  number, not the ending line.  Checks that flag these tokens now
+  point to the correct source location.
+
+- **variables_not_enclosed mixed variable handling**: Strings containing
+  both enclosed (`${bar}`) and unenclosed (`$foo`) variables now
+  correctly flag only the unenclosed references.  Previously the
+  entire string was skipped if any `${...}` pattern was present.
+
+- **resource_reference_without_title_capital expanded allowlist**: The
+  function allowlist that prevents false positives on `name[...]`
+  patterns now covers 40+ Puppet built-in and stdlib functions
+  (`each`, `map`, `filter`, `reduce`, `lookup`, `dig`, etc.),
+  not just the original 5.
+
+### Changed
+
+- **duplicate_params / parameter_order: removed dead code**: Both checks
+  contained `.formatting?` guard clauses that could never trigger
+  because they operate on pre-filtered semantic tokens.  The dead code
+  has been removed for clarity.
+
+- **Check registry duplicate warning**: `OpenvoxLint.new_check` now
+  emits a warning to stderr (when `OPENVOX_LINT_DEBUG` is set) if a
+  check name that is already registered is overwritten.  This helps
+  detect accidental name collisions in custom check plugins.
+
+- **Gemfile cleaned up**: Removed duplicate gem declarations that were
+  listed in both the Gemfile `group` block and the gemspec
+  `add_development_dependency` entries.
+
 ## [1.0.7] - 2026-02-25
 
 ### Changed
@@ -69,7 +246,7 @@ All notable changes to openvox-lint will be documented in this file.
   - **Resources**: `ensure_first_param`, `ensure_not_symlink_target`, `file_mode`, `unquoted_file_mode`, `unquoted_resource_title`, `duplicate_params`, `trailing_comma`
   - **Classes**: `documentation`, `nested_classes_or_defines`, `parameter_order`, `class_inherits_params`, `inherits_across_namespaces`
   - **Conditionals**: `case_without_default`, `selector_inside_resource`
-  - **References**: `leading_zero`, `resource_reference_without_title_capital`, `relative_classname_inclusion`, `autoloader_layout`
+  - **References**: `leading_zero`, `resource_reference_without_title_capital`, `autoloader_layout`
   - **Comments**: `star_comments`
   - **URLs**: `puppet_url_without_modules`
   - **Nodes**: `node_name_unquoted`