puppet-lint-module_reference-check 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2adc6115f3e7f9a1501f7e8f5a123f1058cf1d5ef8b20894617e4b1959ce6fcc
-  data.tar.gz: b4ff6aa3967cb954f245704b3dde86203146b3d8e569de41b318af1aaa53d950
+  metadata.gz: 12922e4a40ec5041a4fdbd2859cbacb179d2ad3242a6c536a0396e14eeb21f53
+  data.tar.gz: 11cafcbe2535f7a2275825a53ff3c590e6ebd28c1ae9239775537a139eb6b061
 SHA512:
-  metadata.gz: 5a3c5a95e0c14cb4bd6eb12497c79e76d5b71bb94437ae16301f458db6bf300675deb2f40aa31959fba84f2d5a0b8d74264a200660566d5f9ccdf8d77404ed6a
-  data.tar.gz: faf782c5114458182a9e5746c6d46c2b66dd15467dcc83f6bdd7dae886c67de50c2dffb3c0371de364538ceb7913bfcbbfcf110dd4815274beb1d9831c9bf243
+  metadata.gz: 558649a232611019dfec62b41f410086855a19d8014e01e42f742d8007b40253a652d913434624d026055fa287d6716cf10344da0ec26756384c2ec43c357ac2
+  data.tar.gz: 55e2eb095791d72415cd9b09ec4b8adcbe0722f8e6679349ed36bfbf1fe2164087a972ec2794565cba91484265f86a2fb74466451f4591c206a7208e062f98b3

data/README.md

@@ -20,6 +20,9 @@ This checks whether used modules are properly referenced in the comments by thes
   - internal modules
   - modules referenced by features
 
+**Note**: This check can only detect component module usage with the `class` and `include` keywords, but supports
+reference comments to undetectable components modules as well.
+
 ## Usage
 
 To use the plugin, add the following line to the Gemfile:

data/lib/puppet-lint/plugins/check_module_reference.rb

@@ -146,6 +146,9 @@ PuppetLint.new_check(:module_reference) do
           break
         end
       end
+      comments[index + 1]&.match(/^@note (?<name>.+)$/) do |matchdata|
+        return_object[:name] = matchdata['name']
+      end
     end
     return_object
   end

data/spec/puppet-lint/plugins/check_module_reference_spec.rb

@@ -59,6 +59,25 @@ describe 'module_reference' do
     end
   end
 
+  context 'valid code with correctly sorted reference to undetectable component module' do
+    let(:code) do
+      <<~CODE
+        # @ref foo
+        # @note undetected-a
+        # @see https://forge.puppet.com/modules/undetected/a
+        # @ref bar
+        # @note undetected-b
+        # @see https://forge.puppet.com/modules/undetected/b
+        class test () {
+        }
+      CODE
+    end
+
+    it 'should detect detect any problems' do
+      expect(problems).to have(0).problems
+    end
+  end
+
   context 'valid code with using include in a different context' do
     let(:code) do
       <<~CODE

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: puppet-lint-module_reference-check
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Dennis Ploeger