wip

BioPhoton · BioPhoton · commit c150de0c073f · 2024-12-28T18:20:32.000+01:00
diff --git a/e2e/plugin-typescript-e2e/eslint.config.js b/e2e/plugin-typescript-e2e/eslint.config.js
@@ -0,0 +1,12 @@
+import tseslint from 'typescript-eslint';
+import baseConfig from '../../eslint.config.js';
+
+export default tseslint.config(...baseConfig, {
+  files: ['**/*.ts'],
+  languageOptions: {
+    parserOptions: {
+      projectService: true,
+      tsconfigRootDir: import.meta.dirname,
+    },
+  },
+});
diff --git a/e2e/plugin-typescript-e2e/mocks/fixtures/default-setup/src/strict-errors.ts b/e2e/plugin-typescript-e2e/mocks/fixtures/default-setup/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/e2e/plugin-typescript-e2e/mocks/fixtures/default-setup/tsconfig.json b/e2e/plugin-typescript-e2e/mocks/fixtures/default-setup/tsconfig.json
@@ -0,0 +1,8 @@
+{
+  "compilerOptions": {
+    "rootDir": "./src",
+    "target": "ES6",
+    "module": "CommonJS"
+  },
+  "include": ["src/**/*.ts"],
+}
diff --git a/e2e/plugin-typescript-e2e/project.json b/e2e/plugin-typescript-e2e/project.json
@@ -0,0 +1,23 @@
+{
+  "name": "plugin-typescript-e2e",
+  "$schema": "../../node_modules/nx/schemas/project-schema.json",
+  "sourceRoot": "e2e/plugin-typescript-e2e/src",
+  "projectType": "application",
+  "targets": {
+    "lint": {
+      "executor": "@nx/linter:eslint",
+      "outputs": ["{options.outputFile}"],
+      "options": {
+        "lintFilePatterns": ["e2e/plugin-typescript-e2e/**/*.ts"]
+      }
+    },
+    "e2e": {
+      "executor": "@nx/vite:test",
+      "options": {
+        "configFile": "e2e/plugin-typescript-e2e/vite.config.e2e.ts"
+      }
+    }
+  },
+  "implicitDependencies": ["cli", "plugin-typescript"],
+  "tags": ["scope:plugin", "type:e2e"]
+}
diff --git a/e2e/plugin-typescript-e2e/tests/collect.e2e.test.ts b/e2e/plugin-typescript-e2e/tests/collect.e2e.test.ts
@@ -0,0 +1,45 @@
+import {cp} from 'node:fs/promises';
+import path from 'node:path';
+import {afterAll, beforeAll, expect} from 'vitest';
+import {nxTargetProject} from '@code-pushup/test-nx-utils';
+import {teardownTestFolder} from '@code-pushup/test-setup';
+import {E2E_ENVIRONMENTS_DIR, removeColorCodes, TEST_OUTPUT_DIR,} from '@code-pushup/test-utils';
+import {executeProcess, readJsonFile} from '@code-pushup/utils';
+import {getCurrentTsVersion} from "@code-pushup/typescript-plugin";
+
+describe('PLUGIN collect report with typescript-plugin NPM package', () => {
+  const testFileDir = path.join(
+    E2E_ENVIRONMENTS_DIR,
+    nxTargetProject(),
+    TEST_OUTPUT_DIR,
+    'collect',
+  );
+  const defaultSetupDir = path.join(testFileDir, 'default-setup');
+
+  const fixturesDir = path.join('e2e', nxTargetProject(), 'mocks/fixtures');
+
+  beforeAll(async () => {
+    await cp(fixturesDir, testFileDir, {recursive: true});
+  });
+
+  afterAll(async () => {
+    await teardownTestFolder(testFileDir);
+  });
+
+  it('should run plugin over CLI and creates report.json', async () => {
+    const {code, stdout} = await executeProcess({
+      command: 'npx',
+      // verbose exposes audits with perfect scores that are hidden in the default stdout
+      args: ['@code-pushup/cli', 'collect', '--no-progress', '--verbose'],
+      cwd: defaultSetupDir,
+    });
+
+    expect(code).toBe(0);
+    const cleanStdout = removeColorCodes(stdout);
+    expect(cleanStdout).toContain('● NoImplicitAny');
+
+    await expect(readJsonFile(
+      path.join('node_modules', '.code-pushup', 'plugin-typescript', 'default-ts-configs', await getCurrentTsVersion()),
+    )).resolves.not.toThrow();
+  });
+});
diff --git a/e2e/plugin-typescript-e2e/tsconfig.json b/e2e/plugin-typescript-e2e/tsconfig.json
@@ -0,0 +1,20 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "module": "ESNext",
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "noImplicitOverride": true,
+    "noPropertyAccessFromIndexSignature": true,
+    "noImplicitReturns": true,
+    "noFallthroughCasesInSwitch": true,
+    "types": ["vitest"]
+  },
+  "files": [],
+  "include": [],
+  "references": [
+    {
+      "path": "./tsconfig.test.json"
+    }
+  ]
+}
diff --git a/e2e/plugin-typescript-e2e/tsconfig.test.json b/e2e/plugin-typescript-e2e/tsconfig.test.json
@@ -0,0 +1,14 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../dist/out-tsc",
+    "types": ["vitest/globals", "vitest/importMeta", "vite/client", "node"],
+    "target": "ES2020"
+  },
+  "include": [
+    "vite.config.e2e.ts",
+    "tests/**/*.e2e.test.ts",
+    "tests/**/*.d.ts",
+    "mocks/**/*.ts"
+  ]
+}
diff --git a/e2e/plugin-typescript-e2e/vite.config.e2e.ts b/e2e/plugin-typescript-e2e/vite.config.e2e.ts
@@ -0,0 +1,21 @@
+/// <reference types="vitest" />
+import { defineConfig } from 'vite';
+import { tsconfigPathAliases } from '../../tools/vitest-tsconfig-path-aliases.js';
+
+export default defineConfig({
+  cacheDir: '../../node_modules/.vite/plugin-typescript-e2e',
+  test: {
+    reporters: ['basic'],
+    testTimeout: 120_000,
+    globals: true,
+    alias: tsconfigPathAliases(),
+    pool: 'threads',
+    poolOptions: { threads: { singleThread: true } },
+    cache: {
+      dir: '../../node_modules/.vitest',
+    },
+    environment: 'node',
+    include: ['tests/**/*.e2e.test.{js,mjs,cjs,ts,mts,cts,jsx,tsx}'],
+    setupFiles: ['../../testing/test-setup/src/lib/reset.mocks.ts'],
+  },
+});
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -27,7 +27,7 @@
     "@code-pushup/portal-client": "^0.9.0",
     "@isaacs/cliui": "^8.0.2",
     "@nx/devkit": "19.8.13",
-    "@poppinss/cliui": "^6.4.2",
+    "@poppinss/cliui": "^6.4.1",
     "@swc/helpers": "0.5.13",
     "ansis": "^3.3.2",
     "build-md": "^0.4.2",
diff --git a/packages/plugin-typescript/src/index.ts b/packages/plugin-typescript/src/index.ts
@@ -2,5 +2,6 @@ import { typescriptPlugin } from './lib/typescript-plugin.js';
 
 export { TYPESCRIPT_PLUGIN_SLUG } from './lib/constants.js';
 export type { TypescriptPluginOptions } from './lib/types.js';
+export {getCurrentTsVersion} from "./lib/runner/utils.js";
 export { typescriptPlugin } from './lib/typescript-plugin.js';
 export default typescriptPlugin;
diff --git a/packages/plugin-typescript/src/lib/normalize-compiler-options.ts b/packages/plugin-typescript/src/lib/normalize-compiler-options.ts
@@ -0,0 +1,44 @@
+import type {TypescriptPluginOptions} from "./types.js";
+import {loadTargetConfig, loadTsConfigDefaultsByVersion} from "./runner/utils.js";
+import type {CompilerOptions} from "typescript";
+import {TS_ERROR_CODES} from "./runner/ts-error-codes.js";
+
+/**
+ * It will evaluate if the option strict is enabled. If so, it must enable all it's dependencies.
+ * [Logic Reference](https://github.com/microsoft/TypeScript/blob/56a08250f3516b3f5bc120d6c7ab4450a9a69352/src/compiler/utilities.ts#L9262)
+ * @param options Current compiler options
+ * @returns CompilerOptions evaluated.
+ */
+export function handleCompilerOptionStrict(options: CompilerOptions) {
+  if (!options.strict) {
+    return options;
+  }
+
+  const strictOptions = Object.fromEntries(
+    Object.keys(TS_ERROR_CODES.strict).map(key => [key, true]),
+  ) as CompilerOptions;
+
+  return {
+    ...options,
+    ...strictOptions,
+  };
+}
+
+/**
+ * It will from the options, and the TS Version, get a final compiler options to be used later for filters
+ * Once it's processed for the first time, it will store the information in a variable, to be retrieve
+ * later if existing
+ * @param options Plugin options
+ */
+export async function normalizeCompilerOptions(
+  options: Required<Pick<TypescriptPluginOptions, 'tsConfigPath'>>,
+) {
+  const {tsConfigPath} = options;
+  const {compilerOptions: defaultCompilerOptions} =
+    await loadTsConfigDefaultsByVersion();
+  const {options: targetCompilerOptions} = await loadTargetConfig(tsConfigPath);
+  return handleCompilerOptionStrict({
+    ...defaultCompilerOptions,
+    ...targetCompilerOptions,
+  });
+}
diff --git a/packages/plugin-typescript/src/lib/normalize-compiler-options.unit-test.ts b/packages/plugin-typescript/src/lib/normalize-compiler-options.unit-test.ts
@@ -0,0 +1,66 @@
+import type {CompilerOptions} from 'typescript';
+import {describe, expect, it} from 'vitest';
+import {handleCompilerOptionStrict, normalizeCompilerOptions} from "./normalize-compiler-options.js";
+
+describe('handleCompilerOptionStrict', () => {
+  it('should return original options when strict is false', () => {
+    const options: CompilerOptions = {
+      strict: false,
+    };
+
+    const result = handleCompilerOptionStrict(options);
+    expect(result).toBe(options);
+  });
+
+  it('should add all strict options when strict is true', () => {
+    const options: CompilerOptions = {
+      strict: true,
+    };
+
+    const result = handleCompilerOptionStrict(options);
+
+    expect(result).toStrictEqual({
+      ...options,
+      noImplicitAny: true,
+      noImplicitThis: true,
+      alwaysStrict: true,
+      strictBuiltinIteratorReturn: true,
+      strictPropertyInitialization: true,
+      strictNullChecks: true,
+      strictBindCallApply: true,
+      strictFunctionTypes: true,
+    });
+  });
+
+  it('should add all strict options when strict is true and override existing value', () => {
+    const options: CompilerOptions = {
+      strict: true,
+      noImplicitAny: false,
+    };
+
+    const result = handleCompilerOptionStrict(options);
+
+    expect(result.noImplicitAny).toBe(true);
+  });
+
+  it('should preserve existing option values while adding strict options', () => {
+    const options: CompilerOptions = {
+      strict: true,
+      target: 2,
+      verbatimModuleSyntax: false,
+    };
+
+    const result = handleCompilerOptionStrict(options);
+
+    expect(result.strict).toBe(true);
+    expect(result.target).toBe(2);
+    expect(result.verbatimModuleSyntax).toBe(false);
+  });
+});
+
+
+describe('normalizeCompilerOptions', () => {
+  it.todo('should return default compiler options from provided file', async () => {
+    expect(await normalizeCompilerOptions({tsConfigPath: ''})).toStrictEqual({}) ;
+  })
+})
diff --git a/packages/plugin-typescript/src/lib/typescript-plugin.ts b/packages/plugin-typescript/src/lib/typescript-plugin.ts
@@ -6,20 +6,20 @@ import type { TypescriptPluginOptions } from './types.js';
 import {
   getAudits,
   getGroups,
-  normalizeCompilerOptions,
-  validateAudits,
+  logSkippedAudits,
 } from './utils.js';
+import {normalizeCompilerOptions} from "./normalize-compiler-options.js";
 
 export async function typescriptPlugin(
   options?: TypescriptPluginOptions,
 ): Promise<PluginConfig> {
   const { tsConfigPath } = options ?? { tsConfigPath: DEFAULT_TS_CONFIG };
 
-  const compilerOptions = await normalizeCompilerOptions(options);
+  const compilerOptions = await normalizeCompilerOptions({tsConfigPath});
   const filteredAudits = getAudits(compilerOptions, options);
   const filteredGroups = getGroups(compilerOptions, options);
 
-  validateAudits(filteredAudits);
+  logSkippedAudits(filteredAudits);
 
   return {
     slug: TYPESCRIPT_PLUGIN_SLUG,
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
diff --git a/tsconfig.base.json b/tsconfig.base.json
