feat: add ts config default generator

Author: BioPhoton

code-pushup.config.ts

@@ -42,5 +42,6 @@ export default mergeConfigs(
   await eslintCoreConfigNx(),
   await typescriptPluginConfigNx({
     tsConfigPath: 'packages/plugin-typescript/tsconfig.lib.json',
+    // onlyAudits: ['verbatim-module-syntax-typescript']
   }),
 );

packages/plugin-typescript/mocks/fixtures/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/project.json

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

packages/plugin-typescript/tools/bin.ts

@@ -0,0 +1,3 @@
+import { updateKnownConfigMap } from './generate-ts-config';
+
+(async () => await updateKnownConfigMap())();

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

@@ -0,0 +1,13 @@
+import { join } from 'node:path';
+import { describe, expect, it } from 'vitest';
+import { readTextFile } from '@code-pushup/utils';
+import { prepareTsConfigFileContent } from './generate-ts-config.js';
+
+describe('prepareTsConfigFileContent', () => {
+  it('should parse tsconfig.json created from init command', async () => {
+    const testContent = await readTextFile(
+      join('./packages/plugin-typescript/mocks/fixtures', 'tsconfig.init.json'),
+    );
+    expect(prepareTsConfigFileContent(testContent)).toMatchSnapshot();
+  });
+});

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

@@ -0,0 +1,212 @@
+// Run typescript init (with a version specified) to generate a tsconfig.json that will have all defaults listed.
+// store this json per ts version in src/default-configs.ts
+// get a list of TS version, maybe from npm and somehow filter only versions
+
+/*
+0. In a chron job on GitHub
+1. Load known config defaults for TS versions from the `src/lib/ts-config` folder. The files are named after the TS version e.g. `1.4.2.ts`.
+2. Load all existing ts versions from NPM. `npm view typescript versions --json`
+2.1. filter for relevant releases `relevantVersions` (only 3 version segments e.g. `3.4.1`):
+  - start from `1.6.2` as before that there was no init
+  - skip all pre-release versions: like `3.5.0-dev.20190404`, `3.6.3-insiders.20190909`, and release candidates like `3.6.1-rc`
+3. Iterate over `version` in `relevantVersions`
+3.1. If the `version` is present in `knownConfigMap` continue
+3.2 Else, run `npx -y -p=typescript@<version> tsc --init`
+3.3 If the config is identical to the previous version stored in `knownConfigMap` continue
+3.4 Else, extract the json form the generated `tsconfig.json` and store data under `version` in `knownConfigMap`
+4. Optional cleanup run `npm uninstall typescript@5.4.2 -g`
+5. Save new known configs into `src/lib/ts-config-per-version.ts`
+*/
+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';
+import { basename, join } from 'node:path';
+import * as process from 'node:process';
+import type { CompilerOptions } from 'typescript';
+import { readJsonFile, readTextFile } from '@code-pushup/utils';
+
+export type SemVerString = `${number}.${number}.${number}`;
+
+export const TS_CONFIG_DIR = join(
+  'packages',
+  'plugin-typescript',
+  'src',
+  'lib',
+  'default-ts-configs',
+);
+export const TMP_TS_CONFIG_DIR = join('tmp', 'plugin-typescript-ts-config');
+
+/**
+ * As typescript does not expose a way to get the default config, we need to maintain them programmatically.
+ * To save memory and have a cleaner git diff we store the configs per version in separate files.
+ *
+ * Folder structure
+ *
+ * src/lib/ts-config
+ * ├── 1.4.2.ts
+ * ├── 1.4.3.ts
+ * ├── ....ts
+ *
+ * @example
+ * // src/lib/ts-config/1.4.2.ts
+ *
+ * export default {
+ *  "compilerOptions": {
+ *  "target": "es5",
+ *  "module": "commonjs",
+ *  "outDir": "./dist",
+ *  "rootDir": "./src",
+ *  "strict": true,
+ *  "esModuleInterop": true,
+ *  "skipLibCheck": true,
+ *  }
+ * }
+ */
+
+/**
+ * Iterate over `version` in `relevantVersions`
+ * If the `version` is present in `knownConfigMap` continue
+ * Else, run `npx -y -p=typescript@<version> tsc --init`
+ * If the config is identical to the previous version stored in `knownConfigMap` continue
+ * Else, extract the json form the generated `tsconfig.json` and store data under `version` in `knownConfigMap`
+ * Optional cleanup run `npm uninstall typescript@5.4.2 -g`
+ *
+ * @param version
+ * @param config
+ */
+export async function updateKnownConfigMap() {
+  const knownVersions = await loadKnownVersions();
+  const relevantVersions = await getRelevantVersions();
+  const versionsToGenerate = relevantVersions.filter(
+    version => !knownVersions.includes(version),
+  );
+
+  console.log(
+    `generate TS config defaults for ${versionsToGenerate.length} versions`,
+  );
+
+  await Promise.all(versionsToGenerate.map(saveDefaultTsConfig));
+}
+
+export async function saveDefaultTsConfig(version: SemVerString) {
+  await generateTsConfigFile(version);
+  const config = await extractTsConfig(version);
+  await cleanupNpmCache(version);
+  return writeFile(
+    join(TS_CONFIG_DIR, `${version}.ts`),
+    `export default ${JSON.stringify(config, null, 2)}`,
+  );
+}
+
+export async function generateTsConfigFile(version: SemVerString) {
+  const dir = join(TMP_TS_CONFIG_DIR, version);
+  await ensureDirectoryExists(dir);
+  await executeProcess({
+    command: 'npx',
+    args: ['-y', `-p=typescript@${version}`, 'tsc', '--init'],
+    cwd: dir,
+  });
+}
+
+/**
+ * Extract the json form the generated `tsconfig.json` and store data under `version` in `knownConfigMap`
+ * @param version
+ */
+export async function extractTsConfig(
+  version: SemVerString,
+): Promise<CompilerOptions> {
+  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) {
+    throw new Error(
+      `Failed to extract tsconfig.json for version ${version}. \n ${(e as Error).message}`,
+    );
+  }
+}
+
+/**
+ * Cleanup run `npm uninstall typescript@5.4.2 -g`
+ * @param version
+ */
+export async function cleanupNpmCache(version: SemVerString) {
+  await executeProcess({
+    command: 'npm',
+    args: ['uninstall', `typescript@${version}`, '-g'],
+  });
+}
+
+/**
+ * Load known config defaults for TS versions from the `src / lib / ts - config` folder. The files are named after the TS version e.g. `1.4.2.ts`.
+ */
+export async function loadKnownVersions() {
+  await ensureDirectoryExists(TS_CONFIG_DIR);
+  // load known config defaults for TS versions from the `src / lib / ts - config` folder. The files are named after the TS version e.g. `1.4.2.ts`.
+  const dirContent = await readdir(join(process.cwd(), TS_CONFIG_DIR));
+  return dirContent.map(
+    file => basename(file).replace('.ts', '') as SemVerString,
+  );
+}
+
+/**
+ * Loads all existing TS versions from NPM via `npm view typescript versions--json`.
+ * Filter for relevant releases `relevantVersions` (only 3 version segments e.g. `3.4.1`):
+ *   - start from `1.6.2` as before that there was no init
+ *   - skip all pre-release versions: like `3.5.0 - dev.20190404`, `3.6.3 - insiders.20190909`, and release candidates like `3.6.1 - rc`
+ */
+export async function getRelevantVersions() {
+  const { stdout } = await executeProcess({
+    command: 'npm',
+    args: ['view', 'typescript', 'versions', '--json'],
+  });
+  const allVersions: SemVerString[] = JSON.parse(stdout);
+  return allVersions.filter(version => {
+    const [major, minor, patch] = version.split('.').map(Number);
+    return (
+      major >= 1 &&
+      minor >= 6 &&
+      patch >= 2 &&
+      !version.includes('rc') &&
+      !version.includes('dev') &&
+      !version.includes('insiders')
+    );
+  });
+}
+
+export function prepareTsConfigFileContent(fileContent: string) {
+  const parsedFileContent = fileContent
+    .split('\n')
+    .map(line =>
+      line
+        // replace all /**/ comments with empty string
+        .replace(/\r/g, '')
+        .replace(/\/\*.*\*\//g, '')
+        // replace all // strings with empty string
+        .replace(/\/\//g, '')
+        .replace(/:\s*([^,\n\r]*)\s*\/\/.*$/gm, ': $1')
+        .replace(/,(\s*[}\]])/gm, '$1')
+        .trim(),
+    )
+    .filter(s => s !== '')
+    .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]*$/)) {
+        return s.replace(/:\s*([^,]*)$/, ': $1,');
+      }
+      return s;
+    })
+    .join('')
+    // last camma is not allowed
+    .replace(/,\s*}/gm, '}');
+
+  return parsedFileContent;
+}