openbolt 5.0.0.rc1 → 5.1.0

data/lib/bolt/config.rb

@@ -101,7 +101,7 @@ module Bolt
 
         Bolt::Logger.warn(
           "unsupported_project_config",
-          "Unsupported project configuration detected in '#{filepath}': #{project_config.keys}. "\
+          "Unsupported project configuration detected in '#{filepath}': #{project_config.keys}. " \
           "Project configuration should be set in 'bolt-project.yaml'."
         )
       end
@@ -114,8 +114,8 @@ module Bolt
 
         Bolt::Logger.warn(
           "unsupported_inventory_config",
-          "Unsupported inventory configuration detected in '#{filepath}': #{transport_config.keys}. "\
-          "Transport configuration should be set under the 'inventory-config' option or "\
+          "Unsupported inventory configuration detected in '#{filepath}': #{transport_config.keys}. " \
+          "Transport configuration should be set under the 'inventory-config' option or " \
           "in 'inventory.yaml'."
         )
       end
@@ -126,13 +126,13 @@ module Bolt
       if data.key?('inventory-config')
         unless data['inventory-config'].is_a?(Hash)
           raise Bolt::ValidationError,
-                "Option 'inventory-config' must be of type Hash, received #{data['inventory-config']} "\
+                "Option 'inventory-config' must be of type Hash, received #{data['inventory-config']} " \
                 "#{data['inventory-config']} (file: #{filepath})"
         end
 
         if data['inventory-config'].key?('_plugin')
           raise Bolt::ValidationError,
-                "Found unsupported key '_plugin' for option 'inventory-config'; supported keys are "\
+                "Found unsupported key '_plugin' for option 'inventory-config'; supported keys are " \
                 "'#{INVENTORY_OPTIONS.keys.join("', '")}' (file: #{filepath})"
         end
 
@@ -309,6 +309,7 @@ module Bolt
 
     private def normalize_log(target)
       return target if target == 'console'
+
       target = target[5..-1] if target.start_with?('file:')
       'file:' + File.expand_path(target, @project.path)
     end
@@ -334,7 +335,7 @@ module Bolt
     def validate
       if @data['modulepath']&.include?(@project.managed_moduledir.to_s)
         raise Bolt::ValidationError,
-              "Found invalid path in modulepath: #{@project.managed_moduledir}. This path "\
+              "Found invalid path in modulepath: #{@project.managed_moduledir}. This path " \
               "is automatically appended to the modulepath and cannot be configured."
       end
 
@@ -479,6 +480,7 @@ module Bolt
     # Check if there is a case-insensitive match to the path
     def check_path_case(type, paths)
       return if paths.nil?
+
       matches = matching_paths(paths)
 
       if matches.any?

data/lib/bolt/executor.rb

@@ -17,7 +17,6 @@ require_relative '../bolt/transport/docker'
 require_relative '../bolt/transport/jail'
 require_relative '../bolt/transport/local'
 require_relative '../bolt/transport/lxd'
-require_relative '../bolt/transport/orch'
 require_relative '../bolt/transport/podman'
 require_relative '../bolt/transport/remote'
 require_relative '../bolt/transport/ssh'
@@ -29,7 +28,6 @@ module Bolt
     jail: Bolt::Transport::Jail,
     local: Bolt::Transport::Local,
     lxd: Bolt::Transport::LXD,
-    pcp: Bolt::Transport::Orch,
     podman: Bolt::Transport::Podman,
     remote: Bolt::Transport::Remote,
     ssh: Bolt::Transport::SSH,
@@ -84,6 +82,7 @@ module Bolt
     def transport(transport)
       impl = @transports[transport || 'ssh']
       raise(Bolt::UnknownTransportError, transport) unless impl
+
       # If there was an error creating the transport, ensure it gets thrown
       impl.no_error!
       impl.value
@@ -107,6 +106,7 @@ module Bolt
         # If types isn't set or if the subscriber is subscribed to
         # that type of event, publish the event
         next unless types.nil? || types.include?(event[:type])
+
         @publisher.post(subscriber) do |sub|
           # Wait for user to input to prompt before printing anything
           sleep(0.1) while @prompting
@@ -129,10 +129,10 @@ module Bolt
     def queue_execute(targets)
       if @warn_concurrency && targets.length > @concurrency
         @warn_concurrency = false
-        msg = "The ulimit is low, which might cause file limit issues. Default concurrency has been set to "\
-              "'#{@concurrency}' to mitigate those issues, which might cause Bolt to run slow. "\
-              "Disable this warning by configuring ulimit using 'ulimit -n <limit>' in your shell "\
-              "configuration, or by configuring Bolt's concurrency. "\
+        msg = "The ulimit is low, which might cause file limit issues. Default concurrency has been set to " \
+              "'#{@concurrency}' to mitigate those issues, which might cause Bolt to run slow. " \
+              "Disable this warning by configuring ulimit using 'ulimit -n <limit>' in your shell " \
+              "configuration, or by configuring Bolt's concurrency. " \
               "See https://puppet.com/docs/bolt/latest/bolt_known_issues.html for details."
         Bolt::Logger.warn("low_ulimit", msg)
       end
@@ -169,6 +169,7 @@ module Bolt
             # exception and some promise is still missing a result.
             result_promises.each do |target, promise|
               next if promise.fulfilled?
+
               error = $ERROR_INFO || Bolt::Error.new("No result was returned for #{target.uri}",
                                                      "puppetlabs.bolt/missing-result-error")
               promise.set(Bolt::Result.from_exception(target, error))
@@ -479,6 +480,7 @@ module Bolt
       start = wait_now
       until yield
         raise(TimeoutError, 'Timed out waiting for target') if (wait_now - start).to_i >= timeout
+
         sleep(retry_interval)
       end
     end
@@ -486,6 +488,7 @@ module Bolt
     def prompt(prompt, options)
       unless $stdin.tty?
         return options[:default] if options[:default]
+
         raise Bolt::Error.new('STDIN is not a tty, unable to prompt', 'bolt/no-tty-error')
       end
 
@@ -511,24 +514,6 @@ module Bolt
       value
     end
 
-    # Plan context doesn't make sense for most transports but it is tightly
-    # coupled with the orchestrator transport since the transport behaves
-    # differently when a plan is running. In order to limit how much this
-    # pollutes the transport API we only handle the orchestrator transport here.
-    # Since we call this function without resolving targets this will result
-    # in the orchestrator transport always being initialized during plan runs.
-    # For now that's ok.
-    #
-    # In the future if other transports need this or if we want a plan stack
-    # we'll need to refactor.
-    def start_plan(plan_context)
-      transport('pcp').plan_context = plan_context
-    end
-
-    def finish_plan(plan_result)
-      transport('pcp').finish_plan(plan_result)
-    end
-
     def without_default_logging
       publish_event(type: :disable_default_output)
       yield

data/lib/bolt/fiber_executor.rb

@@ -82,6 +82,7 @@ module Bolt
         # Once we've restarted the Fiber, check to see if it's finished again
         # and cleanup if it has.
         next if future.alive?
+
         @logger.trace("Cleaning up future '#{future.name}'")
 
         # If the future errored and the main plan has already exited, log the
@@ -99,6 +100,7 @@ module Bolt
       # execute before checking again. This mitigates CPU
       # thrashing.
       return unless active_futures.all? { |f| %i[returned_immediately unfinished].include?(f.value) }
+
       @logger.trace("Nothing can be resumed. Rechecking in 0.5 seconds.")
 
       sleep(0.5)
@@ -145,7 +147,7 @@ module Bolt
         # futures being waited on.
         until (futures = get_futures_for_plan(plan_id: plan_id)).map(&:alive?).none?
           if futures.map(&:fiber).include?(Fiber.current)
-            msg = "The wait() function cannot be called with no arguments inside a "\
+            msg = "The wait() function cannot be called with no arguments inside a " \
                   "background block in the same plan."
             raise Bolt::Error.new(msg, 'bolt/infinite-wait')
           end

data/lib/bolt/inventory/group.rb

@@ -179,6 +179,7 @@ module Bolt
           if (found = @aliases[alia])
             raise ValidationError.new(alias_conflict(alia, found, target_name), @name)
           end
+
           @aliases[alia] = target_name
         end
       end
@@ -339,8 +340,10 @@ module Bolt
 
         Bolt::Config::Options::TRANSPORT_CONFIG.each_key do |transport|
           next unless result['config'].key?(transport)
+
           transport_config = result['config'][transport]
           next unless transport_config.is_a?(Hash)
+
           transport_config = Bolt::Util.postwalk_vals(transport_config) do |val|
             if val.is_a?(Hash)
               val = val.compact

data/lib/bolt/inventory/inventory.rb

@@ -109,6 +109,7 @@ module Bolt
         if target_array.count > 1
           raise ValidationError.new("'#{target}' refers to #{target_array.count} targets", nil)
         end
+
         target_array.first
       end
 
@@ -158,6 +159,7 @@ module Bolt
           # Find groups that match the glob
           group_lookup.each do |name, grp|
             next unless match_wildcard?(target, name, ext_glob: ext_glob)
+
             targets += grp.all_targets.to_a
           end
 

data/lib/bolt/inventory/options.rb

@@ -21,7 +21,7 @@ module Bolt
       # https://github.com/puppetlabs/bolt/blob/main/schemas/README.md
       DEFINITIONS = {
         "alias" => {
-          description: "A unique alias to refer to the target. Aliases cannot conflict "\
+          description: "A unique alias to refer to the target. Aliases cannot conflict " \
                        "with the name of a group, the name of a target, or another alias.",
           type: [String, Array],
           uniqueItems: true,
@@ -74,16 +74,16 @@ module Bolt
           _plugin: true
         },
         "name" => {
-          description: "A human-readable name to refer to the group or target. Names "\
-                       "cannot conflict with the name of a group, the name of a target, "\
-                       "or the alias of a target. A name is required for a group and is "\
+          description: "A human-readable name to refer to the group or target. Names " \
+                       "cannot conflict with the name of a group, the name of a target, " \
+                       "or the alias of a target. A name is required for a group and is " \
                        "required for a target unless the uri option is set.",
           type: String,
           _plugin: true
         },
         "plugin_hooks" => {
-          description: "Configuration for the Puppet library plugin used to install the "\
-                       "Puppet agent on the target. For more information, see "\
+          description: "Configuration for the Puppet library plugin used to install the " \
+                       "Puppet agent on the target. For more information, see " \
                        "https://pup.pt/bolt-plugin-hooks",
           type: Hash,
           properties: {
@@ -115,7 +115,7 @@ module Bolt
           _plugin: true
         },
         "uri" => {
-          description: "The URI of the target. This option is required unless the name "\
+          description: "The URI of the target. This option is required unless the name " \
                        "option is set.",
           type: String,
           format: "uri",

data/lib/bolt/inventory/target.rb

@@ -59,6 +59,7 @@ module Bolt
 
       def set_local_defaults
         return if @set_local_default
+
         defaults = {
           'local' => { 'interpreters' => { '.rb' => RbConfig.ruby } }
         }
@@ -176,8 +177,8 @@ module Bolt
         if (dotted = facts.keys.select { |name| name.include?('.') }).any?
           Bolt::Logger.deprecate(
             'dotted_fact_name',
-            "Target '#{safe_name}' includes dotted fact names: '#{dotted.join("', '")}'. Dotted fact "\
-            "names are deprecated and Bolt does not automatically convert facts with dotted names to "\
+            "Target '#{safe_name}' includes dotted fact names: '#{dotted.join("', '")}'. Dotted fact " \
+            "names are deprecated and Bolt does not automatically convert facts with dotted names to " \
             "structured facts. For more information, see https://pup.pt/bolt-dotted-facts"
           )
         end

data/lib/bolt/inventory.rb

@@ -71,6 +71,7 @@ module Bolt
           source = ENVIRONMENT_VAR
           data = YAML.safe_load(ENV[ENVIRONMENT_VAR])
           raise Bolt::ParseError, "Could not parse inventory from $#{ENVIRONMENT_VAR}" unless data.is_a?(Hash)
+
           logger.debug("Loaded inventory from environment variable #{ENVIRONMENT_VAR}")
         rescue Psych::Exception
           raise Bolt::ParseError, "Could not parse inventory from $#{ENVIRONMENT_VAR}"

data/lib/bolt/logger.rb

@@ -231,11 +231,13 @@ module Bolt
     #
     private_class_method def self.do_warn(msg, id)
       return if @disable_warnings.include?(id)
+
       logger(self).warn(msg)
     end
 
     private_class_method def self.do_warn_once(msg, id)
       return unless @warnings.add?(id)
+
       do_warn(msg, id)
     end
 

data/lib/bolt/module.rb

@@ -15,6 +15,7 @@ module Bolt
 
       modulepath.each do |path|
         next unless File.exist?(path) && File.directory?(path)
+
         Dir.children(path)
            .map { |dir| File.join(path, dir) }
            .select { |dir| File.directory?(dir) }

data/lib/bolt/module_installer/puppetfile.rb

@@ -56,7 +56,7 @@ module Bolt
           else
             unless skip_unsupported_modules
               raise Bolt::ValidationError,
-                    "Cannot parse Puppetfile at #{path}, module '#{mod.title}' is not a "\
+                    "Cannot parse Puppetfile at #{path}, module '#{mod.title}' is not a " \
                     "Puppet Forge or Git module."
             end
           end
@@ -105,7 +105,7 @@ module Bolt
             Puppetfile does not include modules that satisfy the following specifications:
 
             #{unsatisfied_specs.map(&:to_hash).to_yaml.lines.drop(1).join.chomp}
-            
+
             This Puppetfile might not be managed by Bolt. To forcibly overwrite the
             Puppetfile, run '#{command}'.
           MESSAGE
@@ -116,9 +116,9 @@ module Bolt
         if versionless_mods.any?
           message = <<~MESSAGE.chomp
             Puppetfile includes Forge modules without a version requirement:
-            
+
             #{versionless_mods.map(&:to_spec).join.chomp}
-            
+
             This Puppetfile might not be managed by Bolt. To forcibly overwrite the
             Puppetfile, run '#{command}'.
           MESSAGE

data/lib/bolt/module_installer/resolver.rb

@@ -98,8 +98,8 @@ module Bolt
         # names, but we error early here to provide a more helpful message.
         if (name_conflicts = modules.map(&:name) & unresolved.map(&:name)).any?
           raise Bolt::Error.new(
-            "Detected unresolved module specifications with the same name as a resolved module "\
-            "dependency: #{name_conflicts.join(', ')}. Either remove the unresolved module specification "\
+            "Detected unresolved module specifications with the same name as a resolved module " \
+            "dependency: #{name_conflicts.join(', ')}. Either remove the unresolved module specification " \
             "or set the module with the conflicting dependency to not resolve.",
             "bolt/module-name-conflict-error"
           )

data/lib/bolt/module_installer/specs/forge_spec.rb

@@ -38,9 +38,9 @@ module Bolt
         private def parse_name(name)
           unless (match = name.match(NAME_REGEX))
             raise Bolt::ValidationError,
-                  "Invalid name for Forge module specification: #{name}. Name must match "\
-                  "'owner/name'. Owner segment can only include letters or digits. Name "\
-                  "segment must start with a lowercase letter and can only include lowercase "\
+                  "Invalid name for Forge module specification: #{name}. Name must match " \
+                  "'owner/name'. Owner segment can only include letters or digits. Name " \
+                  "segment must start with a lowercase letter and can only include lowercase " \
                   "letters, digits, and underscores."
           end
 
@@ -53,7 +53,7 @@ module Bolt
           [version_requirement, SemanticPuppet::VersionRange.parse(version_requirement || '>= 0')]
         rescue StandardError
           raise Bolt::ValidationError,
-                "Invalid version requirement for Forge module specification #{@full_name}: "\
+                "Invalid version requirement for Forge module specification #{@full_name}: " \
                 "#{version_requirement.inspect}"
         end
 

data/lib/bolt/module_installer/specs/git_spec.rb

@@ -39,7 +39,7 @@ module Bolt
 
           if @name.nil? && @resolve == false
             raise Bolt::ValidationError,
-                  "Missing name for Git module specification: #{@git}. Git module specifications "\
+                  "Missing name for Git module specification: #{@git}. Git module specifications " \
                   "must include a 'name' key when 'resolve' is false."
           end
 
@@ -61,9 +61,9 @@ module Bolt
 
           unless (match = name.match(NAME_REGEX))
             raise Bolt::ValidationError,
-                  "Invalid name for Git module specification: #{name}. Name must match "\
-                  "'name' or 'owner/name'. Owner segment can only include letters or digits. "\
-                  "Name segment must start with a lowercase letter and can only include "\
+                  "Invalid name for Git module specification: #{name}. Name must match " \
+                  "'name' or 'owner/name'. Owner segment can only include letters or digits. " \
+                  "Name segment must start with a lowercase letter and can only include " \
                   "lowercase letters, digits, and underscores."
           end
 
@@ -123,8 +123,8 @@ module Bolt
 
             unless module_id
               raise Bolt::Error.new(
-                "Unable to locate metadata and calculate SHA for ref #{@ref} at #{@git}. This may "\
-                "not be a valid module. For more information about how Bolt attempted to locate "\
+                "Unable to locate metadata and calculate SHA for ref #{@ref} at #{@git}. This may " \
+                "not be a valid module. For more information about how Bolt attempted to locate " \
                 "this information, check the debugging logs.",
                 'bolt/missing-module-metadata-error'
               )

data/lib/bolt/module_installer/specs/id/gitclone.rb

@@ -96,6 +96,7 @@ module Bolt
             Bolt::Logger.debug("Executing command '#{bare_clone.join(' ')}'")
             _out, err, status = Open3.capture3(*bare_clone)
             return true if status.success?
+
             Bolt::Logger.debug("Unable to clone bare repository at #{loc(git, proxy)}: #{err}")
 
             # Fall back to cloning the full repository

data/lib/bolt/module_installer/specs/id/github.rb

@@ -16,6 +16,7 @@ module Bolt
           private_class_method def self.name_and_sha(git, ref, proxy)
             repo = parse_repo(git)
             return nil unless repo
+
             [request_name(repo, ref, proxy), request_sha(repo, ref, proxy)]
           end
 
@@ -72,7 +73,7 @@ module Bolt
               message = "GitHub API rate limit exceeded, unable to calculate SHA."
 
               unless ENV['GITHUB_TOKEN']
-                message += " To increase your rate limit, set the GITHUB_TOKEN environment "\
+                message += " To increase your rate limit, set the GITHUB_TOKEN environment " \
                           "variable with a GitHub personal access token."
               end
 

data/lib/bolt/module_installer/specs/id/gitlab.rb

@@ -16,6 +16,7 @@ module Bolt
           private_class_method def self.name_and_sha(git, ref, proxy)
             repo = parse_repo(git)
             return nil unless repo
+
             [request_name(repo, ref, proxy), request_sha(repo, ref, proxy)]
           end
 
@@ -74,7 +75,7 @@ module Bolt
               message = "GitLab API rate limit exceeded, unable to calculate SHA."
 
               unless ENV['GITLAB_TOKEN']
-                message += " To increase your rate limit, set the GITLAB_TOKEN environment "\
+                message += " To increase your rate limit, set the GITLAB_TOKEN environment " \
                           "variable with a GitLab personal access token."
               end
 

data/lib/bolt/module_installer.rb

@@ -23,7 +23,7 @@ module Bolt
       # Exit early if project config already includes a spec with this name.
       if project_specs.include?(name)
         @outputter.print_message(
-          "Project configuration file #{project_file} already includes specification "\
+          "Project configuration file #{project_file} already includes specification " \
           "with name #{name}. Nothing to do."
         )
         return true
@@ -92,11 +92,13 @@ module Bolt
       # modified.
       old = (old&.modules || []).each_with_object({}) do |mod, acc|
         next unless mod.type == :forge
+
         acc[mod.full_name] = mod
       end
 
       new = new.modules.each_with_object({}) do |mod, acc|
         next unless mod.type == :forge
+
         acc[mod.full_name] = mod
       end
 

data/lib/bolt/outputter/human.rb

@@ -36,6 +36,7 @@ module Bolt
 
       def start_spin
         return unless @spin && @stream.isatty && !@spinning
+
         @spinning = true
         @spin_thread = Thread.new do
           loop do
@@ -47,6 +48,7 @@ module Bolt
 
       def stop_spin
         return unless @spin && @stream.isatty && @spinning
+
         @spinning = false
         @spin_thread.terminate
         @stream.print("\b")
@@ -61,6 +63,7 @@ module Bolt
       #
       def wrap(string, width = 80)
         return string unless string.is_a?(String)
+
         string.gsub(/(.{1,#{width}})(\s+|\Z)/, "\\1\n")
       end
 
@@ -68,6 +71,7 @@ module Bolt
       #
       def truncate(string, width = 80)
         return string unless string.is_a?(String) && string.length > width
+
         string.lines.first[0...width].gsub(/\s\w+\s*$/, '...')
       end
 
@@ -164,6 +168,7 @@ module Bolt
           result.resource_logs.each do |log|
             # Omit low-level info/debug messages
             next if %w[info debug].include?(log['level'])
+
             message = format_log(log)
             @stream.puts(indent(2, message))
           end
@@ -656,7 +661,7 @@ module Bolt
 
         print_message(<<~OUTPUT)
           Created plan '#{name}' at '#{path}'
-  
+
           Show this plan with:
               #{show_command} #{name}
           Run this plan with:
@@ -675,7 +680,7 @@ module Bolt
 
         print_message(<<~OUTPUT)
           Created policy '#{name}' at '#{path}'
-          
+
           Apply this policy with:
               #{apply_command}
           Show available policies with:
@@ -786,8 +791,8 @@ module Bolt
         info = +''
 
         # Add target count summary
-        count = "#{inventory_count + adhoc_count} total, "\
-                "#{inventory_count} from inventory, "\
+        count = "#{inventory_count + adhoc_count} total, " \
+                "#{inventory_count} from inventory, " \
                 "#{adhoc_count} adhoc"
         info << colorize(:cyan, "Target count\n")
         info << indent(2, count)

data/lib/bolt/outputter/rainbow.rb

@@ -65,6 +65,7 @@ module Bolt
 
       def start_spin
         return unless @spin && @stream.isatty && !@spinning
+
         @spinning = true
         @spin_thread = Thread.new do
           loop do

data/lib/bolt/pal/yaml_plan/parameter.rb

@@ -26,8 +26,8 @@ module Bolt
           definition_keys = definition.keys.to_set
           unless PARAMETER_KEYS.superset?(definition_keys)
             invalid_keys = definition_keys - PARAMETER_KEYS
-            raise Bolt::Error.new("Plan parameter #{param.inspect} contains illegal key(s)" \
-                                  " #{invalid_keys.to_a.inspect}",
+            raise Bolt::Error.new("Plan parameter #{param.inspect} contains illegal key(s) " \
+                                  "#{invalid_keys.to_a.inspect}",
                                   "bolt/invalid-plan")
           end
         end

data/lib/bolt/pal/yaml_plan/step/resources.rb

@@ -58,7 +58,7 @@ module Bolt
                   * => $res['parameters'],
                 }
               }
-  
+
               # Add relationships if there is more than one resource
               if $resources.length > 1 {
                 ($resources.length - 1).each |$index| {

data/lib/bolt/pal.rb

@@ -147,6 +147,7 @@ module Bolt
 
     def detect_project_conflict(project, environment)
       return unless project && project.load_as_module?
+
       # The environment modulepath has stripped out non-existent directories,
       # so we don't need to check for them
       modules = environment.modulepath.flat_map do |path|
@@ -192,7 +193,7 @@ module Bolt
             rescue Puppet::PreformattedError => e
               if e.issue_code == :UNKNOWN_VARIABLE &&
                  %w[facts trusted server_facts settings].include?(e.arguments[:name])
-                message = "Evaluation Error: Variable '#{e.arguments[:name]}' is not available in the current scope "\
+                message = "Evaluation Error: Variable '#{e.arguments[:name]}' is not available in the current scope " \
                           "unless explicitly defined."
                 details = { file: e.file, line: e.line, column: e.pos }
                 PALError.new(message, details)
@@ -210,6 +211,7 @@ module Bolt
       if r.is_a?(StandardError) && !r.is_a?(Bolt::PuppetError)
         raise r
       end
+
       r
     end
 
@@ -339,6 +341,7 @@ module Bolt
             # If any file has been updated since we last cached, update the
             # cache
             next unless file_modified?(f['path'], f['mtime'])
+
             data = get_task_info(task_name, with_mtime: true)
             data = Bolt::Util.walk_keys(data, &:to_s)
             # Tell Bolt to write to the cache file once we're done
@@ -495,9 +498,9 @@ module Bolt
 
       pp_path = File.join(mod, 'plans', "#{plan_subpath}.pp")
       if File.exist?(pp_path)
-        require 'puppet-strings'
-        require 'puppet-strings/yard'
-        PuppetStrings::Yard.setup!
+        require 'openvox-strings'
+        require 'openvox-strings/yard'
+        OpenvoxStrings::Yard.setup!
         YARD::Logger.instance.level = if YARD::Logger.const_defined?(:Severity)
                                         YARD::Logger::Severity::ERROR
                                       else

data/lib/bolt/plan_creator.rb

@@ -10,8 +10,8 @@ module Bolt
     def self.validate_plan_name(project, plan_name)
       if project.name.nil?
         raise Bolt::Error.new(
-          "Project directory '#{project.path}' is not a named project. Unable to create "\
-          "a project-level plan. To name a project, set the 'name' key in the 'bolt-project.yaml' "\
+          "Project directory '#{project.path}' is not a named project. Unable to create " \
+          "a project-level plan. To name a project, set the 'name' key in the 'bolt-project.yaml' " \
           "configuration file.",
           "bolt/unnamed-project-error"
         )
@@ -36,7 +36,7 @@ module Bolt
       prefix, _, basename = segment_plan_name(plan_name)
 
       unless prefix == project.name
-        message = "Incomplete plan name: A plan name must be prefixed with the name of the "\
+        message = "Incomplete plan name: A plan name must be prefixed with the name of the " \
           "project or module. Did you mean '#{project.name}::#{plan_name}'?"
 
         raise Bolt::ValidationError, message
@@ -44,6 +44,7 @@ module Bolt
 
       %w[pp yaml].each do |ext|
         next unless (path = project.plans_path + "#{basename}.#{ext}").exist?
+
         raise Bolt::Error.new(
           "A plan with the name '#{plan_name}' already exists at '#{path}', nothing to do.",
           'bolt/existing-plan-error'
@@ -146,7 +147,7 @@ module Bolt
       <<~YAML
         # This is the structure of a simple plan. To learn more about writing
         # YAML plans, see the documentation: http://pup.pt/bolt-yaml-plans
-        
+
         # The description sets the description of the plan that will appear
         # in 'bolt plan show' output.
         description: A plan created with bolt plan new