Puppet Plans are not parsed correctly

[genebean]

What Versions are you running?

Editor Name and Version: VS Code 1.33.1
Extension: 0.18.0
PDK: 1.10.0 (using embedded Puppet from this)
Puppet: 6.4.0

Document: (Include the whole document)

plan upgrade_pe::enable_lb(
  TargetSpec $load_balancers,
) {
  $_load_balancers = $load_balancers.split(',')
  $cms = run_task('upgrade_pe::enable_lb', $_load_balancers, _catch_errors => true)
  $cms.each |$result| {
    if $result.ok {
      notice("${result.target.name} completed:\n${result.message}")
    } else {
      notice("${result.target.name} errored with message:\n${result.error}")
    }
  }
}

What You Are Seeing?

Lots of red that shouldn't be there

What is Expected?

No red when code is correct.

How Did You Get This To Happen? (Steps to Reproduce)

Open any plan with a TargetSpec defined

[jpogran]

As discussed in chat, the crux of the issue here is that we rely on the Puppet Plan folder structure conventions (all plans in a top level plans directory) and metadata.json being present (i.e. that this is a module) defined by the Puppet Plans docs to detect we need to enable the Puppet Plans parser. If that is not the case, we don't enable the parser

[genebean]

Based on above, I think an addition needs to be made for the plans directory being part of a Bolt project as defined at https://puppet.com/docs/bolt/latest/bolt_project_directories.html

The project pictured above corresponds to "Embedded project directory" in the linked docs:

project/ <----------------- this is the folder opened in VS Code
├── Boltdir  <------------- this is the Boltdir in the image above
│   ├── Puppetfile
│   ├── bolt.yaml
│   ├── data
│   │   └── common.yaml
│   ├── inventory.yaml
│   └── site-modules <----- this corresponds to my "site" folder but could have any name
│       └── project <------ this corresponds to my "upgrade_pe" module directory
│           ├── manifests
│           │   └── my_class.pp
│           ├── plans
│           │   ├── deploy.pp
│           │   └── diagnose.pp
│           └── tasks
│               ├── init.json
│               └── init.py
├── src #non Bolt source code for the project
└── tests #non Bolt tests for the project

Note that Bolt projects do not need a metadata.json. I am not sure how you would detect the "Local project directory" version from the docs but the embedded one could key off of the presence of a folder name Boltdir. When that folder is found it could be assumed that any folder named plans with two folders between it and the Boltdir contains Puppet Plans.

[jpogran]

FWIW, this was our original source: https://puppet.com/docs/bolt/latest/writing_plans.html#concept-4485. Apparently things have changed

[genebean]

That does explain a bit :)

[glennsarti]

Transferred issue to PES as this is not a highlighting issue