wip

Author: BioPhoton

code-pushup.preset.ts

@@ -143,7 +143,7 @@ export const typescriptPluginConfigNx = async (
   };
 
   return {
-    plugins: [typescriptPlugin(opt)],
+    plugins: [await typescriptPlugin(opt)],
     categories: [
       {
         slug: 'typescript',

packages/plugin-typescript/src/lib/runner/ts-error-codes.ts

@@ -25,7 +25,7 @@ export const GROUPS_DESCRIPTIONS = {
  * It's divided into: category -> compiler option -> error codes (that might trigger)
  */
 export const TS_ERROR_CODES = {
-  languageAndEnvironment: {
+  languageAndEnvivronment: {
     experimentalDecorators: [1240, 1241, 1242, 1243, 1244, 1270, 1271, 1272],
     emitDecoratorMetadata: [1240, 1241, 1272],
     jsx: [1341, 18007, 18034, 18035, 18053],

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

@@ -10,10 +10,12 @@ import { createRunnerFunction } from './runner/runner.js';
 import type { TypescriptPluginOptions } from './types.js';
 import { filterAuditsBySlug, filterGroupsByAuditSlug } from './utils.js';
 
-export function typescriptPlugin(
+export async function typescriptPlugin(
   options?: TypescriptPluginOptions,
-): PluginConfig {
+): Promise<PluginConfig> {
   const { tsConfigPath = DEFAULT_TS_CONFIG, onlyAudits } = options ?? {};
+  // const defaultConfig = loadDefaultTsConfig(await getCurrentTsVersion());
+  // console.log(defaultConfig);
   const filteredAudits = AUDITS.filter(filterAuditsBySlug(onlyAudits));
   const filteredGroups = GROUPS.filter(filterGroupsByAuditSlug(onlyAudits));
   return {

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

@@ -1,4 +1,7 @@
+import type { CompilerOptions } from 'typescript';
 import type { Audit, Group } from '@code-pushup/models';
+import { executeProcess } from '@code-pushup/utils';
+import type { SemVerString } from '../../tools/generate-ts-config.js';
 
 export function filterAuditsBySlug(slugs?: string[]) {
   return ({ slug }: Audit) => {
@@ -17,3 +20,23 @@ export function filterGroupsByAuditSlug(slugs?: string[]) {
     return true;
   };
 }
+
+export async function getCurrentTsVersion(): Promise<SemVerString> {
+  const { stdout } = await executeProcess({
+    command: 'npx',
+    args: ['tsc', '--version'],
+  });
+  return stdout.trim() as SemVerString;
+}
+
+export async function loadDefaultTsConfig(version: SemVerString) {
+  try {
+    const module = await import(`./${version}.ts`);
+    //const module = await import(`.packages/plugin-typescript/src/lib/default-ts-configs/1.6.2.ts`);
+    return module.default as CompilerOptions;
+  } catch (error) {
+    throw new Error(
+      `Could not find default TS config for version ${version}. /n ${(error as Error).message}`,
+    );
+  }
+}

packages/plugin-typescript/tools/__snapshots__/generate-ts-config.integration.test.ts.snap

@@ -0,0 +1,7 @@
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+
+exports[`prepareTsConfigFileContent > should parse tsconfig.json created from init command 1`] = `
+"{
+"compilerOptions": {"incremental": true"composite": true"tsBuildInfoFile": "./.tsbuildinfo""disableSourceOfProjectReferenceRedirect": true"disableSolutionSearching": true"disableReferencedProjectLoad": true"target": "es2016""lib": []"jsx": "preserve""experimentalDecorators": true"emitDecoratorMetadata": true"jsxFactory": """jsxFragmentFactory": """jsxImportSource": """reactNamespace": """noLib": true"useDefineForClassFields": true"moduleDetection": "auto""module": "commonjs""rootDir": "./""moduleResolution": "node""baseUrl": "./""paths": {}"rootDirs": []"typeRoots": []"types": []"allowUmdGlobalAccess": true"moduleSuffixes": []"resolveJsonModule": true"noResolve": true"allowJs": true"checkJs": true"maxNodeModuleJsDepth": 1"declaration": true"declarationMap": true"emitDeclarationOnly": true"sourceMap": true"outFile": "./""outDir": "./""removeComments": true"noEmit": true"importHelpers": true"importsNotUsedAsValues": "remove""downlevelIteration": true"sourceRoot": """mapRoot": """inlineSourceMap": true"inlineSources": true"emitBOM": true"newLine": "crlf""stripInternal": true"noEmitHelpers": true"noEmitOnError": true"preserveConstEnums": true"declarationDir": "./""preserveValueImports": true"isolatedModules": true"allowSyntheticDefaultImports": true"esModuleInterop": true"preserveSymlinks": true"forceConsistentCasingInFileNames": true"strict": true"noImplicitAny": true"strictNullChecks": true"strictFunctionTypes": true"strictBindCallApply": true"strictPropertyInitialization": true"noImplicitThis": true"useUnknownInCatchVariables": true"alwaysStrict": true"noUnusedLocals": true"noUnusedParameters": true"exactOptionalPropertyTypes": true"noImplicitReturns": true"noFallthroughCasesInSwitch": true"noUncheckedIndexedAccess": true"noImplicitOverride": true"noPropertyAccessFromIndexSignature": true"allowUnusedLabels": true"allowUnreachableCode": true"skipDefaultLibCheck": true"skipLibCheck": true}
+}"
+`;

packages/plugin-typescript/tools/bin.ts

@@ -1,3 +1,6 @@
-import { updateKnownConfigMap } from './generate-ts-config';
+import {updateKnownConfigMap,} from './generate-ts-config.js';
 
-(async () => await updateKnownConfigMap())();
+// eslint-disable-next-line unicorn/prefer-top-level-await
+(async () => {
+  await updateKnownConfigMap();
+})();

packages/plugin-typescript/tools/generate-ts-config.integration.test.ts

@@ -20,10 +20,11 @@
 import { executeProcess } from '@push-based/nx-verdaccio/src/internal/execute-process';
 import { ensureDirectoryExists } from '@push-based/nx-verdaccio/src/internal/file-system';
 import { readdir, writeFile } from 'node:fs/promises';
+// eslint-disable-next-line unicorn/import-style
 import { basename, join } from 'node:path';
 import * as process from 'node:process';
 import type { CompilerOptions } from 'typescript';
-import { readJsonFile, readTextFile } from '@code-pushup/utils';
+import { readTextFile } from '@code-pushup/utils';
 
 export type SemVerString = `${number}.${number}.${number}`;
 
@@ -81,9 +82,10 @@ export async function updateKnownConfigMap() {
     version => !knownVersions.includes(version),
   );
 
-  console.log(
-    `generate TS config defaults for ${versionsToGenerate.length} versions`,
+  console.info(
+    `Generate TS config defaults for ${versionsToGenerate.length} versions: `,
   );
+  console.info(versionsToGenerate);
 
   await Promise.all(versionsToGenerate.map(saveDefaultTsConfig));
 }
@@ -94,7 +96,10 @@ export async function saveDefaultTsConfig(version: SemVerString) {
   await cleanupNpmCache(version);
   return writeFile(
     join(TS_CONFIG_DIR, `${version}.ts`),
-    `export default ${JSON.stringify(config, null, 2)}`,
+    [
+      `const config = ${JSON.stringify(config, null, 2)}`,
+      `export default config;`,
+    ].join('\n'),
   );
 }
 
@@ -118,18 +123,10 @@ export async function extractTsConfig(
   const dir = join(TMP_TS_CONFIG_DIR, version);
   await ensureDirectoryExists(dir);
   try {
-    const fileContent = await readTextFile(join(dir, 'tsconfig.json'));
-
-    await writeFile(
-      join(TMP_TS_CONFIG_DIR, version, `tsconfig.clean.json`),
-      prepareTsConfigFileContent(fileContent),
-    );
-    const stConfigJson = JSON.parse(prepareTsConfigFileContent(fileContent));
-
-    return stConfigJson;
-  } catch (e) {
+    return parseTsConfigJson(await readTextFile(join(dir, 'tsconfig.json')));
+  } catch (error) {
     throw new Error(
-      `Failed to extract tsconfig.json for version ${version}. \n ${(e as Error).message}`,
+      `Failed to extract tsconfig.json for version ${version}. \n ${(error as Error).message}`,
     );
   }
 }
@@ -170,9 +167,10 @@ export async function getRelevantVersions() {
   });
   const allVersions: SemVerString[] = JSON.parse(stdout);
   return allVersions.filter(version => {
-    const [major, minor, patch] = version.split('.').map(Number);
+    const [major = 0, minor = 0, patch = 0] = version.split('.').map(Number);
     return (
       major >= 1 &&
+      // eslint-disable-next-line @typescript-eslint/no-magic-numbers
       minor >= 6 &&
       patch >= 2 &&
       !version.includes('rc') &&
@@ -182,13 +180,19 @@ export async function getRelevantVersions() {
   });
 }
 
-export function prepareTsConfigFileContent(fileContent: string) {
+/**
+ * Parse the tsconfig.json file content into a CompilerOptions object.
+ * tsconfig.json files can have comments and trailing commas, which are not valid JSON.
+ * This function removes comments and trailing commas and parses the JSON.
+ * @param fileContent
+ */
+export function parseTsConfigJson(fileContent: string) {
   const parsedFileContent = fileContent
+    .trim()
     .split('\n')
     .map(line =>
       line
         // replace all /**/ comments with empty string
-        .replace(/\r/g, '')
         .replace(/\/\*.*\*\//g, '')
         // replace all // strings with empty string
         .replace(/\/\//g, '')
@@ -197,16 +201,17 @@ export function prepareTsConfigFileContent(fileContent: string) {
         .trim(),
     )
     .filter(s => s !== '')
+    // missing comma dua to newly uncommented lines
     .map(s => {
-      // if it is a property with a value, check if there is a comma at the end
-      if (s.match(/:\s*[^,\n\r]*$/)) {
+      // if is si noa a opening or closing  object bracket "{" or "}"
+      if (!/[{}[]$/.test(s)) {
+        // add a comma at the end it is missing
         return s.replace(/:\s*([^,]*)$/, ': $1,');
       }
       return s;
     })
     .join('')
-    // last camma is not allowed
+    // remove dangling commas
     .replace(/,\s*}/gm, '}');
-
-  return parsedFileContent;
+  return JSON.parse(parsedFileContent) as CompilerOptions;
 }

packages/plugin-typescript/tools/generate-ts-config.ts

@@ -1,14 +1,54 @@
 import { describe, expect, it } from 'vitest';
-import { prepareTsConfigFileContent } from './generate-ts-config.js';
+import { parseTsConfigJson } from './generate-ts-config.js';
+
+describe('parseTsConfigJson', () => {
+  it('should work', async () => {
+    const testContent = `{
+  "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. */
+
+    /* Type Checking */
+    "strict": true,                                      /* Enable all strict type-checking options. */
+    // "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied 'any' type. */
+
+    /* Completeness */
+    // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
+    "skipLibCheck": true                                 /* Skip type checking all .d.ts files. */
+    // "preserveConstEnums": true,                      /* ... */
+  }
+}`;
+    expect(parseTsConfigJson(testContent)).toStrictEqual({
+      compilerOptions: {
+        incremental: true,
+        composite: true,
+        tsBuildInfoFile: './.tsbuildinfo',
+        disableSourceOfProjectReferenceRedirect: true,
+        disableSolutionSearching: true,
+        disableReferencedProjectLoad: true,
+        strict: true,
+        noImplicitAny: true,
+        skipDefaultLibCheck: true,
+        skipLibCheck: true,
+        preserveConstEnums: true,
+      },
+    });
+  });
 
-describe('prepareTsConfigFileContent', () => {
   it('should remove empty lines', async () => {
     const testContent = `
     {
 
 }
 `;
-    expect(prepareTsConfigFileContent(testContent)).toBe(`{}`);
+    expect(parseTsConfigJson(testContent)).toStrictEqual({});
   });
 
   it('should remove block comments', async () => {
@@ -17,23 +57,37 @@ describe('prepareTsConfigFileContent', () => {
 /* property block comment */
 "prop": 42, /* value block comment */
 }`;
-    expect(prepareTsConfigFileContent(testContent)).toBe(`{"prop": 42}`);
+    expect(parseTsConfigJson(testContent)).toStrictEqual({ prop: 42 });
   });
 
   it('should remove line comments characters', async () => {
     const testContent = `{
 // "prop": 42,
 }`;
-    expect(prepareTsConfigFileContent(testContent)).toBe(`{"prop": 42}`);
+    expect(parseTsConfigJson(testContent)).toStrictEqual({ prop: 42 });
   });
 
   it('should add missing comma for existing properties before a inline comment property', async () => {
     const testContent = `{
       "pro1": 42
 // "prop2": "value"
 }`;
-    expect(prepareTsConfigFileContent(testContent)).toBe(
-      `{"pro1": 42,"prop2": "value"}`,
-    );
+    expect(parseTsConfigJson(testContent)).toStrictEqual({
+      pro1: 42,
+      prop2: 'value',
+    });
+  });
+
+  it('should not comma for opening objects "{"', async () => {
+    const testContent = `{
+"compilerOptions": {
+// "prop2": [
+"value"
+]
+}
+}`;
+    expect(parseTsConfigJson(testContent)).toStrictEqual({
+      compilerOptions: { prop2: ['value'] },
+    });
   });
 });