Externalize target name configurations

[tbinna]

Several parts of the plugin code make assumptions about the target names, which may not always be true. In some cases, the plugin provides an override option; in other cases, it does not.

We should probably externalize target name configurations (just like many other Nx plugins), to make the plugin easier to use in different workspace setups. For example, the @nx/webpack/plugin provides these plugin options:

  {
      "plugin": "@nx/webpack/plugin",
      "options": {
        "buildTargetName": "build",
        "serveTargetName": "serve",
        "previewTargetName": "preview",
        "buildDepsTargetName": "build-deps",
        "watchDepsTargetName": "watch-deps"
      }
    }

Nx by default often configures plugin targets prefixed with the tool name, e.g. webpack:build, vite:build, etc.

Known assumptions in our codebase:

Package executor
(override option via resourceOutputPathMap)

nx-forge/packages/nx-forge/src/executors/build/lib/process-resource-dependencies.ts

Line 93 in ae46099

target: 'build',

Tunnel executor

nx-forge/packages/nx-forge/src/executors/tunnel/lib/start-custom-uis.ts

Line 12 in ae46099

{ project: config.projectName, target: 'serve' },

Challanges

• Tunnel executor: If different Custom UIs use different bundlers, e.g., one with webpack and target name webpack:serve and one with vite and vite:serve, then setting the target name at the plugin level won't help. In this case, the user would have to ensure each Custom UI project has a serve target. They could achieve that by configuring a serve target in each project.json and mapping it to the desired executor. In this case, externalizing this may not make sense.