feat: typescript plugin poc implementation

code-pushup.config.ts

@@ -5,6 +5,7 @@ import {
   eslintCoreConfigNx,
   jsPackagesCoreConfig,
   lighthouseCoreConfig,
+  typescriptPluginConfigNx,
 } from './code-pushup.preset.js';
 import type { CoreConfig } from './packages/models/src/index.js';
 import { mergeConfigs } from './packages/utils/src/index.js';
@@ -38,5 +39,9 @@ export default mergeConfigs(
   await lighthouseCoreConfig(
     'https://github.com/code-pushup/cli?tab=readme-ov-file#code-pushup-cli/',
   ),
+  await typescriptPluginConfigNx({
+    tsConfigPath:
+      'packages/plugin-typescript/mocks/fixtures/basic-setup/tsconfig.json',
+  }),
   await eslintCoreConfigNx(),
 );

code-pushup.preset.ts

@@ -13,6 +13,11 @@ import jsPackagesPlugin from './packages/plugin-js-packages/src/index.js';
 import lighthousePlugin, {
   lighthouseGroupRef,
 } from './packages/plugin-lighthouse/src/index.js';
+import {
+  type TypescriptPluginOptions,
+  typescriptPlugin,
+} from './packages/plugin-typescript/src/index.js';
+import { getCategoryRefsFromGroups } from './packages/plugin-typescript/src/lib/utils.js';
 
 export const jsPackagesCategories: CategoryConfig[] = [
   {
@@ -129,6 +134,49 @@ export const eslintCoreConfigNx = async (
   };
 };
 
+export const typescriptPluginConfigNx = async (
+  options?: TypescriptPluginOptions,
+): Promise<CoreConfig> => {
+  return {
+    plugins: [await typescriptPlugin(options)],
+    categories: [
+      {
+        slug: 'typescript',
+        title: 'Typescript - All Groups',
+        refs: await getCategoryRefsFromGroups(options),
+      },
+      {
+        slug: 'bug-prevention',
+        title: 'Bug prevention',
+        refs: await getCategoryRefsFromGroups({
+          onlyAudits: [
+            'syntax-errors',
+            'semantic-errors',
+            'internal-errors',
+            'configuration-errors',
+          ],
+        }),
+      },
+      {
+        slug: 'code-style',
+        title: 'Code style',
+        description:
+          'TypeScript & Lint rules that promote **good practices** and consistency in your code.',
+        refs: await getCategoryRefsFromGroups({ onlyAudits: ['suggestions'] }),
+      },
+      {
+        slug: 'miscellaneous',
+        title: 'Miscellaneous',
+        description:
+          'Errors that do not bring any specific value to the developer, but are still useful to know.',
+        refs: await getCategoryRefsFromGroups({
+          onlyAudits: ['unknown-codes', 'language-service-errors'],
+        }),
+      },
+    ],
+  };
+};
+
 export const coverageCoreConfigNx = async (
   projectName?: string,
 ): Promise<CoreConfig> => {

e2e/plugin-typescript-e2e/eslint.config.js

@@ -0,0 +1,12 @@
+import tseslint from 'typescript-eslint';
+import baseConfig from '../../eslint.config.js';
+
+export default tseslint.config(...baseConfig, {
+  files: ['**/*.ts'],
+  languageOptions: {
+    parserOptions: {
+      projectService: true,
+      tsconfigRootDir: import.meta.dirname,
+    },
+  },
+});

e2e/plugin-typescript-e2e/mocks/fixtures/default-setup/code-pushup.config.ts

@@ -0,0 +1,19 @@
+import type { CoreConfig } from '@code-pushup/models';
+import {getCategoryRefsFromGroups, typescriptPlugin} from "@code-pushup/typescript-plugin";
+
+export default {
+  plugins: [
+    await typescriptPlugin({
+      tsConfigPath: 'tsconfig.json',
+    }),
+  ],
+  categories: [
+    {
+      slug: 'typescript-quality',
+      title: 'Typescript',
+      refs: await getCategoryRefsFromGroups({
+        tsConfigPath: 'tsconfig.json',
+      })
+    }
+  ],
+} satisfies CoreConfig;

e2e/plugin-typescript-e2e/mocks/fixtures/default-setup/exclude/utils.ts

@@ -0,0 +1,3 @@
+export function test() {
+  return 'test';
+}

e2e/plugin-typescript-e2e/mocks/fixtures/default-setup/src/1-syntax-errors.ts

@@ -0,0 +1 @@
+const a = { ; // Error: TS1136: Property assignment expected

e2e/plugin-typescript-e2e/mocks/fixtures/default-setup/src/2-semantic-errors.ts

@@ -0,0 +1,7 @@
+// 2683 - NoImplicitThis: 'this' implicitly has type 'any'.
+function noImplicitThisTS2683() {
+  console.log(this.value); // Error 2683
+}
+
+// 2531 - StrictNullChecks: Object is possibly 'null'.
+const strictNullChecksTS2531: string = null;

e2e/plugin-typescript-e2e/mocks/fixtures/default-setup/src/4-languale-service.ts

@@ -0,0 +1,6 @@
+class Standalone {
+  override method() { // Error: TS4114 - 'override' modifier can only be used in a class derived from a base class.
+    console.log("Standalone method");
+  }
+}
+const s = Standalone;

e2e/plugin-typescript-e2e/mocks/fixtures/default-setup/src/6-configuration-errors.ts

@@ -0,0 +1 @@
+import { test } from '../exclude/utils'; // TS6059:: File 'exclude/utils.ts' is not under 'rootDir' '.../configuration-errors'. 'rootDir' is expected to contain all source files.

e2e/plugin-typescript-e2e/mocks/fixtures/default-setup/tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "compilerOptions": {
+    "rootDir": "./src",
+    "target": "ES6",
+    "module": "CommonJS",
+    "strict": true,
+    "verbatimModuleSyntax": false
+  },
+  "include": ["src/**/*.ts"],
+}

e2e/plugin-typescript-e2e/project.json

@@ -0,0 +1,23 @@
+{
+  "name": "plugin-typescript-e2e",
+  "$schema": "../../node_modules/nx/schemas/project-schema.json",
+  "sourceRoot": "e2e/plugin-typescript-e2e/src",
+  "projectType": "application",
+  "targets": {
+    "lint": {
+      "executor": "@nx/linter:eslint",
+      "outputs": ["{options.outputFile}"],
+      "options": {
+        "lintFilePatterns": ["e2e/plugin-typescript-e2e/**/*.ts"]
+      }
+    },
+    "e2e": {
+      "executor": "@nx/vite:test",
+      "options": {
+        "configFile": "e2e/plugin-typescript-e2e/vite.config.e2e.ts"
+      }
+    }
+  },
+  "implicitDependencies": ["cli", "plugin-typescript"],
+  "tags": ["scope:plugin", "type:e2e"]
+}

e2e/plugin-typescript-e2e/tests/__snapshots__/typescript-plugin-json-report.json

@@ -0,0 +1,118 @@
+{
+  "categories": [
+    {
+      "refs": [
+        {
+          "plugin": "typescript",
+          "slug": "problems-group",
+          "type": "group",
+          "weight": 1,
+        },
+        {
+          "plugin": "typescript",
+          "slug": "ts-configuration-group",
+          "type": "group",
+          "weight": 1,
+        },
+        {
+          "plugin": "typescript",
+          "slug": "miscellaneous-group",
+          "type": "group",
+          "weight": 1,
+        },
+      ],
+      "slug": "typescript-quality",
+      "title": "Typescript",
+    },
+  ],
+  "packageName": "@code-pushup/core",
+  "plugins": [
+    {
+      "audits": [
+        {
+          "description": "Errors that occur during parsing and lexing of TypeScript source code",
+          "slug": "syntax-errors",
+          "title": "Syntax-Errors",
+        },
+        {
+          "description": "Errors that occur during type checking and type inference",
+          "slug": "semantic-errors",
+          "title": "Semantic-Errors",
+        },
+        {
+          "description": "Errors that occur during TypeScript language service operations",
+          "slug": "language-service-errors",
+          "title": "Language-Service-Errors",
+        },
+        {
+          "description": "Errors that occur during TypeScript internal operations",
+          "slug": "internal-errors",
+          "title": "Internal-Errors",
+        },
+        {
+          "description": "Errors that occur when parsing TypeScript configuration files",
+          "slug": "configuration-errors",
+          "title": "Configuration-Errors",
+        },
+        {
+          "description": "Errors that do not match any known TypeScript error code",
+          "slug": "unknown-codes",
+          "title": "Unknown-Codes",
+        },
+      ],
+      "description": "Official Code PushUp Typescript plugin.",
+      "docsUrl": "https://www.npmjs.com/package/@code-pushup/typescript-plugin/",
+      "groups": [
+        {
+          "description": "Syntax, semantic, and internal compiler errors are critical for identifying and preventing bugs.",
+          "refs": [
+            {
+              "slug": "syntax-errors",
+              "weight": 1,
+            },
+            {
+              "slug": "semantic-errors",
+              "weight": 1,
+            },
+            {
+              "slug": "internal-errors",
+              "weight": 1,
+            },
+          ],
+          "slug": "problems-group",
+          "title": "Problems",
+        },
+        {
+          "description": "TypeScript configuration and options errors ensure correct project setup, reducing risks from misconfiguration.",
+          "refs": [
+            {
+              "slug": "configuration-errors",
+              "weight": 1,
+            },
+          ],
+          "slug": "ts-configuration-group",
+          "title": "Configuration",
+        },
+        {
+          "description": "Errors that do not bring any specific value to the developer, but are still useful to know.",
+          "refs": [
+            {
+              "slug": "unknown-codes",
+              "weight": 1,
+            },
+            {
+              "slug": "language-service-errors",
+              "weight": 1,
+            },
+          ],
+          "slug": "miscellaneous-group",
+          "title": "Miscellaneous",
+        },
+      ],
+      "icon": "typescript",
+      "packageName": "@code-pushup/typescript-plugin",
+      "slug": "typescript",
+      "title": "Typescript",
+    },
+  ],
+}

e2e/plugin-typescript-e2e/tests/__snapshots__/typescript-plugin-terminal-report.txt

@@ -0,0 +1,36 @@
+Code PushUp CLI
+[ info ] Run collect...
+Code PushUp Report - @code-pushup/[email protected]
+
+
+Typescript audits
+
+● Semantic-Errors                                           2
+● Configuration-Errors                                      1
+● Language-Service-Errors                                   1
+● Syntax-Errors                                             1
+● Internal-Errors                                           0
+● Unknown-Codes                                             0
+
+Categories
+
+┌─────────────────────────────────────────────────────────┬─────────┬──────────┐
+│  Category                                               │  Score  │  Audits  │
+├─────────────────────────────────────────────────────────┼─────────┼──────────┤
+│  Typescript                                             │     28  │       6  │
+└─────────────────────────────────────────────────────────┴─────────┴──────────┘
+
+Made with ❤ by code-pushup.dev
+
+[ success ] Generated reports successfully: 
+[ success ] Collecting report successful!
+╭────────────────────────────────────────────────────────────────────────────────────────────╮
+│                                                                                            │
+│    💡 Visualize your reports                                                               │
+│                                                                                            │
+│    ❯ npx code-pushup upload - Run upload to upload the created report to the server        │
+│      https://github.com/code-pushup/cli/tree/main/packages/cli#upload-command              │
+│    ❯ npx code-pushup autorun - Run collect & upload                                        │
+│      https://github.com/code-pushup/cli/tree/main/packages/cli#autorun-command             │
+│                                                                                            │
+╰────────────────────────────────────────────────────────────────────────────────────────────╯