feat(plugin-typescript): add TS core logic

packages/plugin-typescript/mocks/fixtures/basic-setup/exclude/utils.ts

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

packages/plugin-typescript/mocks/fixtures/basic-setup/src/0-no-diagnostics/constants.ts

@@ -0,0 +1 @@
+export const TEST = 'test';

packages/plugin-typescript/mocks/fixtures/basic-setup/src/1-syntax-errors/ts-1136-property-assignment-expected.ts

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

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

@@ -0,0 +1,2 @@
+// 2307 - Cannot find module.
+import { nonExistentModule } from './non-existent';

packages/plugin-typescript/mocks/fixtures/basic-setup/src/2-semantic-errors/strict/no-implicit-this/ts-2683-not-implicit-this.ts

@@ -0,0 +1,4 @@
+// 2683 - NoImplicitThis: 'this' implicitly has type 'any'.
+function noImplicitThisTS2683() {
+  console.log(this.value); // Error 2683
+}

packages/plugin-typescript/mocks/fixtures/basic-setup/src/2-semantic-errors/strict/strict-function-types/ts-2349-not-callable.ts

@@ -0,0 +1,3 @@
+// 2349 - Cannot call a value that is not callable.
+const notCallable = 42;
+notCallable();

packages/plugin-typescript/mocks/fixtures/basic-setup/src/2-semantic-errors/strict/strict-null-checks/ts-2531-strict-null-checks.ts

@@ -0,0 +1,2 @@
+// 2531 - StrictNullChecks: Object is possibly 'null'.
+const strictNullChecksTS2531: string = null;

packages/plugin-typescript/mocks/fixtures/basic-setup/src/2-semantic-errors/ts-2307-cannot-find-module.ts

@@ -0,0 +1 @@
+const value: NonExistentType = 42; // Compiler fails to resolve the type reference

packages/plugin-typescript/mocks/fixtures/basic-setup/src/4-languale-service/ts-4114-incorrect-modifier.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;

packages/plugin-typescript/mocks/fixtures/basic-setup/src/6-configuration-errors/ts-6059-file-is-not-under-root-dir.ts

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

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

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

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

@@ -0,0 +1,16 @@
+{
+  "compilerOptions": {
+    "rootDir": "./src",
+    "strict": true,
+    "verbatimModuleSyntax": false,
+    "target": "ES6",
+    "module": "CommonJS"
+  },
+  "exclude": ["exclude"],
+  "include": [
+    "src/1-syntax-errors/**/*.ts",
+    "src/2-semantic-errors/**/*.ts",
+    "src/4-languale-service/**/*.ts",
+    "src/6-config-errors/**/*.ts"
+  ]
+}

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

@@ -0,0 +1,103 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig to read more about this file */
+
+    /* Projects */
+    // "incremental": true,                              /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
+    // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
+    // "tsBuildInfoFile": "./.tsbuildinfo",              /* Specify the path to .tsbuildinfo incremental compilation file. */
+    // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects. */
+    // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
+    // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
+
+    /* Language and Environment */
+    "target": "es2016" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
+    // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
+    // "jsx": "preserve",                                /* Specify what JSX code is generated. */
+    // "experimentalDecorators": true,                   /* Enable experimental support for TC39 stage 2 draft decorators. */
+    // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
+    // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
+    // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
+    // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
+    // "reactNamespace": "",                             /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
+    // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
+    // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
+    // "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */
+
+    /* Modules */
+    "module": "commonjs" /* Specify what module code is generated. */,
+    // "rootDir": "./",                                  /* Specify the root folder within your source files. */
+    // "moduleResolution": "node",                       /* Specify how TypeScript looks up a file from a given module specifier. */
+    // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
+    // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
+    // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
+    // "typeRoots": [],                                  /* Specify multiple folders that act like './node_modules/@types'. */
+    // "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */
+    // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
+    // "moduleSuffixes": [],                             /* List of file name suffixes to search when resolving a module. */
+    // "resolveJsonModule": true,                        /* Enable importing .json files. */
+    // "noResolve": true,                                /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
+
+    /* JavaScript Support */
+    // "allowJs": true,                                  /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
+    // "checkJs": true,                                  /* Enable error reporting in type-checked JavaScript files. */
+    // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
+
+    /* Emit */
+    // "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
+    // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
+    // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
+    // "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
+    // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
+    // "outDir": "./",                                   /* Specify an output folder for all emitted files. */
+    // "removeComments": true,                           /* Disable emitting comments. */
+    // "noEmit": true,                                   /* Disable emitting files from a compilation. */
+    // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
+    // "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types. */
+    // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
+    // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
+    // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
+    // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
+    // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
+    // "newLine": "crlf",                                /* Set the newline character for emitting files. */
+    // "stripInternal": true,                            /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
+    // "noEmitHelpers": true,                            /* Disable generating custom helper functions like '__extends' in compiled output. */
+    // "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
+    // "preserveConstEnums": true,                       /* Disable erasing 'const enum' declarations in generated code. */
+    // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
+    // "preserveValueImports": true,                     /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
+
+    /* Interop Constraints */
+    // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
+    // "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
+    "esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */,
+    // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
+    "forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */,
+
+    /* Type Checking */
+    "strict": true /* Enable all strict type-checking options. */,
+    // "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied 'any' type. */
+    // "strictNullChecks": true,                         /* When type checking, take into account 'null' and 'undefined'. */
+    // "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
+    // "strictBindCallApply": true,                      /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
+    // "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
+    // "noImplicitThis": true,                           /* Enable error reporting when 'this' is given the type 'any'. */
+    // "useUnknownInCatchVariables": true,               /* Default catch clause variables as 'unknown' instead of 'any'. */
+    // "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
+    // "noUnusedLocals": true,                           /* Enable error reporting when local variables aren't read. */
+    // "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read. */
+    // "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
+    // "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
+    // "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
+    // "noUncheckedIndexedAccess": true,                 /* Add 'undefined' to a type when accessed using an index. */
+    // "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
+    // "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type. */
+    // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
+    // "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */
+
+    /* Completeness */
+    // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
+    "skipLibCheck": true /* Skip type checking all .d.ts files. */
+  }
+}

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

@@ -0,0 +1,8 @@
+{
+  "compilerOptions": {
+    "rootDir": "./",
+    "module": "CommonJS",
+    "out": "./dist/bundle.js"
+  },
+  "include": ["src/0-no-diagnostics/**/*.ts"]
+}

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

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

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

@@ -0,0 +1,8 @@
+{
+  "compilerOptions": {
+    "rootDir": "./src",
+    "strict": true,
+    "target": "ES6",
+    "module": "CommonJS"
+  }
+}

packages/plugin-typescript/package.json

@@ -22,6 +22,10 @@
     "access": "public"
   },
   "type": "module",
-  "dependencies": {},
+  "dependencies": {
+    "@code-pushup/models": "0.58.0",
+    "@code-pushup/utils": "0.58.0",
+    "typescript": "5.5.4"
+  },
   "scripts": {}
 }

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

@@ -1 +1,81 @@
+import type { Audit, Group } from '@code-pushup/models';
+import { toSentenceCase } from '@code-pushup/utils';
+import { TS_CODE_RANGE_NAMES } from './runner/ts-error-codes.js';
+import type { AuditSlug } from './types.js';
+
 export const TYPESCRIPT_PLUGIN_SLUG = 'typescript';
+export const DEFAULT_TS_CONFIG = 'tsconfig.json';
+
+const AUDIT_DESCRIPTIONS: Record<AuditSlug, string> = {
+  'semantic-errors':
+    'Errors that occur during type checking and type inference',
+  'syntax-errors':
+    'Errors that occur during parsing and lexing of TypeScript source code',
+  'configuration-errors':
+    'Errors that occur when parsing TypeScript configuration files',
+  'declaration-and-language-service-errors':
+    'Errors that occur during TypeScript language service operations',
+  'internal-errors': 'Errors that occur during TypeScript internal operations',
+  'no-implicit-any-errors': 'Errors related to no implicit any compiler option',
+  'unknown-codes': 'Errors that do not match any known TypeScript error code',
+};
+export const AUDITS: (Audit & { slug: AuditSlug })[] = Object.values(
+  TS_CODE_RANGE_NAMES,
+).map(slug => ({
+  slug,
+  title: toSentenceCase(slug),
+  description: AUDIT_DESCRIPTIONS[slug],
+}));
+
+/**
+ * # Diagnostic Code Categories
+ * | 🏷️ Category       | Diagnostic Code Ranges | Audits                                                                   |
+ * |-------------------|------------------------|--------------------------------------------------------------------------|
+ * | **Problems**      | 1XXX, 2XXX, 5XXX, 7XXX | `syntax-errors`, `semantic-errors`, `internal-errors`, `no-implicit-any` |
+ * | **Suggestions**   | 3XXX                   | `suggestions`                                                            |
+ * | **Configuration** | 6XXX                   | `configuration-errors`                                                   |
+ */
+export const GROUPS: Group[] = [
+  {
+    slug: 'problems-group',
+    title: 'Problems',
+    description:
+      'Syntax, semantic, and internal compiler errors are critical for identifying and preventing bugs.',
+    refs: (
+      [
+        'syntax-errors',
+        'semantic-errors',
+        'internal-errors',
+        'no-implicit-any-errors',
+      ] satisfies AuditSlug[]
+    ).map(slug => ({
+      slug,
+      weight: 1,
+    })),
+  },
+  {
+    slug: 'ts-configuration-group',
+    title: 'Configuration',
+    description:
+      'TypeScript configuration and options errors ensure correct project setup, reducing risks from misconfiguration.',
+    refs: (['configuration-errors'] satisfies AuditSlug[]).map(slug => ({
+      slug,
+      weight: 1,
+    })),
+  },
+  {
+    slug: 'miscellaneous-group',
+    title: 'Miscellaneous',
+    description:
+      'Errors that do not bring any specific value to the developer, but are still useful to know.',
+    refs: (
+      [
+        'unknown-codes',
+        'declaration-and-language-service-errors',
+      ] satisfies AuditSlug[]
+    ).map(slug => ({
+      slug,
+      weight: 1,
+    })),
+  },
+];