@nrwl/devkit should expose readWorkspace

[yjaaidi]

Description

Some generators could be "Angular CLI schematics" compatible but they are not, because they directly or indirectly call functions like readProjectConfiguration that make nx.json presence mandatory:

nx/packages/devkit/src/generators/project-configuration.ts

Lines 155 to 173 in 4a53453

	export function readProjectConfiguration(host: Tree, projectName: string) {
	const workspace = readWorkspace(host);
	if (!workspace.projects[projectName]) {
	throw new Error(
	`Cannot find configuration for '${projectName}' in ${getWorkspacePath(
	host
	)}.`
	);
	}
	const nxJson = readJson<NxJsonConfiguration>(host, 'nx.json');
	if (!nxJson.projects[projectName]) {
	throw new Error(
	`Cannot find configuration for '${projectName}' in nx.json`
	);
	}
	return getProjectConfiguration(projectName, workspace, nxJson);
	}

It would be nice to make the API more explicit on when nx.json is read & required.

Motivation

This improvement could:

1. make some generators, Angular CLI compatible,
2. encourage the implementation of Angular CLI schematics using @nrwl/devkit

Suggested Implementation

In order to avoid introducing any breaking change, we could add an optional boolean ignoreNxJson parameter to these functions. We could provide different signatures with different return types depending on the value of this option.

Alternate Implementations

Exposing readWorkspace could be a good start.

nx/packages/devkit/src/generators/project-configuration.ts

Line 279 in 4a53453

function readWorkspace(host: Tree): WorkspaceJsonConfiguration {

We, @jscutlery, would be happy to discuss this and provide a PR.

Cc. @edbzn

[github-actions]

This issue has been closed for more than 30 days. If this issue is still occuring, please open a new issue with more recent context.