feat: add TypeScript plugin

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';
@@ -33,10 +34,15 @@ const config: CoreConfig = {
 
 export default mergeConfigs(
   config,
-  await coverageCoreConfigNx(),
+  /* await coverageCoreConfigNx(),
   await jsPackagesCoreConfig(),
   await lighthouseCoreConfig(
     'https://github.com/code-pushup/cli?tab=readme-ov-file#code-pushup-cli/',
   ),
-  await eslintCoreConfigNx(),
+  await eslintCoreConfigNx(),*/
+  await typescriptPluginConfigNx({
+    tsConfigPath:
+      'packages/plugin-typescript/mocks/fixtures/basic-setup/tsconfig.json',
+    // onlyAudits: ['verbatim-module-syntax-typescript']
+  }),
 );

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,24 @@ export const eslintCoreConfigNx = async (
   };
 };
 
+export const typescriptPluginConfigNx = async (
+  options?: TypescriptPluginOptions,
+): Promise<CoreConfig> => {
+  const opt: TypescriptPluginOptions = {
+    ...options,
+  };
+  return {
+    plugins: [await typescriptPlugin(opt)],
+    categories: [
+      {
+        slug: 'typescript',
+        title: 'Typescript',
+        refs: await getCategoryRefsFromGroups(opt),
+      },
+    ],
+  };
+};
+
 export const coverageCoreConfigNx = async (
   projectName?: string,
 ): Promise<CoreConfig> => {

package.json

@@ -15,7 +15,9 @@
   "scripts": {
     "prepare": "husky install",
     "commit": "git-cz",
-    "knip": "knip"
+    "knip": "knip",
+    "postinstall-plugin-typescript": "npx tsx --tsconfig=packages/plugin-typescript/tsconfig.tools.json packages/plugin-typescript/src/postinstall/index.ts",
+    "postinstall": "npm run postinstall-plugin-typescript"
   },
   "private": true,
   "engines": {
@@ -25,7 +27,7 @@
     "@code-pushup/portal-client": "^0.9.0",
     "@isaacs/cliui": "^8.0.2",
     "@nx/devkit": "19.8.13",
-    "@poppinss/cliui": "^6.4.1",
+    "@poppinss/cliui": "^6.4.2",
     "@swc/helpers": "0.5.13",
     "ansis": "^3.3.2",
     "build-md": "^0.4.2",

packages/plugin-typescript/README.md

@@ -0,0 +1,169 @@
+# @code-pushup/typescript-plugin
+
+[![npm](https://img.shields.io/npm/v/%40code-pushup%2Ftypescript-plugin.svg)](https://www.npmjs.com/package/@code-pushup/typescript-plugin)
+[![downloads](https://img.shields.io/npm/dm/%40code-pushup%2Ftypescript-plugin)](https://npmtrends.com/@code-pushup/typescript-plugin)
+[![dependencies](https://img.shields.io/librariesio/release/npm/%40code-pushup/typescript-plugin)](https://www.npmjs.com/package/@code-pushup/typescript-plugin?activeTab=dependencies)
+
+🕵️ **Code PushUp plugin for measuring TypeScript quality with compiler diagnostics.** 🔥
+
+This plugin allows you to measure and track TypeScript compiler diagnostics in your TypeScript/JavaScript project.
+It analyzes your codebase using the TypeScript compiler to detect potential issues and configuration problems.
+
+TypeScript compiler diagnostics are mapped to Code PushUp audits in the following way:
+
+- `value`: The number of issues found for a specific TypeScript configuration option -> 3
+- `displayValue`: The number of issues found -> 3 issues
+- `score`: Binary scoring - 1 if no issues are found, 0 if any issues exist
+- Issues are mapped to audit details, containing:
+  - Source file location
+  - Error message from TypeScript compiler
+  - Code reference where the issue was found
+
+## Getting started
+
+1. If you haven't already, install [@code-pushup/cli](../cli/README.md) and create a configuration file.
+
+2. Install as a dev dependency with your package manager:
+
+   ```sh
+   npm install --save-dev @code-pushup/typescript-plugin
+   ```
+
+   ```sh
+   yarn add --dev @code-pushup/typescript-plugin
+   ```
+
+   ```sh
+   pnpm add --save-dev @code-pushup/typescript-plugin
+   ```
+
+3. Add this plugin to the `plugins` array in your Code PushUp CLI config file (e.g. `code-pushup.config.ts`).
+
+Define the ts config file used to compile your codebase. Based on those compiler options the plugin will generate audits.
+
+```ts
+import typescriptPlugin from '@code-pushup/typescript-plugin';
+
+export default {
+  // ...
+  plugins: [
+    // ...
+    typescriptPlugin({
+      tsConfigPath: './tsconfig.json',
+      onlyAudits: ['no-implicit-any'],
+    }),
+  ],
+};
+```
+
+4. Run the CLI with `npx code-pushup collect` and view or upload the report (refer to [CLI docs](../cli/README.md)).
+
+## About TypeScript checks
+
+The TypeScript plugin analyzes your codebase using the TypeScript compiler to identify potential issues and enforce best practices.
+It helps ensure type safety and maintainability of your TypeScript code.
+
+The plugin provides multiple audits grouped into different sets:
+
+- Language and Environment - Configuration options for TypeScript language features and runtime environment, including decorators, JSX support, target ECMAScript version, and class field behaviors
+- Interop Constraints - Settings that control how TypeScript interoperates with other JavaScript code, including module imports/exports and case sensitivity rules
+- Watch Options - Configuration for TypeScript watch mode behavior, including file watching strategies and dependency tracking
+- Project References - Options for managing TypeScript project references, composite projects, and build optimization settings
+- Module Resolution - Settings that control how TypeScript finds and resolves module imports, including Node.js resolution, package.json exports/imports, and module syntax handling
+- Type Checking Behavior - Configuration for TypeScript type checking strictness and error reporting, including property access rules and method override checking
+- Control Flow Options - Settings that affect code flow analysis, including handling of unreachable code, unused labels, switch statements, and async/generator functions
+- Strict Checks - Strict type checking options that enable additional compile-time verifications, including null checks, implicit any/this, and function type checking
+- Build/Emit Options - Configuration options that control TypeScript output generation, including whether to emit files, how to handle comments and declarations, and settings for output optimization and compatibility helpers
+
+Each audit:
+
+- Checks for specific TypeScript compiler errors and warnings
+- Provides a score based on the number of issues found
+- Includes detailed error messages and locations
+
+Each set is also available as group in the plugin. See more under [Audits and Groups]()
+
+## Plugin architecture
+
+### Plugin configuration specification
+
+The plugin accepts the following parameters:
+
+| Option       | Type     | Default         | Description                                                                                                                                 |
+| ------------ | -------- | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
+| tsConfigPath | string   | `tsconfig.json` | A string that defines the path to your `tsconfig.json` file                                                                                 |
+| onlyAudits   | string[] | undefined       | An array of audit slugs to specify which documentation types you want to measure. Only the specified audits will be included in the results |
+
+#### TsConfigPath
+
+Optional parameter. The `tsConfigPath` option accepts a string that defines the path to your config file and defaults to `tsconfig.json`.
+
+```js
+typescriptPlugin({
+  tsConfigPath: './tsconfig.json',
+});
+```
+
+#### OnlyAudits
+
+Optional parameter. The `onlyAudits` option allows you to specify which documentation types you want to measure. Only the specified audits will be included in the results. Example:
+
+```js
+typescriptPlugin({
+  onlyAudits: ['no-implicit-any'],
+});
+```
+
+### Optionally set up categories
+
+1. Reference audits (or groups) which you wish to include in custom categories (use `npx code-pushup print-config` to list audits and groups).
+
+Assign weights based on what influence each TypeScript checks should have on the overall category score (assign weight 0 to only include as extra info, without influencing category score).
+
+```ts
+// ...
+categories: [
+  {
+    slug: 'typescript',
+    title: 'TypeScript',
+    refs: [
+      {
+        type: 'audit',
+        plugin: 'typescript',
+        slug: 'no-implicit-any',
+        weight: 2,
+      },
+      {
+        type: 'audit',
+        plugin: 'typescript',
+        slug: 'no-explicit-any',
+        weight: 1,
+      },
+      // ...
+    ],
+  },
+  // ...
+];
+```
+
+Also groups can be used:
+
+```ts
+// ...
+categories: [
+  {
+    slug: 'typescript',
+    title: 'TypeScript',
+    refs: [
+      {
+        slug: 'language-and-environment',
+        weight: 1,
+        type: 'group',
+        plugin: 'typescript',
+      },
+      // ...
+    ],
+  },
+  // ...
+];
+```

packages/plugin-typescript/eslint.config.js

@@ -0,0 +1,21 @@
+import tseslint from 'typescript-eslint';
+import baseConfig from '../../eslint.config.js';
+
+export default tseslint.config(
+  ...baseConfig,
+  {
+    files: ['**/*.ts', '!**/mocks'],
+    languageOptions: {
+      parserOptions: {
+        projectService: true,
+        tsconfigRootDir: import.meta.dirname,
+      },
+    },
+  },
+  {
+    files: ['**/*.json'],
+    rules: {
+      '@nx/dependency-checks': 'error',
+    },
+  },
+);

packages/plugin-typescript/mocks/fixtures/basic-setup/src/ts-2307-module-not-fount.ts

@@ -0,0 +1,6 @@
+/**
+ * Error Code: 2307
+ * Compiler Option: moduleResolution
+ * Description: Cannot find module.
+ */
+import { nonExistentModule } from './non-existent';

packages/plugin-typescript/mocks/fixtures/basic-setup/src/ts-2322-strict-null-checks.ts

@@ -0,0 +1,8 @@
+/**
+ * Error Code: 2322
+ * Compiler Option: strictNullChecks
+ * Description: Type 'number' is not assignable to type 'string'.
+ */
+function strictNullChecksError() {
+  let value: string = 42; // Error: Type 'number' is not assignable to type 'string'
+}

packages/plugin-typescript/mocks/fixtures/basic-setup/src/ts-7006-no-implicit-any.ts

@@ -0,0 +1,10 @@
+
+
+/**
+ * Error Code: 7006
+ * Compiler Option: noImplicitAny
+ * Description: Parameter 'param' implicitly has an 'any' type.
+ */
+function noImplicitAnyError(param) {
+  console.log(param);
+}

packages/plugin-typescript/mocks/fixtures/basic-setup/src/ts-7027-strict-property-initialization.ts

@@ -0,0 +1,8 @@
+/**
+ * Error Code: 7027
+ * Compiler Option: strictPropertyInitialization
+ * Description: Property has no initializer and is not definitely assigned in the constructor.
+ */
+class strictPropertyInitializationError {
+  property: string; // Error: Property 'property' has no initializer
+}

packages/plugin-typescript/mocks/fixtures/basic-setup/tsconfig-with-exclude.json

@@ -0,0 +1,9 @@
+{
+  "compilerOptions": {
+    "rootDir": "./src",
+    "strict": true,
+    "target": "ES6",
+    "module": "CommonJS"
+  },
+  "exclude": ["src/**/*.ts", "src/**/*.js"]
+}

packages/plugin-typescript/mocks/fixtures/basic-setup/tsconfig.json

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

packages/plugin-typescript/mocks/fixtures/compiler-defaults/src/strict-errors.ts

@@ -0,0 +1,8 @@
+/**
+ * Error Code: 7006
+ * Compiler Option: noImplicitAny
+ * Description: Parameter 'param' implicitly has an 'any' type.
+ */
+function noImplicitAnyError(param) {
+  console.log(param);
+}

packages/plugin-typescript/mocks/fixtures/compiler-defaults/tsconfig.json

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