Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(core): allow executor definition to point to another executor #23576

Merged
merged 1 commit into from
May 20, 2024
Merged

feat(core): allow executor definition to point to another executor #23576

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 18 additions & 12 deletions packages/nx/src/adapter/ngcli-adapter.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ import {
Executor,
ExecutorConfig,
ExecutorContext,
ExecutorJsonEntryConfig,
ExecutorsJson,
GeneratorCallback,
TaskGraphExecutor,
Expand Down Expand Up @@ -1174,14 +1175,11 @@ async function getWrappedWorkspaceNodeModulesArchitectHost(
builderName
);
const builderInfo = this.readExecutor(packageName, builderName);
const { builders, executors } =
readJsonFile<ExecutorsJson>(executorsFilePath);

return {
name: builderStr,
builderName,
description:
builders?.[builderName]?.description ??
executors?.[builderName]?.description,
description: executorConfig.description,
optionSchema: builderInfo.schema,
import: resolveImplementation(
executorConfig.implementation,
Expand All @@ -1190,7 +1188,14 @@ async function getWrappedWorkspaceNodeModulesArchitectHost(
};
}

private readExecutorsJson(nodeModule: string, builder: string) {
private readExecutorsJson(
nodeModule: string,
builder: string
): {
executorsFilePath: string;
executorConfig: ExecutorJsonEntryConfig;
isNgCompat: true;
} {
const { json: packageJson, path: packageJsonPath } =
readPluginPackageJson(
nodeModule,
Expand All @@ -1209,18 +1214,19 @@ async function getWrappedWorkspaceNodeModulesArchitectHost(
join(dirname(packageJsonPath), executorsFile)
);
const executorsJson = readJsonFile<ExecutorsJson>(executorsFilePath);
const executorConfig: {
implementation: string;
batchImplementation?: string;
schema: string;
hasher?: string;
} =
const executorConfig =
executorsJson.builders?.[builder] ?? executorsJson.executors?.[builder];
if (!executorConfig) {
throw new Error(
`Cannot find builder '${builder}' in ${executorsFilePath}.`
);
}
if (typeof executorConfig === 'string') {
// Angular CLI can have a builder pointing to another package:builder
const [packageName, executorName] = executorConfig.split(':');
return this.readExecutorsJson(packageName, executorName);
}
Comment on lines +1224 to +1228
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Interesting, this is something like this right?:

{
  "builders": {
    "build": "@company/other-pkg:build"
  }
}

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes. See https://github.com/angular/angular-cli/blob/main/packages/angular_devkit/build_angular/builders.json#L4.


return { executorsFilePath, executorConfig, isNgCompat: true };
}

Expand Down
13 changes: 7 additions & 6 deletions packages/nx/src/command-line/run/executor-utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,17 +129,18 @@ function readExecutorJson(
join(dirname(packageJsonPath), executorsFile)
);
const executorsJson = readJsonFile<ExecutorsJson>(executorsFilePath);
const executorConfig: {
implementation: string;
batchImplementation?: string;
schema: string;
hasher?: string;
} = executorsJson.executors?.[executor] || executorsJson.builders?.[executor];
const executorConfig =
executorsJson.executors?.[executor] || executorsJson.builders?.[executor];
if (!executorConfig) {
throw new Error(
`Cannot find executor '${executor}' in ${executorsFilePath}.`
);
}
if (typeof executorConfig === 'string') {
// Angular CLI can have a builder pointing to another package:builder
const [packageName, executorName] = executorConfig.split(':');
return readExecutorJson(packageName, executorName, root, projects);
}
const isNgCompat = !executorsJson.executors?.[executor];
return { executorsFilePath, executorConfig, isNgCompat };
}
3 changes: 2 additions & 1 deletion packages/nx/src/config/misc-interfaces.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,13 +37,14 @@ export interface GeneratorsJsonEntry {

export type OutputCaptureMethod = 'direct-nodejs' | 'pipe';

export interface ExecutorsJsonEntry {
export interface ExecutorJsonEntryConfig {
schema: string;
implementation: string;
batchImplementation?: string;
description?: string;
hasher?: string;
}
export type ExecutorsJsonEntry = string | ExecutorJsonEntryConfig;

export type Dependencies = 'dependencies' | 'devDependencies';

Expand Down
49 changes: 48 additions & 1 deletion packages/nx/src/utils/plugins/plugin-capabilities.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ import { workspaceRoot } from '../workspace-root';
import { hasElements } from './shared';

import type { PluginCapabilities } from './models';
import type { ExecutorsJsonEntry } from '../../config/misc-interfaces';

function tryGetCollection<T extends object>(
packageJsonPath: string,
Expand Down Expand Up @@ -179,7 +180,11 @@ export async function listPluginCapabilities(
bodyLines.push('');
bodyLines.push(
...Object.keys(plugin.executors).map(
(name) => `${chalk.bold(name)} : ${plugin.executors[name].description}`
(name) =>
`${chalk.bold(name)} : ${resolveExecutorDescription(
plugin.executors[name],
projects
)}`
)
);
}
Expand All @@ -197,3 +202,45 @@ export async function listPluginCapabilities(
bodyLines,
});
}

function resolveExecutorDescription(
executorJsonEntry: ExecutorsJsonEntry,
projects: Record<string, ProjectConfiguration>
) {
try {
if (typeof executorJsonEntry === 'string') {
// it points to another executor, resolve it
const [pkgName, executor] = executorJsonEntry.split(':');
const collection = loadExecutorsCollection(
workspaceRoot,
pkgName,
projects
);

return resolveExecutorDescription(collection[executor], projects);
}

return executorJsonEntry.description;
} catch {
return 'No description available';
}
}

function loadExecutorsCollection(
workspaceRoot: string,
pluginName: string,
projects: Record<string, ProjectConfiguration>
): { [name: string]: ExecutorsJsonEntry } {
const { json: packageJson, path: packageJsonPath } = readPluginPackageJson(
pluginName,
projects,
getNxRequirePaths(workspaceRoot)
);

return {
...tryGetCollection(packageJsonPath, packageJson.builders, 'builders'),
...tryGetCollection(packageJsonPath, packageJson.executors, 'builders'),
...tryGetCollection(packageJsonPath, packageJson.builders, 'executors'),
...tryGetCollection(packageJsonPath, packageJson.executors, 'executors'),
};
}
2 changes: 1 addition & 1 deletion packages/plugin/src/migrations/update-16-0-0/cli-in-schema-json.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ function deleteCliPropFromSchemaFile(
entry: ExecutorsJsonEntry | GeneratorsJsonEntry,
tree: Tree
) {
if (!entry.schema) {
if (typeof entry === 'string' || !entry.schema) {
return;
}
const schemaPath = joinPathFragments(dirname(collectionPath), entry.schema);
Expand Down