feat(eslint): add eslint plugin, add expect method call lint rule COMPASS-10060

configs/eslint-config-devtools/common.js

@@ -36,6 +36,7 @@ const testRules = {
   'mocha/no-setup-in-describe': 'off',
   '@typescript-eslint/no-explicit-any': 'off',
   '@typescript-eslint/no-empty-function': 'off',
+  '@mongodb-js/devtools/no-expect-method-without-call': 'error',
 };
 
 const jsConfigurations = ['eslint:recommended'];
@@ -124,7 +125,9 @@ const testOverrides = {
   ],
   env: { mocha: true },
   extends: [...testConfigurations],
-  rules: { ...testRules },
+  rules: {
+    ...testRules,
+  },
 };
 
 module.exports = {

configs/eslint-config-devtools/index.js

@@ -10,6 +10,7 @@ module.exports = {
     'react',
     'react-hooks',
     'filename-rules',
+    '@mongodb-js/devtools',
   ],
   rules: {
     'filename-rules/match': ['error', common.kebabcase],

configs/eslint-config-devtools/package.json

@@ -18,6 +18,7 @@
     "@babel/eslint-parser": "^7.22.7",
     "@babel/preset-env": "^7.22.7",
     "@babel/preset-react": "^7.22.5",
+    "@mongodb-js/eslint-plugin-devtools": "^0.1.0",
     "@typescript-eslint/eslint-plugin": "^5.59.0",
     "@typescript-eslint/parser": "^5.59.0",
     "eslint-config-prettier": "^8.3.0",

configs/eslint-plugin-devtools/.depcheckrc

@@ -0,0 +1,3 @@
+ignores:
+ - '@mongodb-js/prettier-config-devtools'
+ - '@mongodb-js/eslint-config-devtools'

configs/eslint-plugin-devtools/.eslintignore

@@ -0,0 +1,2 @@
+.nyc-output
+dist

configs/eslint-plugin-devtools/.eslintrc.js

@@ -0,0 +1,9 @@
+'use strict';
+module.exports = {
+  root: true,
+  extends: ['@mongodb-js/eslint-config-devtools'],
+  parserOptions: {
+    tsconfigRootDir: __dirname,
+    project: ['./tsconfig-lint.json'],
+  },
+};

configs/eslint-plugin-devtools/.mocharc.js

@@ -0,0 +1,6 @@
+'use strict';
+module.exports = {
+  ...require('@mongodb-js/mocha-config-devtools'),
+  spec: ['rules/**/*.test.js'],
+  watchFiles: ['rules/**/*.js'],
+};

configs/eslint-plugin-devtools/.prettierrc.json

@@ -0,0 +1 @@
+"@mongodb-js/prettier-config-devtools"

configs/eslint-plugin-devtools/index.js

@@ -0,0 +1,6 @@
+'use strict';
+module.exports = {
+  rules: {
+    'no-expect-method-without-call': require('./rules/no-expect-method-without-call'),
+  },
+};

configs/eslint-plugin-devtools/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@mongodb-js/eslint-plugin-devtools",
+  "description": "Custom eslint rules for DevTools",
+  "homepage": "https://github.com/mongodb-js/devtools-shared",
+  "version": "0.1.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/mongodb-js/devtools-shared.git"
+  },
+  "files": [
+    "dist"
+  ],
+  "license": "SSPL",
+  "main": "index.js",
+  "scripts": {
+    "eslint": "eslint",
+    "prettier": "prettier",
+    "lint": "npm run eslint . && npm run prettier -- --check .",
+    "depcheck": "depcheck",
+    "check": "npm run lint && npm run depcheck",
+    "check-ci": "npm run check",
+    "test": "mocha",
+    "test-cov": "nyc --compact=false --produce-source-map=false -x \"**/*.spec.*\" --reporter=lcov --reporter=text --reporter=html npm run test",
+    "test-watch": "npm run test -- --watch",
+    "test-ci": "npm run test-cov",
+    "reformat": "npm run eslint . -- --fix && npm run prettier -- --write ."
+  },
+  "devDependencies": {
+    "@mongodb-js/mocha-config-devtools": "^1.0.5",
+    "@mongodb-js/prettier-config-devtools": "^1.0.1",
+    "depcheck": "^1.4.7",
+    "eslint": "^7.25.0",
+    "mocha": "^8.4.0",
+    "nyc": "^15.1.0"
+  }
+}

configs/eslint-plugin-devtools/rules/no-expect-method-without-call.js

@@ -0,0 +1,119 @@
+'use strict';
+
+const PROPERTY_TERMINATORS = [
+  // Default chai terminators.
+  'ok',
+  'true',
+  'false',
+  'null',
+  'undefined',
+  'exist',
+  'empty',
+  'arguments',
+  'NaN',
+  'extensible',
+  'sealed',
+  'frozen',
+  'finite',
+
+  // Terminators from chai-as-promised.
+  'fulfilled',
+  'rejected',
+
+  // Terminators from sinon-chai.
+  'called',
+  'calledOnce',
+  'calledTwice',
+  'calledThrice',
+  'calledWithNew',
+
+  // Terminators from chai-dom.
+  'displayed',
+  'visible',
+  'focus',
+  'checked',
+];
+
+function followNodeChainToExpectCall(node) {
+  while (node) {
+    if (node.type === 'CallExpression') {
+      if (node.callee.type === 'Identifier' && node.callee.name === 'expect') {
+        return node;
+      }
+      if (node.callee.type === 'MemberExpression') {
+        node = node.callee.object;
+        continue;
+      }
+    }
+
+    // Continue on the node chain (e.g. .not, .to).
+    if (node.type === 'MemberExpression') {
+      node = node.object;
+      continue;
+    }
+
+    break;
+  }
+}
+
+/** @type {import('eslint').Rule.RuleModule} */
+module.exports = {
+  meta: {
+    type: 'problem',
+    docs: {
+      description:
+        'Require invocation of expect method assertions (e.g., to.throw())',
+    },
+  },
+
+  create(context) {
+    const options = context.options[0] ?? {};
+    const additionalTerminators = options.properties ?? [];
+    const validTerminators = [
+      ...PROPERTY_TERMINATORS,
+      ...additionalTerminators,
+    ];
+
+    return {
+      MemberExpression(node) {
+        if (
+          node.type !== 'MemberExpression' ||
+          validTerminators.includes(node.property.name) ||
+          node.property.name === 'expect'
+        ) {
+          return null;
+        }
+
+        const isInvoked =
+          node.parent &&
+          node.parent.type === 'CallExpression' &&
+          node.parent.callee === node;
+
+        const isPartOfLongerChain =
+          node.parent &&
+          node.parent.type === 'MemberExpression' &&
+          node.parent.object === node;
+
+        if (isInvoked || isPartOfLongerChain) {
+          return null;
+        }
+
+        const expectCall = followNodeChainToExpectCall(node);
+        if (!expectCall) {
+          return null;
+        }
+
+        const source = context.getSourceCode();
+        const calleeText = source.getText(node);
+        const expectText = source.getText(expectCall);
+        const assertionText = calleeText.substring(expectText.length + 1);
+
+        context.report({
+          node,
+          // message: `"${assertionText}" used as function`
+          message: `expect().${assertionText} must be invoked with parentheses, e.g., expect().${assertionText}()`,
+        });
+      },
+    };
+  },
+};