chore(plugin-doc-coverage): fix tests, fully remove unnecessary await

Author: aramirezj

code-pushup.preset.ts

@@ -144,7 +144,7 @@ export const docCoverageCoreConfig = async (
   config: DocCoveragePluginConfig,
 ): Promise<CoreConfig> => {
   return {
-    plugins: [await docCoveragePlugin(config)],
+    plugins: [docCoveragePlugin(config)],
     categories: getDocCoverageCategories(config),
   };
 };

packages/plugin-doc-coverage/README.md

@@ -44,7 +44,7 @@ Measured documentation types are mapped to Code PushUp audits in the following w
      // ...
      plugins: [
        // ...
-       await docCoveragePlugin({
+       docCoveragePlugin({
          sourceGlob: ['**/*.ts'],
        }),
      ],
@@ -105,7 +105,7 @@ The plugin accepts the following parameters:
 Required parameter. The `sourceGlob` option accepts an array of strings that define patterns to include or exclude files. You can use glob patterns to match files and the `!` symbol to exclude specific patterns. Example:
 
 ```js
-await docCoveragePlugin({
+docCoveragePlugin({
   sourceGlob: [
     'src/**/*.ts',              // include all TypeScript files in src
     '!src/**/*.{spec,test}.ts', // exclude test files
@@ -119,7 +119,7 @@ await docCoveragePlugin({
 Optional parameter. The `onlyAudits` option allows you to specify which documentation types you want to measure. Only the specified audits will be included in the results. Example:
 
 ```js
-await docCoveragePlugin({
+docCoveragePlugin({
   sourceGlob: ['src/**/*.ts'],
   onlyAudits: [
     'classes-coverage',
@@ -133,7 +133,7 @@ await docCoveragePlugin({
 Optional parameter. The `skipAudits` option allows you to exclude specific documentation types from measurement. All other types will be included in the results.
 
 ```js
-await docCoveragePlugin({
+docCoveragePlugin({
   sourceGlob: ['src/**/*.ts'],
   skipAudits: [
     'variables-coverage',

packages/plugin-doc-coverage/src/lib/config.unit.test.ts

@@ -91,7 +91,7 @@ describe('DocCoveragePlugin Configuration', () => {
         docCoveragePluginConfigSchema.parse({
           onlyAudits: [123, true],
         }),
-      ).toThrow('Expected string');
+      ).toThrow('Expected string, received number');
     });
   });
 

packages/plugin-doc-coverage/src/lib/doc-coverage-plugin.ts

@@ -28,8 +28,8 @@ export const PLUGIN_DOCS_URL =
  *   // ... core config ...
  *   plugins: [
  *     // ... other plugins ...
- *     await docCoveragePlugin({
- *       sourceGlob: 'src/**/*.{ts,tsx}',
+ *     docCoveragePlugin({
+ *       sourceGlob: ['src/**/*.{ts,tsx}']
  *     })
  *   ]
  * }

packages/plugin-doc-coverage/src/lib/doc-coverage-plugin.unit.test.ts

@@ -22,12 +22,12 @@ vi.mock('./runner/runner.js', () => ({
 }));
 
 describe('docCoveragePlugin', () => {
-  it('should create a valid plugin config', async () => {
-    await expect(
+  it('should create a valid plugin config', () => {
+    expect(
       docCoveragePlugin({
         sourceGlob: ['src/**/*.ts', '!**/*.spec.ts', '!**/*.test.ts'],
       }),
-    ).resolves.toStrictEqual(
+    ).toStrictEqual(
       expect.objectContaining({
         slug: PLUGIN_SLUG,
         title: PLUGIN_TITLE,
@@ -41,32 +41,32 @@ describe('docCoveragePlugin', () => {
     );
   });
 
-  it('should throw for invalid plugin options', async () => {
-    await expect(
+  it('should throw for invalid plugin options', () => {
+    expect(() =>
       docCoveragePlugin({
         // @ts-expect-error testing invalid config
         sourceGlob: 123,
       }),
-    ).rejects.toThrow('Expected array, received number');
+    ).toThrow('Expected array, received number');
   });
 
-  it('should filter groups', async () => {
+  it('should filter groups', () => {
     const config = { sourceGlob: ['src/**/*.ts'] };
-    await docCoveragePlugin(config);
+    docCoveragePlugin(config);
 
     expect(filterGroupsByOnlyAudits).toHaveBeenCalledWith(groups, config);
   });
 
   it('should filter audits', async () => {
     const config = { sourceGlob: ['src/**/*.ts'] };
-    await docCoveragePlugin(config);
+    docCoveragePlugin(config);
 
     expect(filterAuditsByPluginConfig).toHaveBeenCalledWith(config);
   });
 
   it('should forward options to runner function', async () => {
     const config = { sourceGlob: ['src/**/*.ts'] };
-    await docCoveragePlugin(config);
+    docCoveragePlugin(config);
 
     expect(createRunnerFunction).toHaveBeenCalledWith(config);
   });

packages/plugin-doc-coverage/src/lib/runner/doc-processer.ts

@@ -53,6 +53,19 @@ export function processDocCoverage(
   return getDocumentationReport(project.getSourceFiles());
 }
 
+export function getAllNodesFromASourceFile(sourceFile: SourceFile) {
+  const classes = sourceFile.getClasses();
+  return [
+    ...sourceFile.getFunctions(),
+    ...classes,
+    ...getClassNodes(classes),
+    ...sourceFile.getTypeAliases(),
+    ...sourceFile.getEnums(),
+    ...sourceFile.getInterfaces(),
+    ...getVariablesInformation(sourceFile.getVariableStatements()),
+  ];
+}
+
 /**
  * Gets the documentation coverage report from the source files
  * @param sourceFiles - The source files to process
@@ -64,23 +77,12 @@ export function getDocumentationReport(
   const unprocessedCoverageReport = sourceFiles.reduce(
     (coverageReportOfAllFiles, sourceFile) => {
       const filePath = sourceFile.getFilePath();
-      const classes = sourceFile.getClasses();
-
-      const allNodesFromFile = [
-        ...sourceFile.getFunctions(),
-        ...classes,
-        ...getClassNodes(classes),
-        ...sourceFile.getTypeAliases(),
-        ...sourceFile.getEnums(),
-        ...sourceFile.getInterfaces(),
-        ...getVariablesInformation(sourceFile.getVariableStatements()),
-      ];
+      const allNodesFromFile = getAllNodesFromASourceFile(sourceFile);
 
       const coverageReportOfCurrentFile = allNodesFromFile.reduce(
         (acc, node) => {
           const nodeType = getCoverageTypeFromKind(node.getKind());
           const currentTypeReport = acc[nodeType];
-
           const updatedIssues =
             node.getJsDocs().length === 0
               ? [

packages/plugin-doc-coverage/src/lib/runner/doc-processer.unit.test.ts

@@ -4,6 +4,7 @@ import {
   sourceFileMock,
 } from '../../../mocks/source-files-mock.generator';
 import {
+  getAllNodesFromASourceFile,
   getClassNodes,
   getDocumentationReport,
   getVariablesInformation,
@@ -276,3 +277,37 @@ describe('getVariablesInformation', () => {
     expect(result).toHaveLength(0);
   });
 });
+
+describe('getAllNodesFromASourceFile', () => {
+  it('should combine all node types from a source file', () => {
+    const mockSourceFile = sourceFileMock('test.ts', {
+      functions: { 1: true },
+      classes: { 2: false },
+      types: { 3: true },
+      enums: { 4: false },
+      interfaces: { 5: true },
+    });
+
+    const result = getAllNodesFromASourceFile(mockSourceFile);
+
+    expect(result).toHaveLength(5);
+  });
+
+  it('should handle empty source file', () => {
+    const mockSourceFile = sourceFileMock('empty.ts', {});
+
+    const result = getAllNodesFromASourceFile(mockSourceFile);
+
+    expect(result).toHaveLength(0);
+  });
+
+  it('should handle source file with only functions', () => {
+    const mockSourceFile = sourceFileMock('functions.ts', {
+      functions: { 1: true, 2: false, 3: true },
+    });
+
+    const result = getAllNodesFromASourceFile(mockSourceFile);
+
+    expect(result).toHaveLength(3);
+  });
+});