feat(nx-plugin): Update executor generator

[MJez29]

Current Behavior

The executor generator generates

import { MyPluginExecutorSchema } from "./schema";

export default async function runExecutor(options: MyPluginExecutorSchema) {
  console.log("Executor ran for MyPlugin", options);
  return {
    success: true,
  };
}

Expected Behavior

The above code does not make it obvious that an executor has a second context argument or that it can return an AsyncIterableIterator. By typing the function against the Executor type the user will have typesafety to know that they are implementing the interface of their executor correctly and an easy way to view the type definition of an executor

import { Executor } from "@nx/devkit";

import { MyPluginExecutorSchema } from "./schema";

const runExecutor: Executor<MyPluginExecutorSchema> = async (
  options,
  context
) => {
  console.log("Executor ran for MyPlugin", options);
  return {
    success: true,
  };
};

export default runExecutor;

[vercel]

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

Name	Status	Preview	Comments	Updated (UTC)
nx-dev	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jun 4, 2024 7:56pm

[nx-cloud]

☁️ Nx Cloud Report

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

📂 See all runs for this branch

---

🟥 Failed Commands
nx affected --target=e2e --base=e8c31d7ac72a6eeb98d07b61f6ae945a2612d8ac --head=e9acd21a900cae47f728412b903c9bcdf16ad71b --parallel=1

✅ Successfully ran 7 targets

• nx affected -t e2e-macos --parallel=1 --base= --head=
• nx run-many -t check-imports check-commit check-lock-files depcheck check-codeowners --parallel=1 --no-dte
• nx affected --target=build --base=e8c31d7ac72a6eeb98d07b61f6ae945a2612d8ac --head=e9acd21a900cae47f728412b903c9bcdf16ad71b --parallel=3
• nx affected --target=test --base=e8c31d7ac72a6eeb98d07b61f6ae945a2612d8ac --head=e9acd21a900cae47f728412b903c9bcdf16ad71b --parallel=1
• nx affected --target=lint --base=e8c31d7ac72a6eeb98d07b61f6ae945a2612d8ac --head=e9acd21a900cae47f728412b903c9bcdf16ad71b --parallel=3
• nx-cloud record -- nx format:check --base=e8c31d7ac72a6eeb98d07b61f6ae945a2612d8ac --head=e9acd21a900cae47f728412b903c9bcdf16ad71b
• nx documentation --no-dte

---

Sent with 💌 from NxCloud.

[MJez29]

Looking at the errors does it make sense to create

export type PromiseExecutor = ...
export type AsyncIterableIteratorExecutor = ...
export type Executor = PromiseExecutor | AsyncIterableIteratorExecutor

and by default generate a PromiseExecutor?

[nx-cloud]

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 2a92a67. 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

---

✅ Successfully ran 6 targets

• nx affected --targets=e2e,e2e-ci --base=c002b54fdc8a6006021d99f73f9e7b9649d36226 --head=2a92a67875b3a0bffec04b5d6e1c0ee99d7f15a3 --parallel=1
• nx affected --targets=lint,test,build --base=c002b54fdc8a6006021d99f73f9e7b9649d36226 --head=2a92a67875b3a0bffec04b5d6e1c0ee99d7f15a3 --parallel=3
• 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=c002b54fdc8a6006021d99f73f9e7b9649d36226 --head=2a92a67875b3a0bffec04b5d6e1c0ee99d7f15a3
• nx documentation --no-dte
• nx affected -t e2e-macos-ci --parallel=1 --base=c002b54fdc8a6006021d99f73f9e7b9649d36226 --head=2a92a67875b3a0bffec04b5d6e1c0ee99d7f15a3

---

Sent with 💌 from NxCloud.

[github-actions]

This pull request has already been merged/closed. If you experience issues related to these changes, please open a new issue referencing this pull request.