add groups

Author: BioPhoton

code-pushup.preset.ts

@@ -17,9 +17,19 @@ import {
   type TypescriptPluginOptions,
   typescriptPlugin,
 } from './packages/plugin-typescript/src/index.js';
-import { AUDITS } from './packages/plugin-typescript/src/lib/audits.generated.js';
-import { BASIC_AUDITS } from './packages/plugin-typescript/src/lib/constants.js';
-import { filterAuditsBySlug } from './packages/plugin-typescript/src/lib/utils.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";
 
 export const jsPackagesCategories: CategoryConfig[] = [
   {
@@ -78,14 +88,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}],
   },
 ];
 
@@ -140,7 +150,6 @@ export const typescriptPluginConfigNx = async (
   options: TypescriptPluginOptions,
 ): Promise<CoreConfig> => {
   const opt: TypescriptPluginOptions = {
-    onlyAudits: BASIC_AUDITS,
     ...options,
   };
 
@@ -150,10 +159,10 @@ export const typescriptPluginConfigNx = async (
       {
         slug: 'typescript',
         title: 'Typescript',
-        refs: AUDITS.filter(filterAuditsBySlug(opt.onlyAudits)).map(
-          ({ slug }) => ({
+        refs: GROUPS.filter(filterGroupsByAuditSlug(opt.onlyAudits)).map(
+          ({slug}) => ({
             plugin: 'typescript',
-            type: 'audit' as const,
+            type: 'group' as const,
             slug,
             weight: 1,
           }),

packages/plugin-typescript/README.md

@@ -4,14 +4,11 @@
 [![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 web performance and quality with Lighthouse.** 🔥
+🕵️ **Code PushUp plugin for measuring TypeScript quality with compiler diagnostics.** 🔥
 
 ---
 
-The plugin parses your Lighthouse configuration and lints all audits of the official [Lighthouse](https://github.com/GoogleChrome/typescript/blob/main/readme.md#typescript-------) CLI.
-
-Detected Lighthouse audits are mapped to Code PushUp audits. Audit reports are calculated based on the [original implementation](https://googlechrome.github.io/typescript/scorecalc/).
-Additionally, Lighthouse categories are mapped to Code PushUp groups which can make it easier to assemble the categories.
+The plugin parses your TypeScript and JavaScript code and lints all audits of the official [TypeScript Compiler]().
 
 For more infos visit the [official docs](https://developer.chrome.com/docs/typescript/overview).
 
@@ -44,7 +41,9 @@ For more infos visit the [official docs](https://developer.chrome.com/docs/types
      // ...
      plugins: [
        // ...
-       await typescriptPlugin('https://example.com'),
+       await typescriptPlugin({
+          tsConfigPath: './tsconfig.json'
+       }),
      ],
    };
    ```
@@ -66,39 +65,14 @@ import { typescriptGroupRef } from './utils';
 export default {
   // ...
   categories: [
-    {
-      slug: 'performance',
-      title: 'Performance',
-      refs: [typescriptGroupRef('performance')],
-    },
-    {
-      slug: 'a11y',
-      title: 'Accessibility',
-      refs: [typescriptGroupRef('accessibility')],
-    },
-    {
-      slug: 'best-practices',
-      title: 'Best Practices',
-      refs: [typescriptGroupRef('best-practices')],
-    },
-    {
-      slug: 'seo',
-      title: 'SEO',
-      refs: [typescriptGroupRef('seo')],
-    },
-    {
-      slug: 'pwa',
-      title: 'PWA',
-      isBinary: true,
-      refs: [typescriptGroupRef('pwa')],
-    },
+    
   ],
 };
 ```
 
 #### Reference groups with `typescriptAuditRef`
 
-The Lighthouse categories are reflected as groups.
+The TypeScript categories are reflected as groups.
 Referencing individual audits offers more granularity. However, keep maintenance costs of a higher number of audits in mind as well.
 
 ```ts
@@ -116,124 +90,3 @@ export default {
   ],
 };
 ```
-
-## Flags
-
-The plugin accepts an optional second argument, `flags`.
-
-`flags` is a JavaScript object containing Lighthouse [CLI flags](https://github.com/GoogleChrome/typescript/blob/7d80178c37a1b600ea8f092fc0b098029799a659/cli/cli-flags.js#L80).
-
-Within the `flags` object, external configuration files can be referenced using options like `configPath` , `preset`, or `budgetPath`. These options allow Lighthouse to load custom configurations, audit presets, or performance budgets from external `json` or JavaScript files.
-
-For a complete list of available options, refer to [the official Lighthouse documentation](https://github.com/GoogleChrome/typescript/blob/main/readme.md#cli-options).
-
-> [!TIP]  
-> If you are new to working with the Lighthouse CLI, flags can be passed like this:
-> `typescript https://example.com --output=json --chromeFlags='--headless=shell'`
->
-> With the plugin, the configuration would be:
->
-> ```ts
-> // code-pushup.config.ts
-> ...
-> typescriptPlugin('https://example.com', {
->   output: 'json',
->   chromeFlags: ['--headless=shell'],
-> });
-> ```
-
-> [!note]
-> The following flags are **not supported** in the current implementation:
->
-> - `list-all-audits` - Prints a list of all available audits and exits. Alternative: `npx code-pushup print-config --onlyPlugins typescript`
-> - `list-locales` - Prints a list of all supported locales and exits.
-> - `list-trace-categories` - Prints a list of all required trace categories and exits.
-> - `view` - Open HTML report in your browser
-
-## Chrome Flags for Tooling
-
-We recommend using Chrome flags for more stable runs in a tooling environment. The [`chrome-launcher`](https://www.npmjs.com/package/chrome-launcher) package offers a well-documented set of flags specifically designed to ensure reliable execution.
-
-The latest version of `@code-pushup/typescript-plugin` provides `DEFAULT_CHROME_FLAGS`, a pre-configured constant that includes Chrome’s default flags for stable, headless execution out of the box. This means you do not need to specify `chromeFlags` manually unless you want to modify them.
-
-### Default Usage
-
-If no `chromeFlags` are provided, the plugin automatically applies the default configuration:
-
-> ```ts
-> import typescriptPlugin from '@code-pushup/typescript-plugin';
->
-> typescriptPlugin('https://example.com', {
->   output: 'json',
->   // Defaults to DEFAULT_CHROME_FLAGS internally
-> });
-> ```
-
-### Adding Extra Flags
-
-If additional Chrome flags are required (e.g., verbose logging or debugging), they can be appended to the default flags:
-
-> ```ts
-> import typescriptPlugin, { DEFAULT_CHROME_FLAGS } from '@code-pushup/typescript-plugin';
->
-> typescriptPlugin('https://example.com', {
->   output: 'json',
->   chromeFlags: DEFAULT_CHROME_FLAGS.concat(['--verbose']),
-> });
-> ```
-
-### Overriding Default Flags
-
-To completely override the default flags and provide a custom configuration:
-
-> ```ts
-> import typescriptPlugin from '@code-pushup/typescript-plugin';
->
-> typescriptPlugin('https://example.com', {
->   output: 'json',
->   chromeFlags: ['--verbose'],
-> });
-> ```
-
-## Config
-
-The plugin accepts a third optional argument, `config`.
-
-`config` is the Lighthouse [configuration](https://github.com/GoogleChrome/typescript/blob/7d80178c37a1b600ea8f092fc0b098029799a659/types/config.d.ts#L21) as a JS object.
-
-For a complete guide on Lighthouse configuration read the [official documentation on configuring](https://github.com/GoogleChrome/typescript/blob/main/docs/configuration.md)
-
-> [!TIP]  
-> If you are not used to work with the Lighthouse CLI you would pass a config like this:
-> `typescript --config-path=path/to/custom-config.js https://example.com`
->
-> And in a separate file you would place the following object:
->
-> ```typescript
-> // custom-config.js file
-> export default {
->   extends: 'typescript:default',
->   settings: {
->     onlyAudits: ['first-meaningful-paint', 'speed-index', 'interactive'],
->   },
-> };
-> ```
->
-> Now with the plugin it would look like this:
->
-> ```ts
-> // code-pushup.config.ts
-> ...
-> typescriptPlugin('https://example.com', undefined, {
->   extends: 'typescript:default',
->   settings: {
->     onlyAudits: [
->       'first-meaningful-paint',
->       'speed-index',
->       'interactive',
->      ],
->  }
-> })
-> ```
-
-If you want to contribute, please refer to [CONTRIBUTING.md](./CONTRIBUTING.md).

packages/plugin-typescript/project.json

@@ -35,9 +35,6 @@
       "options": {
         "configFile": "packages/plugin-typescript/vite.config.integration.ts"
       }
-    },
-    "generate-audits": {
-      "command": "tsx --tsconfig=packages/plugin-typescript/tsconfig.tools.json packages/plugin-typescript/tools/generate-audits/bin.ts"
     }
   },
   "tags": ["scope:plugin", "type:feature", "publishable"]