fix(plugin-typescript): refine types

Author: BioPhoton

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

@@ -5,7 +5,7 @@ import {
 } from './schema.js';
 
 describe('typescriptPluginConfigSchema', () => {
-  const tsConfigPath = 'tsconfig.json';
+  const tsconfig = 'tsconfig.json';
 
   it('accepts a empty configuration', () => {
     expect(() => typescriptPluginConfigSchema.parse({})).not.toThrow();
@@ -14,15 +14,15 @@ describe('typescriptPluginConfigSchema', () => {
   it('accepts a configuration with tsConfigPath set', () => {
     expect(() =>
       typescriptPluginConfigSchema.parse({
-        tsConfigPath,
+        tsconfig,
       } satisfies TypescriptPluginOptions),
     ).not.toThrow();
   });
 
   it('accepts a configuration with tsConfigPath and empty onlyAudits', () => {
     expect(() =>
       typescriptPluginConfigSchema.parse({
-        tsConfigPath,
+        tsconfig,
         onlyAudits: [],
       } satisfies TypescriptPluginOptions),
     ).not.toThrow();
@@ -31,7 +31,7 @@ describe('typescriptPluginConfigSchema', () => {
   it('accepts a configuration with tsConfigPath and full onlyAudits', () => {
     expect(() =>
       typescriptPluginConfigSchema.parse({
-        tsConfigPath,
+        tsconfig,
         onlyAudits: [
           'syntax-errors',
           'semantic-errors',
@@ -52,7 +52,7 @@ describe('typescriptPluginConfigSchema', () => {
   it('throws for invalid onlyAudits items', () => {
     expect(() =>
       typescriptPluginConfigSchema.parse({
-        tsConfigPath,
+        tsconfig,
         onlyAudits: [123, true],
       }),
     ).toThrow('invalid_type');
@@ -61,7 +61,7 @@ describe('typescriptPluginConfigSchema', () => {
   it('throws for unknown audit slug', () => {
     expect(() =>
       typescriptPluginConfigSchema.parse({
-        tsConfigPath,
+        tsconfig,
         onlyAudits: ['unknown-audit'],
       }),
     ).toThrow(/unknown-audit/);

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

@@ -1,8 +1,3 @@
-import type { DiagnosticsOptions } from './runner/ts-runner.js';
 import type { CodeRangeName } from './runner/types.js';
 
 export type AuditSlug = CodeRangeName;
-
-export type FilterOptions = { onlyAudits?: AuditSlug[] | undefined };
-export type TypescriptPluginOptions = Partial<DiagnosticsOptions> &
-  FilterOptions;

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

@@ -3,19 +3,17 @@ import type { PluginConfig } from '@code-pushup/models';
 import { stringifyError } from '@code-pushup/utils';
 import { DEFAULT_TS_CONFIG, TYPESCRIPT_PLUGIN_SLUG } from './constants.js';
 import { createRunnerFunction } from './runner/runner.js';
-import type { DiagnosticsOptions } from './runner/ts-runner.js';
-import { typescriptPluginConfigSchema } from './schema.js';
-import type { AuditSlug } from './types.js';
+import {
+  type TypescriptPluginConfig,
+  type TypescriptPluginOptions,
+  typescriptPluginConfigSchema,
+} from './schema.js';
 import { getAudits, getGroups, logSkippedAudits } from './utils.js';
 
 const packageJson = createRequire(import.meta.url)(
   '../../package.json',
 ) as typeof import('../../package.json');
 
-export type FilterOptions = { onlyAudits?: AuditSlug[] };
-export type TypescriptPluginOptions = Partial<DiagnosticsOptions> &
-  FilterOptions;
-
 export async function typescriptPlugin(
   options?: TypescriptPluginOptions,
 ): Promise<PluginConfig> {

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

@@ -1,7 +1,7 @@
 import { expect } from 'vitest';
 import { pluginConfigSchema } from '@code-pushup/models';
 import { AUDITS, GROUPS } from './constants.js';
-import type { TypescriptPluginOptions } from './types.js';
+import type { TypescriptPluginOptions } from './schema.js';
 import { typescriptPlugin } from './typescript-plugin.js';
 
 describe('typescriptPlugin-config-object', () => {

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

@@ -1,8 +1,11 @@
 import type { CompilerOptions } from 'typescript';
 import type { Audit, CategoryConfig, CategoryRef } from '@code-pushup/models';
-import { kebabCaseToCamelCase } from '@code-pushup/utils';
+import { kebabCaseToCamelCase, ui } from '@code-pushup/utils';
 import { AUDITS, GROUPS, TYPESCRIPT_PLUGIN_SLUG } from './constants.js';
-import type { FilterOptions, TypescriptPluginOptions } from './types.js';
+import type {
+  TypescriptPluginConfig,
+  TypescriptPluginOptions,
+} from './schema.js';
 
 /**
  * It filters the audits by the slugs
@@ -63,7 +66,9 @@ export function getGroups(options?: TypescriptPluginOptions) {
   })).filter(group => group.refs.length > 0);
 }
 
-export function getAudits(options?: FilterOptions) {
+export function getAudits(
+  options?: Pick<TypescriptPluginConfig, 'onlyAudits'>,
+) {
   return AUDITS.filter(filterAuditsBySlug(options?.onlyAudits));
 }
 
@@ -141,6 +146,6 @@ export function logSkippedAudits(audits: Audit[]) {
     audit => !audits.some(filtered => filtered.slug === audit.slug),
   ).map(audit => kebabCaseToCamelCase(audit.slug));
   if (skippedAudits.length > 0) {
-    console.warn(`Skipped audits: [${skippedAudits.join(', ')}]`);
+    ui().logger.info(`Skipped audits: [${skippedAudits.join(', ')}]`);
   }
 }