feat(core): forward string array arguments

[ThePlenkov]

Original discussion:
#27760

Current Behavior

Currently if I create a task like:

{
  "targets": {
    "build-cds": {
      "options": {
        "schema": "SCHEMA_NAME ",
        "filter": [
          "TABLE1",
          "TABLE1"
        ]
      }
    } 
  }
}

it will still call my command like: mycommand --schema SCHEMA_NAME

Expected Behavior

After my change it would run mycommand --schema SCHEMA_NAME --filter=TABLE1,TABLE2,TABLE3

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Skipped Deployment

Name	Status	Preview	Updated (UTC)
nx-dev	⬜️ Ignored (Inspect)	Visit Preview	Sep 4, 2024 11:53am

[nx-cloud]

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 8aaa589. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution

---

🟥 Failed Commands
nx affected --targets=lint,test,build,e2e,e2e-ci --base=f39b995b885e2bec63229af7edce825f9573c98c --head=8aaa589112e32bf94212b18953192b5e9ad6d527 --parallel=3

✅ Successfully ran 3 targets

• nx run-many -t check-imports check-commit check-lock-files check-codeowners documentation --parallel=1 --no-dte
• nx-cloud record -- nx format:check --base=f39b995b885e2bec63229af7edce825f9573c98c --head=8aaa589112e32bf94212b18953192b5e9ad6d527
• nx documentation --no-dte

---

Sent with 💌 from NxCloud.

[ThePlenkov]

I have also reached same goal by creating a plugin:

import {
  CreateNodesContextV2,
  createNodesFromFiles,
  CreateNodesV2,
  ProjectConfiguration,
  readJsonFile,
} from "@nx/devkit";
import { dirname } from "path";

interface Options {
  replace?: {
    regex?: string;
    with?: string;
  };
}

export const createNodesV2: CreateNodesV2<Options> = [
  "**/project.json",
  (projectConfigurationFiles, options, context) => {
    return createNodesFromFiles(
      (configFile, options, context) =>
        createNodesInternal(configFile, options, context),
      projectConfigurationFiles,
      options,
      context,
    );
  },
];

function createNodesInternal(
  configFilePath: string,
  options: Options,
  context: CreateNodesContextV2,
) {
  const root = dirname(configFilePath);
  const project = readJsonFile(configFilePath) as ProjectConfiguration;

  for (const targetName in project.targets) {
    const target = project.targets[targetName];
    for (const optionName in target.options) {
      const option = target.options[optionName];
      if (isArrayOfStrings(option)) {
        const targetOptionName = optionName.replace(/\[\]$/, "");
        target.options[targetOptionName] = option.toString();
      }
    }
  }

  return {
    projects: {
      [root]: project,
    },
  };
}

function isArrayOfStrings(arg: unknown): arg is Array<string> {
  if (Array.isArray(arg)) {
    return arg.every((item) => typeof item === "string");
  }
}

And then in configuration something like:

  "targets": {
    "build": {
      "options": {
        "schema": "MY_SCHEMA",
        "filter[]": [
          "Foo",
          "Bar"        
        ]
      }
    },

unfortunately with my apporach I had to introduce these array brackets in the name because simply replacing the value of the target options will not work. There is another core plugin which is reading project.json in the end and replacing plugin generated values with values from the file. So I'm generating two options, one array, another string. Array is ignored, string not.

With the current PR this plugin will not be needed because array will be directly parsed to comma-separated string.