fix(devkit): executor-to-plugin-migrator should add // targets hint

nrwl · May 3, 2024 · 7f6abce · 7f6abce
1 parent 21d7e92
commit 7f6abce
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 2 deletions.
diff --git a/packages/devkit/src/generators/plugin-migrations/executor-to-plugin-migrator.ts b/packages/devkit/src/generators/plugin-migrations/executor-to-plugin-migrator.ts
@@ -147,6 +147,13 @@ class ExecutorToPluginMigrator<T> {
     } else {
       delete projectConfig.targets[targetName];
     }
+
+    if (!projectConfig['// targets']) {
+      projectConfig[
+        '// targets'
+      ] = `to see all targets run: nx show project ${projectName} --web`;
+    }
+
     updateProjectConfiguration(this.tree, projectName, projectConfig);
 
     return `${projectFromGraph.data.root}/**/*`;

diff --git a/packages/eslint/src/generators/convert-to-inferred/convert-to-inferred.spec.ts b/packages/eslint/src/generators/convert-to-inferred/convert-to-inferred.spec.ts
@@ -10,6 +10,7 @@ import {
   joinPathFragments,
   type ProjectConfiguration,
   type ProjectGraph,
+  readJson,
   readNxJson,
   readProjectConfiguration,
   type Tree,
@@ -413,8 +414,14 @@ describe('Eslint - Convert Executors To Plugin', () => {
       // project.json modifications
       const updatedProject = readProjectConfiguration(tree, project.name);
       const targetKeys = Object.keys(updatedProject.targets);
-      ['lint'].forEach((key) => expect(targetKeys).not.toContain(key));
-
+      expect(targetKeys).not.toContain('lint');
+      const projectJsonForProject = readJson(
+        tree,
+        `${project.root}/project.json`
+      );
+      expect(projectJsonForProject['// targets']).toEqual(
+        'to see all targets run: nx show project myapp --web'
+      );
       // nx.json modifications
       const nxJsonPlugins = readNxJson(tree).plugins;
       const addedTestEslintPlugin = nxJsonPlugins.find((plugin) => {