refactor: remove target generator in favor of task inference

Author: BioPhoton

packages/nx-plugin/src/generators/configuration/generator.int.test.ts

@@ -8,73 +8,7 @@ import { createTreeWithEmptyWorkspace } from '@nx/devkit/testing';
 import * as path from 'node:path';
 import { afterEach, describe, expect, it, vi } from 'vitest';
 import { DEFAULT_TARGET_NAME, PACKAGE_NAME } from '../../internal/constants.js';
-import { addTargetToProject, configurationGenerator } from './generator.js';
-
-describe('addTargetToProject', () => {
-  let tree: Tree;
-  const testProjectName = 'test-app';
-
-  beforeEach(() => {
-    tree = createTreeWithEmptyWorkspace();
-    addProjectConfiguration(tree, 'test-app', {
-      root: 'test-app',
-    });
-  });
-
-  afterEach(() => {
-    //reset tree
-    tree.delete(testProjectName);
-  });
-
-  it('should generate a project target', () => {
-    addTargetToProject(
-      tree,
-      {
-        root: testProjectName,
-        projectType: 'library',
-        sourceRoot: `${testProjectName}/src`,
-        targets: {},
-      },
-      {
-        project: testProjectName,
-      },
-    );
-
-    const projectConfiguration = readProjectConfiguration(
-      tree,
-      testProjectName,
-    );
-
-    expect(projectConfiguration.targets?.[DEFAULT_TARGET_NAME]).toEqual({
-      executor: `${PACKAGE_NAME}:cli`,
-    });
-  });
-
-  it('should use targetName to generate a project target', () => {
-    addTargetToProject(
-      tree,
-      {
-        root: testProjectName,
-        projectType: 'library',
-        sourceRoot: `${testProjectName}/src`,
-        targets: {},
-      },
-      {
-        project: testProjectName,
-        targetName: 'cp',
-      },
-    );
-
-    const projectConfiguration = readProjectConfiguration(
-      tree,
-      testProjectName,
-    );
-
-    expect(projectConfiguration.targets?.['cp']).toEqual({
-      executor: `${PACKAGE_NAME}:cli`,
-    });
-  });
-});
+import { configurationGenerator } from './generator.js';
 
 describe('configurationGenerator', () => {
   let tree: Tree;

packages/nx-plugin/src/generators/configuration/generator.ts

@@ -3,10 +3,7 @@ import {
   formatFiles,
   logger,
   readProjectConfiguration,
-  updateProjectConfiguration,
 } from '@nx/devkit';
-import type { ProjectConfiguration } from 'nx/src/config/workspace-json-project-json';
-import { DEFAULT_TARGET_NAME, PACKAGE_NAME } from '../../internal/constants.js';
 import { generateCodePushupConfig } from './code-pushup-config.js';
 import type { ConfigurationGeneratorOptions } from './schema.js';
 
@@ -16,46 +13,19 @@ export async function configurationGenerator(
 ) {
   const projectConfiguration = readProjectConfiguration(tree, options.project);
 
-  const { skipConfig, skipTarget, skipFormat } = options;
+  const { skipConfig, skipFormat } = options;
 
   if (skipConfig === true) {
     logger.info('Skip config file creation');
   } else {
     generateCodePushupConfig(tree, projectConfiguration.root);
   }
 
-  if (skipTarget === true) {
-    logger.info('Skip adding target to project');
-  } else {
-    addTargetToProject(tree, projectConfiguration, options);
-  }
-
   if (skipFormat === true) {
     logger.info('Skip formatting files');
   } else {
     await formatFiles(tree);
   }
 }
 
-export function addTargetToProject(
-  tree: Tree,
-  projectConfiguration: ProjectConfiguration,
-  options: ConfigurationGeneratorOptions,
-) {
-  const { targets } = projectConfiguration;
-  const { targetName, project } = options;
-
-  const codePushupTargetConfig = {
-    executor: `${PACKAGE_NAME}:cli`,
-  };
-
-  updateProjectConfiguration(tree, project, {
-    ...projectConfiguration,
-    targets: {
-      ...targets,
-      [targetName ?? DEFAULT_TARGET_NAME]: codePushupTargetConfig,
-    },
-  });
-}
-
 export default configurationGenerator;

packages/nx-plugin/src/generators/configuration/schema.json

@@ -15,21 +15,10 @@
         "index": 0
       }
     },
-    "targetName": {
-      "type": "string",
-      "description": "The name of the target.",
-      "x-prompt": "Which name should the target get? default is code-pushup.",
-      "default": "code-pushup"
-    },
     "bin": {
       "type": "string",
       "description": "Path to Code PushUp CLI"
     },
-    "skipTarget": {
-      "type": "boolean",
-      "description": "Skip adding the target to project.json.",
-      "$default": "false"
-    },
     "skipConfig": {
       "type": "boolean",
       "description": "Skip adding the code-pushup.config.ts to the project root.",

packages/nx-plugin/src/plugin/plugin.unit.test.ts

@@ -40,7 +40,7 @@ describe('@code-pushup/nx-plugin/plugin', () => {
       [projectRoot]: {
         targets: {
           [`${CP_TARGET_NAME}--configuration`]: {
-            command: `nx g ${PACKAGE_NAME}:configuration --skipTarget --targetName="code-pushup" --project="@org/empty-root"`,
+            command: `nx g ${PACKAGE_NAME}:configuration --skipTarget --project="@org/empty-root"`,
           },
         },
       },
@@ -66,7 +66,7 @@ describe('@code-pushup/nx-plugin/plugin', () => {
       [projectRoot]: {
         targets: {
           [`${CP_TARGET_NAME}--configuration`]: {
-            command: `nx g ${PACKAGE_NAME}:configuration --skipTarget --targetName="code-pushup" --project="@org/empty-root"`,
+            command: `nx g ${PACKAGE_NAME}:configuration --skipTarget --project="@org/empty-root"`,
           },
         },
       },

packages/nx-plugin/src/plugin/target/configuration-target.ts

@@ -2,22 +2,15 @@ import type { TargetConfiguration } from '@nx/devkit';
 import type { RunCommandsOptions } from 'nx/src/executors/run-commands/run-commands.impl';
 import { objectToCliArgs } from '../../executors/internal/cli.js';
 import { PACKAGE_NAME } from '../../internal/constants.js';
-import { CP_TARGET_NAME } from '../constants.js';
 
 export function createConfigurationTarget(options?: {
-  targetName?: string;
   projectName?: string;
   bin?: string;
 }): TargetConfiguration<RunCommandsOptions> {
-  const {
-    projectName,
-    bin = PACKAGE_NAME,
-    targetName = CP_TARGET_NAME,
-  } = options ?? {};
+  const { projectName, bin = PACKAGE_NAME } = options ?? {};
   return {
     command: `nx g ${bin}:configuration ${objectToCliArgs({
       skipTarget: true,
-      targetName,
       ...(projectName ? { project: projectName } : {}),
     }).join(' ')}`,
   };

packages/nx-plugin/src/plugin/target/configuration.target.unit.test.ts

@@ -7,13 +7,13 @@ describe('createConfigurationTarget', () => {
     expect(
       createConfigurationTarget({ projectName: 'my-project' }),
     ).toStrictEqual({
-      command: `nx g ${PACKAGE_NAME}:configuration --skipTarget --targetName="code-pushup" --project="my-project"`,
+      command: `nx g ${PACKAGE_NAME}:configuration --project="my-project"`,
     });
   });
 
   it('should return code-pushup--configuration target without project name', () => {
     expect(createConfigurationTarget()).toStrictEqual({
-      command: `nx g ${PACKAGE_NAME}:configuration --skipTarget --targetName="code-pushup"`,
+      command: `nx g ${PACKAGE_NAME}:configuration`,
     });
   });
 });