puppet-lint 5.1.0 → 5.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 200023e7df4e5c5ad823fba0f940ee2ad73ae5d05eb04796e83dbcc118e2a47e
-  data.tar.gz: 3a14e87f1f69fdc2495068d246609af04c81e6610e4e878a669ab9b8262f1265
+  metadata.gz: 52a7cadacf8d637032f1ffb76f773566a7f3be3cd9a19fd1fbdbac69c2a68204
+  data.tar.gz: 9d8272950c1abfb41d078bec0c0909a9ae8d8ff66a01019f7908319baf651152
 SHA512:
-  metadata.gz: 5bad4d387c8695aa0bc3fca805a819c5af1e0c410953f61093ec77a1139848c1b284a53aa238bed450ba5195d9af8736a2ba6a9dfec97ceca09bdaca08da80bf
-  data.tar.gz: 4d26e6093580630b0b838562efdc2d2e9492d8185652a469aaca3fdb48cec0f88b9d02367cacc595b46d10d08745d4b76874d304a891e1e265c35ffb01625752
+  metadata.gz: f84a46b9cc61045fd3239f1e00aeda2d6d5ed1c7f68035782763be817b0d696fa829364610ea94389485f05ccf289745a8a58ead975504c2626a431747034272
+  data.tar.gz: 3a75d2e340d8753dc9ec901b8dd183c20847bc70101c08d435ecceb2d956214c8f6704c7fa81072758b3b31fd8fcc8bd79b8c83adc3b61a5a6d34a651feb341a

data/lib/puppet-lint/bin.rb

@@ -90,9 +90,7 @@ class PuppetLint::Bin
 
         return_val = 1 if l.errors? || (l.warnings? && PuppetLint.configuration.fail_on_warnings)
 
-        next unless PuppetLint.configuration.fix && l.problems.none? { |r| r[:check] == :syntax }
-
-        File.binwrite(f, l.manifest)
+        l.write_fixes if PuppetLint.configuration.fix
       end
 
       if PuppetLint.configuration.sarif

data/lib/puppet-lint/version.rb

@@ -1,3 +1,3 @@
 class PuppetLint
-  VERSION = '5.1.0'.freeze
+  VERSION = '5.1.1'.freeze
 end

data/lib/puppet-lint.rb

@@ -235,6 +235,42 @@ class PuppetLint
     report(@problems)
   end
 
+  # Public: Write fixes back to the file if this file type supports fixes.
+  #
+  # Returns nothing.
+  def write_fixes
+    return unless should_write_fixes?
+
+    File.binwrite(@path, @manifest)
+  end
+
+  # Internal: Determine if fixes should be written for this file.
+  #
+  # Returns true if all conditions are met for writing fixes, false otherwise.
+  def should_write_fixes?
+    # Don't write if file type doesn't support fixes
+    return false unless supports_fixes?
+
+    # Don't write if there are syntax errors (can't safely fix)
+    return false if @problems&.any? { |r| r[:check] == :syntax }
+
+    # Don't write if there's no manifest content
+    return false if @manifest.nil? || @manifest.empty?
+
+    true
+  end
+
+  # Public: Determine if this file type supports automatic fixes.
+  #
+  # Returns true if fixes are supported for this file type, false otherwise.
+  def supports_fixes?
+    return false if @path.nil?
+
+    # Only .pp files support fixes currently
+    # YAML files and other types may support fixes in the future
+    File.extname(@path).match?(%r{\.pp$}i)
+  end
+
   # Public: Define a new check.
   #
   # name  - A unique name for the check as a Symbol.

data/spec/fixtures/test/manifests/issue_254_overwriting_yaml/class_with_dash.pp

@@ -0,0 +1,3 @@
+class foo-bar {
+  notify { 'hello': }
+}

data/spec/fixtures/test/manifests/issue_254_overwriting_yaml/class_with_dash.yaml

@@ -0,0 +1,7 @@
+---
+classes:
+  foo-bar:
+    parameters: []
+    resources:
+      notify:
+        - title: hello

data/spec/unit/puppet-lint/bin_spec.rb

@@ -615,9 +615,27 @@ describe PuppetLint::Bin do
     end
   end
 
+  context 'when fixing a directory containing both .pp and .yaml files' do
+    let(:args) { ['--fix', 'spec/fixtures/test/manifests/issue_254_overwriting_yaml'] }
+
+    its(:exitstatus) { is_expected.to eq(1) }
+
+    it 'does not overwrite YAML files' do
+      yaml_file = 'spec/fixtures/test/manifests/issue_254_overwriting_yaml/class_with_dash.yaml'
+      original_yaml = File.read(yaml_file)
+
+      bin # Run the command
+
+      yaml_after = File.read(yaml_file)
+      expect(yaml_after).to eq(original_yaml)
+      expect(yaml_after).to include('classes:')
+      expect(yaml_after).not_to include('class foo-bar {')
+    end
+  end
+
   context 'when overriding config file options with command line options' do
     context 'and config file sets "--only-checks=variable_contains_dash"' do
-      around(:context) do |example|
+      around(:each) do |example|
         Dir.mktmpdir do |tmpdir|
           Dir.chdir(tmpdir) do
             File.open('.puppet-lint.rc', 'wb') do |f|

data/spec/unit/puppet-lint/puppet-lint_spec.rb

@@ -15,4 +15,53 @@ describe PuppetLint do
     linter.run
     expect(linter.manifest).to eq('')
   end
+
+  describe '#supports_fixes?' do
+    context 'with a .pp file' do
+      it 'returns true' do
+        linter.instance_variable_set(:@path, 'test.pp')
+        expect(linter.supports_fixes?).to be true
+      end
+    end
+
+    context 'with a .yaml file' do
+      it 'returns false' do
+        linter.instance_variable_set(:@path, 'test.yaml')
+        expect(linter.supports_fixes?).to be false
+      end
+    end
+
+    context 'with no path set' do
+      it 'returns false' do
+        expect(linter.supports_fixes?).to be false
+      end
+    end
+  end
+
+  describe '#should_write_fixes?' do
+    before(:each) do
+      linter.instance_variable_set(:@path, 'test.pp')
+      linter.instance_variable_set(:@manifest, 'class test { }')
+    end
+
+    context 'when file supports fixes and has no syntax errors' do
+      it 'returns true' do
+        expect(linter.should_write_fixes?).to be true
+      end
+    end
+
+    context 'when file has syntax errors' do
+      it 'returns false' do
+        linter.instance_variable_set(:@problems, [{ check: :syntax }])
+        expect(linter.should_write_fixes?).to be false
+      end
+    end
+
+    context 'when file type does not support fixes' do
+      it 'returns false' do
+        linter.instance_variable_set(:@path, 'test.yaml')
+        expect(linter.should_write_fixes?).to be false
+      end
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: puppet-lint
 version: !ruby/object:Gem::Version
-  version: 5.1.0
+  version: 5.1.1
 platform: ruby
 authors:
 - Tim Sharpe
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-09-25 00:00:00.000000000 Z
+date: 2025-11-06 00:00:00.000000000 Z
 dependencies: []
 description: "    Checks your Puppet manifests against the Puppetlabs style guide
   and alerts you to any discrepancies.\n"
@@ -92,6 +92,8 @@ files:
 - spec/fixtures/test/manifests/ignore_multiple_line.pp
 - spec/fixtures/test/manifests/ignore_reason.pp
 - spec/fixtures/test/manifests/init.pp
+- spec/fixtures/test/manifests/issue_254_overwriting_yaml/class_with_dash.pp
+- spec/fixtures/test/manifests/issue_254_overwriting_yaml/class_with_dash.yaml
 - spec/fixtures/test/manifests/malformed.pp
 - spec/fixtures/test/manifests/mismatched_control_comment.pp
 - spec/fixtures/test/manifests/parseable.yaml