Skip to content

chore(eslint-config): replace no-var-require with no-require-imports COMPASS-9459 #7017

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

Merged
merged 1 commit into from
Jun 16, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion configs/eslint-config-compass/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@ const extraTsRules = {
// clean those out and re-enable the rules
'@typescript-eslint/no-explicit-any': 'warn',
'@typescript-eslint/no-base-to-string': 'warn',
'@typescript-eslint/no-require-imports': 'warn',
'@typescript-eslint/no-unused-vars': [
'error',
{
Expand Down
2 changes: 1 addition & 1 deletion configs/webpack-config-compass/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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>;
};
Expand Down
4 changes: 2 additions & 2 deletions configs/webpack-config-compass/src/loaders.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand All @@ -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[];
Expand Down
2 changes: 1 addition & 1 deletion configs/webpack-config-compass/src/util.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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');
});

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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,
});
Expand Down
7 changes: 4 additions & 3 deletions packages/compass-e2e-tests/helpers/compass.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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'),
Expand Down Expand Up @@ -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'
);
Expand Down Expand Up @@ -966,6 +966,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
Expand Down Expand Up @@ -1100,7 +1101,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');
});
Expand Down
2 changes: 1 addition & 1 deletion packages/compass-e2e-tests/tests/auto-connect.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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');
});

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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)();

Expand Down
2 changes: 1 addition & 1 deletion packages/compass-import-export/src/utils/open-file.ts
Original file line number Diff line number Diff line change
@@ -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);
}
2 changes: 1 addition & 1 deletion packages/compass-intercom/src/setup-intercom.spec.ts
Original file line number Diff line number Diff line change
@@ -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';

Expand Down
2 changes: 1 addition & 1 deletion packages/compass-logging/src/ipc-logger.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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));
Expand Down
2 changes: 1 addition & 1 deletion packages/compass-schema-validation/test/mocha-plugins.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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, () => {}]));
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
2 changes: 1 addition & 1 deletion packages/compass-shell/src/modules/worker-runtime.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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,
});

Expand Down
2 changes: 1 addition & 1 deletion packages/compass-telemetry/src/ipc-track.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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>) =>
Expand Down
2 changes: 1 addition & 1 deletion packages/compass-utils/src/electron.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
/* eslint-disable @typescript-eslint/no-var-requires */
/* eslint-disable @typescript-eslint/no-require-imports */

function getElectronApp() {
let app;
Expand Down
2 changes: 1 addition & 1 deletion packages/compass/src/app/application.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ class Application {
*/
private enableDevelopmentDebug() {
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*');
}
}
Expand Down
2 changes: 1 addition & 1 deletion packages/compass/src/main/menu.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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);
});
Expand Down
2 changes: 1 addition & 1 deletion packages/compass/src/main/optional-deps.ts
Original file line number Diff line number Diff line change
@@ -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'],
Expand Down
2 changes: 1 addition & 1 deletion packages/compass/src/main/setup-csfle-library.ts
Original file line number Diff line number Diff line change
@@ -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';
Expand Down
Loading