@code-pushup/typescript-plugin 0.66.0

package/README.md

@@ -0,0 +1,164 @@
+# @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 **incrementally adopt strict compilation flags in TypeScript projects**.
+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 (e.g. 3)
+- `displayValue`: The number of issues found (e.g. "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`).
+
+By default, a root `tsconfig.json` is 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: [
+    // ...
+    await typescriptPlugin(),
+  ],
+};
+```
+
+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:
+
+- _Semantic Errors_: `semantic-errors` - Errors that occur during type checking and type inference
+- _Syntax Errors_: `syntax-errors` - Errors that occur during parsing and lexing of TypeScript source code
+- _Configuration Errors_: `configuration-errors` - Errors that occur when parsing TypeScript configuration files
+- _Declaration and Language Service Errors_: `declaration-and-language-service-errors` - Errors that occur during TypeScript language service operations
+- _Internal Errors_: `internal-errors` - Errors that occur during TypeScript internal operations
+- _No Implicit Any Errors_: `no-implicit-any-errors` - Errors related to `noImplicitAny` compiler option
+- _Unknown Codes_: `unknown-codes` - Errors that do not match any known TypeScript error code
+
+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](./docs/audits-and-groups.md).
+
+## Plugin architecture
+
+### Plugin configuration specification
+
+The plugin accepts the following parameters:
+
+| Option     | Type     | Default         | Description                                                                                                                                 |
+| ---------- | -------- | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
+| tsconfig   | 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 |
+
+#### `tsconfig`
+
+Optional parameter. The `tsconfig` option accepts a string that defines the path to your config file and defaults to `tsconfig.json`.
+
+```js
+await typescriptPlugin({
+  tsconfig: './tsconfig.json',
+});
+```
+
+#### `onlyAudits`
+
+The `onlyAudits` option allows you to specify which documentation types you want to measure. Only the specified audits will be included in the results. All audits are included by default. Example:
+
+```js
+await typescriptPlugin({
+  onlyAudits: ['no-implicit-any'],
+});
+```
+
+### Optionally set up categories
+
+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: 'semantic-errors',
+        weight: 2,
+      },
+      {
+        type: 'audit',
+        plugin: 'typescript',
+        slug: 'syntax-errors',
+        weight: 1,
+      },
+      // ...
+    ],
+  },
+  // ...
+];
+```
+
+Also groups can be used:
+
+```ts
+// ...
+categories: [
+  {
+    slug: 'typescript',
+    title: 'TypeScript',
+    refs: [
+      {
+        slug: 'language-and-environment',
+        weight: 1,
+        type: 'group',
+        plugin: 'typescript',
+      },
+      // ...
+    ],
+  },
+  // ...
+];
+```

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@code-pushup/typescript-plugin",
+  "version": "0.66.0",
+  "license": "MIT",
+  "description": "Code PushUp plugin for incrementally adopting strict compilation flags in TypeScript projects",
+  "homepage": "https://github.com/code-pushup/cli/tree/main/packages/plugin-typescript#readme",
+  "bugs": {
+    "url": "https://github.com/code-pushup/cli/issues?q=is%3Aissue%20state%3Aopen%20type%3ABug%20label%3A\"🧩%20typescript-plugin\""
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/code-pushup/cli.git",
+    "directory": "packages/plugin-typescript"
+  },
+  "keywords": [
+    "CLI",
+    "Code PushUp",
+    "plugin",
+    "typescript"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "type": "module",
+  "dependencies": {
+    "@code-pushup/models": "0.66.0",
+    "@code-pushup/utils": "0.66.0",
+    "zod": "^3.23.8"
+  },
+  "peerDependencies": {
+    "typescript": ">=4.0.0"
+  },
+  "scripts": {},
+  "module": "./src/index.js",
+  "main": "./src/index.js",
+  "types": "./src/index.d.ts"
+}

package/src/index.d.ts

@@ -0,0 +1,4 @@
+export { TYPESCRIPT_PLUGIN_SLUG } from './lib/constants.js';
+export { typescriptPlugin } from './lib/typescript-plugin.js';
+export { getCategories, getCategoryRefsFromGroups } from './lib/utils.js';
+export { type TypescriptPluginConfig, type TypescriptPluginOptions, typescriptPluginConfigSchema, } from './lib/schema.js';

package/src/index.js

@@ -0,0 +1,5 @@
+export { TYPESCRIPT_PLUGIN_SLUG } from './lib/constants.js';
+export { typescriptPlugin } from './lib/typescript-plugin.js';
+export { getCategories, getCategoryRefsFromGroups } from './lib/utils.js';
+export { typescriptPluginConfigSchema, } from './lib/schema.js';
+//# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../packages/plugin-typescript/src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,oBAAoB,CAAC;AAC5D,OAAO,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAC9D,OAAO,EAAE,aAAa,EAAE,yBAAyB,EAAE,MAAM,gBAAgB,CAAC;AAC1E,OAAO,EAGL,4BAA4B,GAC7B,MAAM,iBAAiB,CAAC"}

package/src/lib/constants.d.ts

@@ -0,0 +1,8 @@
+import type { Audit, Group } from '@code-pushup/models';
+import type { AuditSlug } from './types.js';
+export declare const TYPESCRIPT_PLUGIN_SLUG = "typescript";
+export declare const DEFAULT_TS_CONFIG = "tsconfig.json";
+export declare const AUDITS: (Audit & {
+    slug: AuditSlug;
+})[];
+export declare const GROUPS: Group[];

package/src/lib/constants.js

@@ -0,0 +1,56 @@
+import { toSentenceCase } from '@code-pushup/utils';
+import { TS_CODE_RANGE_NAMES } from './runner/ts-error-codes.js';
+export const TYPESCRIPT_PLUGIN_SLUG = 'typescript';
+export const DEFAULT_TS_CONFIG = 'tsconfig.json';
+const AUDIT_DESCRIPTIONS = {
+    '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 = Object.values(TS_CODE_RANGE_NAMES).map(slug => ({
+    slug,
+    title: toSentenceCase(slug),
+    description: AUDIT_DESCRIPTIONS[slug],
+}));
+export const GROUPS = [
+    {
+        slug: 'problems',
+        title: 'Problems',
+        description: 'Syntax, semantic, and internal compiler errors are critical for identifying and preventing bugs.',
+        refs: [
+            'syntax-errors',
+            'semantic-errors',
+            'no-implicit-any-errors',
+        ].map(slug => ({
+            slug,
+            weight: 1,
+        })),
+    },
+    {
+        slug: 'ts-configuration',
+        title: 'Configuration',
+        description: 'TypeScript configuration and options errors ensure correct project setup, reducing risks from misconfiguration.',
+        refs: ['configuration-errors'].map(slug => ({
+            slug,
+            weight: 1,
+        })),
+    },
+    {
+        slug: 'miscellaneous',
+        title: 'Miscellaneous',
+        description: 'Errors that do not bring any specific value to the developer, but are still useful to know.',
+        refs: [
+            'unknown-codes',
+            'internal-errors',
+            'declaration-and-language-service-errors',
+        ].map(slug => ({
+            slug,
+            weight: 1,
+        })),
+    },
+];
+//# sourceMappingURL=constants.js.map

package/src/lib/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../../../packages/plugin-typescript/src/lib/constants.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AAGjE,MAAM,CAAC,MAAM,sBAAsB,GAAG,YAAY,CAAC;AACnD,MAAM,CAAC,MAAM,iBAAiB,GAAG,eAAe,CAAC;AAEjD,MAAM,kBAAkB,GAA8B;IACpD,iBAAiB,EACf,2DAA2D;IAC7D,eAAe,EACb,uEAAuE;IACzE,sBAAsB,EACpB,+DAA+D;IACjE,yCAAyC,EACvC,iEAAiE;IACnE,iBAAiB,EAAE,yDAAyD;IAC5E,wBAAwB,EAAE,mDAAmD;IAC7E,eAAe,EAAE,0DAA0D;CAC5E,CAAC;AACF,MAAM,CAAC,MAAM,MAAM,GAAoC,MAAM,CAAC,MAAM,CAClE,mBAAmB,CACpB,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACb,IAAI;IACJ,KAAK,EAAE,cAAc,CAAC,IAAI,CAAC;IAC3B,WAAW,EAAE,kBAAkB,CAAC,IAAI,CAAC;CACtC,CAAC,CAAC,CAAC;AAEJ,MAAM,CAAC,MAAM,MAAM,GAAY;IAC7B;QACE,IAAI,EAAE,UAAU;QAChB,KAAK,EAAE,UAAU;QACjB,WAAW,EACT,kGAAkG;QACpG,IAAI,EACF;YACE,eAAe;YACf,iBAAiB;YACjB,wBAAwB;SAE3B,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACb,IAAI;YACJ,MAAM,EAAE,CAAC;SACV,CAAC,CAAC;KACJ;IACD;QACE,IAAI,EAAE,kBAAkB;QACxB,KAAK,EAAE,eAAe;QACtB,WAAW,EACT,iHAAiH;QACnH,IAAI,EAAG,CAAC,sBAAsB,CAAwB,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YAClE,IAAI;YACJ,MAAM,EAAE,CAAC;SACV,CAAC,CAAC;KACJ;IACD;QACE,IAAI,EAAE,eAAe;QACrB,KAAK,EAAE,eAAe;QACtB,WAAW,EACT,6FAA6F;QAC/F,IAAI,EACF;YACE,eAAe;YACf,iBAAiB;YACjB,yCAAyC;SAE5C,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACb,IAAI;YACJ,MAAM,EAAE,CAAC;SACV,CAAC,CAAC;KACJ;CACF,CAAC"}

package/src/lib/runner/runner.d.ts

@@ -0,0 +1,9 @@
+import type { RunnerFunction } from '@code-pushup/models';
+import type { AuditSlug } from '../types.js';
+import { type DiagnosticsOptions } from './ts-runner.js';
+export type RunnerOptions = DiagnosticsOptions & {
+    expectedAudits: {
+        slug: AuditSlug;
+    }[];
+};
+export declare function createRunnerFunction(options: RunnerOptions): RunnerFunction;

package/src/lib/runner/runner.js

@@ -0,0 +1,34 @@
+import { pluralize } from '@code-pushup/utils';
+import { getTypeScriptDiagnostics, } from './ts-runner.js';
+import { getIssueFromDiagnostic, tsCodeToAuditSlug } from './utils.js';
+export function createRunnerFunction(options) {
+    const { tsconfig, expectedAudits } = options;
+    return async () => {
+        const diagnostics = await getTypeScriptDiagnostics({ tsconfig });
+        const result = diagnostics.reduce((acc, diag) => {
+            const slug = tsCodeToAuditSlug(diag.code);
+            const existingIssues = acc[slug]?.details?.issues ?? [];
+            return {
+                ...acc,
+                [slug]: {
+                    slug,
+                    details: {
+                        issues: [...existingIssues, getIssueFromDiagnostic(diag)],
+                    },
+                },
+            };
+        }, {});
+        return expectedAudits.map(({ slug }) => {
+            const { details } = result[slug] ?? {};
+            const issues = details?.issues ?? [];
+            return {
+                slug,
+                score: issues.length === 0 ? 1 : 0,
+                value: issues.length,
+                displayValue: `${issues.length} ${pluralize('issue', issues.length)}`,
+                ...(issues.length > 0 ? { details } : {}),
+            };
+        });
+    };
+}
+//# sourceMappingURL=runner.js.map

package/src/lib/runner/runner.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"runner.js","sourceRoot":"","sources":["../../../../../../packages/plugin-typescript/src/lib/runner/runner.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAE/C,OAAO,EAEL,wBAAwB,GACzB,MAAM,gBAAgB,CAAC;AAExB,OAAO,EAAE,sBAAsB,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAMvE,MAAM,UAAU,oBAAoB,CAAC,OAAsB;IACzD,MAAM,EAAE,QAAQ,EAAE,cAAc,EAAE,GAAG,OAAO,CAAC;IAC7C,OAAO,KAAK,IAA2B,EAAE;QACvC,MAAM,WAAW,GAAG,MAAM,wBAAwB,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC;QACjE,MAAM,MAAM,GAAG,WAAW,CAAC,MAAM,CAE/B,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;YACd,MAAM,IAAI,GAAG,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC1C,MAAM,cAAc,GAAY,GAAG,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,MAAM,IAAI,EAAE,CAAC;YACjE,OAAO;gBACL,GAAG,GAAG;gBACN,CAAC,IAAI,CAAC,EAAE;oBACN,IAAI;oBACJ,OAAO,EAAE;wBACP,MAAM,EAAE,CAAC,GAAG,cAAc,EAAE,sBAAsB,CAAC,IAAI,CAAC,CAAC;qBAC1D;iBACF;aACF,CAAC;QACJ,CAAC,EAAE,EAAE,CAAC,CAAC;QAEP,OAAO,cAAc,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE;YACrC,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;YAEvC,MAAM,MAAM,GAAG,OAAO,EAAE,MAAM,IAAI,EAAE,CAAC;YACrC,OAAO;gBACL,IAAI;gBACJ,KAAK,EAAE,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;gBAClC,KAAK,EAAE,MAAM,CAAC,MAAM;gBACpB,YAAY,EAAE,GAAG,MAAM,CAAC,MAAM,IAAI,SAAS,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,EAAE;gBACrE,GAAG,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;aACpB,CAAC;QAC1B,CAAC,CAAC,CAAC;IACL,CAAC,CAAC;AACJ,CAAC"}

package/src/lib/runner/ts-error-codes.d.ts

@@ -0,0 +1,28 @@
+/**
+ * # Diagnostic Code Ranges and Their Grouping
+ *
+ * TypeScript diagnostic codes are grouped into ranges based on their source and purpose. Here's how they are categorized:
+ *
+ * | Code Range | Type                                             | Description                                                               |
+ * |------------|---------------------------------|--------------------------------------------------|
+ * | 1XXX          | Syntax Errors                                 | Structural issues detected during parsing.            |
+ * | 2XXX          | Semantic Errors                            | Type-checking and type-system violations.          |
+ * | 3XXX          | Suggestions                                  | Optional improvements (e.g., unused variables).  |
+ * | 4XXX          | Declaration & Language Service | Used by editors (e.g., VSCode) for IntelliSense.   |
+ * | 5XXX          | Internal Compiler Errors               | Rare, unexpected failures in the compiler.             |
+ * | 6XXX          | Configuration/Options Errors      | Issues with `tsconfig.json` or compiler options.    |
+ * | 7XXX          | noImplicitAny Errors                     | Issues with commandline compiler options.           |
+ *
+ * The diagnostic messages are exposed over a undocumented and undiscoverable const names `Diagnostics`.
+ * Additional information is derived from [TypeScript's own guidelines on diagnostic code ranges](https://github.com/microsoft/TypeScript/wiki/Coding-guidelines#diagnostic-message-codes)
+ *
+ */
+export declare const TS_CODE_RANGE_NAMES: {
+    readonly '1': "syntax-errors";
+    readonly '2': "semantic-errors";
+    readonly '4': "declaration-and-language-service-errors";
+    readonly '5': "internal-errors";
+    readonly '6': "configuration-errors";
+    readonly '7': "no-implicit-any-errors";
+    readonly '9': "unknown-codes";
+};

package/src/lib/runner/ts-error-codes.js

@@ -0,0 +1,30 @@
+/**
+ * # Diagnostic Code Ranges and Their Grouping
+ *
+ * TypeScript diagnostic codes are grouped into ranges based on their source and purpose. Here's how they are categorized:
+ *
+ * | Code Range | Type                                             | Description                                                               |
+ * |------------|---------------------------------|--------------------------------------------------|
+ * | 1XXX          | Syntax Errors                                 | Structural issues detected during parsing.            |
+ * | 2XXX          | Semantic Errors                            | Type-checking and type-system violations.          |
+ * | 3XXX          | Suggestions                                  | Optional improvements (e.g., unused variables).  |
+ * | 4XXX          | Declaration & Language Service | Used by editors (e.g., VSCode) for IntelliSense.   |
+ * | 5XXX          | Internal Compiler Errors               | Rare, unexpected failures in the compiler.             |
+ * | 6XXX          | Configuration/Options Errors      | Issues with `tsconfig.json` or compiler options.    |
+ * | 7XXX          | noImplicitAny Errors                     | Issues with commandline compiler options.           |
+ *
+ * The diagnostic messages are exposed over a undocumented and undiscoverable const names `Diagnostics`.
+ * Additional information is derived from [TypeScript's own guidelines on diagnostic code ranges](https://github.com/microsoft/TypeScript/wiki/Coding-guidelines#diagnostic-message-codes)
+ *
+ */
+export const TS_CODE_RANGE_NAMES = {
+    '1': 'syntax-errors',
+    '2': 'semantic-errors',
+    // '3': 'suggestions',
+    '4': 'declaration-and-language-service-errors',
+    '5': 'internal-errors',
+    '6': 'configuration-errors',
+    '7': 'no-implicit-any-errors',
+    '9': 'unknown-codes',
+};
+//# sourceMappingURL=ts-error-codes.js.map

package/src/lib/runner/ts-error-codes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ts-error-codes.js","sourceRoot":"","sources":["../../../../../../packages/plugin-typescript/src/lib/runner/ts-error-codes.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG;IACjC,GAAG,EAAE,eAAe;IACpB,GAAG,EAAE,iBAAiB;IACtB,sBAAsB;IACtB,GAAG,EAAE,yCAAyC;IAC9C,GAAG,EAAE,iBAAiB;IACtB,GAAG,EAAE,sBAAsB;IAC3B,GAAG,EAAE,wBAAwB;IAC7B,GAAG,EAAE,eAAe;CACZ,CAAC"}

package/src/lib/runner/ts-runner.d.ts

@@ -0,0 +1,5 @@
+import { type Diagnostic } from 'typescript';
+export type DiagnosticsOptions = {
+    tsconfig: string;
+};
+export declare function getTypeScriptDiagnostics({ tsconfig, }: DiagnosticsOptions): Promise<readonly Diagnostic[]>;

package/src/lib/runner/ts-runner.js

@@ -0,0 +1,14 @@
+import { createProgram, getPreEmitDiagnostics, } from 'typescript';
+import { stringifyError } from '@code-pushup/utils';
+import { loadTargetConfig } from './utils.js';
+export async function getTypeScriptDiagnostics({ tsconfig, }) {
+    const { fileNames, options } = await loadTargetConfig(tsconfig);
+    try {
+        const program = createProgram(fileNames, options);
+        return getPreEmitDiagnostics(program);
+    }
+    catch (error) {
+        throw new Error(`Can't create TS program in getDiagnostics. \n ${stringifyError(error)}`);
+    }
+}
+//# sourceMappingURL=ts-runner.js.map

package/src/lib/runner/ts-runner.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ts-runner.js","sourceRoot":"","sources":["../../../../../../packages/plugin-typescript/src/lib/runner/ts-runner.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,aAAa,EACb,qBAAqB,GACtB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAM9C,MAAM,CAAC,KAAK,UAAU,wBAAwB,CAAC,EAC7C,QAAQ,GACW;IACnB,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,GAAG,MAAM,gBAAgB,CAAC,QAAQ,CAAC,CAAC;IAChE,IAAI,CAAC;QACH,MAAM,OAAO,GAAG,aAAa,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;QAClD,OAAO,qBAAqB,CAAC,OAAO,CAAC,CAAC;IACxC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,IAAI,KAAK,CACb,iDAAiD,cAAc,CAAC,KAAK,CAAC,EAAE,CACzE,CAAC;IACJ,CAAC;AACH,CAAC"}

package/src/lib/runner/types.d.ts

@@ -0,0 +1,5 @@
+import { TS_CODE_RANGE_NAMES } from './ts-error-codes.js';
+type TsCodeRanges = typeof TS_CODE_RANGE_NAMES;
+export type CodeRangeName = TsCodeRanges[keyof TsCodeRanges];
+export type SemVerString = `${number}.${number}.${number}`;
+export {};

package/src/lib/runner/types.js

@@ -0,0 +1,2 @@
+import { TS_CODE_RANGE_NAMES } from './ts-error-codes.js';
+//# sourceMappingURL=types.js.map

package/src/lib/runner/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../../../packages/plugin-typescript/src/lib/runner/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC"}

package/src/lib/runner/utils.d.ts

@@ -0,0 +1,46 @@
+import { type Diagnostic, DiagnosticCategory } from 'typescript';
+import type { Issue } from '@code-pushup/models';
+import type { CodeRangeName } from './types.js';
+/**
+ * Transform the TypeScript error code to the audit slug.
+ * @param code - The TypeScript error code.
+ * @returns The audit slug.
+ * @throws Error if the code is not supported.
+ */
+export declare function tsCodeToAuditSlug(code: number): CodeRangeName;
+/**
+ * Get the severity of the issue based on the TypeScript diagnostic category.
+ * - ts.DiagnosticCategory.Warning (1)
+ * - ts.DiagnosticCategory.Error (2)
+ * - ts.DiagnosticCategory.Suggestion (3)
+ * - ts.DiagnosticCategory.Message (4)
+ * @param category - The TypeScript diagnostic category.
+ * @returns The severity of the issue.
+ */
+export declare function getSeverity(category: DiagnosticCategory): Issue['severity'];
+/**
+ * Format issue message from the TypeScript diagnostic.
+ * @param diag - The TypeScript diagnostic.
+ * @returns The issue message.
+ */
+export declare function getMessage(diag: Diagnostic): string;
+/**
+ * Get the issue from the TypeScript diagnostic.
+ * @param diag - The TypeScript diagnostic.
+ * @returns The issue.
+ * @throws Error if the diagnostic is global (e.g., invalid compiler option).
+ */
+export declare function getIssueFromDiagnostic(diag: Diagnostic): {
+    message: string;
+    severity: "info" | "warning" | "error";
+    source?: {
+        file: string;
+        position?: {
+            startLine: number;
+            startColumn?: number | undefined;
+            endLine?: number | undefined;
+            endColumn?: number | undefined;
+        } | undefined;
+    } | undefined;
+};
+export declare function loadTargetConfig(tsConfigPath: string): Promise<import("typescript").ParsedCommandLine>;

package/src/lib/runner/utils.js

@@ -0,0 +1,89 @@
+// eslint-disable-next-line unicorn/import-style
+import { dirname } from 'node:path';
+import { DiagnosticCategory, flattenDiagnosticMessageText, parseConfigFileTextToJson, parseJsonConfigFileContent, sys, } from 'typescript';
+import { readTextFile, truncateIssueMessage } from '@code-pushup/utils';
+import { TS_CODE_RANGE_NAMES } from './ts-error-codes.js';
+/**
+ * Transform the TypeScript error code to the audit slug.
+ * @param code - The TypeScript error code.
+ * @returns The audit slug.
+ * @throws Error if the code is not supported.
+ */
+export function tsCodeToAuditSlug(code) {
+    const rangeNumber = code
+        .toString()
+        .slice(0, 1);
+    return TS_CODE_RANGE_NAMES[rangeNumber] ?? 'unknown-code';
+}
+/**
+ * Get the severity of the issue based on the TypeScript diagnostic category.
+ * - ts.DiagnosticCategory.Warning (1)
+ * - ts.DiagnosticCategory.Error (2)
+ * - ts.DiagnosticCategory.Suggestion (3)
+ * - ts.DiagnosticCategory.Message (4)
+ * @param category - The TypeScript diagnostic category.
+ * @returns The severity of the issue.
+ */
+export function getSeverity(category) {
+    switch (category) {
+        case DiagnosticCategory.Error:
+            return 'error';
+        case DiagnosticCategory.Warning:
+            return 'warning';
+        default:
+            return 'info';
+    }
+}
+/**
+ * Format issue message from the TypeScript diagnostic.
+ * @param diag - The TypeScript diagnostic.
+ * @returns The issue message.
+ */
+export function getMessage(diag) {
+    const flattened = flattenDiagnosticMessageText(diag.messageText, '\n');
+    const text = flattened
+        .replace(process.cwd(), '.')
+        .replace(process.cwd().replace(/\\/g, '/'), '.');
+    return truncateIssueMessage(`TS${diag.code}: ${text}`);
+}
+/**
+ * Get the issue from the TypeScript diagnostic.
+ * @param diag - The TypeScript diagnostic.
+ * @returns The issue.
+ * @throws Error if the diagnostic is global (e.g., invalid compiler option).
+ */
+export function getIssueFromDiagnostic(diag) {
+    const issue = {
+        severity: getSeverity(diag.category),
+        message: getMessage(diag),
+    };
+    // If undefined, the error might be global (e.g., invalid compiler option).
+    if (diag.file === undefined) {
+        return issue;
+    }
+    const startLine = diag.start === undefined
+        ? undefined
+        : diag.file.getLineAndCharacterOfPosition(diag.start).line + 1;
+    return {
+        ...issue,
+        source: {
+            file: diag.file.fileName,
+            ...(startLine
+                ? {
+                    position: {
+                        startLine,
+                    },
+                }
+                : {}),
+        },
+    };
+}
+export async function loadTargetConfig(tsConfigPath) {
+    const { config } = parseConfigFileTextToJson(tsConfigPath, await readTextFile(tsConfigPath));
+    const parsedConfig = parseJsonConfigFileContent(config, sys, dirname(tsConfigPath));
+    if (parsedConfig.fileNames.length === 0) {
+        throw new Error('No files matched by the TypeScript configuration. Check your "include", "exclude" or "files" settings.');
+    }
+    return parsedConfig;
+}
+//# sourceMappingURL=utils.js.map

package/src/lib/runner/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../../../../packages/plugin-typescript/src/lib/runner/utils.ts"],"names":[],"mappings":"AAAA,gDAAgD;AAChD,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAEL,kBAAkB,EAClB,4BAA4B,EAC5B,yBAAyB,EACzB,0BAA0B,EAC1B,GAAG,GACJ,MAAM,YAAY,CAAC;AAEpB,OAAO,EAAE,YAAY,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AACxE,OAAO,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AAG1D;;;;;GAKG;AACH,MAAM,UAAU,iBAAiB,CAAC,IAAY;IAC5C,MAAM,WAAW,GAAG,IAAI;SACrB,QAAQ,EAAE;SACV,KAAK,CAAC,CAAC,EAAE,CAAC,CAAqC,CAAC;IACnD,OAAO,mBAAmB,CAAC,WAAW,CAAC,IAAI,cAAc,CAAC;AAC5D,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,WAAW,CAAC,QAA4B;IACtD,QAAQ,QAAQ,EAAE,CAAC;QACjB,KAAK,kBAAkB,CAAC,KAAK;YAC3B,OAAO,OAAO,CAAC;QACjB,KAAK,kBAAkB,CAAC,OAAO;YAC7B,OAAO,SAAS,CAAC;QACnB;YACE,OAAO,MAAM,CAAC;IAClB,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,UAAU,CAAC,IAAgB;IACzC,MAAM,SAAS,GAAG,4BAA4B,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;IACvE,MAAM,IAAI,GAAG,SAAS;SACnB,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,GAAG,CAAC;SAC3B,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC;IACnD,OAAO,oBAAoB,CAAC,KAAK,IAAI,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC,CAAC;AACzD,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,sBAAsB,CAAC,IAAgB;IACrD,MAAM,KAAK,GAAU;QACnB,QAAQ,EAAE,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC;QACpC,OAAO,EAAE,UAAU,CAAC,IAAI,CAAC;KAC1B,CAAC;IAEF,2EAA2E;IAC3E,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;QAC5B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,SAAS,GACb,IAAI,CAAC,KAAK,KAAK,SAAS;QACtB,CAAC,CAAC,SAAS;QACX,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,6BAA6B,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC;IAEnE,OAAO;QACL,GAAG,KAAK;QACR,MAAM,EAAE;YACN,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,QAAQ;YACxB,GAAG,CAAC,SAAS;gBACX,CAAC,CAAC;oBACE,QAAQ,EAAE;wBACR,SAAS;qBACV;iBACF;gBACH,CAAC,CAAC,EAAE,CAAC;SACR;KACc,CAAC;AACpB,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,gBAAgB,CAAC,YAAoB;IACzD,MAAM,EAAE,MAAM,EAAE,GAAG,yBAAyB,CAC1C,YAAY,EACZ,MAAM,YAAY,CAAC,YAAY,CAAC,CACjC,CAAC;IAEF,MAAM,YAAY,GAAG,0BAA0B,CAC7C,MAAM,EACN,GAAG,EACH,OAAO,CAAC,YAAY,CAAC,CACtB,CAAC;IAEF,IAAI,YAAY,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACxC,MAAM,IAAI,KAAK,CACb,wGAAwG,CACzG,CAAC;IACJ,CAAC;IAED,OAAO,YAAY,CAAC;AACtB,CAAC"}

package/src/lib/schema.d.ts

@@ -0,0 +1,13 @@
+import { z } from 'zod';
+export declare const typescriptPluginConfigSchema: z.ZodObject<{
+    tsconfig: z.ZodDefault<z.ZodString>;
+    onlyAudits: z.ZodOptional<z.ZodArray<z.ZodEnum<[import("./runner/types.js").CodeRangeName, ...import("./runner/types.js").CodeRangeName[]]>, "many">>;
+}, "strip", z.ZodTypeAny, {
+    tsconfig: string;
+    onlyAudits?: import("./runner/types.js").CodeRangeName[] | undefined;
+}, {
+    tsconfig?: string | undefined;
+    onlyAudits?: import("./runner/types.js").CodeRangeName[] | undefined;
+}>;
+export type TypescriptPluginOptions = z.input<typeof typescriptPluginConfigSchema>;
+export type TypescriptPluginConfig = z.infer<typeof typescriptPluginConfigSchema>;

package/src/lib/schema.js

@@ -0,0 +1,16 @@
+import { z } from 'zod';
+import { AUDITS, DEFAULT_TS_CONFIG } from './constants.js';
+const auditSlugs = AUDITS.map(({ slug }) => slug);
+export const typescriptPluginConfigSchema = z.object({
+    tsconfig: z
+        .string({
+        description: 'Path to a tsconfig file (default is tsconfig.json)',
+    })
+        .default(DEFAULT_TS_CONFIG),
+    onlyAudits: z
+        .array(z.enum(auditSlugs), {
+        description: 'Filters TypeScript compiler errors by diagnostic codes',
+    })
+        .optional(),
+});
+//# sourceMappingURL=schema.js.map

package/src/lib/schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.js","sourceRoot":"","sources":["../../../../../packages/plugin-typescript/src/lib/schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,MAAM,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AAG3D,MAAM,UAAU,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,IAAI,CAG/C,CAAC;AACF,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,CAAC,MAAM,CAAC;IACnD,QAAQ,EAAE,CAAC;SACR,MAAM,CAAC;QACN,WAAW,EAAE,oDAAoD;KAClE,CAAC;SACD,OAAO,CAAC,iBAAiB,CAAC;IAC7B,UAAU,EAAE,CAAC;SACV,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE;QACzB,WAAW,EAAE,wDAAwD;KACtE,CAAC;SACD,QAAQ,EAAE;CACd,CAAC,CAAC"}

package/src/lib/types.d.ts

@@ -0,0 +1,2 @@
+import type { CodeRangeName } from './runner/types.js';
+export type AuditSlug = CodeRangeName;

package/src/lib/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/src/lib/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../../packages/plugin-typescript/src/lib/types.ts"],"names":[],"mappings":""}

package/src/lib/typescript-plugin.d.ts

@@ -0,0 +1,3 @@
+import type { PluginConfig } from '@code-pushup/models';
+import { type TypescriptPluginOptions } from './schema.js';
+export declare function typescriptPlugin(options?: TypescriptPluginOptions): Promise<PluginConfig>;

package/src/lib/typescript-plugin.js

@@ -0,0 +1,37 @@
+import { createRequire } from 'node:module';
+import { stringifyError } from '@code-pushup/utils';
+import { DEFAULT_TS_CONFIG, TYPESCRIPT_PLUGIN_SLUG } from './constants.js';
+import { createRunnerFunction } from './runner/runner.js';
+import { typescriptPluginConfigSchema, } from './schema.js';
+import { getAudits, getGroups, logSkippedAudits } from './utils.js';
+const packageJson = createRequire(import.meta.url)('../../package.json');
+export async function typescriptPlugin(options) {
+    const { tsconfig = DEFAULT_TS_CONFIG, onlyAudits } = parseOptions(options ?? {});
+    const filteredAudits = getAudits({ onlyAudits });
+    const filteredGroups = getGroups({ onlyAudits });
+    logSkippedAudits(filteredAudits);
+    return {
+        slug: TYPESCRIPT_PLUGIN_SLUG,
+        packageName: packageJson.name,
+        version: packageJson.version,
+        title: 'Typescript',
+        description: 'Official Code PushUp Typescript plugin.',
+        docsUrl: 'https://www.npmjs.com/package/@code-pushup/typescript-plugin/',
+        icon: 'typescript',
+        audits: filteredAudits,
+        groups: filteredGroups,
+        runner: createRunnerFunction({
+            tsconfig,
+            expectedAudits: filteredAudits,
+        }),
+    };
+}
+function parseOptions(tsPluginOptions) {
+    try {
+        return typescriptPluginConfigSchema.parse(tsPluginOptions);
+    }
+    catch (error) {
+        throw new Error(`Error parsing TypeScript Plugin options: ${stringifyError(error)}`);
+    }
+}
+//# sourceMappingURL=typescript-plugin.js.map

package/src/lib/typescript-plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"typescript-plugin.js","sourceRoot":"","sources":["../../../../../packages/plugin-typescript/src/lib/typescript-plugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAE5C,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,EAAE,iBAAiB,EAAE,sBAAsB,EAAE,MAAM,gBAAgB,CAAC;AAC3E,OAAO,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AAC1D,OAAO,EAGL,4BAA4B,GAC7B,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAEpE,MAAM,WAAW,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAChD,oBAAoB,CACkB,CAAC;AAEzC,MAAM,CAAC,KAAK,UAAU,gBAAgB,CACpC,OAAiC;IAEjC,MAAM,EAAE,QAAQ,GAAG,iBAAiB,EAAE,UAAU,EAAE,GAAG,YAAY,CAC/D,OAAO,IAAI,EAAE,CACd,CAAC;IAEF,MAAM,cAAc,GAAG,SAAS,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC;IACjD,MAAM,cAAc,GAAG,SAAS,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC;IAEjD,gBAAgB,CAAC,cAAc,CAAC,CAAC;IAEjC,OAAO;QACL,IAAI,EAAE,sBAAsB;QAC5B,WAAW,EAAE,WAAW,CAAC,IAAI;QAC7B,OAAO,EAAE,WAAW,CAAC,OAAO;QAC5B,KAAK,EAAE,YAAY;QACnB,WAAW,EAAE,yCAAyC;QACtD,OAAO,EAAE,+DAA+D;QACxE,IAAI,EAAE,YAAY;QAClB,MAAM,EAAE,cAAc;QACtB,MAAM,EAAE,cAAc;QACtB,MAAM,EAAE,oBAAoB,CAAC;YAC3B,QAAQ;YACR,cAAc,EAAE,cAAc;SAC/B,CAAC;KACH,CAAC;AACJ,CAAC;AAED,SAAS,YAAY,CACnB,eAAwC;IAExC,IAAI,CAAC;QACH,OAAO,4BAA4B,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;IAC7D,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,IAAI,KAAK,CACb,4CAA4C,cAAc,CAAC,KAAK,CAAC,EAAE,CACpE,CAAC;IACJ,CAAC;AACH,CAAC"}

package/src/lib/utils.d.ts

@@ -0,0 +1,70 @@
+import type { CompilerOptions } from 'typescript';
+import type { Audit, CategoryConfig, CategoryRef } from '@code-pushup/models';
+import type { TypescriptPluginConfig, TypescriptPluginOptions } from './schema.js';
+/**
+ * It filters the audits by the slugs
+ *
+ * @param slugs
+ */
+export declare function filterAuditsBySlug(slugs?: string[]): ({ slug }: {
+    slug: string;
+}) => boolean;
+/**
+ * From a list of audits, it will filter out the ones that might have been disabled from the compiler options
+ * plus from the parameter onlyAudits
+ * @param compilerOptions Compiler options
+ * @param onlyAudits OnlyAudits
+ * @returns Filtered Audits
+ */
+export declare function filterAuditsByCompilerOptions(compilerOptions: CompilerOptions, onlyAudits?: string[]): ({ slug }: {
+    slug: string;
+}) => boolean;
+export declare function getGroups(options?: TypescriptPluginOptions): {
+    refs: {
+        slug: string;
+        weight: number;
+    }[];
+    slug: string;
+    title: string;
+    description?: string | undefined;
+    docsUrl?: string | undefined;
+    isSkipped?: boolean | undefined;
+}[];
+export declare function getAudits(options?: Pick<TypescriptPluginConfig, 'onlyAudits'>): ({
+    slug: string;
+    title: string;
+    description?: string | undefined;
+    docsUrl?: string | undefined;
+    isSkipped?: boolean | undefined;
+} & {
+    slug: import("./types.js").AuditSlug;
+})[];
+/**
+ * Retrieve the category references from the groups (already processed from the audits).
+ * Used in the code-pushup preset
+ * @param opt TSPluginOptions
+ * @returns The array of category references
+ */
+export declare function getCategoryRefsFromGroups(opt?: TypescriptPluginOptions): CategoryRef[];
+/**
+ * Retrieve the category references from the audits.
+ * @param opt TSPluginOptions
+ * @returns The array of category references
+ */
+export declare function getCategoryRefsFromAudits(opt?: TypescriptPluginOptions): CategoryRef[];
+export declare const CATEGORY_MAP: Record<string, CategoryConfig>;
+export declare function getCategories(): {
+    slug: string;
+    refs: {
+        slug: string;
+        weight: number;
+        type: "audit" | "group";
+        plugin: string;
+    }[];
+    title: string;
+    description?: string | undefined;
+    docsUrl?: string | undefined;
+    isSkipped?: boolean | undefined;
+    isBinary?: boolean | undefined;
+}[];
+export declare function logSkippedAudits(audits: Audit[]): void;

package/src/lib/utils.js

@@ -0,0 +1,122 @@
+import { kebabCaseToCamelCase, ui } from '@code-pushup/utils';
+import { AUDITS, GROUPS, TYPESCRIPT_PLUGIN_SLUG } from './constants.js';
+/**
+ * It filters the audits by the slugs
+ *
+ * @param slugs
+ */
+export function filterAuditsBySlug(slugs) {
+    return ({ slug }) => {
+        if (slugs && slugs.length > 0) {
+            return slugs.includes(slug);
+        }
+        return true;
+    };
+}
+/**
+ * It transforms a slug code to a compiler option format
+ * By default, kebabCaseToCamelCase.
+ * It will handle also cases like emit-bom that it should be emit-BOM
+ * @param slug Slug to be transformed
+ * @returns The slug as compilerOption key
+ */
+function auditSlugToCompilerOption(slug) {
+    // eslint-disable-next-line sonarjs/no-small-switch
+    switch (slug) {
+        case 'emit-bom':
+            return 'emitBOM';
+        default:
+            return kebabCaseToCamelCase(slug);
+    }
+}
+/**
+ * From a list of audits, it will filter out the ones that might have been disabled from the compiler options
+ * plus from the parameter onlyAudits
+ * @param compilerOptions Compiler options
+ * @param onlyAudits OnlyAudits
+ * @returns Filtered Audits
+ */
+export function filterAuditsByCompilerOptions(compilerOptions, onlyAudits) {
+    return ({ slug }) => {
+        const option = compilerOptions[auditSlugToCompilerOption(slug)];
+        return (option !== false &&
+            option !== undefined &&
+            filterAuditsBySlug(onlyAudits)({ slug }));
+    };
+}
+export function getGroups(options) {
+    return GROUPS.map(group => ({
+        ...group,
+        refs: group.refs.filter(filterAuditsBySlug(options?.onlyAudits)),
+    })).filter(group => group.refs.length > 0);
+}
+export function getAudits(options) {
+    return AUDITS.filter(filterAuditsBySlug(options?.onlyAudits));
+}
+/**
+ * Retrieve the category references from the groups (already processed from the audits).
+ * Used in the code-pushup preset
+ * @param opt TSPluginOptions
+ * @returns The array of category references
+ */
+export function getCategoryRefsFromGroups(opt) {
+    return getGroups(opt).map(({ slug }) => ({
+        plugin: TYPESCRIPT_PLUGIN_SLUG,
+        slug,
+        weight: 1,
+        type: 'group',
+    }));
+}
+/**
+ * Retrieve the category references from the audits.
+ * @param opt TSPluginOptions
+ * @returns The array of category references
+ */
+export function getCategoryRefsFromAudits(opt) {
+    return AUDITS.filter(filterAuditsBySlug(opt?.onlyAudits)).map(({ slug }) => ({
+        plugin: TYPESCRIPT_PLUGIN_SLUG,
+        slug,
+        weight: 1,
+        type: 'audit',
+    }));
+}
+export const CATEGORY_MAP = {
+    typescript: {
+        slug: 'type-safety',
+        title: 'Type Safety',
+        description: 'TypeScript diagnostics and type-checking errors',
+        refs: getCategoryRefsFromGroups(),
+    },
+    'bug-prevention': {
+        slug: 'bug-prevention',
+        title: 'Bug prevention',
+        description: 'Type checks that find **potential bugs** in your code.',
+        refs: getCategoryRefsFromGroups({
+            onlyAudits: [
+                'syntax-errors',
+                'semantic-errors',
+                'internal-errors',
+                'configuration-errors',
+                'no-implicit-any-errors',
+            ],
+        }),
+    },
+    miscellaneous: {
+        slug: 'miscellaneous',
+        title: 'Miscellaneous',
+        description: 'Errors that do not bring any specific value to the developer, but are still useful to know.',
+        refs: getCategoryRefsFromGroups({
+            onlyAudits: ['unknown-codes', 'declaration-and-language-service-errors'],
+        }),
+    },
+};
+export function getCategories() {
+    return Object.values(CATEGORY_MAP);
+}
+export function logSkippedAudits(audits) {
+    const skippedAudits = AUDITS.filter(audit => !audits.some(filtered => filtered.slug === audit.slug)).map(audit => kebabCaseToCamelCase(audit.slug));
+    if (skippedAudits.length > 0) {
+        ui().logger.info(`Skipped audits: [${skippedAudits.join(', ')}]`);
+    }
+}
+//# sourceMappingURL=utils.js.map

package/src/lib/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../../../packages/plugin-typescript/src/lib/utils.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,oBAAoB,EAAE,EAAE,EAAE,MAAM,oBAAoB,CAAC;AAC9D,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,sBAAsB,EAAE,MAAM,gBAAgB,CAAC;AAMxE;;;;GAIG;AACH,MAAM,UAAU,kBAAkB,CAAC,KAAgB;IACjD,OAAO,CAAC,EAAE,IAAI,EAAoB,EAAE,EAAE;QACpC,IAAI,KAAK,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC9B,OAAO,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC9B,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,SAAS,yBAAyB,CAAC,IAAY;IAC7C,mDAAmD;IACnD,QAAQ,IAAI,EAAE,CAAC;QACb,KAAK,UAAU;YACb,OAAO,SAAS,CAAC;QACnB;YACE,OAAO,oBAAoB,CAAC,IAAI,CAAC,CAAC;IACtC,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,6BAA6B,CAC3C,eAAgC,EAChC,UAAqB;IAErB,OAAO,CAAC,EAAE,IAAI,EAAoB,EAAE,EAAE;QACpC,MAAM,MAAM,GAAG,eAAe,CAAC,yBAAyB,CAAC,IAAI,CAAC,CAAC,CAAC;QAChE,OAAO,CACL,MAAM,KAAK,KAAK;YAChB,MAAM,KAAK,SAAS;YACpB,kBAAkB,CAAC,UAAU,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CACzC,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,SAAS,CAAC,OAAiC;IACzD,OAAO,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QAC1B,GAAG,KAAK;QACR,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;KACjE,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;AAC7C,CAAC;AAED,MAAM,UAAU,SAAS,CACvB,OAAoD;IAEpD,OAAO,MAAM,CAAC,MAAM,CAAC,kBAAkB,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC,CAAC;AAChE,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,yBAAyB,CACvC,GAA6B;IAE7B,OAAO,SAAS,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC;QACvC,MAAM,EAAE,sBAAsB;QAC9B,IAAI;QACJ,MAAM,EAAE,CAAC;QACT,IAAI,EAAE,OAAO;KACd,CAAC,CAAC,CAAC;AACN,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,yBAAyB,CACvC,GAA6B;IAE7B,OAAO,MAAM,CAAC,MAAM,CAAC,kBAAkB,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC;QAC3E,MAAM,EAAE,sBAAsB;QAC9B,IAAI;QACJ,MAAM,EAAE,CAAC;QACT,IAAI,EAAE,OAAO;KACd,CAAC,CAAC,CAAC;AACN,CAAC;AAED,MAAM,CAAC,MAAM,YAAY,GAAmC;IAC1D,UAAU,EAAE;QACV,IAAI,EAAE,aAAa;QACnB,KAAK,EAAE,aAAa;QACpB,WAAW,EAAE,iDAAiD;QAC9D,IAAI,EAAE,yBAAyB,EAAE;KAClC;IACD,gBAAgB,EAAE;QAChB,IAAI,EAAE,gBAAgB;QACtB,KAAK,EAAE,gBAAgB;QACvB,WAAW,EAAE,wDAAwD;QACrE,IAAI,EAAE,yBAAyB,CAAC;YAC9B,UAAU,EAAE;gBACV,eAAe;gBACf,iBAAiB;gBACjB,iBAAiB;gBACjB,sBAAsB;gBACtB,wBAAwB;aACzB;SACF,CAAC;KACH;IACD,aAAa,EAAE;QACb,IAAI,EAAE,eAAe;QACrB,KAAK,EAAE,eAAe;QACtB,WAAW,EACT,6FAA6F;QAC/F,IAAI,EAAE,yBAAyB,CAAC;YAC9B,UAAU,EAAE,CAAC,eAAe,EAAE,yCAAyC,CAAC;SACzE,CAAC;KACH;CACF,CAAC;AAEF,MAAM,UAAU,aAAa;IAC3B,OAAO,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;AACrC,CAAC;AAED,MAAM,UAAU,gBAAgB,CAAC,MAAe;IAC9C,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,CACjC,KAAK,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,CAAC,CAChE,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,oBAAoB,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;IACjD,IAAI,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC7B,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,oBAAoB,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACpE,CAAC;AACH,CAAC"}