refactor static ts error data

Author: BioPhoton

code-pushup.preset.ts

@@ -17,19 +17,8 @@ import {
   type TypescriptPluginOptions,
   typescriptPlugin,
 } from './packages/plugin-typescript/src/index.js';
-import {
-  BUILD_EMIT_OPTIONS,
-  CONTROL_FLOW_OPTIONS,
-  INTEROP_CONSTRAINTS,
-  LANGUAGE_ENVIRONMENT_OPTIONS,
-  MODULE_RESOLUTION,
-  PROJECT_REFERENCES,
-  STRICT_CHECKS,
-  TYPE_CHECKING_BEHAVIOR,
-  WATCH_OPTIONS
-} from './packages/plugin-typescript/src/lib/runner/known-ts-error-codes.js';
-import {filterAuditsBySlug, filterGroupsByAuditSlug} from './packages/plugin-typescript/src/lib/utils.js';
-import {GROUPS} from "./packages/plugin-typescript/src/lib/constants";
+import { GROUPS } from './packages/plugin-typescript/src/lib/constants';
+import { filterGroupsByAuditSlug } from './packages/plugin-typescript/src/lib/utils.js';
 
 export const jsPackagesCategories: CategoryConfig[] = [
   {
@@ -88,14 +77,14 @@ export const eslintCategories: CategoryConfig[] = [
     slug: 'bug-prevention',
     title: 'Bug prevention',
     description: 'Lint rules that find **potential bugs** in your code.',
-    refs: [{type: 'group', plugin: 'eslint', slug: 'problems', weight: 1}],
+    refs: [{ type: 'group', plugin: 'eslint', slug: 'problems', weight: 1 }],
   },
   {
     slug: 'code-style',
     title: 'Code style',
     description:
       'Lint rules that promote **good practices** and consistency in your code.',
-    refs: [{type: 'group', plugin: 'eslint', slug: 'suggestions', weight: 1}],
+    refs: [{ type: 'group', plugin: 'eslint', slug: 'suggestions', weight: 1 }],
   },
 ];
 
@@ -160,7 +149,7 @@ export const typescriptPluginConfigNx = async (
         slug: 'typescript',
         title: 'Typescript',
         refs: GROUPS.filter(filterGroupsByAuditSlug(opt.onlyAudits)).map(
-          ({slug}) => ({
+          ({ slug }) => ({
             plugin: 'typescript',
             type: 'group' as const,
             slug,

packages/plugin-typescript/README.md

@@ -42,7 +42,7 @@ For more infos visit the [official docs](https://developer.chrome.com/docs/types
      plugins: [
        // ...
        await typescriptPlugin({
-          tsConfigPath: './tsconfig.json'
+         tsConfigPath: './tsconfig.json',
        }),
      ],
    };
@@ -64,9 +64,7 @@ import { typescriptGroupRef } from './utils';
 
 export default {
   // ...
-  categories: [
-    
-  ],
+  categories: [],
 };
 ```
 

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

@@ -1,6 +1,6 @@
 import { z } from 'zod';
+import { AUDITS } from './constants.js';
 import type { AuditSlug } from './types.js';
-import {AUDITS} from "./constants.js";
 
 const auditSlugs = AUDITS.map(({ slug }) => slug) as [string, ...string[]];
 export const typescriptPluginConfigSchema = z.object({

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

@@ -1,56 +1,38 @@
-import {
-  BUILD_EMIT_OPTIONS,
-  CONTROL_FLOW_OPTIONS,
-  INTEROP_CONSTRAINTS,
-  LANGUAGE_ENVIRONMENT_OPTIONS,
-  MODULE_RESOLUTION,
-  PROJECT_REFERENCES,
-  STRICT_CHECKS,
-  TYPE_CHECKING_BEHAVIOR,
-  WATCH_OPTIONS
-} from './runner/ts-error-codes.js';
-import type {Audit, Group} from "@code-pushup/models";
-import {formatTitle, kebabCaseToCamelCase} from "./utils.js";
+import type { Audit, Group } from '@code-pushup/models';
+import { TS_ERROR_CODES } from './runner/ts-error-codes.js';
+import { camelCaseToKebabCase, formatTitle } from './utils.js';
 
 export const TYPESCRIPT_PLUGIN_SLUG = 'typescript';
 
-export const AUDITS = [
-  STRICT_CHECKS, BUILD_EMIT_OPTIONS,
-  CONTROL_FLOW_OPTIONS, TYPE_CHECKING_BEHAVIOR,
-  MODULE_RESOLUTION, PROJECT_REFERENCES,
-  WATCH_OPTIONS, INTEROP_CONSTRAINTS, LANGUAGE_ENVIRONMENT_OPTIONS
-].flatMap(i => Object.entries(i)).reduce<Audit[]>(
-  (audits, [slug]) => {
-    const anchorText = kebabCaseToCamelCase(slug);
-    const title = formatTitle(slug);
+export const AUDITS = Object.values(TS_ERROR_CODES)
+  .flatMap(i => Object.entries(i))
+  .reduce<Audit[]>((audits, [name]) => {
+    const slug = camelCaseToKebabCase(name);
+    const title = formatTitle(name);
     return [
       ...audits,
       {
         slug,
         title,
-        docsUrl: `https://www.typescriptlang.org/tsconfig/#${anchorText}`
-      }];
+        docsUrl: `https://www.typescriptlang.org/tsconfig/#${name}`,
+      },
+    ];
   }, []);
 
-export const GROUPS: Group[] = Object.entries({
-  'strict-checks': Object.keys(STRICT_CHECKS).map((slug) => ({slug, weight: 3})),
-  'type-checking-behavior': Object.keys(TYPE_CHECKING_BEHAVIOR).map((slug) => ({slug, weight: 2})),
-  'control-flow-options': Object.keys(CONTROL_FLOW_OPTIONS).map((slug) => ({slug, weight: 2})),
-  'interop-constraints': Object.keys(INTEROP_CONSTRAINTS).map((slug) => ({slug, weight: 2})),
-  'module-resolution': Object.keys(MODULE_RESOLUTION).map((slug) => ({slug, weight: 2})),
-  'build-emit-options': Object.keys(BUILD_EMIT_OPTIONS).map((slug) => ({slug, weight: 1})),
-  'project-references': Object.keys(PROJECT_REFERENCES).map((slug) => ({slug, weight: 1})),
-  'watch-options': Object.keys(WATCH_OPTIONS).map((slug) => ({slug, weight: 1})),
-  'language-environment-options': Object.keys(LANGUAGE_ENVIRONMENT_OPTIONS).map((slug) => ({slug, weight: 1}))
-})
-  .reduce((groups, [slug, refs]) => {
-    const group: Group = {
-      slug,
-      title: formatTitle(slug),
-      refs
-    };
-    return [
-      ...groups,
-      group
-    ]
-  }, [] as Group[]);
+const weights = {
+  // eslint-disable-next-line @typescript-eslint/no-magic-numbers
+  strictChecks: 3,
+  typeCheckingBehavior: 2,
+  controlFlowOptions: 2,
+  interopConstraints: 2,
+};
+export const GROUPS: Group[] = Object.entries(TS_ERROR_CODES).map(
+  ([groupSlug, auditMap]) => ({
+    slug: camelCaseToKebabCase(groupSlug),
+    title: formatTitle(groupSlug),
+    refs: Object.keys(auditMap).map(audit => ({
+      slug: camelCaseToKebabCase(audit),
+      weight: weights[audit as keyof typeof weights] ?? 1,
+    })),
+  }),
+);

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

@@ -8,6 +8,7 @@ import type {
   RunnerFunction,
 } from '@code-pushup/models';
 import type { TypescriptPluginOptions } from '../config.js';
+import { AUDITS } from '../constants.js';
 import type { AuditSlug } from '../types.js';
 import { filterAuditsBySlug } from '../utils.js';
 import { getDiagnostics } from './typescript-runner.js';
@@ -16,10 +17,9 @@ import {
   getIssueFromDiagnostic,
   transformTSErrorCodeToAuditSlug,
 } from './utils.js';
-import {AUDITS} from "../constants.js";
 
 export function createRunnerFunction(
-  options: TypescriptPluginOptions & { audits: Audit[]},
+  options: TypescriptPluginOptions & { audits: Audit[] },
 ): RunnerFunction {
   return async (): Promise<AuditOutputs> => {
     const diagnostics = await getDiagnostics(options);
@@ -34,7 +34,7 @@ export function createRunnerFunction(
           category === DiagnosticCategory.Error,
       )
       // filter out unsupported errors
-      .filter(({code}) => AUDIT_LOOKUP.get(code) !== undefined)
+      .filter(({ code }) => AUDIT_LOOKUP.get(code) !== undefined)
       .reduce(
         (acc, diag) => {
           const slug = transformTSErrorCodeToAuditSlug(diag.code);
@@ -59,9 +59,7 @@ export function createRunnerFunction(
         >,
       );
 
-    return AUDITS
-      .filter(filterAuditsBySlug(options.onlyAudits))
-      .map(audit => {
+    return AUDITS.filter(filterAuditsBySlug(options.onlyAudits)).map(audit => {
       const { details } = result[audit.slug as AuditSlug] ?? {};
       const issues = details?.issues ?? [];
       return {