Skip to content

Commit

Permalink
fix(core): take nx-release-publish target defaults into account for i…
Browse files Browse the repository at this point in the history 
…mplicit target (#27764)
  • Loading branch information
@JamesHenry
JamesHenry authored Sep 10, 2024
1 parent 431fe2a commit 44da27d
Show file tree
Hide file tree
Showing 3 changed files with 200 additions and 121 deletions.
2 changes: 1 addition & 1 deletion packages/nx/src/plugins/package-json/create-nodes.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ export function buildProjectConfigurationFromPackageJson(
sourceRoot: projectRoot,
name,
...packageJson.nx,
targets: readTargetsFromPackageJson(packageJson),
targets: readTargetsFromPackageJson(packageJson, nxJson),
tags: getTagsFromPackageJson(packageJson),
metadata: getMetadataFromPackageJson(packageJson),
};
Expand Down
297 changes: 180 additions & 117 deletions packages/nx/src/utils/package-json.spec.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,50 @@ describe('readTargetsFromPackageJson', () => {
},
};

it('should take targetDefaults for nx-release-publish into account when building the implicit target', () => {
const nxJson1 = {
targetDefaults: {
'nx-release-publish': {
dependsOn: ['build', 'lint'],
},
},
};
const result1 = readTargetsFromPackageJson(packageJson, nxJson1);
expect(result1['nx-release-publish']).toMatchInlineSnapshot(`
{
"dependsOn": [
"^nx-release-publish",
"build",
"lint",
],
"executor": "@nx/js:release-publish",
"options": {},
}
`);

const nxJson2 = {
targetDefaults: {
'nx-release-publish': {
dependsOn: ['^something'],
executor: 'totally-different-executor',
},
},
};
const result2 = readTargetsFromPackageJson(packageJson, nxJson2);
expect(result2['nx-release-publish']).toMatchInlineSnapshot(`
{
"dependsOn": [
"^nx-release-publish",
"^something",
],
"executor": "totally-different-executor",
"options": {},
}
`);
});

it('should read targets from project.json and package.json', () => {
const result = readTargetsFromPackageJson(packageJson);
const result = readTargetsFromPackageJson(packageJson, {});
expect(result).toMatchInlineSnapshot(`
{
"build": {
Expand All @@ -66,20 +108,23 @@ describe('readTargetsFromPackageJson', () => {
});

it('should contain extended options from nx property in package.json', () => {
const result = readTargetsFromPackageJson({
name: 'my-other-app',
version: '',
scripts: {
build: 'echo 1',
},
nx: {
targets: {
build: {
outputs: ['custom'],
const result = readTargetsFromPackageJson(
{
name: 'my-other-app',
version: '',
scripts: {
build: 'echo 1',
},
nx: {
targets: {
build: {
outputs: ['custom'],
},
},
},
},
});
{}
);
expect(result).toEqual({
build: { ...packageJsonBuildTarget, outputs: ['custom'] },
'nx-release-publish': {
Expand All @@ -91,17 +136,20 @@ describe('readTargetsFromPackageJson', () => {
});

it('should ignore scripts that are not in includedScripts', () => {
const result = readTargetsFromPackageJson({
name: 'included-scripts-test',
version: '',
scripts: {
test: 'echo testing',
fail: 'exit 1',
},
nx: {
includedScripts: ['test'],
const result = readTargetsFromPackageJson(
{
name: 'included-scripts-test',
version: '',
scripts: {
test: 'echo testing',
fail: 'exit 1',
},
nx: {
includedScripts: ['test'],
},
},
});
{}
);

expect(result).toMatchInlineSnapshot(`
{
Expand All @@ -127,20 +175,23 @@ 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'],
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",
Expand All @@ -159,23 +210,26 @@ describe('readTargetsFromPackageJson', () => {
});

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'],
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",
Expand All @@ -189,23 +243,26 @@ describe('readTargetsFromPackageJson', () => {
});

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',
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",
Expand All @@ -217,20 +274,23 @@ describe('readTargetsFromPackageJson', () => {
});

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'],
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",
Expand All @@ -244,57 +304,60 @@ describe('readTargetsFromPackageJson', () => {
});

it('should support partial target info without including script', () => {
const result = readTargetsFromPackageJson({
name: 'my-remix-app-8cce',
version: '',
scripts: {
build: 'run-s build:*',
'build:icons': 'tsx ./other/build-icons.ts',
'build:remix': 'remix build --sourcemap',
'build:server': 'tsx ./other/build-server.ts',
predev: 'npm run build:icons --silent',
dev: 'remix dev -c "node ./server/dev-server.js" --manual',
'prisma:studio': 'prisma studio',
format: 'prettier --write .',
lint: 'eslint .',
setup:
'npm run build && prisma generate && prisma migrate deploy && prisma db seed && playwright install',
start: 'cross-env NODE_ENV=production node .',
'start:mocks': 'cross-env NODE_ENV=production MOCKS=true tsx .',
test: 'vitest',
coverage: 'nx test --coverage',
'test:e2e': 'npm run test:e2e:dev --silent',
'test:e2e:dev': 'playwright test --ui',
'pretest:e2e:run': 'npm run build',
'test:e2e:run': 'cross-env CI=true playwright test',
'test:e2e:install': 'npx playwright install --with-deps chromium',
typecheck: 'tsc',
validate: 'run-p "test -- --run" lint typecheck test:e2e:run',
},
nx: {
targets: {
'build:icons': {
outputs: ['{projectRoot}/app/components/ui/icons'],
},
'build:remix': {
outputs: ['{projectRoot}/build'],
},
'build:server': {
outputs: ['{projectRoot}/server-build'],
},
test: {
outputs: ['{projectRoot}/test-results'],
},
'test:e2e': {
outputs: ['{projectRoot}/playwright-report'],
},
'test:e2e:run': {
outputs: ['{projectRoot}/playwright-report'],
const result = readTargetsFromPackageJson(
{
name: 'my-remix-app-8cce',
version: '',
scripts: {
build: 'run-s build:*',
'build:icons': 'tsx ./other/build-icons.ts',
'build:remix': 'remix build --sourcemap',
'build:server': 'tsx ./other/build-server.ts',
predev: 'npm run build:icons --silent',
dev: 'remix dev -c "node ./server/dev-server.js" --manual',
'prisma:studio': 'prisma studio',
format: 'prettier --write .',
lint: 'eslint .',
setup:
'npm run build && prisma generate && prisma migrate deploy && prisma db seed && playwright install',
start: 'cross-env NODE_ENV=production node .',
'start:mocks': 'cross-env NODE_ENV=production MOCKS=true tsx .',
test: 'vitest',
coverage: 'nx test --coverage',
'test:e2e': 'npm run test:e2e:dev --silent',
'test:e2e:dev': 'playwright test --ui',
'pretest:e2e:run': 'npm run build',
'test:e2e:run': 'cross-env CI=true playwright test',
'test:e2e:install': 'npx playwright install --with-deps chromium',
typecheck: 'tsc',
validate: 'run-p "test -- --run" lint typecheck test:e2e:run',
},
nx: {
targets: {
'build:icons': {
outputs: ['{projectRoot}/app/components/ui/icons'],
},
'build:remix': {
outputs: ['{projectRoot}/build'],
},
'build:server': {
outputs: ['{projectRoot}/server-build'],
},
test: {
outputs: ['{projectRoot}/test-results'],
},
'test:e2e': {
outputs: ['{projectRoot}/playwright-report'],
},
'test:e2e:run': {
outputs: ['{projectRoot}/playwright-report'],
},
},
includedScripts: [],
},
includedScripts: [],
},
});
{}
);
expect(result.test).toMatchInlineSnapshot(`
{
"outputs": [
Expand Down
Loading

0 comments on commit 44da27d

Please sign in to comment.