Support resolving jest-junit file dependencies (#835)

Author: tryggvigy

packages/knip/fixtures/plugins/jest/customSuiteProperties.cjs

@@ -0,0 +1 @@
+module.exports = {}

packages/knip/fixtures/plugins/jest/jest.config.js

@@ -14,7 +14,11 @@ module.exports = {
   reporters: [
     'default',
     'jest-silent-reporter',
-    ['jest-junit', { outputDirectory: 'reports', outputName: 'report.xml' }],
+    ['jest-junit', {
+      outputDirectory: 'reports', outputName: 'report.xml',
+      testSuitePropertiesFile: 'customSuiteProperties.cjs',
+      testSuitePropertiesDirectory: '<rootDir>',
+     }],
     ['github-actions', { silent: false }],
     'summary',
   ],

packages/knip/fixtures/plugins/jest/junitProperties.js

@@ -0,0 +1 @@
+module.exports = {}

packages/knip/fixtures/plugins/jest2/junitTestCaseProperties.js

@@ -0,0 +1 @@
+module.exports = {}

packages/knip/fixtures/plugins/jest2/package.json

@@ -3,6 +3,7 @@
   "scripts": {},
   "devDependencies": {
     "jest": "*",
-    "@testing-library/jest-dom": "*"
+    "@testing-library/jest-dom": "*",
+    "jest-junit": "*"
   }
 }

packages/knip/fixtures/plugins/jest2/project1/customProperties.cjs

@@ -0,0 +1 @@
+module.exports = {}

packages/knip/fixtures/plugins/jest2/project1/jest.config.js

@@ -4,4 +4,16 @@ module.exports = {
   rootDir: path.join(__dirname, '../'),
   displayName: 'project1',
   setupFilesAfterEnv: ['<rootDir>/project1/setupFiles/setup.js'],
+  reporters: [
+    'default',
+    [
+      'jest-junit',
+      {
+        outputDirectory: '<rootDir>',
+        outputName: 'junit-vcr.xml',
+        testCasePropertiesFile: 'customProperties.cjs',
+        testCasePropertiesDirectory: '<rootDir>/project1',
+      },
+    ],
+  ],
 };

packages/knip/src/plugins/jest/helpers.ts

@@ -0,0 +1,55 @@
+import type { PluginOptions } from '../../types/config.js';
+import { dirname, isInternal, join, toAbsolute } from '../../util/path.js';
+import { load } from '../../util/plugin.js';
+import type { JestInitialOptions } from './types.js';
+
+export const resolveExtensibleConfig = async (configFilePath: string) => {
+  let config = await load(configFilePath);
+  if (config?.preset) {
+    const { preset } = config;
+    if (isInternal(preset)) {
+      const presetConfigPath = toAbsolute(preset, dirname(configFilePath));
+      const presetConfig = await resolveExtensibleConfig(presetConfigPath);
+      config = Object.assign({}, presetConfig, config);
+    }
+  }
+  return config;
+};
+
+const getStringPropOrFallback = (prop: unknown, fallback: string): string => {
+  return typeof prop === 'string' ? prop : fallback;
+};
+
+export const getReportersDependencies = (config: JestInitialOptions, options: PluginOptions) => {
+  // Resolve dependencies for jest-junit reporter config
+  const jUnitReporterDeps: string[] = [];
+  for (const reporter of config.reporters ?? []) {
+    if (typeof reporter !== 'string' && reporter[0] === 'jest-junit') {
+      const {
+        testCasePropertiesFile,
+        testCasePropertiesDirectory,
+        testSuitePropertiesFile,
+        testSuitePropertiesDirectory,
+      } = reporter[1];
+
+      const testCaseFileName = getStringPropOrFallback(testCasePropertiesFile, 'junitProperties.js');
+      const testCaseDirectory = getStringPropOrFallback(testCasePropertiesDirectory, options.rootCwd);
+      const testCaseFilePath = join(testCaseDirectory, testCaseFileName);
+
+      const testSuiteFileName = getStringPropOrFallback(testSuitePropertiesFile, 'junitTestCaseProperties.js');
+      const testSuiteDirectory = getStringPropOrFallback(testSuitePropertiesDirectory, options.rootCwd);
+      const testSuiteFilePath = join(testSuiteDirectory, testSuiteFileName);
+
+      jUnitReporterDeps.push(testCaseFilePath);
+      jUnitReporterDeps.push(testSuiteFilePath);
+    }
+  }
+
+  const reporters = config.reporters
+    ? config.reporters
+        .map(reporter => (typeof reporter === 'string' ? reporter : reporter[0]))
+        .filter(reporter => !['default', 'github-actions', 'summary'].includes(reporter))
+    : [];
+
+  return [...reporters, ...jUnitReporterDeps];
+};

packages/knip/src/plugins/jest/index.ts

@@ -1,7 +1,8 @@
 import type { IsPluginEnabled, Plugin, PluginOptions, ResolveConfig, ResolveEntryPaths } from '../../types/config.js';
 import { type Input, toDeferResolve, toEntry } from '../../util/input.js';
-import { dirname, isInternal, join, toAbsolute } from '../../util/path.js';
-import { hasDependency, load } from '../../util/plugin.js';
+import { isInternal, join, toAbsolute } from '../../util/path.js';
+import { hasDependency } from '../../util/plugin.js';
+import { getReportersDependencies, resolveExtensibleConfig } from './helpers.js';
 import type { JestConfig, JestInitialOptions } from './types.js';
 
 // https://jestjs.io/docs/configuration
@@ -17,19 +18,6 @@ const config = ['jest.config.{js,ts,mjs,cjs,json}', 'package.json'];
 
 const entry = ['**/__tests__/**/*.[jt]s?(x)', '**/?(*.)+(spec|test).[jt]s?(x)'];
 
-const resolveExtensibleConfig = async (configFilePath: string) => {
-  let config = await load(configFilePath);
-  if (config?.preset) {
-    const { preset } = config;
-    if (isInternal(preset)) {
-      const presetConfigPath = toAbsolute(preset, dirname(configFilePath));
-      const presetConfig = await resolveExtensibleConfig(presetConfigPath);
-      config = Object.assign({}, presetConfig, config);
-    }
-  }
-  return config;
-};
-
 const resolveDependencies = async (config: JestInitialOptions, options: PluginOptions): Promise<Input[]> => {
   const { configFileDir } = options;
 
@@ -65,11 +53,7 @@ const resolveDependencies = async (config: JestInitialOptions, options: PluginOp
         ? [config.testEnvironment]
         : [];
   const resolvers = config.resolver ? [config.resolver] : [];
-  const reporters = config.reporters
-    ? config.reporters
-        .map(reporter => (typeof reporter === 'string' ? reporter : reporter[0]))
-        .filter(reporter => !['default', 'github-actions', 'summary'].includes(reporter))
-    : [];
+  const reporters = getReportersDependencies(config, options);
   const watchPlugins =
     config.watchPlugins?.map(watchPlugin => (typeof watchPlugin === 'string' ? watchPlugin : watchPlugin[0])) ?? [];
   const transform = config.transform

packages/knip/test/plugins/jest.test.ts

@@ -31,7 +31,7 @@ test('Find dependencies with the Jest plugin', async () => {
     devDependencies: 1,
     unlisted: 3,
     unresolved: 9,
-    processed: 6,
-    total: 6,
+    processed: 8,
+    total: 8,
   });
 });

packages/knip/test/plugins/jest2.test.ts

@@ -28,7 +28,7 @@ test('Find dependencies with the Jest plugin', async () => {
     devDependencies: 1,
     unlisted: 0,
     unresolved: 0,
-    processed: 5,
-    total: 5,
+    processed: 7,
+    total: 7,
   });
 });