eslint-plugin-jest 29.0.2-next.1 → 29.2.0

package/README.md

@@ -386,6 +386,7 @@ Manually fixable by
 | [valid-describe-callback](docs/rules/valid-describe-callback.md)                     | Enforce valid `describe()` callback                                       | ✅  |     |     |     |
 | [valid-expect](docs/rules/valid-expect.md)                                           | Enforce valid `expect()` usage                                            | ✅  |     | 🔧  |     |
 | [valid-expect-in-promise](docs/rules/valid-expect-in-promise.md)                     | Require promises that have expectations in their chain to be valid        | ✅  |     |     |     |
+| [valid-mock-module-path](docs/rules/valid-mock-module-path.md)                       | Disallow mocking of non-existing module paths                             |     |     |     |     |
 | [valid-title](docs/rules/valid-title.md)                                             | Enforce valid titles                                                      | ✅  |     | 🔧  |     |
 
 ### Requires Type Checking

package/docs/rules/prefer-lowercase-title.md

@@ -109,3 +109,18 @@ describe('MyClass', () => {
   });
 });
 ```
+
+### `ignoreTodos`
+
+This option is used to control whether
+[`todo`](https://jestjs.io/docs/api#testtodoname) Jest functions to be checked
+by this rule. By the default, the option is set to false.
+
+Example of **correct** code for the `{ "ignoreTodos": true }` option:
+
+```js
+/* eslint jest/prefer-lowercase-title: ["error", { "ignoreTodos": true }] */
+test.todo('Uppercase description');
+
+it.todo('Uppercase description');
+```

package/docs/rules/valid-mock-module-path.md

@@ -0,0 +1,70 @@
+# Disallow mocking of non-existing module paths (`valid-mock-module-path`)
+
+<!-- end auto-generated rule header -->
+
+This rule raises an error when using `jest.mock` and `jest.doMock` and the first
+argument for mocked object (module/local file) do not exist.
+
+## Rule details
+
+This rule checks existence of the supplied path for `jest.mock` or `jest.doMock`
+in the first argument.
+
+The following patterns are considered errors:
+
+```js
+// Module(s) that cannot be found
+jest.mock('@org/some-module-not-in-package-json');
+jest.mock('some-module-not-in-package-json');
+
+// Local module (directory) that cannot be found
+jest.mock('../../this/module/does/not/exist');
+
+// Local file that cannot be found
+jest.mock('../../this/path/does/not/exist.js');
+```
+
+The following patterns are **not** considered errors:
+
+```js
+// Module(s) that can be found
+jest.mock('@org/some-module-in-package-json');
+jest.mock('some-module-in-package-json');
+
+// Local module that cannot be found
+jest.mock('../../this/module/really/does/exist');
+
+// Local file that cannot be found
+jest.mock('../../this/path/really/does/exist.js');
+```
+
+## Options
+
+```json
+{
+  "jest/valid-mock-module-path": [
+    "error",
+    {
+      "moduleFileExtensions": [".js", ".ts", ".jsx", ".tsx", ".json"]
+    }
+  ]
+}
+```
+
+### `moduleFileExtensions`
+
+This array option controls which file extensions the plugin checks for
+existence. The default extensions are:
+
+- `".js"`
+- `".ts"`
+- `".jsx"`
+- `".tsx"`
+- `".json"`
+
+For any custom extension, a preceding dot **must** be present before the file
+extension for desired effect.
+
+## When Not To Use It
+
+Don't use this rule on non-jest test files.

package/docs/rules/valid-title.md

@@ -175,6 +175,7 @@ describe('foo', () => {
 interface Options {
   ignoreSpaces?: boolean;
   ignoreTypeOfDescribeName?: boolean;
+  ignoreTypeOfTestName?: boolean;
   disallowedWords?: string[];
   mustNotMatch?: Partial<Record<'describe' | 'test' | 'it', string>> | string;
   mustMatch?: Partial<Record<'describe' | 'test' | 'it', string>> | string;
@@ -187,12 +188,12 @@ Default: `false`
 
 When enabled, the leading and trailing spaces won't be checked.
 
-#### `ignoreTypeOfDescribeName`
+#### `ignoreTypeOfDescribeName` & `ignoreTypeOfTestName`
 
 Default: `false`
 
-When enabled, the type of the first argument to `describe` blocks won't be
-checked.
+When enabled, the type of the first argument to `describe`/`test` blocks won't
+be checked.
 
 #### `disallowedWords`
 

package/lib/rules/no-untyped-mock-factory.js

@@ -6,12 +6,6 @@ Object.defineProperty(exports, "__esModule", {
 exports.default = void 0;
 var _utils = require("@typescript-eslint/utils");
 var _utils2 = require("./utils");
-const findModuleName = node => {
-  if (node.type === _utils.AST_NODE_TYPES.Literal && typeof node.value === 'string') {
-    return node;
-  }
-  return null;
-};
 var _default = exports.default = (0, _utils2.createRule)({
   name: __filename,
   meta: {
@@ -46,7 +40,7 @@ var _default = exports.default = (0, _utils2.createRule)({
           if (hasTypeParameter || hasReturnType) {
             return;
           }
-          const moduleName = findModuleName(nameNode);
+          const moduleName = (0, _utils2.findModuleName)(nameNode);
           context.report({
             messageId: 'addTypeParameterToModuleMock',
             data: {

package/lib/rules/prefer-lowercase-title.js

@@ -53,6 +53,10 @@ var _default = exports.default = (0, _utils.createRule)({
         ignoreTopLevelDescribe: {
           type: 'boolean',
           default: false
+        },
+        ignoreTodos: {
+          type: 'boolean',
+          default: false
         }
       },
       additionalProperties: false
@@ -61,12 +65,14 @@ var _default = exports.default = (0, _utils.createRule)({
   defaultOptions: [{
     ignore: [],
     allowedPrefixes: [],
-    ignoreTopLevelDescribe: false
+    ignoreTopLevelDescribe: false,
+    ignoreTodos: false
   }],
   create(context, [{
     ignore = [],
     allowedPrefixes = [],
-    ignoreTopLevelDescribe
+    ignoreTopLevelDescribe,
+    ignoreTodos
   }]) {
     const ignores = populateIgnores(ignore);
     let numberOfDescribeBlocks = 0;
@@ -84,6 +90,11 @@ var _default = exports.default = (0, _utils.createRule)({
         } else if (jestFnCall.type !== 'test') {
           return;
         }
+
+        // Ignore *.todo test and/or test suites
+        if (ignoreTodos && jestFnCall.members.some(s => (0, _utils.getAccessorValue)(s) === 'todo')) {
+          return;
+        }
         const [firstArg] = node.arguments;
         const description = (0, _utils.getStringValue)(firstArg);
         if (allowedPrefixes.some(name => description.startsWith(name))) {

package/lib/rules/utils/misc.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.getFirstMatcherArg = exports.findTopMostCallExpression = exports.createRule = exports.TestCaseName = exports.ModifierName = exports.HookName = exports.EqualityMatcher = exports.DescribeAlias = void 0;
+exports.getFirstMatcherArg = exports.findTopMostCallExpression = exports.findModuleName = exports.createRule = exports.TestCaseName = exports.ModifierName = exports.HookName = exports.EqualityMatcher = exports.DescribeAlias = void 0;
 exports.getNodeName = getNodeName;
 exports.replaceAccessorFixer = exports.removeExtraArgumentsFixer = exports.isFunction = exports.isBooleanLiteral = exports.hasOnlyOneArgument = exports.getTestCallExpressionsFromDeclaredVariables = void 0;
 var _path = require("path");
@@ -158,4 +158,11 @@ const getFirstMatcherArg = expectFnCall => {
   }
   return (0, _followTypeAssertionChain.followTypeAssertionChain)(firstArg);
 };
-exports.getFirstMatcherArg = getFirstMatcherArg;
+exports.getFirstMatcherArg = getFirstMatcherArg;
+const findModuleName = node => {
+  if (node.type === _utils.AST_NODE_TYPES.Literal && typeof node.value === 'string') {
+    return node;
+  }
+  return null;
+};
+exports.findModuleName = findModuleName;

package/lib/rules/valid-mock-module-path.js

@@ -0,0 +1,90 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _fs = require("fs");
+var _path = _interopRequireDefault(require("path"));
+var _utils = require("@typescript-eslint/utils");
+var _utils2 = require("./utils");
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+var _default = exports.default = (0, _utils2.createRule)({
+  name: __filename,
+  meta: {
+    type: 'problem',
+    docs: {
+      description: 'Disallow mocking of non-existing module paths'
+    },
+    messages: {
+      invalidMockModulePath: 'Module path {{ moduleName }} does not exist'
+    },
+    schema: [{
+      type: 'object',
+      properties: {
+        moduleFileExtensions: {
+          type: 'array',
+          items: {
+            type: 'string'
+          },
+          additionalItems: false
+        }
+      },
+      additionalProperties: false
+    }]
+  },
+  defaultOptions: [{
+    moduleFileExtensions: ['.js', '.ts', '.tsx', '.jsx', '.json']
+  }],
+  create(context, [{
+    moduleFileExtensions = ['.js', '.ts', '.tsx', '.jsx', '.json']
+  }]) {
+    return {
+      CallExpression(node) {
+        if (node.callee.type !== _utils.AST_NODE_TYPES.MemberExpression) {
+          return;
+        }
+        if (!node.arguments.length || !(0, _utils2.isTypeOfJestFnCall)(node, context, ['jest']) || !((0, _utils2.isSupportedAccessor)(node.callee.property) && ['mock', 'doMock'].includes((0, _utils2.getAccessorValue)(node.callee.property)))) {
+          return;
+        }
+        const moduleName = (0, _utils2.findModuleName)(node.arguments[0]);
+        if (!moduleName) {
+          return;
+        }
+        try {
+          if (!moduleName.value.startsWith('.')) {
+            require.resolve(moduleName.value);
+            return;
+          }
+          const resolvedModulePath = _path.default.resolve(_path.default.dirname(context.filename), moduleName.value);
+          const hasPossiblyModulePaths = ['', ...moduleFileExtensions].some(ext => {
+            try {
+              (0, _fs.statSync)(`${resolvedModulePath}${ext}`);
+              return true;
+            } catch {
+              return false;
+            }
+          });
+          if (hasPossiblyModulePaths) {
+            return;
+          }
+        } catch (err) {
+          const castedErr = err;
+
+          // Reports unexpected issues when attempt to verify mocked module path.
+          // The list of possible errors is non-exhaustive.
+          if (castedErr.code !== 'MODULE_NOT_FOUND') {
+            throw new Error(`Error when trying to validate mock module path from \`jest.mock\`: ${err}`);
+          }
+        }
+        context.report({
+          messageId: 'invalidMockModulePath',
+          data: {
+            moduleName: moduleName.raw
+          },
+          node
+        });
+      }
+    };
+  }
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-jest",
-  "version": "29.0.2-next.1",
+  "version": "29.2.0",
   "description": "ESLint rules for Jest",
   "keywords": [
     "eslint",
@@ -94,13 +94,14 @@
     "@types/semver": "^7.5.8",
     "@typescript-eslint/eslint-plugin": "^8.0.0",
     "@typescript-eslint/parser": "^8.0.0",
+    "@typescript-eslint/utils": "^8.0.0",
     "babel-jest": "^30.0.0",
     "babel-plugin-replace-ts-export-assignment": "^0.0.2",
     "dedent": "^1.5.0",
     "eslint": "^8.57.0",
     "eslint-config-prettier": "^10.0.0",
     "eslint-doc-generator": "^2.0.0",
-    "eslint-plugin-eslint-plugin": "~7.0.0",
+    "eslint-plugin-eslint-plugin": "^6.0.0",
     "eslint-plugin-import": "^2.25.1",
     "eslint-plugin-n": "^17.0.0",
     "eslint-plugin-prettier": "^5.0.0",
@@ -133,7 +134,7 @@
       "optional": true
     }
   },
-  "packageManager": "yarn@4.10.3",
+  "packageManager": "yarn@4.11.0",
   "engines": {
     "node": "^20.12.0 || ^22.0.0 || >=24.0.0"
   }