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.

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

fix(core): read all targets from package json when defining target defaults #21719

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,10 @@ import {
import { readJsonFile } from '../../utils/fileutils';
import { combineGlobPatterns } from '../../utils/globs';
import { NxPluginV2 } from '../../utils/nx-plugin';
import { PackageJson } from '../../utils/package-json';
import {
PackageJson,
readTargetsFromPackageJson,
} from '../../utils/package-json';
import { getGlobPatternsFromPackageManagerWorkspaces } from '../package-json-workspaces';

/**
Expand Down Expand Up @@ -58,16 +61,11 @@ export const TargetDefaultsPlugin: NxPluginV2 = {
const packageJson = readJsonOrNull<PackageJson>(
join(ctx.workspaceRoot, root, 'package.json')
);
const includedScripts = packageJson?.nx?.includedScripts;
const projectDefinedTargets = new Set([
...Object.keys(packageJson?.scripts ?? {}).filter((script) => {
if (includedScripts) {
return includedScripts.includes(script);
}
return true;
}),
...Object.keys(projectJson?.targets ?? {}),
...Object.keys(packageJson?.nx?.targets ?? {}),
...(packageJson
? Object.keys(readTargetsFromPackageJson(packageJson))
: []),
]);

const executorToTargetMap = getExecutorToTargetMap(
Expand Down
144 changes: 114 additions & 30 deletions packages/nx/src/utils/package-json.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,36 +10,7 @@ import {

describe('buildTargetFromScript', () => {
it('should use nx:run-script', () => {
const target = buildTargetFromScript('build', null);
expect(target.executor).toEqual('nx:run-script');
});

it('should use options provided in nx target package json configuration', () => {
const target = buildTargetFromScript('build', {
targets: {
build: {
outputs: ['custom'],
},
},
});

expect(target.outputs).toEqual(['custom']);
});

it('should not override script or executor', () => {
const target = buildTargetFromScript('build', {
targets: {
build: {
outputs: ['custom'],
options: {
script: 'other',
},
executor: 'custom:execute',
},
},
});

expect(target.options.script).toEqual('build');
const target = buildTargetFromScript('build');
expect(target.executor).toEqual('nx:run-script');
});
});
Expand Down Expand Up @@ -127,6 +98,119 @@ describe('readTargetsFromPackageJson', () => {
},
});
});

it('should extend script based targets if matching config', () => {
const result = readTargetsFromPackageJson({
name: 'my-other-app',
version: '',
scripts: {
build: 'echo 1',
},
nx: {
targets: {
build: {
outputs: ['custom'],
},
},
},
});
expect(result.build).toMatchInlineSnapshot(`
{
"executor": "nx:run-script",
"options": {
"script": "build",
},
"outputs": [
"custom",
],
}
`);
});

it('should override scripts if provided an executor', () => {
const result = readTargetsFromPackageJson({
name: 'my-other-app',
version: '',
scripts: {
build: 'echo 1',
},
nx: {
targets: {
build: {
executor: 'nx:run-commands',
options: {
commands: ['echo 2'],
},
},
},
},
});
expect(result.build).toMatchInlineSnapshot(`
{
"executor": "nx:run-commands",
"options": {
"commands": [
"echo 2",
],
},
}
`);
});

it('should override script if provided in options', () => {
const result = readTargetsFromPackageJson({
name: 'my-other-app',
version: '',
scripts: {
build: 'echo 1',
},
nx: {
targets: {
build: {
executor: 'nx:run-script',
options: {
script: 'echo 2',
},
},
},
},
});
expect(result.build).toMatchInlineSnapshot(`
{
"executor": "nx:run-script",
"options": {
"script": "echo 2",
},
}
`);
});

it('should support targets without scripts', () => {
const result = readTargetsFromPackageJson({
name: 'my-other-app',
version: '',
nx: {
targets: {
build: {
executor: 'nx:run-commands',
options: {
commands: ['echo 2'],
},
},
},
},
});
expect(result.build).toMatchInlineSnapshot(`
{
"executor": "nx:run-commands",
"options": {
"commands": [
"echo 2",
],
},
}
`);
});
});

const rootPackageJson: PackageJson = readJsonFile(
Expand Down
26 changes: 13 additions & 13 deletions packages/nx/src/utils/package-json.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import {
} from '../config/workspace-json-project-json';
import { readJsonFile } from './fileutils';
import { getNxRequirePaths } from './installation-directory';
import { mergeTargetConfigurations } from '../project-graph/utils/project-configuration-utils';

export interface NxProjectPackageJsonConfiguration {
implicitDependencies?: string[];
Expand Down Expand Up @@ -113,17 +114,10 @@ export function readNxMigrateConfig(
};
}

export function buildTargetFromScript(
script: string,
nx: NxProjectPackageJsonConfiguration
): TargetConfiguration {
const nxTargetConfiguration = nx?.targets?.[script] || {};

export function buildTargetFromScript(script: string): TargetConfiguration {
return {
...nxTargetConfiguration,
executor: 'nx:run-script',
options: {
...(nxTargetConfiguration.options || {}),
script,
},
};
Expand All @@ -132,11 +126,17 @@ export function buildTargetFromScript(
export function readTargetsFromPackageJson(packageJson: PackageJson) {
const { scripts, nx } = packageJson;
const res: Record<string, TargetConfiguration> = {};
Object.keys(scripts || {}).forEach((script) => {
if (!nx?.includedScripts || nx?.includedScripts.includes(script)) {
res[script] = buildTargetFromScript(script, nx);
}
});
const includedScripts = nx?.includedScripts || Object.keys(scripts ?? {});
//
for (const script of includedScripts) {
res[script] = buildTargetFromScript(script);
}
for (const targetName in nx?.targets) {
res[targetName] = mergeTargetConfigurations(
nx?.targets[targetName],
res[targetName]
);
}

/**
* Add implicit nx-release-publish target for all package.json files that are
Expand Down
4 changes: 0 additions & 4 deletions packages/nx/src/utils/project-graph-utils.ts
Original file line number Diff line number Diff line change
@@ -1,9 +1,5 @@
import { buildTargetFromScript, PackageJson } from './package-json';
import { join } from 'path';
import { ProjectGraph, ProjectGraphProjectNode } from '../config/project-graph';
import { readJsonFile } from './fileutils';
import { readCachedProjectGraph } from '../project-graph/project-graph';
import { TargetConfiguration } from '../config/workspace-json-project-json';

export function projectHasTarget(
project: ProjectGraphProjectNode,
Expand Down