miel.truyen/nx
1
0
Fork 0
Code Issues Pull Requests Actions 5 Packages Projects Releases Wiki Activity

feat(misc): change updateBuildableProjectDepsInPackageJson option default value to false (#17920)

Browse Source
This commit is contained in:
Leosvel Pérez Espinosa 2023-07-06 09:06:48 +01:00 committed by GitHub
parent c6a0615fa5
commit 64765eb313
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
22 changed files with 399 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/generated/packages/angular/executors/ng-packagr-lite.json
View File

@ -43,7 +43,7 @@
"updateBuildableProjectDepsInPackageJson": {
"type": "boolean",
"description": "Whether to update the buildable project dependencies in the build output package.json.",
"default": true
"default": false
},
"buildableProjectDepsInPackageJsonType": {
"type": "string",

2
docs/generated/packages/angular/executors/package.json
View File

@ -46,7 +46,7 @@
"updateBuildableProjectDepsInPackageJson": {
"type": "boolean",
"description": "Whether to update the buildable project dependencies in the build output package.json.",
"default": true
"default": false
},
"buildableProjectDepsInPackageJsonType": {
"type": "string",

2
docs/generated/packages/js/executors/swc.json
View File

@ -98,7 +98,7 @@
"updateBuildableProjectDepsInPackageJson": {
"type": "boolean",
"description": "Whether to update the buildable project dependencies in the build output package.json.",
"default": true
"default": false
},
"buildableProjectDepsInPackageJsonType": {
"type": "string",

2
docs/generated/packages/js/executors/tsc.json
View File

@ -98,7 +98,7 @@
"updateBuildableProjectDepsInPackageJson": {
"type": "boolean",
"description": "Whether to update the buildable project dependencies in the build output package.json.",
"default": true
"default": false
},
"buildableProjectDepsInPackageJsonType": {
"type": "string",

2
docs/generated/packages/rollup/executors/rollup.json
View File

@ -84,7 +84,7 @@
"updateBuildableProjectDepsInPackageJson": {
"type": "boolean",
"description": "Update buildable project dependencies in `package.json`.",
"default": true
"default": false
},
"buildableProjectDepsInPackageJsonType": {
"type": "string",

4
e2e/js/src/js-swc.test.ts
View File

@ -91,7 +91,9 @@ describe('js e2e', () => {
return json;
});
runCLI(`build ${lib} --generateLockfile=true`);
runCLI(
`build ${lib} --generateLockfile=true --updateBuildableProjectDepsInPackageJson`
);
checkFilesExist(
`dist/libs/${lib}/package.json`,
`dist/libs/${lib}/${

6
e2e/js/src/js-tsc.test.ts
View File

@ -129,9 +129,7 @@ describe('js e2e', () => {
return json;
});
runCLI(`build ${lib}`);
const rootPackageJson = readJson(`package.json`);
runCLI(`build ${lib} --updateBuildableProjectDepsInPackageJson`);
expect(readJson(`dist/libs/${lib}/package.json`)).toHaveProperty(
'peerDependencies.tslib'
@ -221,7 +219,7 @@ describe('package.json updates', () => {
`;
});
runCLI(`build ${lib}`);
runCLI(`build ${lib} --updateBuildableProjectDepsInPackageJson`);
// Check that only 'react' exists, don't care about version
expect(readJson(`dist/libs/${lib}/package.json`).dependencies).toEqual({

2
e2e/react-core/src/react-package.test.ts
View File

@ -129,7 +129,7 @@ describe('Build React libraries and apps', () => {
/*
* 2. With dependencies
*/
runCLI(`build ${parentLib}`);
runCLI(`build ${parentLib} --updateBuildableProjectDepsInPackageJson`);
checkFilesExist(`dist/libs/${parentLib}/index.js`);

6
packages/angular/migrations.json
View File

@ -263,6 +263,12 @@
},
"description": "Update the @angular/cli package version to ~16.1.0.",
"factory": "./src/migrations/update-16-4-0/update-angular-cli"
},
"explicitly-set-projects-to-update-buildable-deps": {
"cli": "nx",
"version": "16.6.0-beta.0",
"description": "Explicitly set 'updateBuildableProjectDepsInPackageJson' to 'true' in targets that rely on that value as the default.",
"factory": "./src/migrations/update-16-6-0/explicitly-set-projects-to-update-buildable-deps"
}
},
"packageJsonUpdates": {

2
packages/angular/src/executors/ng-packagr-lite/schema.json
View File

@ -40,7 +40,7 @@
"updateBuildableProjectDepsInPackageJson": {
"type": "boolean",
"description": "Whether to update the buildable project dependencies in the build output package.json.",
"default": true
"default": false
},
"buildableProjectDepsInPackageJsonType": {
"type": "string",

2
packages/angular/src/executors/package/schema.json
View File

@ -40,7 +40,7 @@
"updateBuildableProjectDepsInPackageJson": {
"type": "boolean",
"description": "Whether to update the buildable project dependencies in the build output package.json.",
"default": true
"default": false
},
"buildableProjectDepsInPackageJsonType": {
"type": "string",

86
packages/angular/src/migrations/update-16-6-0/explicitly-set-projects-to-update-buildable-deps.spec.ts Normal file
View File

@ -0,0 +1,86 @@
import {
ProjectConfiguration,
Tree,
addProjectConfiguration,
readProjectConfiguration,
} from '@nx/devkit';
import { createTreeWithEmptyWorkspace } from '@nx/devkit/testing';
import migration from './explicitly-set-projects-to-update-buildable-deps';
describe('explicitly-set-projects-to-update-buildable-deps migration', () => {
let tree: Tree;
beforeEach(() => {
tree = createTreeWithEmptyWorkspace({ layout: 'apps-libs' });
});
it.each([
'@nx/angular:ng-packagr-lite',
'@nrwl/angular:ng-packagr-lite',
'@nx/angular:package',
'@nrwl/angular:package',
])(
'should set updateBuildableProjectDepsInPackageJson option to "true" when not specified in target using "%s"',
async (executor) => {
addProjectConfiguration(tree, 'lib1', {
root: 'libs/lib1',
projectType: 'library',
targets: { build: { executor, options: {} } },
});
await migration(tree);
const project = readProjectConfiguration(tree, 'lib1');
expect(
project.targets.build.options.updateBuildableProjectDepsInPackageJson
).toBe(true);
}
);
it.each([
'@nx/angular:ng-packagr-lite',
'@nrwl/angular:ng-packagr-lite',
'@nx/angular:package',
'@nrwl/angular:package',
])(
'should not overwrite updateBuildableProjectDepsInPackageJson option when it is specified in target using "%s"',
async (executor) => {
addProjectConfiguration(tree, 'lib1', {
root: 'libs/lib1',
projectType: 'library',
targets: {
build: {
executor,
options: { updateBuildableProjectDepsInPackageJson: false },
},
},
});
await migration(tree);
const project = readProjectConfiguration(tree, 'lib1');
expect(
project.targets.build.options.updateBuildableProjectDepsInPackageJson
).toBe(false);
}
);
it('should not update targets using other executors', async () => {
const originalProjectConfig: ProjectConfiguration = {
root: 'libs/lib1',
projectType: 'library',
targets: {
build: {
executor: 'some-executor',
options: {},
},
},
};
addProjectConfiguration(tree, 'lib1', originalProjectConfig);
await migration(tree);
const project = readProjectConfiguration(tree, 'lib1');
expect(project.targets).toStrictEqual(originalProjectConfig.targets);
});
});

44
packages/angular/src/migrations/update-16-6-0/explicitly-set-projects-to-update-buildable-deps.ts Normal file
View File

@ -0,0 +1,44 @@
import {
formatFiles,
getProjects,
Tree,
updateProjectConfiguration,
} from '@nx/devkit';
const executors = new Set([
'@nx/angular:ng-packagr-lite',
'@nrwl/angular:ng-packagr-lite',
'@nx/angular:package',
'@nrwl/angular:package',
]);
export default async function (tree: Tree) {
const projects = getProjects(tree);
for (const [projectName, project] of projects) {
if (project.projectType !== 'library') {
continue;
}
let updated = false;
for (const [, target] of Object.entries(project.targets || {})) {
if (!executors.has(target.executor)) {
continue;
}
if (
target.options &&
target.options.updateBuildableProjectDepsInPackageJson === undefined
) {
target.options.updateBuildableProjectDepsInPackageJson = true;
updated = true;
}
}
if (updated) {
updateProjectConfiguration(tree, projectName, project);
}
}
await formatFiles(tree);
}

6
packages/js/migrations.json
View File

@ -41,6 +41,12 @@
"version": "16.0.0-beta.1",
"description": "Replace @nrwl/js with @nx/js",
"implementation": "./src/migrations/update-16-0-0-add-nx-packages/update-16-0-0-add-nx-packages"
},
"explicitly-set-projects-to-update-buildable-deps": {
"cli": "nx",
"version": "16.6.0-beta.0",
"description": "Explicitly set 'updateBuildableProjectDepsInPackageJson' to 'true' in targets that rely on that value as the default.",
"factory": "./src/migrations/update-16-6-0/explicitly-set-projects-to-update-buildable-deps"
}
},
"packageJsonUpdates": {

2
packages/js/src/executors/swc/schema.json
View File

@ -69,7 +69,7 @@
"updateBuildableProjectDepsInPackageJson": {
"type": "boolean",
"description": "Whether to update the buildable project dependencies in the build output package.json.",
"default": true
"default": false
},
"buildableProjectDepsInPackageJsonType": {
"type": "string",

2
packages/js/src/executors/tsc/schema.json
View File

@ -57,7 +57,7 @@
"updateBuildableProjectDepsInPackageJson": {
"type": "boolean",
"description": "Whether to update the buildable project dependencies in the build output package.json.",
"default": true
"default": false
},
"buildableProjectDepsInPackageJsonType": {
"type": "string",

76
packages/js/src/migrations/update-16-6-0/explicitly-set-projects-to-update-buildable-deps.spec.ts Normal file
View File

@ -0,0 +1,76 @@
import {
ProjectConfiguration,
Tree,
addProjectConfiguration,
readProjectConfiguration,
} from '@nx/devkit';
import { createTreeWithEmptyWorkspace } from '@nx/devkit/testing';
import migration from './explicitly-set-projects-to-update-buildable-deps';
describe('explicitly-set-projects-to-update-buildable-deps migration', () => {
let tree: Tree;
beforeEach(() => {
tree = createTreeWithEmptyWorkspace({ layout: 'apps-libs' });
});
it.each(['@nx/js:swc', '@nrwl/js:swc', '@nx/js:tsc', '@nrwl/js:tsc'])(
'should set updateBuildableProjectDepsInPackageJson option to "true" when not specified in target using "%s"',
async (executor) => {
addProjectConfiguration(tree, 'lib1', {
root: 'libs/lib1',
projectType: 'library',
targets: { build: { executor, options: {} } },
});
await migration(tree);
const project = readProjectConfiguration(tree, 'lib1');
expect(
project.targets.build.options.updateBuildableProjectDepsInPackageJson
).toBe(true);
}
);
it.each(['@nx/js:swc', '@nrwl/js:swc', '@nx/js:tsc', '@nrwl/js:tsc'])(
'should not overwrite updateBuildableProjectDepsInPackageJson option when it is specified in target using "%s"',
async (executor) => {
addProjectConfiguration(tree, 'lib1', {
root: 'libs/lib1',
projectType: 'library',
targets: {
build: {
executor,
options: { updateBuildableProjectDepsInPackageJson: false },
},
},
});
await migration(tree);
const project = readProjectConfiguration(tree, 'lib1');
expect(
project.targets.build.options.updateBuildableProjectDepsInPackageJson
).toBe(false);
}
);
it('should not update targets using other executors', async () => {
const originalProjectConfig: ProjectConfiguration = {
root: 'libs/lib1',
projectType: 'library',
targets: {
build: {
executor: 'some-executor',
options: {},
},
},
};
addProjectConfiguration(tree, 'lib1', originalProjectConfig);
await migration(tree);
const project = readProjectConfiguration(tree, 'lib1');
expect(project.targets).toStrictEqual(originalProjectConfig.targets);
});
});

44
packages/js/src/migrations/update-16-6-0/explicitly-set-projects-to-update-buildable-deps.ts Normal file
View File

@ -0,0 +1,44 @@
import {
formatFiles,
getProjects,
Tree,
updateProjectConfiguration,
} from '@nx/devkit';
const executors = new Set([
'@nx/js:swc',
'@nrwl/js:swc',
'@nx/js:tsc',
'@nrwl/js:tsc',
]);
export default async function (tree: Tree) {
const projects = getProjects(tree);
for (const [projectName, project] of projects) {
if (project.projectType !== 'library') {
continue;
}
let updated = false;
for (const [, target] of Object.entries(project.targets || {})) {
if (!executors.has(target.executor)) {
continue;
}
if (
target.options &&
target.options.updateBuildableProjectDepsInPackageJson === undefined
) {
target.options.updateBuildableProjectDepsInPackageJson = true;
updated = true;
}
}
if (updated) {
updateProjectConfiguration(tree, projectName, project);
}
}
await formatFiles(tree);
}

6
packages/rollup/migrations.json
View File

@ -17,6 +17,12 @@
"version": "16-3-3-beta.0",
"description": "Add babelUpwardRootMode if not already defined",
"implementation": "./src/migrations/update-16-3-3-add-babel-upward-root-mode-flag/update-16-3-3-add-babel-upward-root-mode-flag"
},
"explicitly-set-projects-to-update-buildable-deps": {
"cli": "nx",
"version": "16.6.0-beta.0",
"description": "Explicitly set 'updateBuildableProjectDepsInPackageJson' to 'true' in targets that rely on that value as the default.",
"factory": "./src/migrations/update-16-6-0/explicitly-set-projects-to-update-buildable-deps"
}
},
"packageJsonUpdates": {}

2
packages/rollup/src/executors/rollup/schema.json
View File

@ -92,7 +92,7 @@
"updateBuildableProjectDepsInPackageJson": {
"type": "boolean",
"description": "Update buildable project dependencies in `package.json`.",
"default": true
"default": false
},
"buildableProjectDepsInPackageJsonType": {
"type": "string",

76
packages/rollup/src/migrations/update-16-6-0/explicitly-set-projects-to-update-buildable-deps.spec.ts Normal file
View File

@ -0,0 +1,76 @@
import {
ProjectConfiguration,
Tree,
addProjectConfiguration,
readProjectConfiguration,
} from '@nx/devkit';
import { createTreeWithEmptyWorkspace } from '@nx/devkit/testing';
import migration from './explicitly-set-projects-to-update-buildable-deps';
describe('explicitly-set-projects-to-update-buildable-deps migration', () => {
let tree: Tree;
beforeEach(() => {
tree = createTreeWithEmptyWorkspace({ layout: 'apps-libs' });
});
it.each(['@nx/rollup:rollup', '@nrwl/rollup:rollup'])(
'should set updateBuildableProjectDepsInPackageJson option to "true" when not specified in target using "%s"',
async (executor) => {
addProjectConfiguration(tree, 'lib1', {
root: 'libs/lib1',
projectType: 'library',
targets: { build: { executor, options: {} } },
});
await migration(tree);
const project = readProjectConfiguration(tree, 'lib1');
expect(
project.targets.build.options.updateBuildableProjectDepsInPackageJson
).toBe(true);
}
);
it.each(['@nx/js:swc', '@nrwl/js:swc', '@nx/js:tsc', '@nrwl/js:tsc'])(
'should not overwrite updateBuildableProjectDepsInPackageJson option when it is specified in target using "%s"',
async (executor) => {
addProjectConfiguration(tree, 'lib1', {
root: 'libs/lib1',
projectType: 'library',
targets: {
build: {
executor,
options: { updateBuildableProjectDepsInPackageJson: false },
},
},
});
await migration(tree);
const project = readProjectConfiguration(tree, 'lib1');
expect(
project.targets.build.options.updateBuildableProjectDepsInPackageJson
).toBe(false);
}
);
it('should not update targets using other executors', async () => {
const originalProjectConfig: ProjectConfiguration = {
root: 'libs/lib1',
projectType: 'library',
targets: {
build: {
executor: 'some-executor',
options: {},
},
},
};
addProjectConfiguration(tree, 'lib1', originalProjectConfig);
await migration(tree);
const project = readProjectConfiguration(tree, 'lib1');
expect(project.targets).toStrictEqual(originalProjectConfig.targets);
});
});

39
packages/rollup/src/migrations/update-16-6-0/explicitly-set-projects-to-update-buildable-deps.ts Normal file
View File

@ -0,0 +1,39 @@
import {
formatFiles,
getProjects,
Tree,
updateProjectConfiguration,
} from '@nx/devkit';
const executors = new Set(['@nx/rollup:rollup', '@nrwl/rollup:rollup']);
export default async function (tree: Tree) {
const projects = getProjects(tree);
for (const [projectName, project] of projects) {
if (project.projectType !== 'library') {
continue;
}
let updated = false;
for (const [, target] of Object.entries(project.targets || {})) {
if (!executors.has(target.executor)) {
continue;
}
if (
target.options &&
target.options.updateBuildableProjectDepsInPackageJson === undefined
) {
target.options.updateBuildableProjectDepsInPackageJson = true;
updated = true;
}
}
if (updated) {
updateProjectConfiguration(tree, projectName, project);
}
}
await formatFiles(tree);
}