chore(eslint-config): replace no-unused-expressions with chai-friendly version COMPASS-9459 (#7018)

chore(eslint-config): replace no-unused-expressions with chai-friendly version

Author: gribnoysup

configs/eslint-config-compass/index.js

@@ -3,6 +3,7 @@
 const path = require('path');
 const shared = require('@mongodb-js/eslint-config-devtools');
 const common = require('@mongodb-js/eslint-config-devtools/common');
+const chaiFriendly = require('eslint-plugin-chai-friendly');
 
 const extraTsRules = {
   // Newly converted plugins use `any` quite a lot, we can't enable the rule,
@@ -15,6 +16,8 @@ const extraTsRules = {
     'error',
     { fixMixedExportsWithInlineTypeSpecifier: false },
   ],
+  // We use chai outside of tests, hence applying these rules to all ts files
+  ...chaiFriendly.configs.recommended.rules,
   '@typescript-eslint/prefer-promise-reject-errors': 'off',
   '@typescript-eslint/only-throw-error': 'off',
 
@@ -28,7 +31,6 @@ const extraTsRules = {
       caughtErrors: 'none', // should be `'all'`
     },
   ],
-  '@typescript-eslint/no-unused-expressions': 'off', // replace with eslint-plugin-chai-friendly
   '@typescript-eslint/no-redundant-type-constituents': 'warn',
   '@typescript-eslint/unbound-method': 'warn',
   '@typescript-eslint/no-duplicate-type-constituents': 'warn',
@@ -105,7 +107,7 @@ const testTsOverrides = {
 };
 
 module.exports = {
-  plugins: [...shared.plugins, '@mongodb-js/compass'],
+  plugins: [...shared.plugins, '@mongodb-js/compass', 'chai-friendly'],
   rules: {
     ...shared.rules,
     '@mongodb-js/compass/no-leafygreen-outside-compass-components': 'error',

configs/eslint-config-compass/package.json

@@ -22,6 +22,7 @@
     "@typescript-eslint/parser": "^8.34.0",
     "eslint": "^8.57.1",
     "eslint-config-prettier": "^8.3.0",
+    "eslint-plugin-chai-friendly": "^1.1.0",
     "eslint-plugin-filename-rules": "^1.2.0",
     "eslint-plugin-jsx-a11y": "^6.10.2",
     "eslint-plugin-mocha": "^8.0.0",

package-lock.json

@@ -90,7 +90,7 @@ export function DropdownMenuButton<Action extends string>({
             data-testid={dataTestId ? `${dataTestId}-show-actions` : undefined}
             onClick={(evt) => {
               evt.stopPropagation();
-              onClick && onClick(evt);
+              onClick?.(evt);
             }}
             rightGlyph={<Icon glyph={'CaretDown'} />}
             title={buttonText}

packages/compass-components/src/components/actions/dropdown-menu-button.tsx

@@ -124,7 +124,7 @@ export function ItemActionMenu<Action extends string>({
               }
               onClick={(evt) => {
                 evt.stopPropagation();
-                onClick && onClick(evt);
+                onClick?.(evt);
               }}
               className={iconClassName}
               style={iconStyle}

packages/compass-components/src/components/actions/item-action-menu.tsx

@@ -448,7 +448,11 @@ export const HadronElement: React.FunctionComponent<{
   } = useHadronElement(element);
 
   const toggleExpanded = () => {
-    expanded ? collapse() : expand();
+    if (expanded) {
+      collapse();
+    } else {
+      expand();
+    }
   };
 
   const lineNumberMinWidth = useMemo(() => {

packages/compass-components/src/components/document-list/element.tsx

@@ -112,9 +112,7 @@ const ExplainTree: React.FunctionComponent<ExplainTreeProps> = ({
             <ExplainTreeStage
               detailsOpen={detailsOpen === key}
               onToggleDetailsClick={() => {
-                detailsOpen === key
-                  ? setDetailsOpen(null)
-                  : setDetailsOpen(key);
+                setDetailsOpen(detailsOpen === key ? null : key);
               }}
               {...node}
               totalExecTimeMS={root.curStageExecTimeMS}

packages/compass-explain-plan/src/components/explain-tree/explain-tree.tsx

@@ -366,7 +366,11 @@ function GenerativeAIInput({
         }
         handleSubmit(aiPromptText);
       } else if (evt.key === 'Escape') {
-        isFetching ? onCancelRequest() : onClose();
+        if (isFetching) {
+          onCancelRequest();
+        } else {
+          onClose();
+        }
       }
     },
     [aiPromptText, onClose, handleSubmit, isFetching, onCancelRequest]

packages/compass-generative-ai/src/components/generative-ai-input.tsx

@@ -225,7 +225,7 @@ describe('GlobalWritesStore Store', function () {
 
   afterEach(() => {
     sinon.restore();
-    clock && clock.restore();
+    clock?.restore();
   });
 
   it('sets the initial state', function () {

packages/compass-global-writes/src/store/index.spec.ts

@@ -411,10 +411,11 @@ export const runExport = ({
             projection: createProjectionFromSchemaFields(
               Object.values(fieldsToExport)
                 .filter((field) => {
-                  field.selected
-                    ? fieldsIncludedCount++
-                    : fieldsExcludedCount++;
-
+                  if (field.selected) {
+                    fieldsIncludedCount++;
+                  } else {
+                    fieldsExcludedCount++;
+                  }
                   return field.selected;
                 })
                 .map((field) => field.path)

packages/compass-import-export/src/modules/export.ts

@@ -21,7 +21,7 @@ export class Semaphore {
     this.currentCount--;
     if (this.queue.length > 0) {
       const next = this.queue.shift();
-      next && next();
+      next?.();
     }
   }
 }

packages/compass-user-data/src/semaphore.ts

@@ -53,7 +53,9 @@ export async function raceWithAbort<T>(
   try {
     return await Promise.race([pendingPromise, promise]);
   } finally {
-    abortListener && signal.removeEventListener('abort', abortListener);
+    if (abortListener) {
+      signal.removeEventListener('abort', abortListener);
+    }
   }
 }
 

packages/compass-utils/src/cancellable-promise.ts

@@ -288,7 +288,7 @@ const CompassWeb = ({
 
   const telemetryOptions = useRef<TelemetryServiceOptions>({
     sendTrack: (event: string, properties: Record<string, any> | undefined) => {
-      onTrackRef.current && void onTrackRef.current(event, properties || {});
+      void onTrackRef.current?.(event, properties || {});
     },
     logger,
     preferences: preferencesAccess.current,

packages/compass-web/src/entrypoint.tsx

@@ -39,26 +39,29 @@ function quitItem(
     label: label,
     accelerator: 'CmdOrCtrl+Q',
     click() {
-      !compassApp.preferences.getPreferences().enableShowDialogOnQuit
-        ? electronApp.quit()
-        : void dialog
-            .showMessageBox({
-              type: 'warning',
-              title: `Quit ${electronApp.getName()}`,
-              icon: COMPASS_ICON,
-              message: 'Are you sure you want to quit?',
-              buttons: ['Quit', 'Cancel'],
-              checkboxLabel: 'Do not ask me again',
-            })
-            .then((result) => {
-              if (result.response === 0) {
-                if (result.checkboxChecked)
-                  void compassApp.preferences.savePreferences({
-                    enableShowDialogOnQuit: false,
-                  });
-                electronApp.quit();
-              }
-            });
+      if (!compassApp.preferences.getPreferences().enableShowDialogOnQuit) {
+        electronApp.quit();
+        return;
+      }
+
+      void dialog
+        .showMessageBox({
+          type: 'warning',
+          title: `Quit ${electronApp.getName()}`,
+          icon: COMPASS_ICON,
+          message: 'Are you sure you want to quit?',
+          buttons: ['Quit', 'Cancel'],
+          checkboxLabel: 'Do not ask me again',
+        })
+        .then((result) => {
+          if (result.response === 0) {
+            if (result.checkboxChecked)
+              void compassApp.preferences.savePreferences({
+                enableShowDialogOnQuit: false,
+              });
+            electronApp.quit();
+          }
+        });
     },
   };
 }