Add new setting vrdev.buildTools.extraVroGroups

[Indy-rbo]

Description

We enjoy the usage of the lint rule ToolchainVersionRule in our monorepo, as it also informs colleagues on the team what the recommended BTVA version is for a package.

But for some projects in our monorepo we have a custom pom (which has the actual vmware.pscoe pom as parent) to override some behavior to fit our workflow.
When doing this, we lose the lint rules as they are mapped to specific parent artifactId:groupIds

vrealize-developer-tools/packages/node/vrdt-common/src/maven/PomFile.ts

Lines 10 to 19 in 1cc7b69

	static readonly ParentGroupByArtifact = {
	"base-package": "com.vmware.pscoe.o11n",
	"actions-package": "com.vmware.pscoe.o11n",
	"xml-package": "com.vmware.pscoe.o11n",
	"typescript-project": "com.vmware.pscoe.o11n",
	"typescript-project-all": "com.vmware.pscoe.o11n",
	"vra-package": "com.vmware.pscoe.vra",
	"vra-ng-package": "com.vmware.pscoe.vra-ng",
	"polyglot-project": "com.vmware.pscoe.polyglot"
	}

Would it be possible to add a new extension setting, e.g. vrdev.buildTools.extraVroGroups? Here we could provide an object of key/values, similar to the already existing PomFile.ParentGroupByArtifact.

// package.json
{
  "contributes": {
    // ....
    "configuration": {
      // ....
      "vrdev.buildTools.extraVroGroups": {
        "type": "object",
        "required": false,
        "default": {},
        "description": "Extra Parent groups to consider as valid vRO Projects.",
        "scope": "resource"
      }
    }
  }
}

And then add something like:

    static readonly ParentGroupByArtifact = {
        "base-package": "com.vmware.pscoe.o11n",
        "actions-package": "com.vmware.pscoe.o11n",
        "xml-package": "com.vmware.pscoe.o11n",
        "typescript-project": "com.vmware.pscoe.o11n",
        "typescript-project-all": "com.vmware.pscoe.o11n",
        "vra-package": "com.vmware.pscoe.vra",
        "vra-ng-package": "com.vmware.pscoe.vra-ng",
        "polyglot-project": "com.vmware.pscoe.polyglot",
+       ...vscode.workspace.getConfiguration().get<VrealizeSettings>("vrdev").buildTools.extraVroGroups || {}
    }

So the usage would be:

// .vscode/settings.json
{
    "vrdev.buildTools.defaultVersion": "4.6.0",
    "vrdev.buildTools.extraVroGroups": {
        "custom-package": "com.example.custom-vro"
    }
}

Alternatives

Creating custom lint rules for the XML files. But we'd like to keep it to this extension and ESLint.

Additional Context

I am willing to make a PR for this, but would like the input of the maintainers before starting.

[VenelinBakalov]

Thank you for the suggestion, just to clarify if I understand you correctly, you have a parent project containing multiple other projects and this disables linting, is that the case?

[Indy-rbo]

Hi @VenelinBakalov.
I have a project, which would normally point to the parent com.vmware.pscoe.o11n:typescript-project-all.

But we made a custom parent to inject some steps so we have a pom like com.example.custom:custom-project which has the parent com.vmware.pscoe.o11n:typescript-project-all.

<!-- my project pom.xml. ToolchainVersionRule does not work here -->
<parent>
  <groupId>com.example.acme</groupId>
  <artifactId>custom-project</artifactId>
  <version>1.0.0</version>
</parent>

<groupId>com.example.acme</groupId>
<artifactId>my-project</artifactId>
<version>1.0.0</version>
<packaging>pom</packaging>

<!-- custom parent pom.xml. ToolchainVersionRule does work here -->
<parent>
  <groupId>com.vmware.pscoe.o11n</groupId>
  <artifactId>typescript-project-all</artifactId>
  <version>4.6.0</version>
</parent>

<groupId>com.example.acme</groupId>
<artifactId>custom-project</artifactId>
<version>1.0.0</version>
<packaging>pom</packaging>

<build>
  <plugins>
    <!-- Some plugins like exec-maven-plugin -->
  </plugins>
</build>

I understand if this use case is too specific to support, but was hoping with this implementation it would allow some greater flexibility while not interfering with other users.

[VenelinBakalov]

Oh, now I see. So the goal is to make the custom parent still be a valid build tools for aria parent so that it is recognizable from the tools and at the same time dynamically injected based on configuration, right?

[Indy-rbo]

Exactly

[VenelinBakalov]

Oks I will discuss it with the team. Btw have you managed to get it running and functional only with the change mentioned above?

[Indy-rbo]

I have not.
This suggestion was from just reading the source code, as I experience a lot of errors when trying to install the project.

I'm using node v22.13.1 and npm 10.9.2, but the engines field in the package.json specifies "node": ">=14.0.0", and "npm": ">=8.0.0", so that should be okay?

Running npm i gives me npm warn cleanup errors:

Which are then followed by node-gyp errors:

[VenelinBakalov]

This seems to be related to missing distutils package.
https://stackoverflow.com/questions/77251296/distutils-not-found-when-running-npm-install

If you are using homebrew you can try:
brew install python-setuptools

After that npm install should run successfully and you should be able to:
gulp package