test(plugin-typescript): add test case

Author: BioPhoton

packages/plugin-typescript/src/lib/typescript-plugin.unit.test.ts

@@ -1,31 +1,38 @@
-import { expect } from 'vitest';
-import { pluginConfigSchema } from '@code-pushup/models';
-import { AUDITS, GROUPS } from './constants.js';
-import { typescriptPlugin } from './typescript-plugin.js';
+import {expect} from 'vitest';
+import {pluginConfigSchema} from '@code-pushup/models';
+import {AUDITS, GROUPS} from './constants.js';
+import {typescriptPlugin} from './typescript-plugin.js';
+import type {TypescriptPluginOptions} from "./types";
 
 describe('typescriptPlugin-config-object', () => {
-  it('should create valid plugin config without options', async () => {
-    const pluginConfig = await typescriptPlugin();
+    it('should create valid plugin config without options', async () => {
+        const pluginConfig = await typescriptPlugin();
 
-    expect(() => pluginConfigSchema.parse(pluginConfig)).not.toThrow();
+        expect(() => pluginConfigSchema.parse(pluginConfig)).not.toThrow();
 
-    const { audits, groups } = pluginConfig;
-    expect(audits).toHaveLength(AUDITS.length);
-    expect(groups).toBeDefined();
-    expect(groups!).toHaveLength(GROUPS.length);
-  });
-
-  it('should create valid plugin config', async () => {
-    const pluginConfig = await typescriptPlugin({
-      tsConfigPath: 'mocked-away/tsconfig.json',
-      onlyAudits: ['syntax-errors', 'semantic-errors', 'configuration-errors'],
+        const {audits, groups} = pluginConfig;
+        expect(audits).toHaveLength(AUDITS.length);
+        expect(groups).toBeDefined();
+        expect(groups!).toHaveLength(GROUPS.length);
     });
 
-    expect(() => pluginConfigSchema.parse(pluginConfig)).not.toThrow();
+    it('should create valid plugin config', async () => {
+        const pluginConfig = await typescriptPlugin({
+            tsconfig: 'mocked-away/tsconfig.json',
+            onlyAudits: ['syntax-errors', 'semantic-errors', 'configuration-errors'],
+        });
+
+        expect(() => pluginConfigSchema.parse(pluginConfig)).not.toThrow();
 
-    const { audits, groups } = pluginConfig;
-    expect(audits).toHaveLength(3);
-    expect(groups).toBeDefined();
-    expect(groups!).toHaveLength(2);
-  });
+        const {audits, groups} = pluginConfig;
+        expect(audits).toHaveLength(3);
+        expect(groups).toBeDefined();
+        expect(groups!).toHaveLength(2);
+    });
+
+    it('should throw for invalid valid params', async () => {
+        await expect(() => typescriptPlugin({
+            tsconfig: 42
+        } as unknown as TypescriptPluginOptions)).rejects.toThrow(/invalid_type/);
+    });
 });

packages/plugin-typescript/src/lib/utils.ts

@@ -4,6 +4,11 @@ import { kebabCaseToCamelCase } from '@code-pushup/utils';
 import { AUDITS, GROUPS, TYPESCRIPT_PLUGIN_SLUG } from './constants.js';
 import type { FilterOptions, TypescriptPluginOptions } from './types.js';
 
+/**
+ * It filters the audits by the slugs
+ *
+ * @param slugs
+ */
 export function filterAuditsBySlug(slugs?: string[]) {
   return ({ slug }: { slug: string }) => {
     if (slugs && slugs.length > 0) {