Layout/ClosingHeredocIndentation

mhashizume · mhashizume · commit d3d3f48058c6 · 2023-12-19T11:42:55.000-08:00
This commit enables the Rubocop Layout/ClosingHeredocIndentation cop.
diff --git a/.rubocop_todo.yml b/.rubocop_todo.yml
@@ -69,10 +69,6 @@ Layout/AssignmentIndentation:
     - 'lib/puppet/util.rb'
     - 'lib/puppet/util/windows/daemon.rb'
 
-# This cop supports safe auto-correction (--auto-correct).
-Layout/ClosingHeredocIndentation:
-  Enabled: false
-
 # This cop supports safe auto-correction (--auto-correct).
 Layout/ClosingParenthesisIndentation:
   Enabled: false
diff --git a/lib/puppet/application/doc.rb b/lib/puppet/application/doc.rb
@@ -112,7 +112,7 @@ module - see https://github.com/puppetlabs/puppetlabs-strings for more informati
 ---------
 Copyright (c) 2011 Puppet Inc., LLC Licensed under the Apache 2.0 License
 
-HELP
+    HELP
   end
 
   def handle_unknown( opt, arg )
diff --git a/lib/puppet/application/ssl.rb b/lib/puppet/application/ssl.rb
@@ -83,7 +83,7 @@ def help
 
  * show:
   Print the full-text version of this host's certificate.
-HELP
+    HELP
   end
 
   option('--target CERTNAME') do |arg|
diff --git a/lib/puppet/datatypes/error.rb b/lib/puppet/datatypes/error.rb
@@ -14,7 +14,7 @@
     functions => {
       message => Callable[[], String[1]]
     }
-    PUPPET
+  PUPPET
 
   require_relative '../../puppet/datatypes/impl/error'
 
diff --git a/lib/puppet/defaults.rb b/lib/puppet/defaults.rb
@@ -430,7 +430,7 @@ def self.initialize_default_settings!(settings)
       between the configured or resolved path.
 
       When set to false, the resolved paths are reported instead of the configured paths.
-    EOT
+      EOT
     },
     :use_last_environment => {
       :type     => :boolean,
@@ -441,7 +441,7 @@ def self.initialize_default_settings!(settings)
       environment and skip the node request.
 
       When set to false, we will do the node request and ignore the environment data from the last_run_summary file.
-    EOT
+      EOT
     },
     :always_retry_plugins => {
         :type     => :boolean,
@@ -462,7 +462,7 @@ def self.initialize_default_settings!(settings)
         feature.  This behavior is almost always appropriate for the server,
         and can result in a significant performance improvement for types and
         features that are checked frequently.
-      EOT
+        EOT
     },
     :diff_args => {
         :default  => lambda { default_diffargs },
@@ -709,7 +709,7 @@ def self.initialize_default_settings!(settings)
 releases this value will only determine if file content is cached.
 
 Valid values are 0 (never cache) and 15 (15 second minimum wait time).
-            WARNING
+          WARNING
         end
       end
     },
diff --git a/lib/puppet/parser/functions/break.rb b/lib/puppet/parser/functions/break.rb
@@ -34,7 +34,7 @@
 
 * Also see functions `next` and `return`
 * Since 4.8.0
-DOC
+  DOC
 ) do |_args|
   Puppet::Parser::Functions::Error.is4x('break')
 end
diff --git a/lib/puppet/parser/functions/create_resources.rb b/lib/puppet/parser/functions/create_resources.rb
@@ -51,7 +51,7 @@
     data binding and Puppet default value expressions are considered (in that order) for the
     final value of a parameter (just as when setting a parameter to `undef` in a Puppet language
     resource declaration).
-  ENDHEREDOC
+ENDHEREDOC
   if Puppet[:tasks]
     raise Puppet::ParseErrorWithIssue.from_issue_and_stack(
       Puppet::Pops::Issues::CATALOG_OPERATION_NOT_SUPPORTED_WHEN_SCRIPTING,
diff --git a/lib/puppet/parser/functions/dig.rb b/lib/puppet/parser/functions/dig.rb
@@ -33,7 +33,7 @@
 exists in a structure without mandating that it always exists.
 
 * Since 4.5.0
-DOC
+  DOC
 ) do |_args|
   Puppet::Parser::Functions::Error.is4x('dig')
 end
diff --git a/lib/puppet/parser/functions/each.rb b/lib/puppet/parser/functions/each.rb
@@ -99,7 +99,7 @@
 documentation.
 
 - Since 4.0.0
-DOC
+  DOC
 ) do |_args|
   Puppet::Parser::Functions::Error.is4x('each')
 end
diff --git a/lib/puppet/parser/functions/filter.rb b/lib/puppet/parser/functions/filter.rb
@@ -74,7 +74,7 @@
 ~~~
 
 - Since 4.0.0
-DOC
+  DOC
 ) do |_args|
   Puppet::Parser::Functions::Error.is4x('filter')
 end
diff --git a/lib/puppet/parser/functions/hiera_array.rb b/lib/puppet/parser/functions/hiera_array.rb
@@ -85,7 +85,7 @@ module Puppet::Parser::Functions
 for more information about Hiera lookup functions.
 
 - Since 4.0.0
-DOC
+    DOC
 ) do |*_args|
     Error.is4x('hiera_array')
   end
diff --git a/lib/puppet/parser/functions/hiera_hash.rb b/lib/puppet/parser/functions/hiera_hash.rb
@@ -95,7 +95,7 @@ module Puppet::Parser::Functions
 for more information about Hiera lookup functions.
 
 - Since 4.0.0
-DOC
+    DOC
   ) do |*_args|
     Error.is4x('hiera_hash')
   end
diff --git a/lib/puppet/parser/functions/hiera_include.rb b/lib/puppet/parser/functions/hiera_include.rb
@@ -94,7 +94,7 @@ module Puppet::Parser::Functions
 with calls to stdlib's `deep_merge` function depending on kind of hiera call and setting of merge in hiera.yaml.
 
 - Since 4.0.0
-DOC
+    DOC
   ) do |*_args|
     Error.is4x('hiera_include')
   end
diff --git a/lib/puppet/parser/functions/lest.rb b/lib/puppet/parser/functions/lest.rb
@@ -44,7 +44,7 @@
 Would notice the value `20`
 
 * Since 4.5.0
-DOC
+  DOC
 ) do |_args|
   Puppet::Parser::Functions::Error.is4x('lest')
 end
diff --git a/lib/puppet/parser/functions/lookup.rb b/lib/puppet/parser/functions/lookup.rb
@@ -127,7 +127,7 @@ module Puppet::Parser::Functions
               },
     })
 
-ENDHEREDOC
+  ENDHEREDOC
   Error.is4x('lookup')
   end
 end
diff --git a/lib/puppet/parser/functions/map.rb b/lib/puppet/parser/functions/map.rb
@@ -71,7 +71,7 @@
 ~~~
 
 - Since 4.0.0
-DOC
+  DOC
 ) do |_args|
   Puppet::Parser::Functions::Error.is4x('map')
 end
diff --git a/lib/puppet/parser/functions/match.rb b/lib/puppet/parser/functions/match.rb
@@ -38,7 +38,7 @@
 ~~~
 
 - Since 4.0.0
-DOC
+  DOC
 ) do |_args|
   Puppet::Parser::Functions::Error.is4x('match')
 end
diff --git a/lib/puppet/parser/functions/new.rb b/lib/puppet/parser/functions/new.rb
@@ -985,7 +985,7 @@
 notice($fmt(256)) # will notice '0x100'
 ```
 
-DOC
+  DOC
 ) do |_args|
   Puppet::Parser::Functions::Error.is4x('new')
 end
diff --git a/lib/puppet/parser/functions/next.rb b/lib/puppet/parser/functions/next.rb
@@ -33,7 +33,7 @@
 
 * Also see functions `return` and `break`
 * Since 4.8.0
-DOC
+  DOC
 ) do |_args|
   Puppet::Parser::Functions::Error.is4x('next')
 end
diff --git a/lib/puppet/parser/functions/reduce.rb b/lib/puppet/parser/functions/reduce.rb
@@ -132,7 +132,7 @@
 ~~~
 
 - Since 4.0.0
-DOC
+  DOC
 ) do |_args|
   Puppet::Parser::Functions::Error.is4x('reduce')
 end
diff --git a/lib/puppet/parser/functions/return.rb b/lib/puppet/parser/functions/return.rb
@@ -87,7 +87,7 @@ class { example: x => [some_value] }
 
 * Also see functions `return` and `break`
 * Since 4.8.0
-DOC
+  DOC
 ) do |_args|
   Puppet::Parser::Functions::Error.is4x('return')
 end
diff --git a/lib/puppet/parser/functions/reverse_each.rb b/lib/puppet/parser/functions/reverse_each.rb
@@ -78,7 +78,7 @@
 
 * Since 4.4.0
 
-DOC
+  DOC
 ) do |_args|
   Puppet::Parser::Functions::Error.is4x('reverse_each')
 end
diff --git a/lib/puppet/parser/functions/scanf.rb b/lib/puppet/parser/functions/scanf.rb
@@ -31,7 +31,7 @@
 ```
 
 - Since 4.0.0
-DOC
+  DOC
 ) do |args|
   data = args[0]
   format = args[1]
diff --git a/lib/puppet/parser/functions/slice.rb b/lib/puppet/parser/functions/slice.rb
@@ -34,7 +34,7 @@
     $a.slice(2) |$first, $second| { ... }
 
 - Since 4.0.0
-DOC
+  DOC
 ) do |_args|
   Puppet::Parser::Functions::Error.is4x('slice')
 end
diff --git a/lib/puppet/parser/functions/step.rb b/lib/puppet/parser/functions/step.rb
@@ -79,7 +79,7 @@
 
 * Since 4.4.0
 
-DOC
+  DOC
 ) do |_args|
   Puppet::Parser::Functions::Error.is4x('step')
 end
diff --git a/lib/puppet/parser/functions/then.rb b/lib/puppet/parser/functions/then.rb
@@ -68,7 +68,7 @@
 
 * Since 4.5.0
 
-DOC
+  DOC
 ) do |_args|
   Puppet::Parser::Functions::Error.is4x('then')
 end
diff --git a/lib/puppet/parser/functions/type.rb b/lib/puppet/parser/functions/type.rb
@@ -48,7 +48,7 @@
 
  * Since 4.4.0
 
-DOC
+  DOC
 ) do |_args|
   Puppet::Parser::Functions::Error.is4x('type')
 end
diff --git a/lib/puppet/parser/functions/with.rb b/lib/puppet/parser/functions/with.rb
@@ -23,7 +23,7 @@
 ~~~
 
 - Since 4.0.0
-DOC
+  DOC
 ) do |_args|
   Puppet::Parser::Functions::Error.is4x('with')
 end
diff --git a/lib/puppet/type/schedule.rb b/lib/puppet/type/schedule.rb
@@ -54,7 +54,7 @@ module Puppet
       resource could be checked & applied multiple times in the schedule as
       the information about when the resource was last checked will have
       expired from the cache.
-      EOT
+    EOT
 
     apply_to_all
 
@@ -72,7 +72,7 @@ module Puppet
               schedule => 'everyday',
             }
 
-        EOT
+      EOT
       isnamevar
     end
 

Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@`
`14`	`14`	`functions => {`
`15`	`15`	`message => Callable[[], String[1]]`
`16`	`16`	`}`
`17`		`- PUPPET`
	`17`	`+ PUPPET`
`18`	`18`
`19`	`19`	`require_relative '../../puppet/datatypes/impl/error'`
`20`	`20`