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

fix(devkit): show example in deprecation message (#18823)

Browse Source
This commit is contained in:
Jason Jean 2023-08-24 17:08:58 -04:00 committed by GitHub
parent bd76b6228f
commit 02c5aeb255
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
packages/devkit/src/generators/project-name-and-root-utils.ts
View File

@ -15,6 +15,7 @@ const {
readJson,
readNxJson,
updateNxJson,
stripIndents,
} = requireNx();
export type ProjectNameAndRootFormat = 'as-provided' | 'derived';
@ -154,8 +155,9 @@ async function determineFormat(
format === asProvidedSelectedValue ? 'as-provided' : 'derived'
);
const deprecationWarning =
'In Nx 18, generating projects will no longer derive the name and root. Please provide the exact project name and root in the future.';
const deprecationWarning = stripIndents`
In Nx 18, generating projects will no longer derive the name and root.
Please provide the exact project name and root in the future.`;
if (result === 'as-provided' && callingGenerator) {
const { saveDefault } = await prompt<{ saveDefault: boolean }>({
@ -174,7 +176,8 @@ async function determineFormat(
logger.warn(deprecationWarning);
}
} else {
logger.warn(deprecationWarning);
const example = `Example: nx g ${callingGenerator} ${formats[result].projectName} --directory ${formats[result].projectRoot}`;
logger.warn(deprecationWarning + '\n' + example);
}
return result;