feat: use jiti for plugin loading #1228

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft

BioPhoton wants to merge 55 commits into main from feat/jiti-module-loading

package-lock.json

Large diffs are not rendered by default.

package.json

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -74,12 +74,13 @@
  
        "@types/benchmark": "^2.1.5",

        "@types/debug": "^4.1.12",

        "@types/eslint": "^8.44.2",

        "@types/jsdom": "^27.0.0",

        "@types/node": "^22.13.4",

        "@types/react": "18.3.1",

        "@types/react-dom": "18.3.0",

        "@vitejs/plugin-react": "^5.0.0",

        "@vitest/coverage-v8": "1.3.1",

        "@vitest/eslint-plugin": "^1.1.38",

        "@vitest/eslint-plugin": "^1.6.6",

        "@vitest/ui": "1.3.1",

        "benchmark": "^2.1.4",

        "chrome-launcher": "^1.1.2",

    @@ -102,7 +103,7 @@
  
        "husky": "^8.0.0",

        "inquirer": "^9.3.7",

        "jest-extended": "^6.0.0",

        "jiti": "2.4.2",

        "jiti": "^2.4.2",

        "jsdom": "~24.0.0",

        "jsonc-eslint-parser": "^2.4.0",

        "knip": "^5.33.3",

packages/cli/mocks/configs/code-pushup.config.js

-Original file line number
+Diff line change
@@ -0,0 +1,43 @@
+    export default {
+      upload: {
+        organization: 'code-pushup',
+        project: 'cli-js',
+        apiKey: 'e2e-api-key',
+        server: 'https://e2e.com/api',
+      },
+      categories: [
+        {
+          slug: 'category-1',
+          title: 'Category 1',
+          refs: [
+            {
+              type: 'audit',
+              plugin: 'node',
+              slug: 'node-version',
+              weight: 1,
+            },
+          ],
+        },
+      ],
+      plugins: [
+        {
+          audits: [
+            {
+              slug: 'node-version',
+              title: 'Node version',
+              description: 'prints node version to file',
+              docsUrl: 'https://nodejs.org/',
+            },
+          ],
+          runner: {
+            command: 'node',
+            args: ['-v'],
+            outputFile: 'output.json',
+          },
+          groups: [],
+          slug: 'node',
+          title: 'Node.js',
+          icon: 'javascript',
+        },
+      ],
+    };

packages/cli/mocks/configs/code-pushup.config.mjs

-Original file line number
+Diff line change
@@ -0,0 +1,43 @@
+    export default {
+      upload: {
+        organization: 'code-pushup',
+        project: 'cli-mjs',
+        apiKey: 'e2e-api-key',
+        server: 'https://e2e.com/api',
+      },
+      categories: [
+        {
+          slug: 'category-1',
+          title: 'Category 1',
+          refs: [
+            {
+              type: 'audit',
+              plugin: 'node',
+              slug: 'node-version',
+              weight: 1,
+            },
+          ],
+        },
+      ],
+      plugins: [
+        {
+          audits: [
+            {
+              slug: 'node-version',
+              title: 'Node version',
+              description: 'prints node version to file',
+              docsUrl: 'https://nodejs.org/',
+            },
+          ],
+          runner: {
+            command: 'node',
+            args: ['-v'],
+            outputFile: 'output.json',
+          },
+          groups: [],
+          slug: 'node',
+          title: 'Node.js',
+          icon: 'javascript',
+        },
+      ],
+    };

packages/cli/mocks/configs/code-pushup.config.ts

-Original file line number
+Diff line change
@@ -0,0 +1,43 @@
+    export default {
+      upload: {
+        organization: 'code-pushup',
+        project: 'cli-ts',
+        apiKey: 'e2e-api-key',
+        server: 'https://e2e.com/api',
+      },
+      categories: [
+        {
+          slug: 'category-1',
+          title: 'Category 1',
+          refs: [
+            {
+              type: 'audit',
+              plugin: 'node',
+              slug: 'node-version',
+              weight: 1,
+            },
+          ],
+        },
+      ],
+      plugins: [
+        {
+          audits: [
+            {
+              slug: 'node-version',
+              title: 'Node version',
+              description: 'prints node version to file',
+              docsUrl: 'https://nodejs.org/',
+            },
+          ],
+          runner: {
+            command: 'node',
+            args: ['-v'],
+            outputFile: 'output.json',
+          },
+          groups: [],
+          slug: 'node',
+          title: 'Node.js',
+          icon: 'javascript',
+        },
+      ],
+    };

packages/cli/mocks/configs/code-pushup.needs-tsconfig.config.ts

-Original file line number
+Diff line change
@@ -0,0 +1,8 @@
+    // the point is to test runtime import which requires tsconfig for path aliases
+    import customPlugin from '@example/custom-plugin';
+    const config = {
+      plugins: [customPlugin],
+    };
+    export default config;

packages/cli/mocks/configs/custom-plugin.ts

-Original file line number
+Diff line change
@@ -0,0 +1,24 @@
+    const customPluginConfig = {
+      slug: 'good-feels',
+      title: 'Good feels',
+      icon: 'javascript',
+      audits: [
+        {
+          slug: 'always-perfect',
+          title: 'Always perfect',
+        },
+      ],
+      runner: () => [
+        {
+          slug: 'always-perfect',
+          score: 1,
+          value: 100,
+          displayValue: '✅ Perfect! 👌',
+        },
+      ],
+    };
+    export function customPlugin() {
+      return customPluginConfig;
+    }
+    export default customPluginConfig;

packages/cli/mocks/configs/tsconfig.json

-Original file line number
+Diff line change
@@ -0,0 +1,11 @@
+    {
+      "compilerOptions": {
+        "baseUrl": ".",
+        "allowImportingTsExtensions": true,
+        "moduleResolution": "node",
+        "paths": {
+          "@example/custom-plugin": ["./custom-plugin.ts"]
+        }
+      },
+      "include": ["*.ts"]
+    }

packages/cli/mocks/core-config-middleware.int-helper.ts

-Original file line number
+Diff line change
@@ -0,0 +1,35 @@
+    import { coreConfigMiddleware } from '../src/lib/implementation/core-config.middleware.js';
+    // Suppress all console output except our JSON
+    const originalStdoutWrite = process.stdout.write.bind(process.stdout);
+    const originalStderrWrite = process.stderr.write.bind(process.stderr);
+    process.stdout.write = () => true;
+    process.stderr.write = () => true;
+    const CLI_DEFAULTS = {
+      plugins: [],
+      onlyPlugins: [],
+      skipPlugins: [],
+    };
+    const configPath = process.argv[2];
+    if (!configPath) {
+      process.stderr.write = originalStderrWrite;
+      process.stderr.write('Error: Config path argument is required\n');
+      process.exit(1);
+    }
+    const tsconfigPath = process.argv[3];
+    const result = await coreConfigMiddleware({
+      config: configPath, // relative path from cwd
+      ...(tsconfigPath ? { tsconfig: tsconfigPath } : {}),
+      // If no tsconfig provided, should fallback to ./tsconfig.json
+      ...CLI_DEFAULTS,
+    });
+    // Restore stdout and stderr, then write only JSON
+    process.stdout.write = originalStdoutWrite;
+    process.stderr.write = originalStderrWrite;
+    process.stdout.write(JSON.stringify({ success: true, config: result.config }));

packages/cli/src/lib/implementation/core-config.middleware.int.test.ts

-Original file line number
+Diff line change
@@ -1,5 +1,6 @@
     import path from 'node:path';
     import { fileURLToPath } from 'node:url';
+    import { executeProcess } from '@code-pushup/utils';
     import { coreConfigMiddleware } from './core-config.middleware.js';
     const configDirPath = path.join(
@@ Expand All / @@ -8,15 +9,31 @@ const configDirPath = path.join( @@
       '..',
       '..',
       '..',
-      '..',
-      'testing',
-      'test-fixtures',
-      'src',
-      'lib',
-      'fixtures',
+      'cli',
+      'mocks',
       'configs',
     );
+    const helperPath = path.join(
+      fileURLToPath(path.dirname(import.meta.url)),
+      '..',
+      '..',
+      '..',
+      '..',
+      'cli',
+      'mocks',
+      'core-config-middleware.int-helper.ts',
+    );
+    const runMiddlewareInCwd = async (configPath: string, tsconfigPath?: string) =>
+      await executeProcess({
+        command: 'npx',
+        args: [
+          'tsx',
+          helperPath,
+          configPath,
+          ...(tsconfigPath ? [tsconfigPath] : []),
+        ],
+        cwd: configDirPath,
+      });
     describe('coreConfigMiddleware', () => {
       const CLI_DEFAULTS = {
         plugins: [],
@@ Expand All / @@ -43,16 +60,17 @@ describe('coreConfigMiddleware', () => { @@
       });
       it('should load config which relies on provided --tsconfig', async () => {
-        await expect(
-          coreConfigMiddleware({
-            config: path.join(
-              configDirPath,
-              'code-pushup.needs-tsconfig.config.ts',
-            ),
-            tsconfig: path.join(configDirPath, 'tsconfig.json'),
-            ...CLI_DEFAULTS,
-          }),
-        ).resolves.toBeTruthy();
+        const { stdout, code } = await runMiddlewareInCwd(
+          'code-pushup.needs-tsconfig.config.ts',
+          path.join(configDirPath, 'tsconfig.json'),
+        );
+        expect(code).toBe(0);
+        const output = JSON.parse(stdout);
+        expect(output).toStrictEqual({
+          success: true,
+          config: expect.any(String),
+        });
       });
       it('should throw if --tsconfig is missing but needed to resolve import', async () => {
@@ Expand Down @@

packages/core/src/lib/implementation/read-rc-file.ts

-Original file line number
+Diff line change
@@ Expand Up / @@ -27,7 +27,6 @@ export async function readRcByPath( @@
           const result = await importModule({
             filepath: filePath,
             tsconfig,
-            format: 'esm',
           });
           return { result, message: `Imported config from ${formattedTarget}` };
         },
@@ Expand Down @@

packages/core/src/lib/implementation/read-rc-file.unit.test.ts

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -3,32 +3,33 @@ import { CONFIG_FILE_NAME, type CoreConfig } from '@code-pushup/models';
  
    import { MEMFS_VOLUME } from '@code-pushup/test-utils';

    import { autoloadRc } from './read-rc-file.js';

    // mock bundleRequire inside importEsmModule used for fetching config

    vi.mock('bundle-require', async () => {

    // mock importModule from @code-pushup/utils used for fetching config

    vi.mock('@code-pushup/utils', async () => {

      const utils =

        await vi.importActual<typeof import('@code-pushup/utils')>(

          '@code-pushup/utils',

        );

      const { CORE_CONFIG_MOCK }: Record<string, CoreConfig> =

        await vi.importActual('@code-pushup/test-fixtures');

      return {

        bundleRequire: vi

        ...utils,

        importModule: vi

          .fn()

          .mockImplementation((options: { filepath: string }) => {

          .mockImplementation(async (options: { filepath: string }) => {

            const extension = options.filepath.split('.').at(-1);

            return {

              mod: {

                default: {

                  ...CORE_CONFIG_MOCK,

                  upload: {

                    ...CORE_CONFIG_MOCK?.upload,

                    project: extension, // returns loaded file extension to check format precedence

                  },

                },

              ...CORE_CONFIG_MOCK,

              upload: {

                ...CORE_CONFIG_MOCK?.upload,

                project: extension, // returns loaded file extension to check format precedence

              },

            };

          }),

      };

    });

    // Note: memfs files are only listed to satisfy a system check, value is used from bundle-require mock

    // Note: memfs files are only listed to satisfy a system check, value is used from importModule mock

    describe('autoloadRc', () => {

      it('prioritise a .ts configuration file', async () => {

        vol.fromJSON(

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: use jiti for plugin loading #1228

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Uh oh!

Uh oh!

feat: use jiti for plugin loading #1228

Are you sure you want to change the base?

Uh oh!

feat: use jiti for plugin loading #1228

Uh oh!

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Uh oh!

Uh oh!