feat: change from compodoc to typedoc

Author: aramirezj

package-lock.json

@@ -110,6 +110,8 @@
     "tsconfig-paths": "^4.2.0",
     "tsx": "^4.19.0",
     "type-fest": "^4.26.1",
+    "typedoc": "^0.27.5",
+    "typedoc-plugin-coverage": "^3.4.0",
     "typescript": "5.5.4",
     "typescript-eslint": "^8.18.0",
     "verdaccio": "^5.32.2",

package.json

@@ -0,0 +1,4 @@
+/** Dummy function */
+export function DUMMY_FUNCTION() {
+  return 'Hello World';
+}

packages/plugin-doc-coverage/mocks/component-mock.ts

@@ -3,23 +3,21 @@ import { z } from 'zod';
 export type DocType = 'percentage-coverage';
 
 export const docCoveragePluginConfigSchema = z.object({
-  coverageToolCommand: z
-    .object({
-      command: z
-        .string({ description: 'Command to run coverage tool (compodoc).' })
-        .min(1),
-      args: z
-        .array(z.string(), {
-          description: 'Arguments to be passed to the coverage tool.',
-        })
-        .optional(),
+  language: z.enum(['javascript', 'typescript'], {
+    description: 'Programming language of the source code to analyze',
+  }),
+  sourceGlob: z
+    .string({
+      description: 'Glob pattern to find source files',
+    })
+    .optional(),
+  outputFolderPath: z
+    .string({
+      description: 'Path to the output folder',
     })
     .optional(),
-  outputPath: z
-    .string({ description: 'Path to the documentation.json file.' })
-    .default('documentation/documentation.json'),
 });
 
-export type DocCoveragePluginConfig = z.infer<
+export type DocCoveragePluginConfig = z.input<
   typeof docCoveragePluginConfigSchema
 >;

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

@@ -8,45 +8,57 @@ describe('docCoveragePluginConfigSchema', () => {
   it('accepts a documentation coverage configuration with all entities', () => {
     expect(() =>
       docCoveragePluginConfigSchema.parse({
-        coverageToolCommand: {
-          command: 'npx @compodoc/compodoc',
-          args: ['-p', 'tsconfig.json'],
-        },
-        outputPath: 'documentation/custom-doc.json',
+        language: 'typescript',
+        sourceGlob: 'src/**/*.{ts,tsx}',
       } satisfies DocCoveragePluginConfig),
     ).not.toThrow();
   });
 
-  it('accepts a minimal documentation coverage configuration', () => {
+  it('accepts minimal configuration with only language', () => {
     expect(() =>
-      docCoveragePluginConfigSchema.parse({} satisfies DocCoveragePluginConfig),
+      docCoveragePluginConfigSchema.parse({
+        language: 'javascript',
+      } satisfies DocCoveragePluginConfig),
     ).not.toThrow();
   });
 
-  it('uses default output path when not provided', () => {
-    const config = {} satisfies DocCoveragePluginConfig;
+  it('accepts configuration without sourceGlob', () => {
+    const config = {
+      language: 'typescript',
+    } satisfies DocCoveragePluginConfig;
     const parsed = docCoveragePluginConfigSchema.parse(config);
 
-    expect(parsed.outputPath).toBe('documentation/documentation.json');
+    expect(parsed.sourceGlob).toBeUndefined();
   });
 
-  it('throws for missing command in coverageToolCommand', () => {
+  it('throws for missing language', () => {
     expect(() =>
       docCoveragePluginConfigSchema.parse({
-        coverageToolCommand: {
-          args: ['-p', 'tsconfig.json'],
-        },
+        sourceGlob: 'src/**/*.ts',
       }),
     ).toThrow('invalid_type');
   });
 
-  it('accepts empty args in coverageToolCommand', () => {
+  it('throws for invalid language', () => {
     expect(() =>
       docCoveragePluginConfigSchema.parse({
-        coverageToolCommand: {
-          command: 'npx @compodoc/compodoc',
-        },
-      } satisfies DocCoveragePluginConfig),
+        language: 'python',
+        sourceGlob: 'src/**/*.py',
+      }),
+    ).toThrow('Invalid enum value');
+  });
+
+  it('accepts both typescript and javascript as valid languages', () => {
+    expect(() =>
+      docCoveragePluginConfigSchema.parse({
+        language: 'typescript',
+      }),
+    ).not.toThrow();
+
+    expect(() =>
+      docCoveragePluginConfigSchema.parse({
+        language: 'javascript',
+      }),
     ).not.toThrow();
   });
 });

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

@@ -19,8 +19,7 @@ import { createRunnerConfig } from './runner/index.js';
  *   plugins: [
  *     // ... other plugins ...
  *     await docCoveragePlugin({
- *
- *       docTypes: ['class', 'function']
+ *       language: 'typescript'
  *     })
  *   ]
  * }