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

feat(devkit): allow updating package json based projects #27138

Merged
merged 1 commit into from
Jul 26, 2024
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
2 changes: 1 addition & 1 deletion .nxignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
nx-dev/**/jest.config.js
.next
.next
52 changes: 52 additions & 0 deletions packages/nx/src/generators/utils/project-configuration.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -277,5 +277,57 @@ describe('project configuration', () => {
root: 'proj',
});
});

it('should handle reading + writing project configuration', () => {
writeJson(tree, 'proj/package.json', {
name: 'proj',
nx: {},
});

const proj = readProjectConfiguration(tree, 'proj');
expect(proj).toEqual({
name: 'proj',
root: 'proj',
});

updateProjectConfiguration(tree, 'proj', {
name: 'proj',
root: 'proj',
sourceRoot: 'proj/src',
targets: {
build: {
command: 'echo "building"',
},
},
});

const updatedProj = readProjectConfiguration(tree, 'proj');
expect(updatedProj).toEqual({
name: 'proj',
root: 'proj',
sourceRoot: 'proj/src',
targets: {
build: {
command: 'echo "building"',
},
},
});

expect(tree.read('proj/package.json', 'utf-8')).toMatchInlineSnapshot(`
"{
"name": "proj",
"nx": {
"sourceRoot": "proj/src",
"targets": {
"build": {
"command": "echo \\"building\\""
}
}
}
}
"
`);
expect(tree.exists('proj/project.json')).toBeFalsy();
});
});
});
95 changes: 75 additions & 20 deletions packages/nx/src/generators/utils/project-configuration.ts
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
import { minimatch } from 'minimatch';
import { basename, join, relative } from 'path';
import { basename, dirname, join, relative } from 'path';

import {
buildProjectConfigurationFromPackageJson,
getGlobPatternsFromPackageManagerWorkspaces,
} from '../../plugins/package-json';
import { getGlobPatternsFromPackageManagerWorkspaces } from '../../plugins/package-json';
import { buildProjectFromProjectJson } from '../../plugins/project-json/build-nodes/project-json';
import { renamePropertyWithStableKeys } from '../../adapter/angular-json';
import {
Expand All @@ -23,6 +20,7 @@ import { readJson, writeJson } from './json';
import { readNxJson } from './nx-json';

import type { Tree } from '../tree';
import { toProjectName } from '../../config/to-project-name';

export { readNxJson, updateNxJson } from './nx-json';

Expand Down Expand Up @@ -82,17 +80,73 @@ export function updateProjectConfiguration(
projectName: string,
projectConfiguration: ProjectConfiguration
): void {
if (
tree.exists(joinPathFragments(projectConfiguration.root, 'project.json'))
) {
updateProjectConfigurationInProjectJson(
tree,
projectName,
projectConfiguration
);
} else if (
tree.exists(joinPathFragments(projectConfiguration.root, 'package.json'))
) {
updateProjectConfigurationInPackageJson(
tree,
projectName,
projectConfiguration
);
} else {
throw new Error(
`Cannot update Project ${projectName} at ${projectConfiguration.root}. It either doesn't exist yet, or may not use project.json for configuration. Use \`addProjectConfiguration()\` instead if you want to create a new project.`
);
}
}

function updateProjectConfigurationInPackageJson(
tree: Tree,
projectName: string,
projectConfiguration: ProjectConfiguration
) {
const packageJsonFile = joinPathFragments(
projectConfiguration.root,
'package.json'
);

const packageJson = readJson<PackageJson>(tree, packageJsonFile);

if (packageJson.name === projectConfiguration.name ?? projectName) {
Copy link
Collaborator

Choose a reason for hiding this comment

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

If the name is not equal, what do we do? Do we set it in package.json#name or do we set it in package.json#nx.name?

Copy link
Member Author

Choose a reason for hiding this comment

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

nx.name, setting package.json name could break a published package

delete projectConfiguration.name;
}

if (
projectConfiguration.targets &&
!Object.keys(projectConfiguration.targets).length
) {
delete projectConfiguration.targets;
}

packageJson.nx = {
...packageJson.nx,
...projectConfiguration,
root: undefined,
};

writeJson(tree, packageJsonFile, packageJson);
}

function updateProjectConfigurationInProjectJson(
tree: Tree,
projectName: string,
projectConfiguration: ProjectConfiguration
) {
const projectConfigFile = joinPathFragments(
projectConfiguration.root,
'project.json'
);

if (!tree.exists(projectConfigFile)) {
throw new Error(
`Cannot update Project ${projectName} at ${projectConfiguration.root}. It either doesn't exist yet, or may not use project.json for configuration. Use \`addProjectConfiguration()\` instead if you want to create a new project.`
);
}
handleEmptyTargets(projectName, projectConfiguration);

writeJson(tree, projectConfigFile, {
name: projectConfiguration.name ?? projectName,
$schema: getRelativeProjectJsonSchemaPath(tree, projectConfiguration),
Expand Down Expand Up @@ -215,21 +269,22 @@ function readAndCombineAllProjectConfigurations(tree: Tree): {
);
} else if (basename(projectFile) === 'package.json') {
const packageJson = readJson<PackageJson>(tree, projectFile);
const config = buildProjectConfigurationFromPackageJson(
packageJson,
tree.root,
projectFile,
readNxJson(tree)
);

// We don't want to have all of the extra inferred stuff in here, as
// when generators update the project they shouldn't inline that stuff.
// so rather than using `buildProjectFromPackageJson` and stripping it out
// we are going to build the config manually.
const config = {
root: dirname(projectFile),
name: packageJson.name ?? toProjectName(projectFile),
...packageJson.nx,
};
if (!rootMap[config.root]) {
mergeProjectConfigurationIntoRootMap(
rootMap,
// Inferred targets, tags, etc don't show up when running generators
// This is to help avoid running into issues when trying to update the workspace
{
name: config.name,
root: config.root,
},
config,
undefined,
undefined,
true
Expand Down
10 changes: 3 additions & 7 deletions packages/nx/src/utils/package-json.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { existsSync } from 'fs';
import { dirname, join } from 'path';
import {
InputDefinition,
ProjectConfiguration,
ProjectMetadata,
TargetConfiguration,
} from '../config/workspace-json-project-json';
Expand All @@ -13,12 +13,8 @@ import {
getPackageManagerCommand,
} from './package-manager';

export interface NxProjectPackageJsonConfiguration {
name?: string;
implicitDependencies?: string[];
tags?: string[];
namedInputs?: { [inputName: string]: (string | InputDefinition)[] };
targets?: Record<string, TargetConfiguration>;
export interface NxProjectPackageJsonConfiguration
extends Partial<ProjectConfiguration> {
includedScripts?: string[];
}

Expand Down