Whitelist for 'Module "..." has been externalized for...' warning

[sevenc-nanashi]

Description

I have an electron app that has helpers/logger.ts, a logger which is usable and imported from both electron and browser.
The file is like this:

let electronLog;

export function log(message: string) {
  if (isBrowser) {
    console.log(message);
  } else if (isElectron) {
    if (!electronLog) {
      electronLog = import("electron-log/main");
    }
    electronLog.then((log) => {
      log.log(message)
    });
  }
}

In this module, electron-log, a Node.js only package, is imported dynamically, and I know electron-log and its dependent Node.js modules are not used on browser.

But vite still warns about that Node.js modules are externalized.

Suggested solution

It would be great if there is option (or possible directive) to mute that warning.

// By option (vite.config.ts)
export default defineConfig({
  resolve: {
    expectNodeModule: ["electron-log"]
  },
})

// By directive
electronLog = /** vite:expect-node-module */ import("electron-log");

Alternative

Or mute all externalization warning (But this is scary)

Additional context

N/A

Validations

• Follow our Code of Conduct
• Read the Contributing Guidelines.
• Read the docs.
• Check that there isn't already an issue that request the same feature to avoid creating a duplicate.

[github-actions]

Hello @sevenc-nanashi. Please provide a minimal reproduction using a GitHub repository or StackBlitz. Issues marked with needs reproduction will be closed if they have no activity within 3 days.

[sevenc-nanashi]

This is not a bug, but a feature request.

[hi-ogawa]

The reproduction of the warning would help a lot to understand the current situation and discuss the solution 🙏

[sevenc-nanashi]

https://github.com/sevenc-nanashi/vite-feature-request-mute-node-warning

I made an example.

Let's say:

• there is an application logic that is required from both renderer and electron,
  • isEven of myLogic.ts in that example
• the logic depends on another code that depends on platform,
  • log of log.ts in that example
• and that code uses dynamic import to switch whether to import node specific modules.
  • electron-log/main in that example

[hi-ogawa]

I think the underlying issue is expected to be dealt with in a different way than suppressing the warning.

I would imagine that ideally electron renderer build should tree shake out main process specific logic entirely and this can by normally achieved by build-time define. I'm not sure if vite-plugin-electron provides such mechanism, but doing this seems to work.

// vite.config.ts
export default defineConfig({
  plugins: [
    electron({
      main: {
        // Shortcut of `build.lib.entry`
        entry: "electron/main.ts",
        vite: {
          define: {
            '__ELECTRON_IS_NODE__': 'true'
          }
        }
      },
    }),
  ],
  define: {
    '__ELECTRON_IS_NODE__': 'false'
  },
});

// src/log.ts
export function log(message: string) {
  if (__ELECTRON_IS_NODE__) {
    if (!electronLog) {
      electronLog = import("electron-log/main");
    }
    electronLog.then(({ default: log }) => {
      log.log(message);
    });
    return;
  }
  console.log(message);
}

I'm closing this feature request since the suggested solution is not likely what Vite core needs to provide. I think this kind of needs can be solved at framework levels by providing a way/convention to branch out the code based on the environment.