clarify new field name

koliveira15 · Mar 18, 2024 · 2938232 · 2938232
1 parent cf637cd
commit 2938232
Show file tree

Hide file tree

Showing 4 changed files with 101 additions and 82 deletions.
diff --git a/packages/nx-sonarqube/src/executors/scan/executor.spec.ts b/packages/nx-sonarqube/src/executors/scan/executor.spec.ts
@@ -238,7 +238,7 @@ describe('Scan Executor', (): void => {
         hostUrl: 'url',
         projectKey: 'key',
         qualityGate: true,
-        skipTypeDefs: [DependencyType.implicit],
+        skipDependencyTypes: ['implicit'],
       },
       context
     );

diff --git a/packages/nx-sonarqube/src/executors/scan/schema.d.ts b/packages/nx-sonarqube/src/executors/scan/schema.d.ts
@@ -8,7 +8,7 @@ export interface ScanExecutorSchema {
   projectVersion?: string;
   qualityGate?: boolean;
   qualityGateTimeout?: string;
-  skipTypeDeps?: string[];
+  skipDependencyTypes?: Array<'implicit' | 'static' | 'dynamic'>;
   skipProjects?: string[];
   skipPaths?: string[];
   testInclusions?: string;

diff --git a/packages/nx-sonarqube/src/executors/scan/schema.json b/packages/nx-sonarqube/src/executors/scan/schema.json
@@ -46,10 +46,13 @@
       "type": "string",
       "default": "300"
     },
-    "skipTypeDeps": {
-      "description": "Skips adding implicit or dynamic dependencies to the project graph analysis",
+    "skipDependencyTypes": {
       "type": "array",
-      "default": []
+      "items": {
+        "type": "string",
+        "enum": ["implicit", "static", "dynamic"]
+      },
+      "description": "Skips specified dependency types from the dependency graph. More info: https://nx.dev/nx-api/devkit/documents/DependencyType#enumeration-dependencytype"
     },
     "skipProjects": {
       "description": "Skips projects to the project graph analysis",

diff --git a/packages/nx-sonarqube/src/executors/scan/utils/utils.ts b/packages/nx-sonarqube/src/executors/scan/utils/utils.ts
@@ -84,105 +84,121 @@ export async function determinePaths(
     testTarget: projectConfiguration.targets.test,
   });
 
-  deps.workspaceLibraries
-    .filter((project) =>
-      context.projectName === project.name || (options.skipPaths.length ? options.skipPaths.some(path => project.sourceRoot.includes(path)) : true)
+  const workspaceLibraries = deps.workspaceLibraries
+    .filter(
+      (project) =>
+        context.projectName === project.name ||
+        (options.skipPaths?.length
+          ? options.skipPaths.some((path) => project.sourceRoot.includes(path))
+          : true)
     )
-    .filter((project) =>
-      context.projectName === project.name || (options.skipProjects.length ? options.skipProjects.includes(project.name) : true)
+    .filter(
+      (project) =>
+        context.projectName === project.name ||
+        (options.skipProjects?.length
+          ? options.skipProjects.includes(project.name)
+          : true)
     )
-    .filter((project) =>
-      context.projectName === project.name || (options.skipTypeDeps.length ? options.skipTypeDeps.includes(project.type) : true)
-    )
-    .forEach((dep) => {
-      sources.push(dep.sourceRoot);
+    .filter((project) => {
+      if (
+        context.projectName === project.name ||
+        !options.skipDependencyTypes?.length
+      ) {
+        return true;
+      }
+      return options.skipDependencyTypes.includes(
+        project.type as 'implicit' | 'static' | 'dynamic'
+      );
+    });
+  workspaceLibraries.forEach((dep) => {
+    sources.push(dep.sourceRoot);
 
-      if (dep.testTarget) {
-        const executor: Executor = getExecutor(dep.testTarget.executor);
-        const coverageDirectoryName: CoverageDirectoryName =
-          getCoverageDirectoryName(executor);
+    if (dep.testTarget) {
+      const executor: Executor = getExecutor(dep.testTarget.executor);
+      const coverageDirectoryName: CoverageDirectoryName =
+        getCoverageDirectoryName(executor);
 
-        if (dep.testTarget.options?.[coverageDirectoryName]) {
+      if (dep.testTarget.options?.[coverageDirectoryName]) {
+        lcovPaths.push(
+          joinPathFragments(
+            dep.testTarget.options[coverageDirectoryName]
+              .replace(new RegExp(/'/g), '')
+              .replace(/^(?:\.\.\/)+/, ''),
+            'lcov.info'
+          )
+        );
+      } else if (
+        executor === '@nx/jest:jest' &&
+        dep.testTarget.options?.jestConfig
+      ) {
+        const jestConfigPath = dep.testTarget.options.jestConfig;
+        const jestConfig = readFileSync(jestConfigPath, 'utf-8');
+        const ast = tsquery.ast(jestConfig);
+        const nodes = tsquery(
+          ast,
+          'Identifier[name="coverageDirectory"] ~ StringLiteral',
+          { visitAllChildren: true }
+        );
+
+        if (nodes.length) {
           lcovPaths.push(
             joinPathFragments(
-              dep.testTarget.options[coverageDirectoryName]
+              nodes[0]
+                .getText()
                 .replace(new RegExp(/'/g), '')
                 .replace(/^(?:\.\.\/)+/, ''),
               'lcov.info'
             )
           );
-        } else if (
-          executor === '@nx/jest:jest' &&
-          dep.testTarget.options?.jestConfig
-        ) {
-          const jestConfigPath = dep.testTarget.options.jestConfig;
-          const jestConfig = readFileSync(jestConfigPath, 'utf-8');
-          const ast = tsquery.ast(jestConfig);
-          const nodes = tsquery(
-            ast,
-            'Identifier[name="coverageDirectory"] ~ StringLiteral',
-            { visitAllChildren: true }
+        } else {
+          logger.warn(
+            `Skipping ${dep.name} as it does not have a coverageDirectory in ${jestConfigPath}`
           );
+        }
+      } else if (executor === '@nx/vite:test') {
+        const configPath: string | undefined = getViteConfigPath(
+          context.root,
+          dep
+        );
 
-          if (nodes.length) {
-            lcovPaths.push(
-              joinPathFragments(
-                nodes[0]
-                  .getText()
-                  .replace(new RegExp(/'/g), '')
-                  .replace(/^(?:\.\.\/)+/, ''),
-                'lcov.info'
-              )
-            );
-          } else {
-            logger.warn(
-              `Skipping ${dep.name} as it does not have a coverageDirectory in ${jestConfigPath}`
-            );
-          }
-        } else if (executor === '@nx/vite:test') {
-          const configPath: string | undefined = getViteConfigPath(
-            context.root,
-            dep
+        if (configPath === undefined) {
+          logger.warn(
+            `Skipping ${dep.name} as we cannot find a vite config file`
           );
 
-          if (configPath === undefined) {
-            logger.warn(
-              `Skipping ${dep.name} as we cannot find a vite config file`
-            );
+          return;
+        }
 
-            return;
-          }
+        const config = readFileSync(configPath, 'utf-8');
+        const ast = tsquery.ast(config);
+        const nodes = tsquery(
+          ast,
+          'Identifier[name="reportsDirectory"] ~ StringLiteral',
+          { visitAllChildren: true }
+        );
 
-          const config = readFileSync(configPath, 'utf-8');
-          const ast = tsquery.ast(config);
-          const nodes = tsquery(
-            ast,
-            'Identifier[name="reportsDirectory"] ~ StringLiteral',
-            { visitAllChildren: true }
+        if (nodes.length) {
+          lcovPaths.push(
+            joinPathFragments(
+              nodes[0]
+                .getText()
+                .replace(new RegExp(/'/g), '')
+                .replace(/^(?:\.\.\/)+/, ''),
+              'lcov.info'
+            )
           );
-
-          if (nodes.length) {
-            lcovPaths.push(
-              joinPathFragments(
-                nodes[0]
-                  .getText()
-                  .replace(new RegExp(/'/g), '')
-                  .replace(/^(?:\.\.\/)+/, ''),
-                'lcov.info'
-              )
-            );
-          } else {
-            logger.warn(
-              `Skipping ${dep.name} as it does not have a reportsDirectory in ${configPath}`
-            );
-          }
         } else {
-          logger.warn(`Skipping ${dep.name} as it does not have a jestConfig`);
+          logger.warn(
+            `Skipping ${dep.name} as it does not have a reportsDirectory in ${configPath}`
+          );
         }
       } else {
-        logger.warn(`Skipping ${dep.name} as it does not have a test target`);
+        logger.warn(`Skipping ${dep.name} as it does not have a jestConfig`);
       }
-    });
+    } else {
+      logger.warn(`Skipping ${dep.name} as it does not have a test target`);
+    }
+  });
 
   return Promise.resolve({
     lcovPaths: lcovPaths.join(','),