puppet-lint-param_comment-check 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 001c0354a4c8e6d8d852d3f07122cf01f80603b17aaa8eebe9954ea4566704b6
-  data.tar.gz: 2502c094ecbbebca5c3986ec25f8f1a2563b55cf1d430d8abe575e9d637abfe0
+  metadata.gz: b4b8ad42633483b29d912da99b108a9bcd277b7c6b1d21ebaeeedb4aa9634e12
+  data.tar.gz: 768790358859c7375df58da9fbbd2b932a94f606647d9f13e513fc119cbd29e3
 SHA512:
-  metadata.gz: 60175714324271adf92951be259db9ad0dc292c35681784058d7f8b1e5dbec2ecb01c589186c89938aaec72ca62ccef50c7c5d96a2a67c33f08420c5f5f978a4
-  data.tar.gz: 5a15fc0ea2b159d6d41470b0f74267d1a74d518f840da822c1e94544b258c78314f3a36e491c9d885e05ca2b68d6da00495305f20b6c39fba379901b263355d7
+  metadata.gz: eee0e509c76c55d1cc9b97ed444bdadbf1caa8a970e03e339618083d1e5019f0a18e70d627b4f691f1aa255a78a8240972db6a68d38b2a41c9f9993f3a3714e4
+  data.tar.gz: 6af8ad1b81d6d0b9f2e4d8cbf9cee33507e6813f025691187edab23adc9f0510372e4cd88362f614066904c32243bc3bc0a550fddfe238f9e5c250bfc897f592

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

@@ -57,6 +57,7 @@ def analyze_params(param_tokens)
       current_param = EMPTY_PARAM.dup
     end
   end
+  params.append(current_param) unless current_param == EMPTY_PARAM
   params
 end
 

data/lib/puppet-lint-param_comment-check/param_workflow.rb

@@ -11,6 +11,9 @@ class ParamWorkflow < FiniteMachine::Definition
   event :got_description, from: :awaiting_description, to: :awaiting_separator
   event :got_separator, from: :awaiting_separator, to: :awaiting_header
 
+  # for multi-line descriptions
+  event :got_description, from: :awaiting_separator, to: :awaiting_separator
+
   # handling options
   event :got_option_header, from: :awaiting_separator, to: :awaiting_option_description
   event :got_option_description, from: :awaiting_option_description, to: :awaiting_separator

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

@@ -11,6 +11,7 @@ describe 'param_comment' do
         #
         # @param mandatory
         #   A mandatory parameter
+        #   with two lines
         #
         # @param withdefault
         #   A parameter with a default value
@@ -23,7 +24,7 @@ describe 'param_comment' do
         class my_class (
             String $mandatory,
             Boolean $withdefault = false,
-            Optional[String] $optional = undef,
+            Optional[String] $optional = undef
         ) {}
       CODE
     end
@@ -170,6 +171,9 @@ describe 'param_comment' do
         #   A mandatory parameter
         # @option mandatory [Boolean] :some_option
         #   An option
+        # @option mandatory [String] :some_other_option
+        #   Another option
+        #   with multiple lines of description
         class my_class (
             Hash $mandatory,
         ) {}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-lint-param_comment-check
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Dennis Ploeger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-30 00:00:00.000000000 Z
+date: 2022-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puppet-lint