fix: adjust plugin options

Author: BioPhoton

code-pushup.config.ts

@@ -8,7 +8,10 @@ import {
   typescriptPluginConfigNx,
 } from './code-pushup.preset.js';
 import type { CoreConfig } from './packages/models/src/index.js';
-import { BASIC_CHECKES } from './packages/plugin-typescript/src/lib/constants';
+import {
+  BASIC_CHECKES,
+  SUPPORTED_TS_ERROR_CODES,
+} from './packages/plugin-typescript/src/lib/constants';
 import { mergeConfigs } from './packages/utils/src/index.js';
 
 // load upload configuration from environment
@@ -43,6 +46,6 @@ export default mergeConfigs(
   await eslintCoreConfigNx(),
   await typescriptPluginConfigNx({
     tsConfigPath: 'packages/plugin-typescript/tsconfig.lib.json',
-    tsCodes: [...BASIC_CHECKES],
+    tsAudits: ['stris'],
   }),
 );

code-pushup.preset.ts

@@ -13,9 +13,14 @@ import jsPackagesPlugin from './packages/plugin-js-packages/src/index.js';
 import lighthousePlugin, {
   lighthouseGroupRef,
 } from './packages/plugin-lighthouse/src/index.js';
-import { typescriptPlugin } from './packages/plugin-typescript/src';
-import { AUDITS } from './packages/plugin-typescript/src/lib/generated/audits';
-import { TypescriptPluginOptions } from './packages/plugin-typescript/src/lib/typescript-plugin';
+import {
+  type TypescriptPluginOptions,
+  typescriptPlugin,
+} from './packages/plugin-typescript/src/index.js';
+import { SUPPORTED_TS_ERROR_CODES } from './packages/plugin-typescript/src/lib/constants.js';
+import { AUDITS } from './packages/plugin-typescript/src/lib/generated/audits.js';
+import { AuditSlug } from './packages/plugin-typescript/src/lib/types.js';
+import { filterAuditsBySlug } from './packages/plugin-typescript/src/lib/utils.js';
 
 export const jsPackagesCategories: CategoryConfig[] = [
   {
@@ -135,18 +140,25 @@ export const eslintCoreConfigNx = async (
 export const typescriptPluginConfigNx = async (
   options: TypescriptPluginOptions,
 ): Promise<CoreConfig> => {
+  const opt: TypescriptPluginOptions = {
+    tsAudits: Object.values(SUPPORTED_TS_ERROR_CODES) as AuditSlug[],
+    ...options,
+  };
+
   return {
-    plugins: [await typescriptPlugin(options)],
+    plugins: [await typescriptPlugin(opt)],
     categories: [
       {
         slug: 'typescript',
         title: 'Typescript',
-        refs: AUDITS.map(({ slug }) => ({
-          plugin: 'typescript',
-          type: 'audit' as const,
-          slug,
-          weight: 1,
-        })),
+        refs: AUDITS.filter(filterAuditsBySlug(opt.tsAudits)).map(
+          ({ slug }) => ({
+            plugin: 'typescript',
+            type: 'audit' as const,
+            slug,
+            weight: 1,
+          }),
+        ),
       },
     ],
   };

packages/plugin-typescript/src/index.ts

@@ -1,4 +1,5 @@
 import { typescriptPlugin } from './lib/typescript-plugin.js';
 
+export type { TypescriptPluginOptions } from './lib/config.js';
 export { typescriptPlugin } from './lib/typescript-plugin.js';
 export default typescriptPlugin;

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

@@ -1,13 +1,14 @@
 import { z } from 'zod';
+import type { AuditSlug } from './types.js';
 
 export const typescriptPluginConfigSchema = z.object({
   tsConfigPath: z.string().describe('Path to the TsConfig'),
-  tsCodes: z
-    .array(z.number())
+  tsAudits: z
+    .array(z.string())
     .optional()
     .describe('Array with specific TsCodes to measure'),
 });
 
 export type TypescriptPluginOptions = z.infer<
   typeof typescriptPluginConfigSchema
->;
+> & { tsAudits?: AuditSlug[] | undefined };

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

@@ -1,7 +1,7 @@
 import type { Audit } from '@code-pushup/models';
 
 /* eslint-disable max-lines */
-export const AUDITS: Audit[] = [
+export const AUDITS = [
   {
     slug: 'unterminated-string-literal',
     title: 'Unterminated String Literal',
@@ -7493,5 +7493,5 @@ export const AUDITS: Audit[] = [
     description:
       "String literal import and export names are not supported when the '--module' flag is set to 'es2015' or 'es2020'.",
   },
-];
+] as const satisfies Audit[];
 /* eslint-enable max-lines */

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

@@ -9,6 +9,7 @@ import type {
 import type { TypescriptPluginOptions } from '../config.js';
 import { AUDITS } from '../generated/audits.js';
 import type { AuditSlug } from '../types.js';
+import { filterAuditsBySlug } from '../utils.js';
 import { getDiagnostics } from './typescript-runner.js';
 import {
   getIssueFromDiagnostic,
@@ -36,7 +37,8 @@ export function createRunnerFunction(
           const issue = getIssueFromDiagnostic(diag);
 
           const existingIssues: Issue[] =
-            (acc[slug] && acc[slug].details?.issues) || ([] as Issue[]);
+            ((acc[slug] as Issue) && acc[slug].details?.issues) ||
+            ([] as Issue[]);
 
           return {
             ...acc,
@@ -63,6 +65,6 @@ export function createRunnerFunction(
         value: issues.length,
         ...(issues.length > 0 ? { details } : {}),
       } satisfies AuditOutput;
-    });
+    }).filter(filterAuditsBySlug(options.tsAudits));
   };
 }

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

@@ -1,5 +1,3 @@
-import { SUPPORTED_TS_ERROR_CODES } from './constants.js';
-import type { SupportedCompilerErrorCode } from './runner/models.js';
+import { AUDITS } from './generated/audits.js';
 
-export type AuditSlug =
-  (typeof SUPPORTED_TS_ERROR_CODES)[SupportedCompilerErrorCode];
+export type AuditSlug = (typeof AUDITS)[number]['slug'];

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

@@ -4,6 +4,7 @@ import type { TypescriptPluginOptions } from './config.js';
 import { TYPESCRIPT_PLUGIN_SLUG } from './constants.js';
 import { AUDITS } from './generated/audits.js';
 import { createRunnerFunction } from './runner/runner.js';
+import { filterAuditsBySlug } from './utils.js';
 
 export const PLUGIN_TITLE = 'Typescript';
 
@@ -23,7 +24,7 @@ export function typescriptPlugin(
     description: PLUGIN_DESCRIPTION,
     docsUrl: PLUGIN_DOCS_URL,
     icon: 'typescript',
-    audits: AUDITS,
+    audits: AUDITS.filter(filterAuditsBySlug(options.tsAudits)),
     groups: [],
     runner: createRunnerFunction(options),
   };

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

@@ -0,0 +1,10 @@
+import type { Audit } from '@code-pushup/models';
+
+export function filterAuditsBySlug(slugs?: string[]) {
+  return ({ slug }: Audit) => {
+    if (slugs && slugs.length > 0) {
+      return slugs.includes(slug);
+    }
+    return true;
+  };
+}

packages/plugin-typescript/tools/generate-audits/utils.ts

@@ -55,7 +55,7 @@ export async function generateAuditsFromGithub() {
     `
   import type {Audit} from "@code-pushup/models";
   /* eslint-disable max-lines */
-  export const AUDITS: Audit[] = ${JSON.stringify(audits, null, 2)};
+  export const AUDITS = ${JSON.stringify(audits, null, 2)} as const satisfies Audit[];
   /* eslint-enable max-lines */
   `,
   );