wip

BioPhoton · BioPhoton · commit 05b2504bcd94 · 2024-12-27T18:22:49.000+01:00
diff --git a/code-pushup.config.ts b/code-pushup.config.ts
@@ -41,7 +41,7 @@ export default mergeConfigs(
   ),
   await eslintCoreConfigNx(),*/
   await typescriptPluginConfigNx({
-    tsConfigPath: 'packages/plugin-typescript/tsconfig.lib.json',
+    tsConfigPath: 'packages/plugin-typescript/mocks/fixtures/basic-setup/tsconfig.json',
     // onlyAudits: ['verbatim-module-syntax-typescript']
   }),
 );
diff --git a/code-pushup.preset.ts b/code-pushup.preset.ts
@@ -17,8 +17,9 @@ import {
   type TypescriptPluginOptions,
   typescriptPlugin,
 } from './packages/plugin-typescript/src/index.js';
-import { GROUPS } from './packages/plugin-typescript/src/lib/constants';
-import { filterGroupsByAuditSlug } from './packages/plugin-typescript/src/lib/utils.js';
+import {AUDITS, GROUPS} from './packages/plugin-typescript/src/lib/constants';
+import {filterGroupsByAuditSlug, getFinalAuditSlugs} from './packages/plugin-typescript/src/lib/utils.js';
+import {a} from "vitest/dist/suite-UrZdHRff";
 
 export const jsPackagesCategories: CategoryConfig[] = [
   {
@@ -142,22 +143,21 @@ export const typescriptPluginConfigNx = async (
     ...options,
   };
 
+
   return {
     plugins: [await typescriptPlugin(opt)],
-    /*categories: [
-      {
+    categories: [
+  /*    {
         slug: 'typescript',
         title: 'Typescript',
-        refs: GROUPS.filter(filterGroupsByAuditSlug(opt.onlyAudits)).map(
-          ({ slug }) => ({
-            plugin: 'typescript',
-            type: 'group' as const,
-            slug,
-            weight: 1,
-          }),
-        ),
-      },
-    ],*/
+        refs: AUDITS.filter(filterGroupsByAuditSlug(await getFinalAuditSlugs(opt))).map( ({slug}) => ({
+          type: 'audit',
+          plugin: 'typescript',
+          slug,
+          weight: 1,
+        }))
+      },*/
+    ],
   };
 };
 
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -25,7 +25,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",
diff --git a/packages/plugin-typescript/mocks/fixtures/basic-setup/tsconfig.json b/packages/plugin-typescript/mocks/fixtures/basic-setup/tsconfig.json
@@ -3,13 +3,7 @@
     "rootDir": "./src",
     "strict": true,
     "target": "ES6",
-    "module": "CommonJS",
-    "noImplicitAny": true,
-    "strictNullChecks": true,
-    "strictFunctionTypes": true,
-    "strictBindCallApply": true,
-    "strictPropertyInitialization": true,
-    "alwaysStrict": true
+    "module": "CommonJS"
   },
   "include": ["src/**/*.ts", "src/**/*.js"],
 }
diff --git a/packages/plugin-typescript/mocks/fixtures/compiler-defaults/src/strict-errors.ts b/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);
+}
diff --git a/packages/plugin-typescript/mocks/fixtures/compiler-defaults/tsconfig.json b/packages/plugin-typescript/mocks/fixtures/compiler-defaults/tsconfig.json
@@ -0,0 +1,8 @@
+{
+  "compilerOptions": {
+    "rootDir": "./src",
+    "target": "ES6",
+    "module": "CommonJS"
+  },
+  "include": ["src/**/*.ts"],
+}
diff --git a/packages/plugin-typescript/src/lib/runner/runner.ts b/packages/plugin-typescript/src/lib/runner/runner.ts
@@ -1,33 +1,14 @@
-import type {
-  Audit,
-  AuditOutput,
-  AuditOutputs,
-  AuditReport,
-  Issue,
-  RunnerFunction,
-} from '@code-pushup/models';
-import type { CompilerOptionName } from '../types.js';
-import { mergeTsConfigs } from '../typescript-plugin';
-import {
-  type DiagnosticsOptions,
-  getDiagnostics,
-  getTsConfigurationFromPath,
-} from './typescript-runner.js';
-import {
-  AUDIT_LOOKUP,
-  getIssueFromDiagnostic,
-  tSCodeToAuditSlug,
-} from './utils.js';
-
-export type RunnerOptions = DiagnosticsOptions & {
-  filteredAudits: Audit[];
-};
+import type {Audit, AuditOutput, AuditOutputs, AuditReport, Issue, RunnerFunction,} from '@code-pushup/models';
+import type {CompilerOptionName, TypescriptPluginOptions} from '../types.js';
+import {getDiagnostics,} from './typescript-runner.js';
+import {AUDIT_LOOKUP, getIssueFromDiagnostic, tSCodeToAuditSlug, validateDiagnostics} from './utils.js';
+export type RunnerOptions = TypescriptPluginOptions & {filteredAudits: Audit[]};
 
 export function createRunnerFunction(options: RunnerOptions): RunnerFunction {
   return async (): Promise<AuditOutputs> => {
-    const { filteredAudits, compilerOptions, fileNames } = options;
-    const diagnostics = await getDiagnostics({ fileNames, compilerOptions });
 
+    const diagnostics = await getDiagnostics(options.tsConfigPath);
+    validateDiagnostics(diagnostics);
     const result: Record<
       CompilerOptionName,
       Pick<AuditReport, 'slug' | 'details'>
@@ -55,7 +36,7 @@ export function createRunnerFunction(options: RunnerOptions): RunnerFunction {
         >,
       );
 
-    return filteredAudits.map(audit => {
+    return options.filteredAudits.map(audit => {
       const { details } = result[audit.slug as CompilerOptionName] ?? {};
       const issues = details?.issues ?? [];
       return {
diff --git a/packages/plugin-typescript/src/lib/runner/ts-error-codes.ts b/packages/plugin-typescript/src/lib/runner/ts-error-codes.ts
@@ -21,6 +21,21 @@ export const GROUPS_DESCRIPTIONS = {
     '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',
 };
 
+/**
+ *  Strict grouping: https://github.com/microsoft/TypeScript/blob/56a08250f3516b3f5bc120d6c7ab4450a9a69352/src/compiler/utilities.ts Line 9113
+ *      noImplicitThis: {
+ *         dependencies: ["strict"],
+ *         computeValue: compilerOptions => {
+ *             return getStrictOptionValue(compilerOptions, "noImplicitThis");
+ *         },
+ *     },
+ *  Line 9262
+ *  export function getStrictOptionValue(compilerOptions: CompilerOptions, flag: StrictOptionName): boolean {
+ *     return compilerOptions[flag] === undefined ? !!compilerOptions.strict : !!compilerOptions[flag];
+ * }
+ * https://github.com/microsoft/TypeScript/blob/56a08250f3516b3f5bc120d6c7ab4450a9a69352/src/compiler/utilities.ts#L9262
+ */
+
 /** This is the list of error codes that can be triggered by the TypeScript compiler.
  * It's divided into: category -> compiler option -> error codes (that might trigger)
  */
@@ -46,6 +61,7 @@ export const TS_ERROR_CODES = {
     isolatedModules: [18055, 18056, 18057],
     preserveSymlinks: [1421],
   } as const,
+  /*
   watchOptions: {
     assumeChangesOnlyAffectDirectDependencies: [6373],
     preserveWatchOutput: [6379], // This affects watch mode behavior rather than emitting errors
@@ -57,31 +73,25 @@ export const TS_ERROR_CODES = {
     disableReferencedProjectLoad: [6371],
     disableSolutionSearching: [6370],
     disableSourceOfProjectReferenceRedirect: [6374],
-  } as const,
+  } as const,*/
   moduleResolution: {
-    moduleResolutionNode: [2307],
-    moduleResolutionBundler: [1479],
+    moduleResolution: [2307, 1479],
     customConditions: [1378],
     resolvePackageJsonExports: [1343],
     resolvePackageJsonImports: [1344],
     verbatimModuleSyntax: [1286, 1287, 1288, 1484, 1485],
   } as const,
   typeCheckingBehavior: {
-    noErrorTruncation: [2322, 2345], // This affects error message display rather than triggering specific errors
+    // noErrorTruncation: [2322, 2345], // This affects error message display rather than triggering specific errors
     exactOptionalPropertyTypes: [2775],
     noUncheckedIndexedAccess: [7061],
     noImplicitOverride: [4114, 4113],
     noPropertyAccessFromIndexSignature: [4111],
   } as const,
   controlFlowOptions: {
     allowUnreachableCode: [7027],
-    allowUnusedLabels: [7028],
-    noUnusedLabels: [7028],
-    noImplicitReturnsInAsyncFunctions: [7030, 1064],
-    allowUnusedParameters: [6134],
+    noImplicitReturns: [7030, 1064],
     noFallthroughCasesInSwitch: [7029],
-    noImplicitReturnsInGenerators: [7030],
-    noPropertyAccessFromComputedKey: [4111],
   } as const,
   buildEmitOptions: {
     noEmit: [6059],
@@ -95,7 +105,7 @@ export const TS_ERROR_CODES = {
     downlevelIteration: [2569],
     emitDeclarationOnly: [5069],
   } as const,
-  strictChecks: {
+  strict: {
     noImplicitAny: [
       7005, 7006, 7008, 7009, 7010, 7011, 7015, 7016, 7017, 7018, 7019, 7031,
       7032, 7033,
diff --git a/packages/plugin-typescript/src/lib/runner/typescript-runner.integration.test.ts b/packages/plugin-typescript/src/lib/runner/typescript-runner.integration.test.ts
@@ -1,11 +1,34 @@
 // eslint-disable-next-line unicorn/import-style
-import { basename } from 'node:path';
-import { describe, expect } from 'vitest';
+import {describe, expect} from 'vitest';
 import {
-  getDiagnostics,
   getTsConfigurationFromPath,
 } from './typescript-runner.js';
 
+describe('getTsConfigurationFromPath', () => {
+  it('should accept valid options', async () => {
+    await expect(
+      getTsConfigurationFromPath({
+        tsConfigPath: 'packages/plugin-typescript/mocks/fixtures/basic-setup/tsconfig.json',
+      }),
+    ).resolves.toStrictEqual({
+      compilerOptions: {
+        configFilePath: undefined,
+        module: 1,
+        rootDir: expect.any(String),
+        strict: true,
+        target: 2,
+      },
+      fileNames: expect.arrayContaining([
+        expect.any(String),
+        expect.any(String),
+        expect.any(String),
+        expect.any(String),
+      ]),
+    });
+  });
+
+});
+
 /*
 describe('getDiagnostics', () => {
   it('should accept valid options', async () => {
diff --git a/packages/plugin-typescript/src/lib/runner/typescript-runner.ts b/packages/plugin-typescript/src/lib/runner/typescript-runner.ts
@@ -11,26 +11,27 @@ import {
   sys,
 } from 'typescript';
 import type { TypescriptPluginOptions } from '../types.js';
+import {loadTargetConfig} from "../utils.js";
 
 export type DiagnosticsOptions = {
   fileNames: string[];
   compilerOptions: CompilerOptions;
 };
 
-export async function getDiagnostics({
-  fileNames,
-  compilerOptions,
-}: DiagnosticsOptions): Promise<readonly Diagnostic[]> {
-  const program = createProgram(fileNames, compilerOptions);
+export async function getDiagnostics(tsConfigPath: string): Promise<readonly Diagnostic[]> {
+  try {
+    const {fileNames, options}= await loadTargetConfig(tsConfigPath);
+  const program = createProgram(fileNames, options);
   return getPreEmitDiagnostics(program);
+  } catch (error) {
+    throw new Error(`Can't create TS program in getDiagnostics. \n ${(error as Error).message}`);
+  }
 }
 
 export async function getTsConfigurationFromPath(
-  options: Pick<TypescriptPluginOptions, 'tsConfigPath'> & {
-    existingConfig: CompilerOptions;
-  },
+  options: Pick<TypescriptPluginOptions, 'tsConfigPath'>
 ): Promise<DiagnosticsOptions> {
-  const { tsConfigPath, existingConfig } = options;
+  const { tsConfigPath } = options;
   const configPath = resolve(process.cwd(), tsConfigPath);
   const basePath = dirname(configPath);
 
@@ -46,8 +47,7 @@ export async function getTsConfigurationFromPath(
   const parsed = parseJsonConfigFileContent(
     config,
     sys,
-    basePath,
-    existingConfig,
+    basePath
   );
 
   const { options: compilerOptions, fileNames } = parsed;
diff --git a/packages/plugin-typescript/src/lib/runner/utils.ts b/packages/plugin-typescript/src/lib/runner/utils.ts
@@ -4,7 +4,7 @@ import {
   flattenDiagnosticMessageText,
 } from 'typescript';
 import type { Issue } from '@code-pushup/models';
-import { camelCaseToKebabCase } from '@code-pushup/utils';
+import {camelCaseToKebabCase, truncateIssueMessage} from '@code-pushup/utils';
 import type { CompilerOptionName } from '../types.js';
 import { TS_ERROR_CODES } from './ts-error-codes.js';
 
@@ -32,6 +32,14 @@ export function tSCodeToAuditSlug(code: number): CompilerOptionName {
   return knownCode;
 }
 
+//OK DOOONE, now it's more beautiful, goodbye! let me know when u finish if u want
+// I was getting so frustrated of with webstorm sry xD
+export function validateDiagnostics(diagnostics: readonly Diagnostic[]){
+  diagnostics.filter(({code}) => !AUDIT_LOOKUP.has(code)).forEach(({code, messageText}) => {
+    console.warn(`Diagnostic Warning: The code ${code} is not supported. ${messageText}`)
+  })
+}
+
 /**
  * Get the severity of the issue based on the TypeScript diagnostic category.
  * - ts.DiagnosticCategory.Warning (1)
@@ -73,7 +81,7 @@ export function getIssueFromDiagnostic(diag: Diagnostic) {
 
   return {
     severity: getSeverity(diag.category),
-    message,
+    message: truncateIssueMessage(message),
     source: {
       file: diag.file.fileName,
       ...(startLine
diff --git a/packages/plugin-typescript/src/lib/schema.ts b/packages/plugin-typescript/src/lib/schema.ts
@@ -1,6 +1,6 @@
 import { z } from 'zod';
 import { AUDITS, DEFAULT_TS_CONFIG } from './constants.js';
-import type { CompilerOptionName } from './types.js';
+import type {AuditSlug, CompilerOptionName} from './types.js';
 
 const auditSlugs = AUDITS.map(({ slug }) => slug) as [string, ...string[]];
 export const typescriptPluginConfigSchema = z.object({
@@ -13,9 +13,9 @@ export const typescriptPluginConfigSchema = z.object({
     .array(z.enum(auditSlugs), {
       description: 'Array with specific TsCodes to measure',
     })
-    .optional(),
+    .optional()
 });
 
 export type TypescriptPluginOptions = z.infer<
   typeof typescriptPluginConfigSchema
-> & { onlyAudits?: (string | CompilerOptionName)[] | undefined };
+> & { onlyAudits?: (string | AuditSlug)[] | undefined };
diff --git a/packages/plugin-typescript/src/lib/typescript-plugin.ts b/packages/plugin-typescript/src/lib/typescript-plugin.ts
diff --git a/packages/plugin-typescript/src/lib/utils.integration.test.ts b/packages/plugin-typescript/src/lib/utils.integration.test.ts
diff --git a/packages/plugin-typescript/src/lib/utils.ts b/packages/plugin-typescript/src/lib/utils.ts
diff --git a/packages/plugin-typescript/src/lib/utils.unit.test.ts b/packages/plugin-typescript/src/lib/utils.unit.test.ts
