fix(eslint): rename and re-enable no-require-imports rule; fix some missed cases

gribnoysup · gribnoysup · commit 858eb7feb101 · 2025-04-01T18:56:29.000+02:00
diff --git a/configs/eslint-config-compass/index.js b/configs/eslint-config-compass/index.js
@@ -20,7 +20,6 @@ const extraTsRules = {
   '@typescript-eslint/prefer-promise-reject-errors': 'off',
   '@typescript-eslint/no-explicit-any': 'off',
   '@typescript-eslint/no-base-to-string': 'off',
-  '@typescript-eslint/no-require-imports': 'off',
   '@typescript-eslint/no-unsafe-declaration-merging': 'off',
   '@typescript-eslint/unbound-method': 'off',
   '@typescript-eslint/no-redundant-type-constituents': 'off',
diff --git a/configs/webpack-config-compass/src/index.ts b/configs/webpack-config-compass/src/index.ts
@@ -301,7 +301,7 @@ export function createElectronRendererConfig(
 export function createWebConfig(args: Partial<ConfigArgs>): WebpackConfig {
   const opts = webpackArgsWithDefaults(args, { target: 'web' });
 
-  // eslint-disable-next-line @typescript-eslint/no-var-requires
+  // eslint-disable-next-line @typescript-eslint/no-require-imports
   const { peerDependencies } = require(path.join(opts.cwd, 'package.json')) as {
     peerDependencies: Record<string, string>;
   };
diff --git a/configs/webpack-config-compass/src/loaders.ts b/configs/webpack-config-compass/src/loaders.ts
@@ -7,7 +7,7 @@ import { isServe } from './args';
 import chalk from 'chalk';
 
 function isLatestBrowserslist() {
-  // eslint-disable-next-line @typescript-eslint/no-var-requires
+  // eslint-disable-next-line @typescript-eslint/no-require-imports
   const browserslistVersion = require('browserslist/package.json').version;
   const command = `npm view browserslist version --json`;
   const latestBrowserslistVersion = JSON.parse(
@@ -18,7 +18,7 @@ function isLatestBrowserslist() {
 }
 
 const electronVersion = (() => {
-  // eslint-disable-next-line @typescript-eslint/no-var-requires
+  // eslint-disable-next-line @typescript-eslint/no-require-imports
   const [maj, min] = require('electron/package.json').version.split(
     '.'
   ) as string[];
diff --git a/configs/webpack-config-compass/src/util.ts b/configs/webpack-config-compass/src/util.ts
@@ -62,7 +62,7 @@ export function camelCase(str: string): string {
 }
 
 export function getLibraryNameFromCwd(cwd: string): string {
-  // eslint-disable-next-line @typescript-eslint/no-var-requires
+  // eslint-disable-next-line @typescript-eslint/no-require-imports
   const { name, productName } = require(path.join(cwd, 'package.json')) as {
     name: string;
     productName: string;
diff --git a/packages/compass-e2e-tests/helpers/commands/get-feature.ts b/packages/compass-e2e-tests/helpers/commands/get-feature.ts
@@ -7,7 +7,7 @@ export async function getFeature<K extends keyof UserPreferences>(
 ): Promise<UserPreferences[K]> {
   return await browser.execute(async (_name) => {
     return (
-      // eslint-disable-next-line @typescript-eslint/no-var-requires
+      // eslint-disable-next-line @typescript-eslint/no-require-imports
       (await require('electron').ipcRenderer.invoke('compass:get-preferences'))[
         _name
       ]
diff --git a/packages/compass-e2e-tests/helpers/commands/open-settings-modal.ts b/packages/compass-e2e-tests/helpers/commands/open-settings-modal.ts
@@ -6,7 +6,7 @@ export async function openSettingsModal(
   tab?: string
 ): Promise<void> {
   await browser.execute(() => {
-    // eslint-disable-next-line @typescript-eslint/no-var-requires
+    // eslint-disable-next-line @typescript-eslint/no-require-imports
     require('electron').ipcRenderer.emit('window:show-settings');
   });
 
diff --git a/packages/compass-e2e-tests/helpers/commands/set-feature.ts b/packages/compass-e2e-tests/helpers/commands/set-feature.ts
@@ -31,7 +31,7 @@ export async function setFeature<K extends keyof UserPreferences>(
 
   await browser.execute(
     async (_name, _value) => {
-      // eslint-disable-next-line @typescript-eslint/no-var-requires
+      // eslint-disable-next-line @typescript-eslint/no-require-imports
       await require('electron').ipcRenderer.invoke('compass:save-preferences', {
         [_name]: _value === null ? undefined : _value,
       });
diff --git a/packages/compass-e2e-tests/helpers/compass.ts b/packages/compass-e2e-tests/helpers/compass.ts
@@ -220,7 +220,7 @@ export class Compass {
     // close it and load the logs
     [this.logPath, this.userDataPath, this.appName, this.mainProcessPid] =
       await this.browser.execute(() => {
-        // eslint-disable-next-line @typescript-eslint/no-var-requires
+        // eslint-disable-next-line @typescript-eslint/no-require-imports
         const { ipcRenderer } = require('electron');
         return Promise.all([
           ipcRenderer.invoke('compass:logPath'),
@@ -350,7 +350,7 @@ export class Compass {
       debug('Writing coverage');
       const coverage: Coverage = await this.browser.executeAsync((done) => {
         void (async () => {
-          // eslint-disable-next-line @typescript-eslint/no-var-requires
+          // eslint-disable-next-line @typescript-eslint/no-require-imports
           const mainCoverage = await require('electron').ipcRenderer.invoke(
             'coverage'
           );
@@ -963,6 +963,7 @@ async function getCompassBuildMetadata(): Promise<BinPathOptions> {
         packagerOptions: { name: process.env.COMPASS_APP_NAME },
       };
     } else {
+      // eslint-disable-next-line @typescript-eslint/no-require-imports
       metadata = require('mongodb-compass/dist/target.json');
     }
     // Double-checking that Compass app path exists, not only the metadata
@@ -1097,7 +1098,7 @@ export async function init(
     }
   } else {
     await browser.execute(() => {
-      // eslint-disable-next-line @typescript-eslint/no-var-requires
+      // eslint-disable-next-line @typescript-eslint/no-require-imports
       const { ipcRenderer } = require('electron');
       void ipcRenderer.invoke('compass:maximize');
     });
diff --git a/packages/compass-e2e-tests/tests/auto-connect.test.ts b/packages/compass-e2e-tests/tests/auto-connect.test.ts
@@ -307,7 +307,7 @@ describe('Automatically connecting from the command line', function () {
       await browser.closeWorkspaceTabs();
 
       await browser.execute(() => {
-        // eslint-disable-next-line @typescript-eslint/no-var-requires
+        // eslint-disable-next-line @typescript-eslint/no-require-imports
         require('electron').ipcRenderer.call('test:show-connect-window');
       });
 
diff --git a/packages/compass-import-export/src/components/export-modal.tsx b/packages/compass-import-export/src/components/export-modal.tsx
@@ -191,7 +191,7 @@ function ExportModal({
   );
 
   const onClickExport = useCallback(() => {
-    // eslint-disable-next-line @typescript-eslint/consistent-type-imports, @typescript-eslint/no-var-requires
+    // eslint-disable-next-line @typescript-eslint/consistent-type-imports, @typescript-eslint/no-require-imports
     const electron: typeof import('@electron/remote') = require('@electron/remote');
     const fileBackend = createElectronFileInputBackend(electron, null)();
 
diff --git a/packages/compass-import-export/src/utils/open-file.ts b/packages/compass-import-export/src/utils/open-file.ts
@@ -1,5 +1,5 @@
 export async function openFile(fileName: string) {
-  // eslint-disable-next-line @typescript-eslint/no-var-requires, @typescript-eslint/consistent-type-imports
+  // eslint-disable-next-line @typescript-eslint/no-require-imports, @typescript-eslint/consistent-type-imports
   const { shell }: typeof import('electron') = require('electron');
   return shell.openPath(fileName);
 }
diff --git a/packages/compass-intercom/src/setup-intercom.spec.ts b/packages/compass-intercom/src/setup-intercom.spec.ts
@@ -1,4 +1,4 @@
-/* eslint-disable @typescript-eslint/no-var-requires */
+/* eslint-disable @typescript-eslint/no-require-imports */
 import type { SinonStub } from 'sinon';
 import sinon from 'sinon';
 
diff --git a/packages/compass-logging/src/ipc-logger.ts b/packages/compass-logging/src/ipc-logger.ts
@@ -18,7 +18,7 @@ function emit(
 export function createLogger(component: string) {
   // This application may not be running in an Node.js/Electron context.
   const ipc: HadronIpcRenderer | null | undefined = isElectronRenderer
-    ? // eslint-disable-next-line @typescript-eslint/no-var-requires
+    ? // eslint-disable-next-line @typescript-eslint/no-require-imports
       require('hadron-ipc').ipcRenderer
     : null;
   return createGenericLogger(component, emit.bind(null, ipc));
diff --git a/packages/compass-schema-validation/test/mocha-plugins.ts b/packages/compass-schema-validation/test/mocha-plugins.ts
@@ -2,7 +2,7 @@ import { EventEmitter } from 'events';
 
 const setupIpc = () => {
   let preferences = {};
-  // eslint-disable-next-line @typescript-eslint/no-var-requires
+  // eslint-disable-next-line @typescript-eslint/no-require-imports
   require('hadron-ipc').ipcRenderer = Object.assign(new EventEmitter(), {
     createInvoke: (name: string, methods: string[]) => {
       return Object.fromEntries(methods.map((m) => [m, () => {}]));
diff --git a/packages/compass-serverstats/src/components/current-op-component.tsx b/packages/compass-serverstats/src/components/current-op-component.tsx
@@ -3,11 +3,11 @@ import { useTelemetry } from '@mongodb-js/compass-telemetry/provider';
 import { useConnectionInfoRef } from '@mongodb-js/compass-connections/provider';
 
 // No types exist for these files
-/* eslint-disable @typescript-eslint/no-var-requires */
+/* eslint-disable @typescript-eslint/no-require-imports */
 const timer = require('d3-timer');
 const Actions = require('../actions');
 const DBErrorStore = require('../stores/dberror-store');
-/* eslint-enable @typescript-eslint/no-var-requires */
+/* eslint-enable @typescript-eslint/no-require-imports */
 
 type Row = {
   ns: string;
diff --git a/packages/compass-shell/src/modules/worker-runtime.ts b/packages/compass-shell/src/modules/worker-runtime.ts
@@ -77,7 +77,7 @@ export function createWorkerRuntime(
       platform: process.platform,
       arch: process.arch,
     },
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-argument, @typescript-eslint/no-var-requires
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-argument, @typescript-eslint/no-require-imports
     mongoshVersion: require('../../package.json').version,
   });
 
diff --git a/packages/compass-telemetry/src/ipc-track.ts b/packages/compass-telemetry/src/ipc-track.ts
@@ -30,7 +30,7 @@ export function createIpcTrack(
 export function createIpcSendTrack() {
   // This application may not be running in an Node.js/Electron context.
   const ipc =
-    // eslint-disable-next-line @typescript-eslint/no-var-requires
+    // eslint-disable-next-line @typescript-eslint/no-require-imports
     require('hadron-ipc').ipcRenderer;
 
   const sendTrack = (event: string, properties: Record<string, unknown>) =>
diff --git a/packages/compass-utils/src/electron.ts b/packages/compass-utils/src/electron.ts
@@ -1,4 +1,4 @@
-/* eslint-disable @typescript-eslint/no-var-requires */
+/* eslint-disable @typescript-eslint/no-require-imports */
 
 function getElectronApp() {
   let app;
diff --git a/packages/compass/src/app/index.tsx b/packages/compass/src/app/index.tsx
@@ -183,24 +183,10 @@ const Application = View.extend({
    */
   preRender: function () {
     if (process.env.NODE_ENV === 'development') {
-      // eslint-disable-next-line @typescript-eslint/no-var-requires
+      // eslint-disable-next-line @typescript-eslint/no-require-imports
       require('debug').enable('mon*,had*');
     }
   },
-  /**
-   * Pre-load into the require cache a bunch of expensive modules while the
-   * user is choosing which connection, so when the user clicks on Connect,
-   * Compass can connect to the MongoDB instance faster.
-   */
-  postRender: function () {
-    marky.mark('Pre-loading additional modules required to connect');
-    // Seems like this doesn't have as much of an effect as we'd hoped as
-    // most of the expense has already occurred. You can see it take 1700ms
-    // or so if you move this to the top of the file.
-    require('local-links');
-    require('mongodb-instance-model');
-    marky.stop('Pre-loading additional modules required to connect');
-  },
   /**
    * Called a soon as the DOM is ready so we can
    * start showing status indicators as
@@ -398,7 +384,6 @@ const app = {
     // As soon as dom is ready, render and set up the rest.
     state.render();
     marky.stop('Time to Connect rendered');
-    state.postRender();
     marky.stop('Time to user can Click Connect');
     if (process.env.MONGODB_COMPASS_TEST_UNCAUGHT_EXCEPTION) {
       queueMicrotask(() => {
diff --git a/packages/compass/src/main/menu.spec.ts b/packages/compass/src/main/menu.spec.ts
@@ -25,7 +25,7 @@ describe('CompassMenu', function () {
   beforeEach(async function () {
     App.preferences = await createSandboxFromDefaultPreferences();
     delete require.cache[require.resolve('./menu')];
-    // eslint-disable-next-line @typescript-eslint/no-var-requires
+    // eslint-disable-next-line @typescript-eslint/no-require-imports
     CompassMenu = require('./menu').CompassMenu;
     CompassMenu.init(App);
   });
diff --git a/packages/compass/src/main/optional-deps.ts b/packages/compass/src/main/optional-deps.ts
@@ -1,4 +1,4 @@
-/* eslint-disable @typescript-eslint/no-var-requires */
+/* eslint-disable @typescript-eslint/no-require-imports */
 const attempts = [
   [() => require('interruptor'), 'interruptor'],
   [() => require('keytar'), 'keytar'],
diff --git a/packages/compass/src/main/setup-csfle-library.ts b/packages/compass/src/main/setup-csfle-library.ts
@@ -1,4 +1,4 @@
-/* eslint-disable @typescript-eslint/no-var-requires */
+/* eslint-disable @typescript-eslint/no-require-imports */
 import { createLogger } from '@mongodb-js/compass-logging';
 import path from 'path';
 import { promises as fs } from 'fs';

Original file line number	Diff line number	Diff line change
`@@ -62,7 +62,7 @@ export function camelCase(str: string): string {`
`62`	`62`	`}`
`63`	`63`
`64`	`64`	`export function getLibraryNameFromCwd(cwd: string): string {`
`65`		`- // eslint-disable-next-line @typescript-eslint/no-var-requires`
	`65`	`+ // eslint-disable-next-line @typescript-eslint/no-require-imports`
`66`	`66`	`const { name, productName } = require(path.join(cwd, 'package.json')) as {`
`67`	`67`	`name: string;`
`68`	`68`	`productName: string;`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@ export async function getFeature<K extends keyof UserPreferences>(`
`7`	`7`	`): Promise<UserPreferences[K]> {`
`8`	`8`	`return await browser.execute(async (_name) => {`
`9`	`9`	`return (`
`10`		`- // eslint-disable-next-line @typescript-eslint/no-var-requires`
	`10`	`+ // eslint-disable-next-line @typescript-eslint/no-require-imports`
`11`	`11`	`(await require('electron').ipcRenderer.invoke('compass:get-preferences'))[`
`12`	`12`	`_name`
`13`	`13`	`]`